diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/pies.texi | 51 |
1 files changed, 27 insertions, 24 deletions
diff --git a/doc/pies.texi b/doc/pies.texi index e47f6a6..8569ab7 100644 --- a/doc/pies.texi +++ b/doc/pies.texi @@ -86,6 +86,7 @@ documents @command{pies} Version @value{VERSION}. Appendices +* User-Group ACLs:: * Copying This Manual:: The GNU Free Documentation License. * Concept Index:: Index of Concepts. @@ -184,20 +185,20 @@ component to handle that connection. In this case, the connection is bound to component's @samp{stdin} and @samp{stdout} streams. The @samp{stderr} stream can be redirected to a file or to syslog, as described above. This mode of operation is similar to that of -@command{inetd} utility. +the @command{inetd} utility. @anchor{meta1-style} @cindex meta1-style components @cindex smtps - The third type of components, supported by @command{pies} are -@dfn{meta1-style} components. As the name suggests this type is + Third type of components supported by @command{pies} are +@dfn{meta1-style} components. As its name suggests, this type is designed expressly as a support for MeTA1@footnote{See @uref{http://www.meta1.org}} components, namely @command{smtps}. This type can be regarded as a mixture of the above two. For each meta1-style component @command{pies} opens a socket after start-up, and then executes the component. Once the component -is running, @command{pies} passes it the file descriptor of the -socket, using a preconfigured @acronym{UNIX}-style socket. Further +is running, @command{pies} passes it the file descriptor of that +socket, through another preconfigured @acronym{UNIX}-style socket. Further handling of the socket is the responsibility of the component itself. @anchor{accept-style} @@ -211,11 +212,11 @@ starts the component, without waiting for an actual connection. simultaneously. Components are started in the order of their appearance in the -configuration file and terminated in the reverse order. When starting or -stopping component dependencies, the same ordering is preserved. +configuration file and terminated in the reverse order. The same +ordering applies when starting or stopping a component dependencies, - This order is reversed for files included by @code{include-meta1} -statement (@pxref{include-meta1}). + As an exception, this order is reversed for the components read from +files included by @code{include-meta1} statement (@pxref{include-meta1}). @node Pies Configuration File @chapter Pies Configuration File @@ -227,16 +228,16 @@ statement (@pxref{include-meta1}). configuration directory} (in most cases @file{/etc} or @file{/usr/local/etc}, depending on how the package was compiled). An alternative location may be specified using @option{--config-file} -(@option{-c} command line option. +(@option{-c} command line option). If any errors are encountered in the configuration file, the program -reports them on the standard error and exits with a non-zero status. +reports them on the standard error and exits with status 78. @xopindex{lint, introduced} To test the configuration file without actually starting the server, the @option{--lint} (@option{-t}) command line option is provided. It causes @command{pies} to check its configuration file and exit with status 0 -if no errors were detected, and with status 1 otherwise. +if no errors were detected, and with status 78 otherwise. @cindex @option{-E}, introduced Before parsing, configuration file is preprocessed using @@ -302,11 +303,11 @@ occurrence of @samp{*/} (star, slash). @cindex statement, simple @cindex simple statements A @dfn{simple statement} consists of a keyword and value -separated by any amount of whitespace. Simple statement is terminated +separated by any amount of whitespace. The simple statement is terminated with a semicolon (@samp{;}), unless it contains a @dfn{here-document} -(see below), in which case semicolon is optional. +(see below), in which case the semicolon is optional. - Examples of simple statements: + Examples of simple statements are: @smallexample pidfile /var/run/pies.pid; @@ -355,12 +356,14 @@ with a single character according to the following rules: @item \n @tab Newline character (@acronym{ASCII} 10) @item \r @tab Carriage return character (@acronym{ASCII} 13) @item \t @tab Horizontal tabulation character (@acronym{ASCII} 9) +@item \v @tab Vertical tabulation character (@acronym{ASCII} 11) @item \\ @tab A single backslash (@samp{\}) @item \" @tab A double-quote. @end multitable @end float - In addition, the sequence @samp{\@var{newline}} is removed from + In addition, any occurrence of @samp{\} immediately followed by +a newline character (@acronym{ASCII} 10) is removed from the string. This allows to split long strings over several physical lines, e.g.: @@ -376,7 +379,7 @@ above, the backslash is ignored and a warning is issued. Two or more adjacent quoted strings are concatenated, which gives another way to split long strings over several lines to improve -readability. The following fragment produces the same result as the +readability. The following fragment produces the same result as in the example above: @smallexample @@ -451,7 +454,7 @@ dependents (pmult, auth); In any case where a list is appropriate, a single value is allowed without being a member of a list: it is equivalent to a list with a single member. This means that, e.g. @samp{dependents auth;} is -equivalent to @samp{dependents (mime);}. +equivalent to @samp{dependents (auth);}. @end table @@ -521,7 +524,7 @@ component @var{tag} @{ The component is identified by its @dfn{tag}, which is given as argument to the @code{component} keyword. -Following are the basic statements which are allowed within the +The following are the basic statements which are allowed within the @code{component} block: @deffn {Config: component} mode @var{mode} @@ -531,19 +534,19 @@ Following are the basic statements which are allowed within the @table @asis @item exec @itemx wait - Create an @samp{init-style} component (@pxref{init-style}). This is + Define an @samp{init-style} component (@pxref{init-style}). This is the default. @item inetd @itemx nostartaccept - Create an @samp{inetd-style} component (@pxref{inetd-style}). + Define an @samp{inetd-style} component (@pxref{inetd-style}). @item pass @itemx pass-fd - Create a @samp{meta1-style} component (@pxref{meta1-style}). + Define a @samp{meta1-style} component (@pxref{meta1-style}). @item accept - Create a @samp{accept-style} component (@pxref{accept-style}). + Define a @samp{accept-style} component (@pxref{accept-style}). @end table @end deffn @@ -625,7 +628,7 @@ component tags. @node Component Privileges @subsection Component Privileges @cindex privileges - Following statements control the privileges the component + The following statements control the privileges the component is executed with. @deffn {Config: component} user @var{user-name} |