diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-12-10 13:52:43 +0200 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-12-10 13:52:43 +0200 |
commit | b038141d8ba5e916bfa97a3c7cb08bb87af1c900 (patch) | |
tree | de4e5f8db20c6d20dae09f2b6bfda490fec66b25 /doc/pies.texi | |
parent | e668360caeb54d64b67130f6f4f674d8738a909a (diff) | |
download | pies-b038141d8ba5e916bfa97a3c7cb08bb87af1c900.tar.gz pies-b038141d8ba5e916bfa97a3c7cb08bb87af1c900.tar.bz2 |
Improve docs + bugfix.
* doc/inetd.texi: New file.
* doc/Makefile.am: Add inetd.texi.
* doc/pies.texi, doc/usr-acl.texi: Update.
* src/pies.c (socktype_xtab): SOCK_PACKET not always defined.
Diffstat (limited to 'doc/pies.texi')
-rw-r--r-- | doc/pies.texi | 129 |
1 files changed, 122 insertions, 7 deletions
diff --git a/doc/pies.texi b/doc/pies.texi index d5e9d02..7008ce6 100644 --- a/doc/pies.texi +++ b/doc/pies.texi @@ -92,6 +92,7 @@ documents @command{pies} Version @value{VERSION}. Appendices +* inetd.conf:: @file{Inetd.conf} Format. * User-Group ACLs:: * Copying This Manual:: The GNU Free Documentation License. * Concept Index:: Index of Concepts. @@ -105,7 +106,8 @@ Pies Configuration File * Component Statement:: * Notification:: Mail Notification * ACL:: Access Control Lists -* include-meta1:: +* inetd:: Using @command{inetd} Configuration Files +* include-meta1:: Using @command{meta1} Configuration Files * Global Configuration:: Configuration File Syntax @@ -263,7 +265,7 @@ option. This option instructs @command{pies} that any configuration files given after it have are written in the specified @var{format}. Valid formats are: @samp{pies}, @samp{inetd} and @samp{meta1}, which stand for pies native format, inetd-style configuration files -(@FIXME-pxref{inetd-format} and MeTA1-style configuration files. The +(@pxref{inetd.conf}) and MeTA1-style configuration files. The configuration file format set by the @option{--syntax} option remains in effect for all @option{--config-file} options that follow it, up to the end of the command line or the next occurrence of the @@ -281,12 +283,13 @@ pies /etc/pies.conf \ The rest of this chapter concerns the @command{pies} native configuration file format. The use of inetd configuration files is -covered in @FIXME-ref{inetd} and the use of meta1 configuration files -is described in @FIXME-ref{meta1} +covered in @ref{inetd} and the use of meta1 configuration files +is described in @ref{include-meta1} If any errors are encountered in the configuration file, the program reports them on the standard error and exits with status 78. +@anchor{lint} @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 @@ -309,6 +312,7 @@ directives any time by running @command{pies --config-help}. * Component Statement:: * Notification:: Mail Notification * ACL:: Access Control Lists +* inetd:: * include-meta1:: * Global Configuration:: @end menu @@ -656,7 +660,7 @@ disabled by @command{pies}, even if they respawn too fast. This flag is valid only for @samp{inetd} components. It has the same meaning as @samp{wait} in @file{inetd.conf} file, i.e. it tells @command{pies} to wait for the server program to -return. @FIXME-xref{inetd}. +return. @xref{inetd.conf, wait}. @item tcpmux This is a @acronym{TCPMUX} component. @xref{TCPMUX}. @@ -1766,6 +1770,113 @@ acl @{ @end group @end smallexample +@node inetd +@section Using @command{inetd} Configuration Files +@cindex inetd.conf +@flindex /etc/inetd.conf + In addition to its native configuration file format, GNU +@command{pies} is able to read configuration files of several other +widely-used utilities. One of these is @command{inetd}. The simplest +way to use such configuration files is by including them to your main +@file{pies.conf} using the @dfn{include-inetd} statement: + +@deffn {Config} include-inetd @var{file} +Read components from @command{inetd}-style configuration file +@var{file}. The argument may also be a directory, in which case +all regular files from that directory will be read and parsed +as @command{inetd}-style configuration files. + +The components read from @var{file} are appended to the @command{pies} +list of components in order of their appearance. + +For example, the following statement reads components from the +standard @command{inetd} configuration file: + +@smallexample +include-inetd /etc/inetd.conf; +@end smallexample + +Any number of @code{include-inetd} may be specified. For example, the +following reads the contents of the @file{/etc/inetd.conf} +configuration file and all files from the @file{/etc/inetd.d} +directory: + +@smallexample +include-inetd /etc/inetd.conf; +include-inetd /etc/inetd.d; +@end smallexample +@end deffn + + Another way to read @command{inetd} configuration files is to supply +them in the command line, like this: + +@smallexample +pies --syntax=inetd --config-file /etc/inetd.conf +@end smallexample + +Notice the @option{--syntax} option (@pxref{config syntax}). It +informs @command{pies} that the following files are in @command{inetd} +format. Of course, several configuration file may be given: + +@smallexample +@group +pies --syntax=inetd \ + --config-file /etc/inetd.conf --config-file /etc/inetd.d +@end group +@end smallexample + +A special option is provided that instructs @command{pies} to behave +as @command{inetd}: + +@table @option +@xopindex{inetd, described} +@item --inetd +Read configuration from @file{@var{sysconfdir}/inetd.conf} and make +sure @command{pies} state files (@FIXME-pxref{state files}) do not +conflict with those from other @command{pies} instances. +@end table + +The GNU Pies package also provides a wrapper that allows to use +@command{pies} instead of @command{inetd}. It is built if the package +is configured with the @option{--enable-inetd} option. The wrapper +is then installed in @var{sbindir} as @file{inetd}, possibly replacing +the system binary of that name. + +The command line usage of the @command{inetd} wrapper is entirely +compatible with that of the usual @command{inetd} utility, i.e.: + +@smallexample +inetd [@var{option}] [@var{config} [@var{config}...]] [-- @var{pies-options}] +@end smallexample + +Options are: + +@table @option +@item -d +Increase debug level. +@item -R @var{rate} +Set maximum rate (@pxref{max-rate}). +@end table + +For convenience, the following additional options are understood: + +@table @option +@item -t +@itemx --lint +Parse configuration file or files and exit. @xref{lint}. + +@item -s +@itemx --status +Display info about the running instance. @xref{pies-status}. + +@item -S +@itemx --stop +Stop the running instance. +@end table + + Finally, any additional options @command{pies} understands may be +given to @command{inetd} after the @samp{--} separator. + @node include-meta1 @section Using MeTA1 Configuration File @flindex /etc/meta1/meta1.conf @@ -2245,7 +2356,7 @@ Display a short usage summary and exit. @itemx -i Run in @command{inetd}-compatibility mode. It is roughly equivalent to @command{pies --instance=inetd --syntax=inetd}. -@FIXME-xref{inetd}. +@xref{inetd}. @opsummary{instance} @item --instance=@var{name} @@ -2284,7 +2395,7 @@ for @var{type} are: Native @command{pies} configuration. @xref{Pies Configuration File}. @item inetd -@samp{Inetd}-style configuration files. @FIXME-xref{inetd}. +@samp{Inetd}-style configuration files. @xref{inetd.conf}. @item meta1 @samp{meta1}-style configuration files. @FIXME-xref{meta1}. @@ -2343,6 +2454,10 @@ line options used). @item Conditions under which the bug appears. @end itemize +@node inetd.conf +@appendix @file{Inetd.conf} Format +@include inetd.texi + @node User-Group ACLs @appendix User-Group ACLs @include usr-acl.texi |