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