Subversion Repositories

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

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

Rev 67 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-SESSION 8
5 
.Dt PRAYER-SESSION 8
6 
.Sh NAME
6 
.Sh NAME
7 
.Nm prayer-session
7 
.Nm prayer-session
8 
.Nd Prayer user session backend daemon
8 
.Nd Prayer user session backend daemon
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
16 
.Op Fl -foreground
17 
.Sh DESCRIPTION
17 
.Sh DESCRIPTION
18 
.Nm
18 
.Nm
19 
is the backend process in the Prayer Webmail system. A fresh
19 
is the backend process in the Prayer Webmail system. A fresh
20 
.Nm
20 
.Nm
21 
backend is forked off whenever a user logs in.
21 
backend is forked off whenever a user logs in.
22 
.Pp
22 
.Pp
23 
This process contains all of the permanent state associated with that login
23 
This process contains all of the permanent state associated with that login
24 
session including one or more connections to a IMAP server and possibly
24 
session including one or more connections to a IMAP server and possibly
25 
connections to accountd servers. prayer-session communicates with the user
25 
connections to accountd servers. prayer-session communicates with the user
26 
using HTML over HTTP connections via the
26 
using HTML over HTTP connections via the
27 
.Xr prayer 8 proxy. Each login has a session ID that the front end processes
27 
.Xr prayer 8 proxy. Each login has a session ID that the front end processes
28 
use to find the correct backend.
28 
use to find the correct backend.
29 
.Pp
29 
.Pp
30 
Backend server processes move into a dormant state after a certain period
30 
Backend server processes move into a dormant state after a certain period
31 
of inactivity, shutting down IMAP and accountd connections which can be
31 
of inactivity, shutting down IMAP and accountd connections which can be
32 
easily resuscitated when the session wakes up. After a long period of
32 
easily resuscitated when the session wakes up. After a long period of
33 
inactivity, typically several hours the session process shuts down.
33 
inactivity, typically several hours the session process shuts down.
34 
.Pp
34 
.Pp
35 
.Nm
35 
.Nm
36 
accepts the following command-line options:
36 
accepts the following command-line options:
37 
.Bl -tag -width Ds
37 
.Bl -tag -width Ds
38 
.It	Fl -config-file Ar file
38 
.It	Fl -config-file Ar file
39 
Reads configuration from
39 
Reads configuration from
40 
.Ar file
40 
.Ar file
41 
instead of the default
41 
instead of the default
42 
.Pa /etc/prayer/prayer.cf .
42 
.Pa /etc/prayer/prayer.cf .
43 
.It Fl -config-option Ar name Ns = Ns Ar value
43 
.It Fl -config-option Ar name Ns = Ns Ar value
44 
Sets (overrides) the configuration option
44 
Sets (overrides) the configuration option
45 
.Ar name
45 
.Ar name
46 
to
46 
to
47 
.Ar value .
47 
.Ar value .
48 
Any number of options can be specified in this manner.
48 
Any number of options can be specified in this manner.
49 
.It Fl -foreground
49 
.It Fl -foreground
50 
Debug mode. Run a single process in the foreground.
50 
Debug mode. Run a single process in the foreground.
51 
.El
51 
.El
52 
.
52 
.
53 
.Sh ENVIRONMENT
53 
.Sh ENVIRONMENT
54 
.
54 
.
55 
.Bl -tag -width Ds
55 
.Bl -tag -width Ds
56 
.It Ev PRAYER_CONFIG_FILE
56 
.It Ev PRAYER_CONFIG_FILE
57 
Can be set to specify the configuration file to use. The
57 
Can be set to specify the configuration file to use. The
58 
.Fl -config-file
58 
.Fl -config-file
59 
option takes precedence over this variable.
59 
option takes precedence over this variable.
60 
.It Ev PRAYER_HOSTNAME
60 
.It Ev PRAYER_HOSTNAME
61 
Local hostname. Overrides the
61 
Local hostname. Overrides the
62 
.Cd hostname
62 
.Cd hostname
63 
setting in the configuration file as well as on the command line.
63 
setting in the configuration file as well as on the command line.
64 
.El
64 
.El
65 
.Sh FILES
65 
.Sh FILES
66 
.Bl -tag -width Ds
66 
.Bl -tag -width Ds
67 
.It Pa /etc/prayer/prayer.cf
67 
.It Pa /etc/prayer/prayer.cf
68 
Default configuration file.
68 
Default configuration file.
69 
.It /usr/share/prayer/templates/
69 
.It /usr/share/prayer/templates/
70 
Location of standard templates (in the separate
70 
Location of standard templates (in the separate
71 
.Em prayer-templates
71 
.Em prayer-templates
72 
package). The templates are compiled into
72 
package). The templates are compiled into
73 
.Nm
73 
.Nm
74 
for performance reasons, so the template files are actually not
74 
for performance reasons, so the template files are actually not
75 
used, but they are available for customization.
75 
used, but they are available for customization.
76 
.It /etc/prayer/templates/
76 
.It /etc/prayer/templates/
77 
The Debian pre-configured
77 
The Debian pre-configured
78 
.Cd template_path .
78 
.Cd template_path .
79 
As a Debian extension,
79 
As a Debian extension,
80 
.Nm
80 
.Nm
81 
looks here before falling back to the compiled template if
81 
looks here before falling back to the compiled template if
82 
.Cd template_use_compiled No is Li false .
82 
.Cd template_use_compiled No is Li false .
83 
.El
83 
.El
84 
.
84 
.
85 
.Sh SEE ALSO
85 
.Sh SEE ALSO
86 
.
86 
.
87 
.Xr prayer 8 ,
87 
.Xr prayer 8 ,
88 
.Xr prayer.cf 5
88 
.Xr prayer.cf 5
89 
.
89 
.
90 
.Sh AUTHORS
90 
.Sh AUTHORS
91 
.
91 
.
92 
This manual page was put together by
92 
This manual page was put together by
93 
.An "Magnus Holmgren" <holmgren@debian.org>
93 
.An "Magnus Holmgren" <holmgren@debian.org>
94 
using documentation written by
94 
using documentation written by
95 
.An "David Carter" <dpc22@cam.ac.uk> .
95 
.An "David Carter" <dpc22@cam.ac.uk> .
96 
.\" .Sh BUGS
96 
.\" .Sh BUGS