aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2009-09-15 10:40:29 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2009-09-15 10:40:54 +0300
commit989a5bbb74c3620abaa2191ce2c4f8d5968dbf0a (patch)
treec0b2324a523905c3c17201cc2468c9078976fc74 /doc
parentdbad35177723e19147ab49b59a3728e00fe05875 (diff)
downloadpies-989a5bbb74c3620abaa2191ce2c4f8d5968dbf0a.tar.gz
pies-989a5bbb74c3620abaa2191ce2c4f8d5968dbf0a.tar.bz2
Branch off from the Mailfromd project into a separate repository.
Diffstat (limited to 'doc')
-rw-r--r--doc/.gitignore22
-rw-r--r--doc/Makefile.am39
-rw-r--r--doc/pies.texi176
3 files changed, 176 insertions, 61 deletions
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..94d867b
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1,22 @@
+Makefile
+Makefile.in
+pies.info*
+stamp-vti
+version.texi
+pies.aux
+pies.cp
+pies.cps
+pies.dvi
+pies.fl
+pies.fn
+pies.kw
+pies.ky
+pies.log
+pies.mt
+pies.op
+pies.pg
+pies.pr
+pies.ps
+pies.toc
+pies.tp
+pies.vr
diff --git a/doc/Makefile.am b/doc/Makefile.am
index ee522f2..502c46e 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,5 +1,5 @@
-# This file is part of Mailfromd.
+# This file is part of Pies.
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Sergey Poznyakoff
#
-# Mailfromd is free software; you can redistribute it and/or modify
+# Pies is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@@ -8,3 +8,3 @@
#
-# Mailfromd is distributed in the hope that it will be useful,
+# Pies is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -14,19 +14,10 @@
# You should have received a copy of the GNU General Public License
-# along with Mailfromd. If not, see <http://www.gnu.org/licenses/>.
+# along with Pies. If not, see <http://www.gnu.org/licenses/>.
-info_TEXINFOS=mailfromd.texi
-mailfromd_TEXINFOS=\
+info_TEXINFOS=pies.texi
+pies_TEXINFOS=\
fdl.texi\
- gacopyz.texi\
macros.texi\
- mtasim.texi\
pies.texi\
- pmult.texi\
- pragma-database.texi\
- pragma-option.texi\
- rendition.texi\
- smap.texi\
- strftime.texi\
- upgrade.texi\
- values.texi
+ rendition.texi
@@ -43,3 +34,3 @@ clean-local:
check-format:
- @if test -n "`cat $(info_TEXINFOS) $(mailfromd_TEXINFOS) | tr -d -c '\t'`"; then \
+ @if test -n "`cat $(info_TEXINFOS) $(pies_TEXINFOS) | tr -d -c '\t'`"; then \
echo "Sources contain tabs; run make untabify"; \
@@ -67,3 +58,3 @@ check-config:
'/mf_cfg_param\[\] *= *{/,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg' \
- 's/@deffn {Mailfromd Conf} *\([^@,]*\).*/\1/p' \
+ 's/@deffn {Pies Conf} *\([^@,]*\).*/\1/p' \
$(top_srcdir)/mfd/main.c -- \
@@ -103,3 +94,3 @@ check-exceptions:
's/@cindex \([^,][^,]*\), exception type/\1/p' \
- $(top_srcdir)/mfd/mailfromd.h -- \
+ $(top_srcdir)/mfd/pies.h -- \
$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \
@@ -108,3 +99,3 @@ check-exceptions:
check-refs:
- @for file in $(info_TEXINFOS) $(mailfromd_TEXINFOS); \
+ @for file in $(info_TEXINFOS) $(pies_TEXINFOS); \
do \
@@ -122,3 +113,3 @@ check-refs:
check-fixmes:
- @for file in $(info_TEXINFOS) $(mailfromd_TEXINFOS); \
+ @for file in $(info_TEXINFOS) $(pies_TEXINFOS); \
do \
@@ -137,3 +128,3 @@ check-fixmes:
check-writeme:
- @grep -Hn @WRITEME $(info_TEXINFOS) $(mailfromd_TEXINFOS) > $@-t; \
+ @grep -Hn @WRITEME $(info_TEXINFOS) $(pies_TEXINFOS) > $@-t; \
if [ -s $@-t ]; then \
@@ -148,3 +139,3 @@ check-writeme:
check-unrevised:
- @grep -Hn @UNREVISED $(info_TEXINFOS) $(mailfromd_TEXINFOS) > $@-t; \
+ @grep -Hn @UNREVISED $(info_TEXINFOS) $(pies_TEXINFOS) > $@-t; \
if [ -s $@-t ]; then \
@@ -172,3 +163,3 @@ master-menu:
untabify:
- @emacs -batch -l untabify.el $(info_TEXINFOS) $(mailfromd_TEXINFOS)
+ @emacs -batch -l untabify.el $(info_TEXINFOS) $(pies_TEXINFOS)
diff --git a/doc/pies.texi b/doc/pies.texi
index 7f020f1..cc35b5d 100644
--- a/doc/pies.texi
+++ b/doc/pies.texi
@@ -1,5 +1,101 @@
-@c This file is part of the Mailfromd manual.
-@c Copyright (C) 2008, 2009 Sergey Poznyakoff
-@c See file mailfromd.texi for copying conditions.
-@c *******************************************************************
+\input texinfo @c -*-texinfo-*-
+@smallbook
+@c %**start of header
+@setfilename pies.info
+@settitle Pies
+@c %**end of header
+@setchapternewpage odd
+
+@defcodeindex pr
+@defcodeindex op
+@c mt is the same as op, but used for mtasim options.
+@defcodeindex mt
+@defcodeindex kw
+@defcodeindex fl
+
+@syncodeindex fn cp
+@syncodeindex vr cp
+@syncodeindex ky cp
+@syncodeindex mt cp
+@syncodeindex pg cp
+@syncodeindex tp cp
+@syncodeindex op cp
+@syncodeindex pr cp
+@syncodeindex kw cp
+@syncodeindex fl cp
+
+@include version.texi
+@include rendition.texi
+@include macros.texi
+
+@ifinfo
+@dircategory GNU Utilities
+@direntry (pies) pies. Program execution supervisor.
+@end direntry
+@end ifinfo
+
+@copying
+Published by the Free Software Foundation,
+51 Franklin Street, Fifth Floor,
+Boston, MA 02110-1301 USA
+
+Copyright @copyright{} 2005, 2006, 2007, 2008, 2009 Sergey Poznyakoff
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.2 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with the Front-Cover texts being ``Pies Manual'',
+and with the Back-Cover Texts as in (a) below. A copy of the license
+is included in the section entitled ``GNU Free Documentation License''.
+
+(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
+this GNU Manual, like GNU software. Copies published by the Free
+Software Foundation raise funds for GNU development.''
+@end copying
+
+@titlepage
+@title Program Invocation and Execution Supervisor
+@subtitle version @value{VERSION}, @value{UPDATED}
+@author Sergey Poznyakoff.
+@page
+@vskip 0pt plus 1filll
+@insertcopying
+@end titlepage
+
+@page
+@summarycontents
+@page
+@contents
+
+@ifnottex
+@node Top
+@top Pies
+
+This edition of the @cite{Pies Manual}, last updated @value{UPDATED},
+documents @command{pies} Version @value{VERSION}.
+@end ifnottex
+
+@menu
+* Intro::
+* Pies Configuration File::
+* Component Statement::
+* include-meta1::
+* Global Configuration::
+* Pies Debugging::
+* Configuration Example::
+* Command Line Usage::
+* Pies Invocation::
+
+Appendices
+
+* Copying This Manual:: The GNU Free Documentation License.
+* Concept Index:: Index of Concepts.
+
+@c @detailmenu
+@c @end detailmenu
+
+@end menu
+
+@node Intro
+@chapter Introduction
@cindex component, pies
@@ -87,10 +183,2 @@ statement (@pxref{include-meta1}).
@menu
-* Pies Configuration File::
-* Component Statement::
-* include-meta1::
-* Global Configuration::
-* Pies Debugging::
-* Configuration Example::
-* Command Line Usage::
-* Pies Invocation::
@end menu
@@ -98,3 +186,3 @@ statement (@pxref{include-meta1}).
@node Pies Configuration File
-@section Pies Configuration File
+@chapter Pies Configuration File
@command{Pies} reads its configuration from the main Mailutils
@@ -106,3 +194,3 @@ Statement,, mailutils, GNU Mailutils Manual}), and to place
@command{pies} configuration in file @file{@var{directory}/pies}.
-@xref{MeTA1}, for an example.
+@xref{MeTA1,,, mailfromd, Mailfromd Manual}, for an example.
@@ -125,3 +213,3 @@ mailutils, GNU Mailutils Manual}.
@node Component Statement
-@section Component Statement
+@chapter Component Statement
@kwindex component
@@ -205,3 +293,3 @@ respawn too fast.
@node Prerequisites
-@subsection Component Prerequisites
+@section Component Prerequisites
@cindex declaring prerequisites
@@ -232,3 +320,3 @@ component tags.
@node Component Privileges
-@subsection Component Privileges
+@section Component Privileges
@cindex privileges, pies
@@ -252,3 +340,3 @@ components specified in @file{meta1.conf} file (@pxref{include-meta1}).
@node Resources
-@subsection Resources
+@section Resources
@@ -342,3 +430,3 @@ before assignment.
@node Actions Before Startup
-@subsection Actions Before Startup
+@section Actions Before Startup
@@ -367,3 +455,3 @@ This may change in future versions.
@node Exit Actions
-@subsection Exit Actions
+@section Exit Actions
@kwindex return-code
@@ -479,3 +567,3 @@ The following macro-variables are expanded within @var{string}:
@item program-name @tab Program name of the @command{pies} binary.
-@item package @tab Package name (@samp{Mailfromd}).
+@item package @tab Package name (@samp{Pies}).
@item version @tab Package version (@value{VERSION}).
@@ -506,3 +594,3 @@ all components. Any @code{return-code} statements appearing within a
@node Output Redirectors
-@subsection Output Redirectors
+@section Output Redirectors
@cindex repeater
@@ -552,3 +640,3 @@ through @samp{local7} (all names case-insensitive), or a facility number.
@node Inetd-Style Components
-@subsection Inetd-Style Components
+@section Inetd-Style Components
@cindex inetd-style components
@@ -610,3 +698,3 @@ be added if there is a demand.
@node Meta1-Style Components
-@subsection Meta1-Style Components
+@section Meta1-Style Components
@cindex meta1-style components
@@ -629,3 +717,3 @@ upon its startup.
@node Component Syntax Summary
-@subsection Component Syntax Summary
+@section Component Syntax Summary
This subsection summarizes the @code{component} summary. For each
@@ -729,3 +817,3 @@ component @var{tag} @{
@node include-meta1
-@section Using MeTA1 Configuration File
+@chapter Using MeTA1 Configuration File
@cindex /etc/meta1/meta1.conf
@@ -784,3 +872,3 @@ component smtps @{
@node Global Configuration
-@section Global Configuration
+@chapter Global Configuration
The statements described in this section affect @command{pies}
@@ -813,3 +901,3 @@ Default is 5 seconds.
@node Less Useful Statements
-@subsection Less Useful Statements
+@section Less Useful Statements
@@ -828,3 +916,3 @@ Write PID of the master @command{pies} process to @var{file}. By
default, master PID is stored in @file{@var{statedir}/pies.pid}
-(@pxref{statedir}).
+(@FIXME-pxref{statedir}).
@end deffn
@@ -860,3 +948,3 @@ Retain all supplementary groups of which user, given with
@node Pies Debugging
-@section Pies Debugging
+@chapter Pies Debugging
The amount of debugging information produced by @command{pies} is configured
@@ -896,3 +984,3 @@ Debug the lexical analyzer of MeTA1 configuration file.
@node Configuration Example
-@section Configuration Example
+@chapter Configuration Example
In this section we provide several examples of working @command{pies}
@@ -907,4 +995,5 @@ configuration files.
@node Simple Pies
-@subsection Simplest Case: Using Pies to Run Pmult
- The example below runs @command{pmult} (@pxref{pmult}) utility with
+@section Simplest Case: Using Pies to Run Pmult
+ The example below runs @command{pmult} (@pxref{pmult, Pmilter
+multiplexer program,, mailfromd, Mailfromd Manual}) utility with
the privileges of @samp{meta1} user. Both standard error and standard
@@ -924,3 +1013,3 @@ component pmult @{
@node Hairy Pies
-@subsection Using Pies to Run Pmult and MeTA1
+@section Using Pies to Run Pmult and MeTA1
The example below is a working configuration file for running
@@ -966,3 +1055,3 @@ include-meta1 "/etc/meta1/meta1.conf";
@node Inetd Pies
-@subsection Running Pies Instead of Inetd
+@section Running Pies Instead of Inetd
@@ -999,3 +1088,3 @@ component pop3d @{
@node Command Line Usage
-@section Command Line Usage
+@chapter Command Line Usage
@@ -1108,3 +1197,3 @@ smtps: smar qmgr
@node Pies Invocation
-@section Pies Invocation
+@chapter Pies Invocation
@@ -1159 +1248,14 @@ errors. @xref{Common Options, Common Options, , mailutils, GNU
Mailutils Manual}, for a detailed description of these.
+
+@node Copying This Manual
+@appendix GNU Free Documentation License
+@include fdl.texi
+
+@node Concept Index
+@unnumbered Concept Index
+
+This is a general index of all issues discussed in this manual
+
+@printindex cp
+
+@bye

Return to:

Send suggestions and report system problems to the System administrator.