diff options
author | Sergey Poznyakoff <gray@gnu.org> | 2020-12-02 08:40:31 +0200 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org> | 2020-12-02 08:40:31 +0200 |
commit | 69431c377e35378306c1d6e87412af32d4b2a4a1 (patch) | |
tree | f1b6923c5dbeda414b9d3987bf5898b31fda5703 /doc/pies.texi | |
parent | c0f4c3b99bb3364fe3f840b1ecb44af2eeba097b (diff) | |
download | pies-69431c377e35378306c1d6e87412af32d4b2a4a1.tar.gz pies-69431c377e35378306c1d6e87412af32d4b2a4a1.tar.bz2 |
Minor fixes in the docs
Diffstat (limited to 'doc/pies.texi')
-rw-r--r-- | doc/pies.texi | 63 |
1 files changed, 31 insertions, 32 deletions
diff --git a/doc/pies.texi b/doc/pies.texi index 7a21434..1e9afa3 100644 --- a/doc/pies.texi +++ b/doc/pies.texi @@ -739,7 +739,7 @@ The following are the basic statements which are allowed within the Declare the type (style) of the component. Following are the basic values for @var{mode}: -@table @asis +@table @code @kindex exec @kindex respawn @item exec @@ -778,7 +778,7 @@ after all regular components have terminated. When run as init process (@pxref{Init Process}), the following @var{mode}s are also allowed: -@table @asis +@table @code @item boot The process will be executed during system boot. The @samp{runlevel} settings are ignored. @@ -838,9 +838,8 @@ any other processes. @end deffn @deffn {Config: component} command @var{string} -Command line to run. The argument is the full command line. The -first word (in the shell sense) in @var{string} is the name of the -program to invoke. +Command line to run. @var{string} is the full command line. Its +first word (in the shell sense) is the name of the program to invoke. @end deffn @deffn {Config: component} program @var{name} @@ -855,7 +854,7 @@ the running program as @code{argv[0]}. Define flags for this component. The @var{flag-list} is a comma-separated list of flags. Valid flags are: -@table @asis +@table @code @kwindex disable @item disable This component is disabled, i.e.@: @command{pies} will parse and @@ -963,10 +962,10 @@ Prerequisites (@pxref{component prerequisite}) for a component are declared using the following statement: @deffn {Config: component} prerequisites @var{tag-list} -The argument is either a list of component tags, @emph{defined before -this component}, or one of the following words: +The argument is either a list of component tags or one of the +following words: -@table @asis +@table @code @item all Declare all components defined so far as prerequisites for this one. @@ -1006,8 +1005,8 @@ components specified in @file{meta1.conf} file (@pxref{include-meta1}). @subsection Resources @deffn {Config: component} limits @var{string} -Impose limits on system resources, as defined by @var{string}. The -argument consists of @dfn{commands}, optionally separated by any +Impose limits on system resources, as defined by the @var{string} +argument. It consists of @dfn{commands}, optionally separated by any amount of whitespace. A command is a single command letter followed by a number, that specifies the limit. The command letters are case-insensitive and coincide with those used by the shell @code{ulimit} @@ -1487,7 +1486,7 @@ Redirect standard error (if @code{stderr}) or standard output (if The type of redirection is specified by @var{type} argument: -@table @asis +@table @code @item file Redirect to a file. In this case @var{channel} gives the full name of the file. For example: @@ -1549,7 +1548,7 @@ control ownership and file mode of @var{file}. They are a list of assignments, separated by semicolons. The following values are allowed: -@table @asis +@table @code @item user User name of the socket owner. @@ -1651,7 +1650,7 @@ components that are supported internally by @command{pies} and do not require external programs. In @command{pies} version @value{VERSION} those are: -@table @asis +@table @code @cindex echo @item echo Send back any received data. Defined in @RFC{862}. @@ -1783,7 +1782,7 @@ Sets the name of the master TCPMUX service. The @code{flags} statement (@pxref{flags}) must contain at least one of the following flags: -@table @asis +@table @code @item tcpmux A ``dedicated'' TCPMUX subordinate service. When invoked, it must output the @samp{+ CRLF} response itself. @@ -2157,14 +2156,14 @@ The table below lists all available variables and their expansions: @caption{Notification Variables} @multitable @columnfractions 0.5 0.5 @headitem Variable @tab Expansion -@item canonical_program_name @tab @samp{pies} -@item program_name @tab Program name of the @command{pies} binary. -@item package @tab Package name (@samp{GNU Pies}). -@item instance @tab Instance name (@pxref{instances}). -@item version @tab Package version (@value{VERSION}). -@item component @tab Name of the terminated component. -@item termination @tab Termination cause (see below). -@item retcode @tab Component exit code (or signal number, if exited +@item @code{canonical_program_name} @tab @samp{pies} +@item @code{program_name} @tab Program name of the @command{pies} binary. +@item @code{package} @tab Package name (@samp{GNU Pies}). +@item @code{instance} @tab Instance name (@pxref{instances}). +@item @code{version} @tab Package version (@value{VERSION}). +@item @code{component} @tab Name of the terminated component. +@item @code{termination} @tab Termination cause (see below). +@item @code{retcode} @tab Component exit code (or signal number, if exited on signal), in decimal. @end multitable @end float @@ -2443,7 +2442,7 @@ an absolute or relative file name. Optional arguments @var{args} control ownership and file mode of @var{file}. They are a semicolon-separated list of assignments to the following variables: -@table @asis +@table @code @item user User name of the socket owner. @@ -2827,7 +2826,7 @@ for their termination. If any components are left running after procedure. This means that @command{pies} termination sequence can take -up to 5*@code{shutdown-timeout} seconds. +up to 2*@code{shutdown-timeout} seconds. @end deffn @node Pies Privileges @@ -2975,7 +2974,7 @@ sections describe available commands in detail. @command{pies} instance organized as key-value pairs. When invoked without arguments, the following data are returned: -@table @asis +@table @code @item package Canonical package name. @item version @@ -3139,7 +3138,7 @@ eklogin IR 13836 /usr/local/sbin/klogind -k -c -e Use @var{condition} to select the components to list. In its simplest form, @var{condition} is one of the following @dfn{terms}: -@table @asis +@table @code @item all Selects all processes, including internal services, such as output redirectors. @@ -3167,7 +3166,7 @@ piesctl list mode inetd @item status @var{arg} Selects processes with the given status. Argument is one of: -@table @asis +@table @code @item finished Component is finished. @@ -3425,7 +3424,7 @@ both of them can be missing. states is controlled by @dfn{runlevel}, which also defines the set of components that must be executed. Startup states are: -@table @asis +@table @code @item sysinit System initialization state. This state marks the beginning of the startup process. Only root partition is mounted, and is usually @@ -3543,7 +3542,7 @@ Command to be executed and its arguments. Component execution modes are: -@table @asis +@table @code @item respawn The basic execution mode. A @dfn{respawn} component is restarted each time it terminates. If it is restarted more than 10 @@ -3638,7 +3637,7 @@ word @samp{pies} (with any amount of white space in between) introduce a pragmatic comment that modifies the behavior of the configuration parser. The following such comments are understood: -@table @asis +@table @code @item #pies pragma debug @var{n} Set debugging level @var{n} (a decimal number). @xref{Pies Debugging}. @@ -4288,7 +4287,7 @@ Define the syntax for parsing the configuration files specified by any @option{--config-file} options that follow this one. Possible values for @var{type} are: -@table @asis +@table @code @item pies Native @command{pies} configuration. @xref{Configuration}. |