aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2009-10-15 20:08:54 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2009-10-15 20:08:54 +0300
commit9670b8cada0df307c6ffd9be1b14f5dfd51cc958 (patch)
tree76e1323bace8855ef30a7ae733a37ae456790ce7 /doc
parent289d283fe50f85411e6a9cca9389cd803ed88c95 (diff)
downloadpies-9670b8cada0df307c6ffd9be1b14f5dfd51cc958.tar.gz
pies-9670b8cada0df307c6ffd9be1b14f5dfd51cc958.tar.bz2
Proofread the docs.
* doc/pies.texi: Final cleanup. * doc/usr-acl.texi: Minor fix.
Diffstat (limited to 'doc')
-rw-r--r--doc/pies.texi88
-rw-r--r--doc/usr-acl.texi2
2 files changed, 44 insertions, 46 deletions
diff --git a/doc/pies.texi b/doc/pies.texi
index 8569ab7..f1654c0 100644
--- a/doc/pies.texi
+++ b/doc/pies.texi
@@ -754,7 +754,7 @@ As of version @value{VERSION} only one @command{remove-file} may be given.
754@end deffn 754@end deffn
755 755
756@deffn {Config: component} settle-timeout @var{number} 756@deffn {Config: component} settle-timeout @var{number}
757Wait @var{number} seconds. This is kind of kludge. Currently it is 757Wait @var{number} of seconds. This is kind of kludge. Currently it is
758used for components imported from @file{meta1.conf} file 758used for components imported from @file{meta1.conf} file
759(@pxref{include-meta1}), where @code{settle-timeout 1} is implied. 759(@pxref{include-meta1}), where @code{settle-timeout 1} is implied.
760This may change in future versions. 760This may change in future versions.
@@ -801,7 +801,7 @@ names from the table below:
801@item EX_CONFIG @tab 78 801@item EX_CONFIG @tab 78
802@end multitable 802@end multitable
803 803
804Signal codes can be given either as @samp{SIG+@var{n}}, where @var{n} 804Signal numbers can be given either as @samp{SIG+@var{n}}, where @var{n}
805is the signal number, or as signal names from the following list: 805is the signal number, or as signal names from the following list:
806@samp{SIGHUP}, @samp{SIGINT}, @samp{SIGQUIT}, @samp{SIGILL}, 806@samp{SIGHUP}, @samp{SIGINT}, @samp{SIGQUIT}, @samp{SIGILL},
807@samp{SIGTRAP}, @samp{SIGABRT}, @samp{SIGIOT}, @samp{SIGBUS}, 807@samp{SIGTRAP}, @samp{SIGABRT}, @samp{SIGIOT}, @samp{SIGBUS},
@@ -815,13 +815,14 @@ is the signal number, or as signal names from the following list:
815 815
816 If the component exits with an exit code listed in @var{codes} 816 If the component exits with an exit code listed in @var{codes}
817or is terminated on a signal listed in @var{codes}, 817or is terminated on a signal listed in @var{codes},
818@command{pies} executes actions specified by its substatements. 818@command{pies} executes actions specified in that @samp{return-code}
819They are executed in the order of their appearance below: 819block. The actions are executed in the order of their appearance below:
820 820
821@deffn {Config: return-code} exec @var{command} 821@deffn {Config: return-code} exec @var{command}
822Execute external command. Prior to execution of @var{command} all 822Execute the supplied external command. Prior to execution, all
823file descriptors are closed. It inherits the environment from the 823file descriptors are closed. The @var{command} inherits the
824main @command{pies} process with the following additional variables: 824environment from the main @command{pies} process with the following
825additional variables:
825 826
826@table @env 827@table @env
827@item PIES_VERSION 828@item PIES_VERSION
@@ -862,10 +863,11 @@ Supply notification message text to use by @code{notify} statement.
862 Any number of @code{return-code} statements are allowed, provided 863 Any number of @code{return-code} statements are allowed, provided
863that their @var{codes} do not intersect. 864that their @var{codes} do not intersect.
864 865
865 Such statements can also be used outside of @code{component} block. 866 The @code{return-code} statements can also be used outside of
866In this case, they supply global actions, i.e. actions applicable to 867@code{component} block. In this case, they supply global actions,
867all components. Any @code{return-code} statements appearing within a 868i.e. actions applicable to all components. Any @code{return-code}
868@code{component} block override the global ones. 869statements appearing within a @code{component} block override the
870global ones.
869 871
870@node Output Redirectors 872@node Output Redirectors
871@subsection Output Redirectors 873@subsection Output Redirectors
@@ -882,7 +884,7 @@ The type of redirection is specified by @var{type} argument:
882 884
883@table @asis 885@table @asis
884@item file 886@item file
885Redirect to the file. In this case @var{channel} gives the full name of 887Redirect to a file. In this case @var{channel} gives the full name of
886the file. For example: 888the file. For example:
887 889
888@smallexample 890@smallexample
@@ -890,11 +892,11 @@ stderr file /var/log/component/name.err;
890@end smallexample 892@end smallexample
891 893
892@item syslog 894@item syslog
893Redirect to the syslog channel. The syslog priority is given by the 895Redirect to a syslog channel. The syslog priority is given by the
894@var{channel} argument. Its allowed values are: @samp{emerg}, 896@var{channel} argument. Its allowed values are: @samp{emerg},
895@samp{alert}, @samp{crit}, @samp{err}, @samp{warning}, @samp{notice}, 897@samp{alert}, @samp{crit}, @samp{err}, @samp{warning}, @samp{notice},
896@samp{info}, @samp{debug}. The facility is inherited from the 898@samp{info}, @samp{debug}. The facility is inherited from the
897@code{syslog} statement (@pxref{syslog}), or from @code{facility} 899@code{syslog} statement (@pxref{syslog}), or from the @code{facility}
898statement (see below), if given. 900statement (see below), if given.
899 901
900Example: 902Example:
@@ -907,7 +909,7 @@ stderr syslog err;
907 909
908@deffn {Config: component} facility @var{syslog-facility} 910@deffn {Config: component} facility @var{syslog-facility}
909Specify the syslog facility to use in syslog redirectors. Allowed 911Specify the syslog facility to use in syslog redirectors. Allowed
910values for @var{syslog-facility} are: @samp{user}, @samp{daemon}, 912@var{syslog-facility} values are: @samp{user}, @samp{daemon},
911@samp{auth}, @samp{authpriv}, @samp{mail}, @samp{cron}, @samp{local0} 913@samp{auth}, @samp{authpriv}, @samp{mail}, @samp{cron}, @samp{local0}
912through @samp{local7} (all names case-insensitive), or a facility number. 914through @samp{local7} (all names case-insensitive), or a facility number.
913@end deffn 915@end deffn
@@ -916,8 +918,7 @@ through @samp{local7} (all names case-insensitive), or a facility number.
916@subsection Inetd-Style Components 918@subsection Inetd-Style Components
917@cindex inetd-style components 919@cindex inetd-style components
918 Inetd-style components are declared using @code{mode inetd} 920 Inetd-style components are declared using @code{mode inetd}
919statement. You must also declare a socket to listen for requests for 921statement. You must also declare a socket to listen on.
920such components:
921 922
922@anchor{inetd-socket} 923@anchor{inetd-socket}
923@deffn {Config: component} socket @var{url} 924@deffn {Config: component} socket @var{url}
@@ -932,8 +933,8 @@ component (@pxref{Actions Before Startup, chdir}).
932@item local://@var{file}[;@var{args}] 933@item local://@var{file}[;@var{args}]
933@itemx file://@var{file}[;@var{args}] 934@itemx file://@var{file}[;@var{args}]
934@itemx unix://@var{file}[;@var{args}] 935@itemx unix://@var{file}[;@var{args}]
935Listen on the @acronym{UNIX} socket file @var{file}, which may be either 936Listen on the @acronym{UNIX} socket file @var{file}, which is either
936absolute or relative file name, as described above. Optional 937an absolute or relative file name, as described above. Optional
937arguments @var{args} control ownership and file mode of @var{file}. They 938arguments @var{args} control ownership and file mode of @var{file}. They
938are a list of assignments, separated by semicolons. The following 939are a list of assignments, separated by semicolons. The following
939values are allowed: 940values are allowed:
@@ -956,7 +957,7 @@ and @samp{777}).
956For example: 957For example:
957 958
958@smallexample 959@smallexample
959socket unix:/var/run/socket;user=nobody;group=mail;mode=770 960socket "unix:/var/run/socket;user=nobody;group=mail;mode=770";
960@end smallexample 961@end smallexample
961 962
962@item inet://@var{ip}:@var{port} 963@item inet://@var{ip}:@var{port}
@@ -1098,10 +1099,10 @@ send email messages when components terminate. The exact contents
1098of such notifications and the list of their recipients may depend on 1099of such notifications and the list of their recipients may depend on
1099the exit code which the component returned. Notification is 1100the exit code which the component returned. Notification is
1100configured by supplying @samp{notify} and @samp{message} statements 1101configured by supplying @samp{notify} and @samp{message} statements
1101within a @samp{return-code} block. 1102in a @samp{return-code} block.
1102 1103
1103@deffn {Config: return-code} notify @var{email-string} 1104@deffn {Config: return-code} notify @var{email-string}
1104Send an email notification to addresses from @var{email-string}. The 1105Send email notification to addresses from @var{email-string}. The
1105latter is a comma-separated list of email addresses, e.g.: 1106latter is a comma-separated list of email addresses, e.g.:
1106 1107
1107@smallexample 1108@smallexample
@@ -1190,7 +1191,7 @@ Subject: Component $@{component@} $@{termination@} $@{retcode@}.
1190 1191
1191@cindex mailer 1192@cindex mailer
1192@cindex @command{sendmail} 1193@cindex @command{sendmail}
1193 Notification messages are sent using external program, called 1194 Notification messages are sent using an external program, called
1194@dfn{mailer}. By default it is @command{/usr/sbin/sendmail}. You can 1195@dfn{mailer}. By default it is @command{/usr/sbin/sendmail}. You can
1195change it using the following configuration statement: 1196change it using the following configuration statement:
1196 1197
@@ -1310,18 +1311,18 @@ future use and is described in more detail in @ref{User-Group ACLs}.
1310 1311
1311@anchor{acl-ref} 1312@anchor{acl-ref}
1312The @var{sub-acl} part, if present, allows to branch to another 1313The @var{sub-acl} part, if present, allows to branch to another
1313@acronym{ACL}. The syntax of this group is: 1314@acronym{ACL}. The syntax of this part is:
1314 1315
1315@smallexample 1316@smallexample
1316acl @var{name} 1317acl @var{name}
1317@end smallexample 1318@end smallexample
1318 1319
1319@noindent 1320@noindent
1320where @var{name} is the name of @acronym{ACL} defined previously in 1321where @var{name} is the name of an @acronym{ACL} defined previously in
1321@samp{defacl} statement. 1322@samp{defacl} statement.
1322 1323
1323The @var{host-list} group allows to match client addresses. 1324The @var{host-list} group allows to match client addresses.
1324It consists of a @code{from} keyword followed by a list of 1325It consists of the @code{from} keyword followed by a list of
1325@dfn{address specifiers}. Allowed address specifiers are: 1326@dfn{address specifiers}. Allowed address specifiers are:
1326 1327
1327@table @asis 1328@table @asis
@@ -1348,11 +1349,11 @@ Matches if connection was received from a @acronym{UNIX} socket
1348@var{filename}, which must be given as an absolute file name. 1349@var{filename}, which must be given as an absolute file name.
1349@end table 1350@end table
1350 1351
1351@anchor{acl-any}. 1352@anchor{acl-any}
1352The special form @samp{allow any} means to allow access 1353The special form @samp{allow any} means to allow access
1353unconditionally. Similarly, @samp{deny any}, denies access 1354unconditionally. Similarly, @samp{deny any}, denies access
1354unconditionally. Normally, these forms appear as the last 1355unconditionally. Normally, one of these forms appears as the last
1355statements in an @acronym{ACL} definition. 1356statement in an @acronym{ACL} definition.
1356 1357
1357To summarize, the syntax of an access statement is: 1358To summarize, the syntax of an access statement is:
1358 1359
@@ -1361,15 +1362,14 @@ allow|deny [acl @var{name}] [from @var{addr-list}]
1361@end smallexample 1362@end smallexample
1362 1363
1363@noindent 1364@noindent
1364where square brackets denote optional parts and vertical bar means 1365where square brackets denote optional parts.
1365@samp{one of}.
1366 1366
1367When an @acronym{ACL} is checked, its entries are tried in turn until 1367When an @acronym{ACL} is checked, its entries are tried in turn until
1368one of them matches, or the end of the list is reached. If a matched 1368one of them matches, or the end of the list is reached. If a matched
1369entry is found, its command verb, @code{allow} or @code{deny}, defines 1369entry is found, its command verb, @code{allow} or @code{deny}, defines
1370the result of @acronym{ACL} match. If the end of list is reached, 1370the result of the @acronym{ACL} check. If the end of the list is reached,
1371the result is @samp{allow}, unless explicitly specified otherwise 1371the result is @samp{allow}, unless explicitly specified otherwise
1372(using the @pxref{acl-any, ``any'' form}). 1372(using the @ref{acl-any, ``any'' form}.)
1373 1373
1374For example, the following @acronym{ACL} allows access for anybody 1374For example, the following @acronym{ACL} allows access for anybody
1375coming from networks @samp{192.168.10.0/24} and @samp{192.168.100.0/24}, 1375coming from networks @samp{192.168.10.0/24} and @samp{192.168.100.0/24},
@@ -1393,9 +1393,8 @@ acl @{
1393 MeTA1 is a mail transfer agent of new generation, designed 1393 MeTA1 is a mail transfer agent of new generation, designed
1394to replace Sendmail in the future (@uref{http://www.meta1.org}). 1394to replace Sendmail in the future (@uref{http://www.meta1.org}).
1395It has a modular structure, each module being an independent 1395It has a modular structure, each module being an independent
1396program, which is responsible for a particular task. The components 1396responsible for a particular task. The components are configured in
1397are configured in the MeTA1 configuration file 1397the MeTA1 configuration file @file{/etc/meta1/meta1.conf}.
1398@file{/etc/meta1/meta1.conf}.
1399 1398
1400 @command{Pies} is able to take a list of components directly 1399 @command{Pies} is able to take a list of components directly
1401from MeTA1 configuration file: 1400from MeTA1 configuration file:
@@ -1431,7 +1430,7 @@ chdir @var{queue-dir}
1431Here, @var{compname} stands for the name of the component, and 1430Here, @var{compname} stands for the name of the component, and
1432@var{queue-dir} stands for the name of MeTA1 queue directory. The 1431@var{queue-dir} stands for the name of MeTA1 queue directory. The
1433latter is @file{/var/spool/meta1} by default. It can be changed using 1432latter is @file{/var/spool/meta1} by default. It can be changed using
1434the following statement 1433the following statement:
1435 1434
1436@deffn {Config} meta1-queue-dir @var{dir} 1435@deffn {Config} meta1-queue-dir @var{dir}
1437Set name of MeTA1 queue directory. 1436Set name of MeTA1 queue directory.
@@ -1439,8 +1438,9 @@ Set name of MeTA1 queue directory.
1439 1438
1440To override any default settings for a MeTA1 component, add a 1439To override any default settings for a MeTA1 component, add a
1441@code{command} section with the desired settings after including 1440@code{command} section with the desired settings after including
1442@file{meta1.conf}. For example, here is how to redirect program 1441@file{meta1.conf}. For example, here is how to redirect the
1443diagnostics to @samp{local1.debug} syslog channel: 1442standard error of the @samp{smtps} component to @samp{local1.debug}
1443syslog channel:
1444 1444
1445@smallexample 1445@smallexample
1446include-meta1 /etc/meta1/meta1.conf 1446include-meta1 /etc/meta1/meta1.conf
@@ -1466,6 +1466,7 @@ substatements:
1466@deffn {Config: syslog} tag @var{string} 1466@deffn {Config: syslog} tag @var{string}
1467Prefix syslog messages with this string. By default, the program name 1467Prefix syslog messages with this string. By default, the program name
1468is used. 1468is used.
1469@end deffn
1469 1470
1470@deffn {Config: syslog} facility @var{string} 1471@deffn {Config: syslog} facility @var{string}
1471Set syslog facility to use. Allowed values are: @samp{user}, 1472Set syslog facility to use. Allowed values are: @samp{user},
@@ -1473,7 +1474,6 @@ Set syslog facility to use. Allowed values are: @samp{user},
1473@samp{local0} through @samp{local7} (case-insensitive), or a facility 1474@samp{local0} through @samp{local7} (case-insensitive), or a facility
1474number. 1475number.
1475@end deffn 1476@end deffn
1476@end deffn
1477 1477
1478@deffn {Config} umask @var{number} 1478@deffn {Config} umask @var{number}
1479Set the default umask. The @var{number} must be an octal value not greater 1479Set the default umask. The @var{number} must be an octal value not greater
@@ -1514,7 +1514,7 @@ suit your needs:
1514 1514
1515@deffn {Config} pidfile @var{file} 1515@deffn {Config} pidfile @var{file}
1516Write PID of the master @command{pies} process to @var{file}. By 1516Write PID of the master @command{pies} process to @var{file}. By
1517default, master PID is stored in @file{@var{localstatedir}/pies.pid}, 1517default the master PID is stored in @file{@var{localstatedir}/pies.pid},
1518where @var{localstatedir} is the @dfn{local state directory}, defined 1518where @var{localstatedir} is the @dfn{local state directory}, defined
1519at compile time (usually, it is @file{/usr/local/var} or @file{/usr/var}). 1519at compile time (usually, it is @file{/usr/local/var} or @file{/usr/var}).
1520@end deffn 1520@end deffn
@@ -1533,13 +1533,12 @@ Set file name of the statistics output file. Default is
1533however, you found such an implementation for it, that requires another 1533however, you found such an implementation for it, that requires another
1534privileges, you may change them using the following three statements: 1534privileges, you may change them using the following three statements:
1535 1535
1536@command{pies} process.
1537@deffn {Config} user @var{user-name} 1536@deffn {Config} user @var{user-name}
1538Start @command{pies} with the UID and GID of this user. 1537Start @command{pies} with the UID and GID of this user.
1539@end deffn 1538@end deffn
1540 1539
1541@deffn {Config} group @var{group-list} 1540@deffn {Config} group @var{group-list}
1542Retain supplementary groups, specified in @var{group-list}. 1541Retain the supplementary groups, specified in @var{group-list}.
1543@end deffn 1542@end deffn
1544 1543
1545@deffn {Config} allgroups @var{bool} 1544@deffn {Config} allgroups @var{bool}
@@ -1670,7 +1669,6 @@ and restricts access to them to two local subnets:
1670 1669
1671@smallexample 1670@smallexample
1672acl @{ 1671acl @{
1673 log from any "Connect from $@{address@}";
1674 allow from 10.10.10.0/24; 1672 allow from 10.10.10.0/24;
1675 allow from 192.168.10.0/27; 1673 allow from 192.168.10.0/27;
1676 deny from any; 1674 deny from any;
@@ -1683,7 +1681,7 @@ component ftp @{
1683 socket "inet://0.0.0.0:21"; 1681 socket "inet://0.0.0.0:21";
1684 umask 027; 1682 umask 027;
1685 program /usr/sbin/ftpd 1683 program /usr/sbin/ftpd
1686 command ftpd -l -C; 1684 command "ftpd -l -C";
1687@} 1685@}
1688 1686
1689component pop3d @{ 1687component pop3d @{
diff --git a/doc/usr-acl.texi b/doc/usr-acl.texi
index 1fd69f5..86d70f1 100644
--- a/doc/usr-acl.texi
+++ b/doc/usr-acl.texi
@@ -27,7 +27,7 @@ Authenticated users which are members of at least one of groups listed in
27 27
28For example, the following statement defines an @acronym{ACL} 28For example, the following statement defines an @acronym{ACL}
29which allows access for any user connected via local @acronym{UNIX} 29which allows access for any user connected via local @acronym{UNIX}
30socket @file{/tmp/dicod.sock} or coming from a local network 30socket @file{/tmp/pies.sock} or coming from a local network
31@samp{192.168.10.0/24}. Any authenticated users are allowed, provided 31@samp{192.168.10.0/24}. Any authenticated users are allowed, provided
32that they are allowed by another @acronym{ACL} @samp{my-nets} (which 32that they are allowed by another @acronym{ACL} @samp{my-nets} (which
33should have been defined before this definition). Users coming from 33should have been defined before this definition). Users coming from

Return to:

Send suggestions and report system problems to the System administrator.