aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2009-12-11 13:31:58 +0200
committerSergey Poznyakoff <gray@gnu.org.ua>2009-12-11 13:31:58 +0200
commit4d759daeec0abf98294ece5a689c608890ffb4d1 (patch)
tree7287200a195bf1bc6169d66c97c6b6211cf26ad1 /doc
parent9cfa003658ff1df27284e409cbeda705496a808a (diff)
downloadpies-4d759daeec0abf98294ece5a689c608890ffb4d1.tar.gz
pies-4d759daeec0abf98294ece5a689c608890ffb4d1.tar.bz2
Finish the docs.
* doc/inetd.texi: Update. * doc/pies.texi: Update.
Diffstat (limited to 'doc')
-rw-r--r--doc/inetd.texi7
-rw-r--r--doc/pies.texi183
2 files changed, 116 insertions, 74 deletions
diff --git a/doc/inetd.texi b/doc/inetd.texi
index a1c5f8a..c7c8bbb 100644
--- a/doc/inetd.texi
+++ b/doc/inetd.texi
@@ -107,7 +107,7 @@ Servers using stream sockets generally are multi-threaded and use the
107accepted by @command{pies}, and the server is given only the 107accepted by @command{pies}, and the server is given only the
108newly-accepted socket connected to a client of the service. Most 108newly-accepted socket connected to a client of the service. Most
109stream-based services and all TCPMUX services operate in this manner. 109stream-based services and all TCPMUX services operate in this manner.
110For such services, the invocation rate may be limitied by specifying 110For such services, the invocation rate may be limited by specifying
111optional @samp{max-rate} suffix (a decimal number), e.g.: 111optional @samp{max-rate} suffix (a decimal number), e.g.:
112@samp{nowait.15}. 112@samp{nowait.15}.
113 113
@@ -187,14 +187,13 @@ causes any previous default address specifier to be forgotten.
187 187
188An example of @file{inetd.conf} file with various services follows: 188An example of @file{inetd.conf} file with various services follows:
189 189
190@example 190@smallexample
191ftp stream tcp nowait root /usr/libexec/ftpd ftpd -l 191ftp stream tcp nowait root /usr/libexec/ftpd ftpd -l
192ntalk dgram udp wait root /usr/libexec/ntalkd ntalkd 192ntalk dgram udp wait root /usr/libexec/ntalkd ntalkd
193tcpmux stream tcp nowait root internal 193tcpmux stream tcp nowait root internal
194tcpmux/+scp-to stream tcp nowait guest /usr/sbin/in.wydawca wydawca 194tcpmux/+scp-to stream tcp nowait guest /usr/sbin/in.wydawca wydawca
195tcpmux/docref stream tcp nowait guest /usr/bin/docref docref 195tcpmux/docref stream tcp nowait guest /usr/bin/docref docref
196@end example 196@end smallexample
197
198 197
199 198
200 199
diff --git a/doc/pies.texi b/doc/pies.texi
index db438c6..04c85a4 100644
--- a/doc/pies.texi
+++ b/doc/pies.texi
@@ -85,7 +85,7 @@ documents @command{pies} Version @value{VERSION}.
85* Dependencies:: 85* Dependencies::
86* Pies Configuration File:: 86* Pies Configuration File::
87* Pies Debugging:: 87* Pies Debugging::
88* Configuration Example:: 88* Configuration Examples::
89* Command Line Usage:: 89* Command Line Usage::
90* Invocation:: 90* Invocation::
91* Reporting Bugs:: 91* Reporting Bugs::
@@ -106,8 +106,8 @@ Pies Configuration File
106* Component Statement:: 106* Component Statement::
107* Notification:: Mail Notification 107* Notification:: Mail Notification
108* ACL:: Access Control Lists 108* ACL:: Access Control Lists
109* inetd:: 109* inetd:: Using @command{inetd} Configuration Files
110* include-meta1:: 110* include-meta1:: Using @command{meta1} Configuration Files
111* Global Configuration:: 111* Global Configuration::
112* Pies Privileges:: 112* Pies Privileges::
113* State Files:: 113* State Files::
@@ -132,11 +132,12 @@ Component Statement
132 132
133Inetd-Style Components 133Inetd-Style Components
134 134
135* builtin:: Built-in Inetd Services 135* builtin:: Built-in Inetd Services
136* TCPMUX:: TCPMUX Services 136* TCPMUX:: TCPMUX Services
137* sockenv:: Socket Environment Variables 137* sockenv:: Socket Environment Variables
138* inetd exit:: Exit Actions in Inetd Components
138 139
139Configuration Example 140Configuration Examples
140 141
141* Simple Pies:: 142* Simple Pies::
142* Hairy Pies:: 143* Hairy Pies::
@@ -164,7 +165,7 @@ redirected to a file or to an arbitrary @command{syslog} channel.
164 165
165@anchor{init-style} 166@anchor{init-style}
166@cindex init-style components 167@cindex init-style components
167 This way of operation applies to the @dfn{init-style} 168 This way of operation applies to @dfn{init-style}
168components, called so because of the similarity with the 169components, called so because of the similarity with the
169@command{init} process manager. @command{Pies} is also able to handle 170@command{init} process manager. @command{Pies} is also able to handle
170components that receive input on their @samp{stdin} and send reply to 171components that receive input on their @samp{stdin} and send reply to
@@ -185,11 +186,12 @@ the @command{inetd} utility.
185 186
186@anchor{meta1-style} 187@anchor{meta1-style}
187@cindex meta1-style components 188@cindex meta1-style components
189@cindex pass-style components
188@cindex smtps 190@cindex smtps
189 Yet another type of components supported by @command{pies} are 191 Yet another type of components supported by @command{pies} are
190@dfn{meta1-style} components. As its name suggests, this type is 192@dfn{pass-style} or @dfn{meta1-style} components. As the name
191designed expressly as a support for MeTA1@footnote{See 193suggests, this type is designed expressly as a support for
192@uref{http://www.meta1.org}} components, namely 194MeTA1@footnote{See @uref{http://www.meta1.org}} components, namely
193@command{smtps}. This type can be regarded as a mixture of the above 195@command{smtps}. This type can be regarded as a mixture of the above
194two. For each meta1-style component @command{pies} opens a socket 196two. For each meta1-style component @command{pies} opens a socket
195after start-up, and starts the component binary. Once the component 197after start-up, and starts the component binary. Once the component
@@ -209,10 +211,12 @@ simultaneously.
209 211
210 Components are started in the order of their appearance in the 212 Components are started in the order of their appearance in the
211configuration file and terminated in reverse order. The same 213configuration file and terminated in reverse order. The same
212ordering applies when starting or stopping a component dependencies, 214ordering applies when starting or stopping component dependencies,
213 215
214 As an exception, this order is reversed for the components read from 216 As an exception, this order is reversed for the components read from
215files included by @code{include-meta1} statement (@pxref{include-meta1}). 217MeTA1 configuration files, either included by @code{include-meta1}
218statement (@pxref{include-meta1}) or expressly supplied in the command
219line (@pxref{config syntax}).
216 220
217@node Dependencies 221@node Dependencies
218@chapter Inter-Component Dependencies 222@chapter Inter-Component Dependencies
@@ -228,7 +232,7 @@ startup. Components @samp{B} and @samp{C} are called
228 232
229 Before restarting any component, @command{pies} verifies if it is a 233 Before restarting any component, @command{pies} verifies if it is a
230prerequisite for any other components. If so, it first terminates its 234prerequisite for any other components. If so, it first terminates its
231dependencies, then restarts the component, and then starts its 235dependencies, restarts the component, and then starts its
232dependencies again, in the order of their appearance in the 236dependencies again, in the order of their appearance in the
233configuration file. 237configuration file.
234 238
@@ -242,9 +246,9 @@ or more @dfn{configuration files}. The default configuration file
242is named @file{pies.conf} and is located in the @dfn{system 246is named @file{pies.conf} and is located in the @dfn{system
243configuration directory} (in most cases @file{/etc} or 247configuration directory} (in most cases @file{/etc} or
244@file{/usr/local/etc}, depending on how the package was compiled). 248@file{/usr/local/etc}, depending on how the package was compiled).
245This file uses the @dfn{native Pies configuration syntax}. The 249This file uses the @dfn{native Pies configuration syntax}. Apart from
246program also understands configuration files in @dfn{inetd} and 250this format, the program also understands configuration files in
247@dfn{meta1} formats. 251@dfn{inetd} and @dfn{meta1} formats.
248 252
249 Alternative configuration files may be specified using @option{--config-file} 253 Alternative configuration files may be specified using @option{--config-file}
250(@option{-c} command line option), e.g.: 254(@option{-c} command line option), e.g.:
@@ -279,8 +283,11 @@ pies /etc/pies.conf \
279@end group 283@end group
280@end smallexample 284@end smallexample
281 285
286@xopindex{config-help, introduced}
282 The rest of this chapter concerns the @command{pies} native 287 The rest of this chapter concerns the @command{pies} native
283configuration file format. The use of inetd configuration files is 288configuration file format. You can receive a concise summary of all
289configuration directives any time by running @command{pies
290--config-help}. The use of inetd configuration files is
284covered in @ref{inetd} and the use of meta1 configuration files 291covered in @ref{inetd} and the use of meta1 configuration files
285is described in @ref{include-meta1} 292is described in @ref{include-meta1}
286 293
@@ -300,18 +307,13 @@ if no errors were detected, and with status 78 otherwise.
300configuration without actually parsing it, use @option{-E} command 307configuration without actually parsing it, use @option{-E} command
301line option. 308line option.
302 309
303@xopindex{config-help, introduced}
304 The rest of this section describes the configuration file syntax in
305detail. You can receive a concise summary of all configuration
306directives any time by running @command{pies --config-help}.
307
308@menu 310@menu
309* Syntax:: Configuration File Syntax 311* Syntax:: Configuration File Syntax
310* Component Statement:: 312* Component Statement::
311* Notification:: Mail Notification 313* Notification:: Mail Notification
312* ACL:: Access Control Lists 314* ACL:: Access Control Lists
313* inetd:: 315* inetd:: Using @command{inetd} Configuration Files
314* include-meta1:: 316* include-meta1:: Using @command{meta1} Configuration Files
315* Global Configuration:: 317* Global Configuration::
316* Pies Privileges:: 318* Pies Privileges::
317* State Files:: 319* State Files::
@@ -361,9 +363,8 @@ occurrence of @samp{*/} (star, slash).
361@cindex statement, simple 363@cindex statement, simple
362@cindex simple statements 364@cindex simple statements
363 A @dfn{simple statement} consists of a keyword and value 365 A @dfn{simple statement} consists of a keyword and value
364separated by any amount of whitespace. The simple statement is terminated 366separated by any amount of whitespace. The statement is terminated
365with a semicolon (@samp{;}), unless it contains a @dfn{here-document} 367with a semicolon (@samp{;}).
366(see below), in which case the semicolon is optional.
367 368
368 Examples of simple statements are: 369 Examples of simple statements are:
369 370
@@ -573,7 +574,7 @@ symbols may be undefined using the following command line options:
573@cindex @option{-D} 574@cindex @option{-D}
574@item --define=@var{sym}[=@var{value}] 575@item --define=@var{sym}[=@var{value}]
575@itemx -D @var{symbol}[=@var{value}] 576@itemx -D @var{symbol}[=@var{value}]
576Define symbol @var{sym} as having @var{value}, or emtpy, if 577Define symbol @var{sym} as having @var{value}, or empty, if
577the @var{value} is not given. 578the @var{value} is not given.
578 579
579@xopindex{undefine, described} 580@xopindex{undefine, described}
@@ -598,7 +599,8 @@ component @var{tag} @{
598@end smallexample 599@end smallexample
599 600
600The component is identified by its @dfn{tag}, which is given as 601The component is identified by its @dfn{tag}, which is given as
601argument to the @code{component} keyword. 602argument to the @code{component} keyword. Component declarations with
603the same tags are merged into a single declaration.
602 604
603The following are the basic statements which are allowed within the 605The following are the basic statements which are allowed within the
604@code{component} block: 606@code{component} block:
@@ -732,7 +734,7 @@ component tags.
732@node Component Privileges 734@node Component Privileges
733@subsection Component Privileges 735@subsection Component Privileges
734@cindex privile