From af62c704053b5d34672497eb5bdc4764ebbb5f4f Mon Sep 17 00:00:00 2001 From: Kay Sievers Date: Fri, 25 Jun 2010 00:04:29 +0200 Subject: [PATCH] man: various fixes --- man/pam_systemd.xml | 28 ++++++++++++++-------------- man/runlevel.xml | 6 +++--- man/sd-daemon.xml | 2 +- man/sd_booted.xml | 2 +- man/sd_is_fifo.xml | 6 +++--- man/sd_listen_fds.xml | 7 +++---- man/sd_notify.xml | 10 +++++----- man/systemctl.xml | 10 +++++----- man/systemd.service.xml | 26 +++++++++++++------------- man/systemd.special.xml.in | 12 ++++++------ man/systemd.unit.xml | 4 ++-- man/systemd.xml | 16 ++++++++-------- 12 files changed, 64 insertions(+), 65 deletions(-) diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index a98c36bd..bfcc6845 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -63,19 +63,19 @@ On login, this module ensures the following: - If it does not exist yet the + If it does not exist yet, the user runtime directory /var/run/user/$USER is created and its ownership changed to the user that is logging in. If - is set the + is set, the $XDG_SESSION_ID environment variable is initialized. If auditing is available and pam_loginuid.so run before - this module (which es recommended), the + this module (which is highly recommended), the variable is initialized from the auditing session id (/proc/self/sessionid). Otherwise @@ -83,14 +83,14 @@ used. If - is set a new + is set, a new control group /user/$USER/$XDG_SESSION_ID is created and the login process moved into it. If - is set a new + is set, a new control group /user/$USER/no-session is created and the login process moved into @@ -107,7 +107,7 @@ remaining processes in the /user/$USER/$XDG_SESSION_ID control group are killed and the control group - removed. + is removed. If $XDG_SESSION_ID is set and @@ -116,17 +116,17 @@ /user/$USER/$XDG_SESSION_ID control group are migrated to /user/$USER/no-session and - the original control group + the original control group is removed. If is specified, and - no other user session control group remains + no other user session control group remains, except - /user/$USER/no-session + /user/$USER/no-session, all remaining processes in the /user/$USER hierarchy - are killed and the control group removed. + are killed and the control group is removed. If is specified, and @@ -143,7 +143,7 @@ If the system was not booted up with systemd as - init system this module does nothing and immediately + init system, this module does nothing and immediately returns PAM_SUCCESS. @@ -165,11 +165,11 @@ login process moved to the /user/$USER/$XDG_SESSION_ID control group. It is recommended that - all services that are directly created + all services which are directly created on the user's behalf set this option. Only for services that shall automatically be terminated when the - user logs out completely otherwise, + user logs out completely, otherwise create-session=0 should be set. @@ -196,7 +196,7 @@ completely. This is a weaker version of and is more friendly for users logged in more - than once as their processes are + than once, as their processes are terminated only on their complete logout. diff --git a/man/runlevel.xml b/man/runlevel.xml index 879b5e1e..51bc3ed9 100644 --- a/man/runlevel.xml +++ b/man/runlevel.xml @@ -61,10 +61,10 @@ The two runlevel characters are seperated by a single space character. If a runlevel cannot be - determined N is printed instead. If neither can be - determined the word "unknown" is printed. + determined, N is printed instead. If neither can be + determined, the word "unknown" is printed. - Unless overridden in the environment this will + Unless overridden in the environment, this will check the utmp database for recent runlevel changes. diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index da1e5b31..d9615133 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -141,7 +141,7 @@ daemons become NOPs when -DDISABLE_SYSTEMD is set during compilation. In addition, if sd-daemon.c is compiled on - non-Linux systems they become NOPs, too. + non-Linux systems they become NOPs. diff --git a/man/sd_booted.xml b/man/sd_booted.xml index 4d747336..15cd6ce4 100644 --- a/man/sd_booted.xml +++ b/man/sd_booted.xml @@ -69,7 +69,7 @@ On failure, this call returns a negative errno-style error code. If the system was booted up - with systemd as init system this call returns a + with systemd as init system, this call returns a positive return value, zero otherwise. diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index f1f6d376..0e3f3d03 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -94,8 +94,8 @@ sd_is_fifo() may be called to check whether the specified file descriptor refers - to a FIFO or pipe. It the path - parameter is not NULL it is checked whether the FIFO + to a FIFO or pipe. If the path + parameter is not NULL, it is checked whether the FIFO is bound to the specified file system path. sd_is_socket() may be @@ -193,7 +193,7 @@ sd_listen_fds3, systemd.service5, systemd.socket5 - + diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index 734e2374..06403eca 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -96,8 +96,7 @@ for the service to work, hence it should not be verified. On the other hand, whether a socket is a datagram or stream socket matters a lot for the most - common program logics and should hence be - checked. + common program logics and should be checked. This function call will set the FD_CLOEXEC flag for all passed file descriptors to avoid further @@ -111,9 +110,9 @@ errno-style error code. If $LISTEN_FDS/$LISTEN_PID was not set or not correctly set for this daemon and - hence no file descriptors received 0 is + hence no file descriptors received, 0 is returned. Otherwise the number of file descriptors - passed is returned, the application may find them + passed is returned. The application may find them starting with file descriptor SD_LISTEN_FDS_START, i.e. file descriptor 3. diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 8e6ee610..80856a22 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -104,7 +104,7 @@ definition file has Type=notify set. The passed argument is a boolean "1" or "0". Since there is little - value in signalling non-readiness the + value in signalling non-readiness, the only value daemons should send is "READY=1". @@ -115,7 +115,7 @@ Passes a single-line status string back to the init system that describes the daemon state. This - is free-from and can be used for + is free-form and can be used for various purposes: general state feedback, fsck-like programs could pass completion percentages and @@ -177,11 +177,11 @@ On failure, these calls return a negative errno-style error code. If $NOTIFY_SOCKET was not set and - hence no status data could be sent 0 is returned. If + hence no status data could be sent, 0 is returned. If the status was sent these functions return with a - positive return value. In order to support both init + positive return value. In order to support both, init systems that implement this scheme and those which - don't it is generally recommended to ignore the return + don't, it is generally recommended to ignore the return value of this call. diff --git a/man/systemctl.xml b/man/systemctl.xml index 2ffc87df..9f00324e 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -178,7 +178,7 @@ cannot be used to reload unit configuration. Use the daemon-reload - command for that. All in all this + command for that. All in all, this command is of little use except for debugging. This command should not be @@ -276,11 +276,11 @@ snapshot [NAME] Create a snapshot. If - a snapshot name is specified the new + a snapshot name is specified, the new snapshot will be named after it. If none is specified an automatic snapshot name is generated. In either - case the snapshot name used is printed + case, the snapshot name used is printed to STDOUT. A snapshot refers to a saved @@ -308,8 +308,8 @@ configuration. This will reload all unit files and recreate the entire dependency tree. While the daemon is - reloaded all sockets systemd listens - on on behalf of user configuration will + reloaded, all sockets systemd listens + on on behalf of user configuration, will stay accessible. This command should not be confused with the load or diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 5285ce3d..5230a783 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -94,14 +94,14 @@ daemon process. This is the behaviour of traditional UNIX daemons. If this setting is - used it is recommended to also + used, it is recommended to also use the PIDFile= option, so that systemd can identify the main process of - the daemon. systemd will start - follow-up units as soon as the - parent process exited. + the daemon. systemd will proceed + starting follow-up units as soon + as the parent process exits. If set to simple (the @@ -110,12 +110,12 @@ configured with ExecStart= is the main process of the - daemon. In this mode + daemon. In this mode, communication channels must be available before the daemon is - started up, as systemd will - immediately start follow-up - units. + started up (sockets set up by systemd), + as systemd will immediately proceed + starting follow-up units. Behaviour of finish is @@ -136,9 +136,9 @@ the daemon acquires a name on the D-Bus bus, as configured by - BusName=. Follow-up - units will be started after - the name has been + BusName=. Systemd will + proceed starting follow-up + units after the D-Bus bus name has been acquired. @@ -170,8 +170,8 @@ BusName= - Takes a D-Bus bus name - that this service is reachable + Takes a D-Bus bus name, + where this service is reachable as. This option is mandatory for services where Type= is diff --git a/man/systemd.special.xml.in b/man/systemd.special.xml.in index 09707aa0..0c86902a 100644 --- a/man/systemd.special.xml.in +++ b/man/systemd.special.xml.in @@ -109,12 +109,12 @@ target unit to all SysV service units configured for runlevel 1 to 5. - Usually this should pull - in all sockets, mount points, + Usually this should pull-in + all sockets, mount points, swap devices and other basic initialization necessary for the general purpose - daemons. Most normal daemon + daemons. Most normal daemons should have dependencies of type After and Requires on this unit. @@ -166,14 +166,14 @@ The display manager service. Usually this should be aliased (symlinked) to - gdm.service + xdm.service or a similar display manager service. systemd automatically adds dependencies of type After for this target unit to all SysV init script service - units with an LSB header + units with a LSB header referring to the $x-display-manager facility, for compatibility @@ -265,7 +265,7 @@ The mail transfer agent (MTA) service. Usually this - should pull in all units + should pull-in all units necessary for sending/receiving mails on the local host. diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 99bd8b39..8a402d05 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -413,14 +413,14 @@ Alias= - Additional names this + Additional names, this unit shall be installed under. The names listed here must have the same suffix (i.e. type) as the unit file name. This option may be specified more than once, in which case all listed names are used. At installation - time + time, systemd-install will create symlinks from these names to the unit file name. Note that this diff --git a/man/systemd.xml b/man/systemd.xml index 8f58b665..27756723 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -62,12 +62,12 @@ systemd is a system and session manager for Linux operating systems. When run as first process on - boot (as PID 1) it may act as init system that brings - up and maintains userspace. + boot (as PID 1), it acts as init system that brings + up and maintains userspace services. - For compatibility with SysV if systemd is called + For compatibility with SysV, if systemd is called as init and a PID that is not - 1 it will execute telinit and pass + 1, it will execute telinit and pass all command line arguments unmodified. That means init and telinit are mostly equivalent when invoked from normal login sessions. See @@ -142,7 +142,7 @@ D-Bus interfaces repository. Optionally the interface name for the introspection data may be - specified. If omitted the + specified. If omitted, the introspection data for all interfaces is dumped. @@ -220,8 +220,8 @@ --variable=systemdsystemconfdir returns the path of the system configuration directory. Packages - should alter this directory only with - the + should alter the content of these directories + only with the systemd-install1 tool. @@ -261,7 +261,7 @@ SysV init script directory varies between distributions. If systemd cannot find a native unit file for a - requested service it will look for a + requested service, it will look for a SysV init script of the same name (with the .service suffix -- 2.39.5