Subversion Repositories

.\" -*- nroff -*-
.Dd 17 August 2008
.Os "The Prayer Webmail Interface"
.ds volume-operating-system
.Dt PRAYER 8
.Sh NAME
.Nm prayer
.Nd standalone IMAP-based webmail server
.Sh SYNOPSIS
.Nm
.Oo Fl -config-file
.Ar file Oc
.Oo Oo Fl -config-option
.Ar name Ns = Ns Ar value Oc
.Ar ... Oc
.Op Fl -foreground | -disable-prefork
.Oo Fl -disable-session | -
.Ar session-options Ar ... Oc
.
.Sh DESCRIPTION
.Nm
is the normal frontend daemon in the Prayer Webmail system. It is a
simple HTTP server and proxy that serves icons and other static files,
but firstly and foremostly forwards requests to the correct backend
daemons based on session IDs passed either in cookies or as part of
the URL.
.Pp
The master daemon normally preforks a number of child processes that
each will serve a configurable number of requests. The total number of
child processes is limited to prevent denial of service attacks.
.Pp
.Nm
accepts the following command-line options:
.Bl -tag -width indent
.It Fl -config-file Ar file
Reads configuration from
.Ar file
instead of the default.
.It Fl -config-option Ar name Ns = Ns Ar value
Sets (overrides) the configuration option
.Ar name No to Ar value .
Any number of options can be specified in this manner.
.It Fl -foreground
Debug mode. Run a single process in the foreground.
.It Fl -disable-prefork
Disable preforking. The master daemon will listen for connections
on the configured ports and spawn child processes one at a time.
.It Fl -disable-session
Do not start the session server,
.Xr prayer-session 8 .
.It Fl -
End of
.Nm
options; remaining options will be passed to 
.Xr prayer-session 8 .
.El
.
.Sh ENVIRONMENT
.
.Bl -tag -width ".Ev PRAYER_CONFIG_FILE "
.It Ev PRAYER_CONFIG_FILE
Can be set to specify the configuration file to use.
.It Ev PRAYER_HOSTNAME
Local hostname. Overrides the
.Cd hostname
setting in the configuration file as well as on the command line.
.El
.
.Sh FILES
.
.Bl -tag -compact
.It Pa /etc/prayer/prayer.cf
Default configuration file.
.It Pa /usr/share/prayer/icons/
Location of the standard icons used by the interface.
.It Pa /usr/share/prayer/static/
Directory containing other static files; currently only CSS files.
.It Pa /var/run/prayer/sockets/
Pre-configured location of sockets for frontend to backend communication.
.El
.
.Sh SEE ALSO
.
.Xr prayer-session 8 ,
.Xr prayer.cf 5
.
.Sh AUTHORS
.
This manual page was put together by
.An -nosplit
.An "Magnus Holmgren" <holmgren@debian.org>
.No using documentation written by An "David Carter" <dpc22@cam.ac.uk> .
.\" .Sh BUGS