aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2009-10-15 16:54:15 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2009-10-15 16:54:15 +0300
commit289d283fe50f85411e6a9cca9389cd803ed88c95 (patch)
tree58b2081ceecacf03573dbc2c705427a21b838ffa /doc
parentb713e2208519e7cba1c779cbd9387137eb101e5e (diff)
downloadpies-289d283fe50f85411e6a9cca9389cd803ed88c95.tar.gz
pies-289d283fe50f85411e6a9cca9389cd803ed88c95.tar.bz2
More fixes.
* doc/pies.texi: More fixes. * pp-setup: Remove MFD leftovers.
Diffstat (limited to 'doc')
-rw-r--r--doc/pies.texi51
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}.
86 86
87Appendices 87Appendices
88 88
89* User-Group ACLs::
89* Copying This Manual:: The GNU Free Documentation License. 90* Copying This Manual:: The GNU Free Documentation License.
90* Concept Index:: Index of Concepts. 91* Concept Index:: Index of Concepts.
91 92
@@ -184,20 +185,20 @@ component to handle that connection. In this case, the connection is
184bound to component's @samp{stdin} and @samp{stdout} streams. The 185bound to component's @samp{stdin} and @samp{stdout} streams. The
185@samp{stderr} stream can be redirected to a file or to syslog, as 186@samp{stderr} stream can be redirected to a file or to syslog, as
186described above. This mode of operation is similar to that of 187described above. This mode of operation is similar to that of
187@command{inetd} utility. 188the @command{inetd} utility.
188 189
189@anchor{meta1-style} 190@anchor{meta1-style}
190@cindex meta1-style components 191@cindex meta1-style components
191@cindex smtps 192@cindex smtps
192 The third type of components, supported by @command{pies} are 193 Third type of components supported by @command{pies} are
193@dfn{meta1-style} components. As the name suggests this type is 194@dfn{meta1-style} components. As its name suggests, this type is
194designed expressly as a support for MeTA1@footnote{See 195designed expressly as a support for MeTA1@footnote{See
195@uref{http://www.meta1.org}} components, namely 196@uref{http://www.meta1.org}} components, namely
196@command{smtps}. This type can be regarded as a mixture of the above 197@command{smtps}. This type can be regarded as a mixture of the above
197two. For each meta1-style component @command{pies} opens a socket 198two. For each meta1-style component @command{pies} opens a socket
198after start-up, and then executes the component. Once the component 199after start-up, and then executes the component. Once the component
199is running, @command{pies} passes it the file descriptor of the 200is running, @command{pies} passes it the file descriptor of that
200socket, using a preconfigured @acronym{UNIX}-style socket. Further 201socket, through another preconfigured @acronym{UNIX}-style socket. Further
201handling of the socket is the responsibility of the component itself. 202handling of the socket is the responsibility of the component itself.
202 203
203@anchor{accept-style} 204@anchor{accept-style}
@@ -211,11 +212,11 @@ starts the component, without waiting for an actual connection.
211simultaneously. 212simultaneously.
212 213
213 Components are started in the order of their appearance in the 214 Components are started in the order of their appearance in the
214configuration file and terminated in the reverse order. When starting or 215configuration file and terminated in the reverse order. The same
215stopping component dependencies, the same ordering is preserved. 216ordering applies when starting or stopping a component dependencies,
216 217
217 This order is reversed for files included by @code{include-meta1} 218 As an exception, this order is reversed for the components read from
218statement (@pxref{include-meta1}). 219files included by @code{include-meta1} statement (@pxref{include-meta1}).
219 220
220@node Pies Configuration File 221@node Pies Configuration File
221@chapter Pies Configuration File 222@chapter Pies Configuration File
@@ -227,16 +228,16 @@ statement (@pxref{include-meta1}).
227configuration directory} (in most cases @file{/etc} or 228configuration directory} (in most cases @file{/etc} or
228@file{/usr/local/etc}, depending on how the package was compiled). 229@file{/usr/local/etc}, depending on how the package was compiled).
229An alternative location may be specified using @option{--config-file} 230An alternative location may be specified using @option{--config-file}
230(@option{-c} command line option. 231(@option{-c} command line option).
231 232
232 If any errors are encountered in the configuration file, the program 233 If any errors are encountered in the configuration file, the program
233reports them on the standard error and exits with a non-zero status. 234reports them on the standard error and exits with status 78.
234 235
235@xopindex{lint, introduced} 236@xopindex{lint, introduced}
236 To test the configuration file without actually starting the server, the 237 To test the configuration file without actually starting the server, the
237@option{--lint} (@option{-t}) command line option is provided. It causes 238@option{--lint} (@option{-t}) command line option is provided. It causes
238@command{pies} to check its configuration file and exit with status 0 239@command{pies} to check its configuration file and exit with status 0
239if no errors were detected, and with status 1 otherwise. 240if no errors were detected, and with status 78 otherwise.
240 241
241@cindex @option{-E}, introduced 242@cindex @option{-E}, introduced
242 Before parsing, configuration file is preprocessed using 243 Before parsing, configuration file is preprocessed using
@@ -302,11 +303,11 @@ occurrence of @samp{*/} (star, slash).
302@cindex statement, simple 303@cindex statement, simple
303@cindex simple statements 304@cindex simple statements
304 A @dfn{simple statement} consists of a keyword and value 305 A @dfn{simple statement} consists of a keyword and value
305separated by any amount of whitespace. Simple statement is terminated 306separated by any amount of whitespace. The simple statement is terminated
306with a semicolon (@samp{;}), unless it contains a @dfn{here-document} 307with a semicolon (@samp{;}), unless it contains a @dfn{here-document}
307(see below), in which case semicolon is optional. 308(see below), in which case the semicolon is optional.
308 309
309 Examples of simple statements: 310 Examples of simple statements are:
310 311
311@smallexample 312@smallexample
312pidfile /var/run/pies.pid; 313pidfile /var/run/pies.pid;
@@ -355,12 +356,14 @@ with a single character according to the following rules:
355@item \n @tab Newline character (@acronym{ASCII} 10) 356@item \n @tab Newline character (@acronym{ASCII} 10)
356@item \r @tab Carriage return character (@acronym{ASCII} 13) 357@item \r @tab Carriage return character (@acronym{ASCII} 13)
357@item \t @tab Horizontal tabulation character (@acronym{ASCII} 9) 358@item \t @tab Horizontal tabulation character (@acronym{ASCII} 9)
359@item \v @tab Vertical tabulation character (@acronym{ASCII} 11)
358@item \\ @tab A single backslash (@samp{\}) 360@item \\ @tab A single backslash (@samp{\})
359@item \" @tab A double-quote. 361@item \" @tab A double-quote.
360@end multitable 362@end multitable
361@end float 363@end float
362 364
363 In addition, the sequence @samp{\@var{newline}} is removed from 365 In addition, any occurrence of @samp{\} immediately followed by
366a newline character (@acronym{ASCII} 10) is removed from
364the string. This allows to split long strings over several 367the string. This allows to split long strings over several
365physical lines, e.g.: 368physical lines, e.g.:
366 369
@@ -376,7 +379,7 @@ above, the backslash is ignored and a warning is issued.
376 379
377 Two or more adjacent quoted strings are concatenated, which gives 380 Two or more adjacent quoted strings are concatenated, which gives
378another way to split long strings over several lines to improve 381another way to split long strings over several lines to improve
379readability. The following fragment produces the same result as the 382readability. The following fragment produces the same result as in the
380example above: 383example above:
381 384
382@smallexample 385@smallexample
@@ -451,7 +454,7 @@ dependents (pmult, auth);
451 In any case where a list is appropriate, a single value is allowed 454 In any case where a list is appropriate, a single value is allowed
452without being a member of a list: it is equivalent to a list with a 455without being a member of a list: it is equivalent to a list with a
453single member. This means that, e.g. @samp{dependents auth;} is 456single member. This means that, e.g. @samp{dependents auth;} is
454equivalent to @samp{dependents (mime);}. 457equivalent to @samp{dependents (auth);}.
455 458
456@end table 459@end table
457 460
@@ -521,7 +524,7 @@ component @var{tag} @{
521The component is identified by its @dfn{tag}, which is given as 524The component is identified by its @dfn{tag}, which is given as
522argument to the @code{component} keyword. 525argument to the @code{component} keyword.
523 526
524Following are the basic statements which are allowed within the 527The following are the basic statements which are allowed within the
525@code{component} block: 528@code{component} block:
526 529
527@deffn {Config: component} mode @var{mode} 530@deffn {Config: component} mode @var{mode}
@@ -531,19 +534,19 @@ Following are the basic statements which are allowed within the
531@table @asis 534@table @asis
532@item exec 535@item exec
533@itemx wait 536@itemx wait
534 Create an @samp{init-style} component (@pxref{init-style}). This is 537 Define an @samp{init-style} component (@pxref{init-style}). This is
535the default. 538the default.
536 539
537@item inetd 540@item inetd
538@itemx nostartaccept 541@itemx nostartaccept
539 Create an @samp{inetd-style} component (@pxref{inetd-style}). 542 Define an @samp{inetd-style} component (@pxref{inetd-style}).
540 543
541@item pass 544@item pass
542@itemx pass-fd 545@itemx pass-fd
543 Create a @samp{meta1-style} component (@pxref{meta1-style}). 546 Define a @samp{meta1-style} component (@pxref{meta1-style}).
544 547
545@item accept 548@item accept
546 Create a @samp{accept-style} component (@pxref{accept-style}). 549 Define a @samp{accept-style} component (@pxref{accept-style}).
547@end table 550@end table
548@end deffn 551@end deffn
549 552
@@ -625,7 +628,7 @@ component tags.
625@node Component Privileges 628@node Component Privileges
626@subsection Component Privileges 629@subsection Component Privileges
627@cindex privileges 630@cindex privileges
628 Following statements control the privileges the component 631 The following statements control the privileges the component
629is executed with. 632is executed with.
630 633
631@deffn {Config: component} user @var{user-name} 634@deffn {Config: component} user @var{user-name}

Return to:

Send suggestions and report system problems to the System administrator.