diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-10-15 20:08:54 +0300 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-10-15 20:08:54 +0300 |
commit | 9670b8cada0df307c6ffd9be1b14f5dfd51cc958 (patch) | |
tree | 76e1323bace8855ef30a7ae733a37ae456790ce7 /doc | |
parent | 289d283fe50f85411e6a9cca9389cd803ed88c95 (diff) | |
download | pies-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.texi | 88 | ||||
-rw-r--r-- | doc/usr-acl.texi | 2 |
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 @@ -756,3 +756,3 @@ As of version @value{VERSION} only one @command{remove-file} may be given. @deffn {Config: component} settle-timeout @var{number} -Wait @var{number} seconds. This is kind of kludge. Currently it is +Wait @var{number} of seconds. This is kind of kludge. Currently it is used for components imported from @file{meta1.conf} file @@ -803,3 +803,3 @@ names from the table below: -Signal codes can be given either as @samp{SIG+@var{n}}, where @var{n} +Signal numbers can be given either as @samp{SIG+@var{n}}, where @var{n} is the signal number, or as signal names from the following list: @@ -817,9 +817,10 @@ is the signal number, or as signal names from the following list: or is terminated on a signal listed in @var{codes}, -@command{pies} executes actions specified by its substatements. -They are executed in the order of their appearance below: +@command{pies} executes actions specified in that @samp{return-code} +block. The actions are executed in the order of their appearance below: @deffn {Config: return-code} exec @var{command} -Execute external command. Prior to execution of @var{command} all -file descriptors are closed. It inherits the environment from the -main @command{pies} process with the following additional variables: +Execute the supplied external command. Prior to execution, all +file descriptors are closed. The @var{command} inherits the +environment from the main @command{pies} process with the following +additional variables: @@ -864,6 +865,7 @@ that their @var{codes} do not intersect. - Such statements can also be used outside of @code{component} block. -In this case, they supply global actions, i.e. actions applicable to -all components. Any @code{return-code} statements appearing within a -@code{component} block override the global ones. + The @code{return-code} statements can also be used outside of +@code{component} block. In this case, they supply global actions, +i.e. actions applicable to all components. Any @code{return-code} +statements appearing within a @code{component} block override the +global ones. @@ -884,3 +886,3 @@ The type of redirection is specified by @var{type} argument: @item file -Redirect to the file. In this case @var{channel} gives the full name of +Redirect to a file. In this case @var{channel} gives the full name of the file. For example: @@ -892,3 +894,3 @@ stderr file /var/log/component/name.err; @item syslog -Redirect to the syslog channel. The syslog priority is given by the +Redirect to a syslog channel. The syslog priority is given by the @var{channel} argument. Its allowed values are: @samp{emerg}, @@ -896,3 +898,3 @@ Redirect to the syslog channel. The syslog priority is given by the @samp{info}, @samp{debug}. The facility is inherited from the -@code{syslog} statement (@pxref{syslog}), or from @code{facility} +@code{syslog} statement (@pxref{syslog}), or from the @code{facility} statement (see below), if given. @@ -909,3 +911,3 @@ stderr syslog err; Specify the syslog facility to use in syslog redirectors. Allowed -values for @var{syslog-facility} are: @samp{user}, @samp{daemon}, +@var{syslog-facility} values are: @samp{user}, @samp{daemon}, @samp{auth}, @samp{authpriv}, @samp{mail}, @samp{cron}, @samp{local0} @@ -918,4 +920,3 @@ through @samp{local7} (all names case-insensitive), or a facility number. Inetd-style components are declared using @code{mode inetd} -statement. You must also declare a socket to listen for requests for -such components: +statement. You must also declare a socket to listen on. @@ -934,4 +935,4 @@ component (@pxref{Actions Before Startup, chdir}). @itemx unix://@var{file}[;@var{args}] -Listen on the @acronym{UNIX} socket file @var{file}, which may be either -absolute or relative file name, as described above. Optional +Listen on the @acronym{UNIX} socket file @var{file}, which is either +an absolute or relative file name, as described above. Optional arguments @var{args} control ownership and file mode of @var{file}. They @@ -958,3 +959,3 @@ For example: @smallexample -socket unix:/var/run/socket;user=nobody;group=mail;mode=770 +socket "unix:/var/run/socket;user=nobody;group=mail;mode=770"; @end smallexample @@ -1100,6 +1101,6 @@ the exit code which the component returned. Notification is configured by supplying @samp{notify} and @samp{message} statements -within a @samp{return-code} block. +in a @samp{return-code} block. @deffn {Config: return-code} notify @var{email-string} -Send an email notification to addresses from @var{email-string}. The +Send email notification to addresses from @var{email-string}. The latter is a comma-separated list of email addresses, e.g.: @@ -1192,3 +1193,3 @@ Subject: Component $@{component@} $@{termination@} $@{retcode@}. @cindex @command{sendmail} - Notification messages are sent using external program, called + Notification messages are sent using an external program, called @dfn{mailer}. By default it is @command{/usr/sbin/sendmail}. You can @@ -1312,3 +1313,3 @@ future use and is described in more detail in @ref{User-Group ACLs}. The @var{sub-acl} part, if present, allows to branch to another -@acronym{ACL}. The syntax of this group is: +@acronym{ACL}. The syntax of this part is: @@ -1319,3 +1320,3 @@ acl @var{name} @noindent -where @var{name} is the name of @acronym{ACL} defined previously in +where @var{name} is the name of an @acronym{ACL} defined previously in @samp{defacl} statement. @@ -1323,3 +1324,3 @@ where @var{name} is the name of @acronym{ACL} defined previously in The @var{host-list} group allows to match client addresses. -It consists of a @code{from} keyword followed by a list of +It consists of the @code{from} keyword followed by a list of @dfn{address specifiers}. Allowed address specifiers are: @@ -1350,7 +1351,7 @@ Matches if connection was received from a @acronym{UNIX} socket -@anchor{acl-any}. +@anchor{acl-any} The special form @samp{allow any} means to allow access unconditionally. Similarly, @samp{deny any}, denies access -unconditionally. Normally, these forms appear as the last -statements in an @acronym{ACL} definition. +unconditionally. Normally, one of these forms appears as the last +statement in an @acronym{ACL} definition. @@ -1363,4 +1364,3 @@ allow|deny [acl @var{name}] [from @var{addr-list}] @noindent -where square brackets denote optional parts and vertical bar means -@samp{one of}. +where square brackets denote optional parts. @@ -1369,5 +1369,5 @@ one of them matches, or the end of the list is reached. If a matched entry is found, its command verb, @code{allow} or @code{deny}, defines -the result of @acronym{ACL} match. If the end of list is reached, +the result of the @acronym{ACL} check. If the end of the list is reached, the result is @samp{allow}, unless explicitly specified otherwise -(using the @pxref{acl-any, ``any'' form}). +(using the @ref{acl-any, ``any'' form}.) @@ -1395,5 +1395,4 @@ to replace Sendmail in the future (@uref{http://www.meta1.org}). It has a modular structure, each module being an independent -program, which is responsible for a particular task. The components -are configured in the MeTA1 configuration file -@file{/etc/meta1/meta1.conf}. +responsible for a particular task. The components are configured in +the MeTA1 configuration file @file{/etc/meta1/meta1.conf}. @@ -1433,3 +1432,3 @@ Here, @var{compname} stands for the name of the component, and latter is @file{/var/spool/meta1} by default. It can be changed using -the following statement +the following statement: @@ -1441,4 +1440,5 @@ To override any default settings for a MeTA1 component, add a @code{command} section with the desired settings after including -@file{meta1.conf}. For example, here is how to redirect program -diagnostics to @samp{local1.debug} syslog channel: +@file{meta1.conf}. For example, here is how to redirect the +standard error of the @samp{smtps} component to @samp{local1.debug} +syslog channel: @@ -1468,2 +1468,3 @@ Prefix syslog messages with this string. By default, the program name is used. +@end deffn @@ -1475,3 +1476,2 @@ number. @end deffn -@end deffn @@ -1516,3 +1516,3 @@ suit your needs: Write PID of the master @command{pies} process to @var{file}. By -default, master PID is stored in @file{@var{localstatedir}/pies.pid}, +default the master PID is stored in @file{@var{localstatedir}/pies.pid}, where @var{localstatedir} is the @dfn{local state directory}, defined @@ -1535,3 +1535,2 @@ privileges, you may change them using the following three statements: -@command{pies} process. @deffn {Config} user @var{user-name} @@ -1541,3 +1540,3 @@ Start @command{pies} with the UID and GID of this user. @deffn {Config} group @var{group-list} -Retain supplementary groups, specified in @var{group-list}. +Retain the supplementary groups, specified in @var{group-list}. @end deffn @@ -1672,3 +1671,2 @@ and restricts access to them to two local subnets: acl @{ - log from any "Connect from $@{address@}"; allow from 10.10.10.0/24; @@ -1685,3 +1683,3 @@ component ftp @{ program /usr/sbin/ftpd - command ftpd -l -C; + command "ftpd -l -C"; @} 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 @@ -29,3 +29,3 @@ For example, the following statement defines an @acronym{ACL} which allows access for any user connected via local @acronym{UNIX} -socket @file{/tmp/dicod.sock} or coming from a local network +socket @file{/tmp/pies.sock} or coming from a local network @samp{192.168.10.0/24}. Any authenticated users are allowed, provided |