Subversion Repositories

?revision_form?Rev ?revision_input??revision_submit??revision_endform?

Rev 61 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 61 Rev 71
1 
.\" -*- nroff -*-
1 
.\" -*- nroff -*-
2 
.Dd 17 August 2008
2 
.Dd 17 August 2008
3 
.Os "The Prayer Webmail Interface"
3 
.Os "The Prayer Webmail Interface"
4 
.ds volume-operating-system
4 
.ds volume-operating-system
5 
.Dt PRAYER 8
5 
.Dt PRAYER 8
6 
.Sh NAME
6 
.Sh NAME
7 
.Nm prayer
7 
.Nm prayer
8 
.Nd standalone IMAP-based webmail server
8 
.Nd standalone IMAP-based webmail server
9 
.Sh SYNOPSIS
9 
.Sh SYNOPSIS
10 
.Nm
10 
.Nm
11 
.Oo Fl -config-file
11 
.Oo Fl -config-file
12 
.Ar file Oc
12 
.Ar file Oc
13 
.Oo Oo Fl -config-option
13 
.Oo Oo Fl -config-option
14 
.Ar name Ns = Ns Ar value Oc
14 
.Ar name Ns = Ns Ar value Oc
15 
.Ar ... Oc
15 
.Ar ... Oc
16 
.Op Fl -foreground | -disable-prefork
16 
.Op Fl -foreground | -disable-prefork
17 
.Oo Fl -disable-session | -
17 
.Oo Fl -disable-session | -
18 
.Ar session-options Ar ... Oc
18 
.Ar session-options Ar ... Oc
19 
.
19 
.
20 
.Sh DESCRIPTION
20 
.Sh DESCRIPTION
21 
.Nm
21 
.Nm
22 
is the normal frontend daemon in the Prayer Webmail system. It is a
22 
is the normal frontend daemon in the Prayer Webmail system. It is a
23 
simple HTTP server and proxy that serves icons and other static files,
23 
simple HTTP server and proxy that serves icons and other static files,
24 
but firstly and foremostly forwards requests to the correct backend
24 
but firstly and foremostly forwards requests to the correct backend
25 
daemons based on session IDs passed either in cookies or as part of
25 
daemons based on session IDs passed either in cookies or as part of
26 
the URL.
26 
the URL.
27 
.Pp
27 
.Pp
28 
The master daemon normally preforks a number of child processes that
28 
The master daemon normally preforks a number of child processes that
29 
each will serve a configurable number of requests. The total number of
29 
each will serve a configurable number of requests. The total number of
30 
child processes is limited to prevent denial of service attacks.
30 
child processes is limited to prevent denial of service attacks.
31 
.Pp
31 
.Pp
32 
.Nm
32 
.Nm
33 
accepts the following command-line options:
33 
accepts the following command-line options:
34 
.Bl -tag -width indent
34 
.Bl -tag -width indent
35 
.It Fl -config-file Ar file
35 
.It Fl -config-file Ar file
36 
Reads configuration from
36 
Reads configuration from
37 
.Ar file
37 
.Ar file
38 
instead of the default.
38 
instead of the default.
39 
.It Fl -config-option Ar name Ns = Ns Ar value
39 
.It Fl -config-option Ar name Ns = Ns Ar value
40 
Sets (overrides) the configuration option
40 
Sets (overrides) the configuration option
41 
.Ar name No to Ar value .
41 
.Ar name No to Ar value .
42 
Any number of options can be specified in this manner.
42 
Any number of options can be specified in this manner.
43 
.It Fl -foreground
43 
.It Fl -foreground
44 
Debug mode. Run a single process in the foreground.
44 
Debug mode. Run a single process in the foreground.
45 
.It Fl -disable-prefork
45 
.It Fl -disable-prefork
46 
Disable preforking. The master daemon will listen for connections
46 
Disable preforking. The master daemon will listen for connections
47 
on the configured ports and spawn child processes one at a time.
47 
on the configured ports and spawn child processes one at a time.
48 
.It Fl -disable-session
48 
.It Fl -disable-session
49 
Do not start the session server,
49 
Do not start the session server,
50 
.Xr prayer-session 8 .
50 
.Xr prayer-session 8 .
51 
.It Fl -
51 
.It Fl -
52 
End of
52 
End of
53 
.Nm
53 
.Nm
54 
options; remaining options will be passed to
54 
options; remaining options will be passed to
55 
.Xr prayer-session 8 .
55 
.Xr prayer-session 8 .
56 
.El
56 
.El
57 
.
57 
.
58 
.Sh ENVIRONMENT
58 
.Sh ENVIRONMENT
59 
.
59 
.
60 
.Bl -tag -width ".Ev PRAYER_CONFIG_FILE "
60 
.Bl -tag -width ".Ev PRAYER_CONFIG_FILE "
61 
.It Ev PRAYER_CONFIG_FILE
61 
.It Ev PRAYER_CONFIG_FILE
62 
Can be set to specify the configuration file to use.
62 
Can be set to specify the configuration file to use.
63 
.It Ev PRAYER_HOSTNAME
63 
.It Ev PRAYER_HOSTNAME
64 
Local hostname. Overrides the
64 
Local hostname. Overrides the
65 
.Cd hostname
65 
.Cd hostname
66 
setting in the configuration file as well as on the command line.
66 
setting in the configuration file as well as on the command line.
67 
.El
67 
.El
68 
.
68 
.
69 
.Sh FILES
69 
.Sh FILES
70 
.
70 
.
71 
.Bl -tag -compact
71 
.Bl -tag -compact
72 
.It Pa /etc/prayer/prayer.cf
72 
.It Pa /etc/prayer/prayer.cf
73 
Default configuration file.
73 
Default configuration file.
74 
.It Pa /usr/share/prayer/icons/
74 
.It Pa /usr/share/prayer/icons/
75 
Location of the standard icons used by the interface.
75 
Location of the standard icons used by the interface.
76 
.It Pa /usr/share/prayer/static/
76 
.It Pa /usr/share/prayer/static/
77 
Directory containing other static files; currently only CSS files.
77 
Directory containing other static files; currently only CSS files.
78 
.It Pa /var/run/prayer/sockets/
78 
.It Pa /var/run/prayer/sockets/
79 
Pre-configured location of sockets for frontend to backend communication.
79 
Pre-configured location of sockets for frontend to backend communication.
80 
.El
80 
.El
81 
.
81 
.
82 
.Sh SEE ALSO
82 
.Sh SEE ALSO
83 
.
83 
.
84 
.Xr prayer-session 8 ,
84 
.Xr prayer-session 8 ,
85 
.Xr prayer.cf 5
85 
.Xr prayer.cf 5
86 
.
86 
.
87 
.Sh AUTHORS
87 
.Sh AUTHORS
88 
.
88 
.
89 
This manual page was put together by
89 
This manual page was put together by
90 
.An -nosplit
90 
.An -nosplit
91 
.An "Magnus Holmgren" <holmgren@debian.org>
91 
.An "Magnus Holmgren" <holmgren@debian.org>
92 
.No using documentation written by An "David Carter" <dpc22@cam.ac.uk> .
92 
.No using documentation written by An "David Carter" <dpc22@cam.ac.uk> .
93 
.\" .Sh BUGS
93 
.\" .Sh BUGS