aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2009-05-08 15:48:00 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2009-05-09 00:02:44 +0300
commit30775f7ce1215423967c681ab9f3cf0a4704b51e (patch)
tree55c74e44570a1d698fb00497a9965b8ec4e3a3e4
parentae42310eae46e763e207a2204d43dbadf20f8390 (diff)
downloadmailfromd-30775f7ce1215423967c681ab9f3cf0a4704b51e.tar.gz
mailfromd-30775f7ce1215423967c681ab9f3cf0a4704b51e.tar.bz2
Fix the docs
-rw-r--r--doc/gacopyz.texi6
-rw-r--r--doc/pies.texi59
-rw-r--r--doc/pmult.texi30
3 files changed, 50 insertions, 45 deletions
diff --git a/doc/gacopyz.texi b/doc/gacopyz.texi
index 7354db6c..88348cc6 100644
--- a/doc/gacopyz.texi
+++ b/doc/gacopyz.texi
@@ -1,4 +1,4 @@
1@c Copyright (C) 2005, 2006 Sergey Poznyakoff 1@c Copyright (C) 2005, 2006, 2009 Sergey Poznyakoff
2@c Permission is granted to copy, distribute and/or modify this document 2@c Permission is granted to copy, distribute and/or modify this document
3@c under the terms of the GNU Free Documentation License, Version 1.2 or 3@c under the terms of the GNU Free Documentation License, Version 1.2 or
4@c any later version published by the Free Software Foundation; with no 4@c any later version published by the Free Software Foundation; with no
@@ -35,11 +35,11 @@ new and more flexible @acronym{API}. The old @acronym{API} is
35supported for compatibility with @command{libmilter}. 35supported for compatibility with @command{libmilter}.
36 36
37 The library name comes from the song @samp{Rozprawa o robokach} by 37 The library name comes from the song @samp{Rozprawa o robokach} by
38@uref{http://gray.gnu.org.ua/grzeskowiak.html, Kazimierz Grzeskowiak}. 38@uref{http://grzeskowiak.art.pl, Kazimierz Grzeskowiak}.
39The phrase @samp{A to nie je mysa, ino gacopyz} exactly describes what 39The phrase @samp{A to nie je mysa, ino gacopyz} exactly describes what
40the library is: @samp{That is no libmilter, but gacopyz}. 40the library is: @samp{That is no libmilter, but gacopyz}.
41 41
42 Future versions of this documentation will include the detailed 42 Future versions of this documentation will include a detailed
43description of the library. 43description of the library.
44 44
45 45
diff --git a/doc/pies.texi b/doc/pies.texi
index 599e630d..1d9df839 100644
--- a/doc/pies.texi
+++ b/doc/pies.texi
@@ -1,5 +1,5 @@
1@c This file is part of the Mailfromd manual. 1@c This file is part of the Mailfromd manual.
2@c Copyright (C) 2008 Sergey Poznyakoff 2@c Copyright (C) 2008, 2009 Sergey Poznyakoff
3@c See file mailfromd.texi for copying conditions. 3@c See file mailfromd.texi for copying conditions.
4@c ******************************************************************* 4@c *******************************************************************
5@cindex component, pies 5@cindex component, pies
@@ -7,9 +7,9 @@
7@samp{Program Invocation and Execution Supervisor}. This utility 7@samp{Program Invocation and Execution Supervisor}. This utility
8starts and controls execution of external programs, called 8starts and controls execution of external programs, called
9@dfn{components}. Each component is a stand-alone program, which is 9@dfn{components}. Each component is a stand-alone program, which is
10executed in foreground. Upon startup, @command{pies} reads the list 10executed in the foreground. Upon startup, @command{pies} reads the list
11of components from its configuration file, starts them, and remains in 11of components from its configuration file, starts them, and remains in
12background, controlling their execution. When any of the components 12the background, controlling their execution. When any of the components
13terminates, @command{pies} restarts it. Its configuration allows to 13terminates, @command{pies} restarts it. Its configuration allows to
14specify actions other than simple restart, depending on the exit code 14specify actions other than simple restart, depending on the exit code
15of the component. 15of the component.
@@ -48,7 +48,7 @@ components.
48startup. Instead, @command{pies} opens a socket for each of them and 48startup. Instead, @command{pies} opens a socket for each of them and
49listens for connections on these sockets. When a connection arrives, 49listens for connections on these sockets. When a connection arrives,
50it decides what component the socket corresponds to, and invokes this 50it decides what component the socket corresponds to, and invokes this
51component to service that connection. In this case, the connection is 51component to handle that connection. In this case, the connection is
52bound to component's @samp{stdin} and @samp{stdout} streams. The 52bound to component's @samp{stdin} and @samp{stdout} streams. The
53@samp{stderr} stream can be redirected to a file or to syslog, as 53@samp{stderr} stream can be redirected to a file or to syslog, as
54described above. This mode of operation is similar to that of 54described above. This mode of operation is similar to that of
@@ -57,7 +57,7 @@ described above. This mode of operation is similar to that of
57@anchor{meta1-style} 57@anchor{meta1-style}
58@cindex meta1-style components 58@cindex meta1-style components
59@cindex smtps 59@cindex smtps
60 Third type of components, supported by @command{pies} are 60 The third type of components, supported by @command{pies} are
61@dfn{meta1-style} components. As the name suggests this type is 61@dfn{meta1-style} components. As the name suggests this type is
62designed expressly as a support for MeTA1 components, namely 62designed expressly as a support for MeTA1 components, namely
63@command{smtps}. This type can be regarded as a mixture of the above 63@command{smtps}. This type can be regarded as a mixture of the above
@@ -78,8 +78,8 @@ starts the component, without waiting for an actual connection.
78simultaneously. 78simultaneously.
79 79
80 Components are started in the order of their appearance in the 80 Components are started in the order of their appearance in the
81configuration file and terminated in reverse order. When starting or 81configuration file and terminated in the reverse order. When starting or
82stopping component dependencies, the same order is preserved. 82stopping component dependencies, the same ordering is preserved.
83 83
84 This order is reversed for files included by @code{include-meta1} 84 This order is reversed for files included by @code{include-meta1}
85statement (@pxref{include-meta1}). 85statement (@pxref{include-meta1}).
@@ -136,6 +136,8 @@ component @var{tag} @{
136The component is identified by its @dfn{tag}, which is given as 136The component is identified by its @dfn{tag}, which is given as
137argument to the @code{component} keyword. 137argument to the @code{component} keyword.
138 138
139The following statements are allowed within the @code{component} block:
140
139@deffn {Pies Conf} mode @var{mode} 141@deffn {Pies Conf} mode @var{mode}
140 Declare the type (style) of the component. Accepted values for 142 Declare the type (style) of the component. Accepted values for
141@var{mode} are: 143@var{mode} are:
@@ -230,8 +232,8 @@ component tags.
230@node Component Privileges 232@node Component Privileges
231@subsection Component Privileges 233@subsection Component Privileges
232@cindex privileges, pies 234@cindex privileges, pies
233 Following statements control the privileges with which the component 235 Following statements control the privileges the component
234is executed. 236is executed with.
235 237
236@deffn {Pies Conf} user @var{user-name} 238@deffn {Pies Conf} user @var{user-name}
237Start component with the UID and GID of this user. 239Start component with the UID and GID of this user.
@@ -242,8 +244,8 @@ Retain supplementary groups, specified in @var{group-list}.
242@end deffn 244@end deffn
243 245
244@deffn {Pies Conf} allgroups @var{bool} 246@deffn {Pies Conf} allgroups @var{bool}
245Retain all supplementary groups of which user, given with 247Retain all supplementary groups of which the user (as given with
246@command{user} statement, is a member. This is the default for 248@command{user} statement) is a member. This is the default for
247components specified in @file{meta1.conf} file (@pxref{include-meta1}). 249components specified in @file{meta1.conf} file (@pxref{include-meta1}).
248@end deffn 250@end deffn
249 251
@@ -406,9 +408,10 @@ are:
406 408
407@deffn {Pies Conf} action @samp{disable | restart} 409@deffn {Pies Conf} action @samp{disable | restart}
408If @samp{restart} is given, restart the component. This is the 410If @samp{restart} is given, restart the component. This is the
409default. Otherwise, mark the component and as disabled. Component 411default. Otherwise, mark the component as disabled. Component
410dependents are stopped and marked as disabled as well. Disabled 412dependents are stopped and marked as disabled as well. Once disabled,
411components are never started, unless requested by the administrator. 413the components are never restarted, unless their restart is requested
414by the administrator.
412@end deffn 415@end deffn
413 416
414@deffn {Pies Conf} notify @var{email-string} 417@deffn {Pies Conf} notify @var{email-string}
@@ -460,13 +463,13 @@ that their @var{codes} do not intersect.
460 463
461 Such statements can also be used outside of @code{component} block. 464 Such statements can also be used outside of @code{component} block.
462In this case, they supply global actions, i.e. actions applicable to 465In this case, they supply global actions, i.e. actions applicable to
463all components. The @code{return-code} statements appearing within a 466all components. Any @code{return-code} statements appearing within a
464@code{component} block override the global ones. 467@code{component} block override the global ones.
465 468
466@node Output Redirectors 469@node Output Redirectors
467@subsection Output Redirectors 470@subsection Output Redirectors
468@cindex repeater 471@cindex repeater
469 Output redirectors allow to redirect standard error and/or standard 472 Output redirectors allow to redirect the standard error and/or standard
470output of a component to a file or @command{syslog} facility. 473output of a component to a file or @command{syslog} facility.
471 474
472@deffn {Pies Conf} stderr @var{type} @var{channel} 475@deffn {Pies Conf} stderr @var{type} @var{channel}
@@ -478,7 +481,7 @@ The type of redirection is specified by @var{type} argument:
478 481
479@table @asis 482@table @asis
480@item file 483@item file
481Redirect to file. In this case @var{channel} gives the full name of 484Redirect to the file. In this case @var{channel} gives the full name of
482the file. For example: 485the file. For example:
483 486
484@smallexample 487@smallexample
@@ -529,7 +532,7 @@ component (@pxref{Actions Before Startup, chdir}).
529@item local://@var{file}[;@var{args}] 532@item local://@var{file}[;@var{args}]
530@itemx file://@var{file}[;@var{args}] 533@itemx file://@var{file}[;@var{args}]
531@itemx unix://@var{file}[;@var{args}] 534@itemx unix://@var{file}[;@var{args}]
532Listen on a @acronym{UNIX} socket file @var{file}, which may be either 535Listen on the @acronym{UNIX} socket file @var{file}, which may be either
533absolute or relative file name, as described above. Optional 536absolute or relative file name, as described above. Optional
534arguments @var{args} control ownership and file mode of @var{file}. They 537arguments @var{args} control ownership and file mode of @var{file}. They
535are a list of assignments, separated by semicolons. The following 538are a list of assignments, separated by semicolons. The following
@@ -689,7 +692,7 @@ component @var{tag} @{
689@node include-meta1 692@node include-meta1
690@section Using MeTA1 Configuration File 693@section Using MeTA1 Configuration File
691@cindex /etc/meta1/meta1.conf 694@cindex /etc/meta1/meta1.conf
692 @command{Pies} is able to take list of components from MeTA1 695 @command{Pies} is able to take a list of components from MeTA1
693configuration file: 696configuration file:
694 697
695@deffn {Pies Conf} include-meta1 @var{file} 698@deffn {Pies Conf} include-meta1 @var{file}
@@ -705,8 +708,8 @@ Thus, you can use @command{pies} instead of the default MeTA1 program
705manager @command{mcp}. 708manager @command{mcp}.
706 709
707To ensure compatibility with MeTA1, the components read from MeTA1 710To ensure compatibility with MeTA1, the components read from MeTA1
708configuration are started in reverse order (i.e. from last to first), 711configuration are started in the reverse order (i.e. from last to first),
709and stopped in order of their appearance in @var{file}. Of course, 712and stopped in the order of their appearance in @var{file}. Of course,
710this does not affect normal @command{pies} components. 713this does not affect normal @command{pies} components.
711 714
712The following @command{pies} statements are silently applied to 715The following @command{pies} statements are silently applied to
@@ -800,7 +803,7 @@ Set file name of the statistics output file. Default is
800@end deffn 803@end deffn
801 804
802 Normally, @command{pies} must be run with root privileges. If, 805 Normally, @command{pies} must be run with root privileges. If,
803however, you've found an implementation for it, that requires another 806however, you found such an implementation for it, that requires another
804privileges, you may change them using the following three statements: 807privileges, you may change them using the following three statements:
805 808