picnoir/Systemd
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

man: various fixes

Browse source
This commit is contained in:
Kay Sievers 2010-06-25 00:04:29 +02:00 committed by Lennart Poettering
parent 11e299550e
commit af62c70405
12 changed files with 64 additions and 65 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
man/pam_systemd.xml
View file

@ -63,19 +63,19 @@
<para>On login, this module ensures the following:</para> <para>On login, this module ensures the following:</para>
<orderedlist> <orderedlist>
<listitem><para>If it does not exist yet the <listitem><para>If it does not exist yet, the
user runtime directory user runtime directory
<filename>/var/run/user/$USER</filename> is <filename>/var/run/user/$USER</filename> is
created and its ownership changed to the user created and its ownership changed to the user
that is logging in.</para></listitem> that is logging in.</para></listitem>
<listitem><para>If <listitem><para>If
<option>create-session=1</option> is set the <option>create-session=1</option> is set, the
<varname>$XDG_SESSION_ID</varname> environment <varname>$XDG_SESSION_ID</varname> environment
variable is initialized. If auditing is variable is initialized. If auditing is
available and available and
<command>pam_loginuid.so</command> run before <command>pam_loginuid.so</command> run before
this module (which es recommended), the this module (which is highly recommended), the
variable is initialized from the auditing variable is initialized from the auditing
session id session id
(<filename>/proc/self/sessionid</filename>). Otherwise (<filename>/proc/self/sessionid</filename>). Otherwise
@ -83,14 +83,14 @@
used.</para></listitem> used.</para></listitem>
<listitem><para>If <listitem><para>If
<option>create-session=1</option> is set a new <option>create-session=1</option> is set, a new
control group control group
<filename>/user/$USER/$XDG_SESSION_ID</filename> <filename>/user/$USER/$XDG_SESSION_ID</filename>
is created and the login process moved into is created and the login process moved into
it.</para></listitem> it.</para></listitem>
<listitem><para>If <listitem><para>If
<option>create-session=0</option> is set a new <option>create-session=0</option> is set, a new
control group control group
<filename>/user/$USER/no-session</filename> <filename>/user/$USER/no-session</filename>
is created and the login process moved into is created and the login process moved into
@ -107,7 +107,7 @@
remaining processes in the remaining processes in the
<filename>/user/$USER/$XDG_SESSION_ID</filename> <filename>/user/$USER/$XDG_SESSION_ID</filename>
control group are killed and the control group control group are killed and the control group
removed.</para></listitem> is removed.</para></listitem>
<listitem><para>If <listitem><para>If
<varname>$XDG_SESSION_ID</varname> is set and <varname>$XDG_SESSION_ID</varname> is set and
@ -116,17 +116,17 @@
<filename>/user/$USER/$XDG_SESSION_ID</filename> <filename>/user/$USER/$XDG_SESSION_ID</filename>
control group are migrated to control group are migrated to
<filename>/user/$USER/no-session</filename> and <filename>/user/$USER/no-session</filename> and
the original control group the original control group is
removed.</para></listitem> removed.</para></listitem>
<listitem><para>If <listitem><para>If
<option>kill-user=1</option> is specified, and <option>kill-user=1</option> is specified, and
no other user session control group remains no other user session control group remains,
except except
<filename>/user/$USER/no-session</filename> <filename>/user/$USER/no-session</filename>,
all remaining processes in the all remaining processes in the
<filename>/user/$USER</filename> hierarchy <filename>/user/$USER</filename> hierarchy
are killed and the control group removed.</para></listitem> are killed and the control group is removed.</para></listitem>
<listitem><para>If <listitem><para>If
<option>kill-user=0</option> is specified, and <option>kill-user=0</option> is specified, and
@ -143,7 +143,7 @@
</orderedlist> </orderedlist>
<para>If the system was not booted up with systemd as <para>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.</para> returns PAM_SUCCESS.</para>
</refsect1> </refsect1>
@ -165,11 +165,11 @@
login process moved to the login process moved to the
<filename>/user/$USER/$XDG_SESSION_ID</filename> <filename>/user/$USER/$XDG_SESSION_ID</filename>
control group. It is recommended that 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 on the user's behalf set this
option. Only for services that shall option. Only for services that shall
automatically be terminated when the automatically be terminated when the
user logs out completely otherwise, user logs out completely, otherwise
<varname>create-session=0</varname> <varname>create-session=0</varname>
should be set.</para></listitem> should be set.</para></listitem>
</varlistentry> </varlistentry>
@ -196,7 +196,7 @@
completely. This is a weaker version completely. This is a weaker version
of <option>kill-session=1</option> and is of <option>kill-session=1</option> and is
more friendly for users logged in more more friendly for users logged in more
than once as their processes are than once, as their processes are
terminated only on their complete terminated only on their complete
logout.</para></listitem> logout.</para></listitem>
</varlistentry> </varlistentry>

6
man/runlevel.xml
View file

@ -61,10 +61,10 @@
<para>The two runlevel characters are seperated by a <para>The two runlevel characters are seperated by a
single space character. If a runlevel cannot be single space character. If a runlevel cannot be
determined N is printed instead. If neither can be determined, N is printed instead. If neither can be
determined the word "unknown" is printed.</para> determined, the word "unknown" is printed.</para>
<para>Unless overridden in the environment this will <para>Unless overridden in the environment, this will
check the utmp database for recent runlevel check the utmp database for recent runlevel
changes.</para> changes.</para>
</refsect1> </refsect1>

2
man/sd-daemon.xml
View file

@ -141,7 +141,7 @@
daemons become NOPs when -DDISABLE_SYSTEMD is set daemons become NOPs when -DDISABLE_SYSTEMD is set
during compilation. In addition, if during compilation. In addition, if
<filename>sd-daemon.c</filename> is compiled on <filename>sd-daemon.c</filename> is compiled on
non-Linux systems they become NOPs, too.</para> non-Linux systems they become NOPs.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>

2
man/sd_booted.xml
View file

@ -69,7 +69,7 @@
<para>On failure, this call returns a negative <para>On failure, this call returns a negative
errno-style error code. If the system was booted up 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.</para> positive return value, zero otherwise.</para>
</refsect1> </refsect1>

4
man/sd_is_fifo.xml
View file

@ -94,8 +94,8 @@
<para><function>sd_is_fifo()</function> may be called <para><function>sd_is_fifo()</function> may be called
to check whether the specified file descriptor refers to check whether the specified file descriptor refers
to a FIFO or pipe. It the <parameter>path</parameter> to a FIFO or pipe. If the <parameter>path</parameter>
parameter is not NULL it is checked whether the FIFO parameter is not NULL, it is checked whether the FIFO
is bound to the specified file system path.</para> is bound to the specified file system path.</para>
<para><function>sd_is_socket()</function> may be <para><function>sd_is_socket()</function> may be

7
man/sd_listen_fds.xml
View file

@ -96,8 +96,7 @@
for the service to work, hence it should not be for the service to work, hence it should not be
verified. On the other hand, whether a socket is a verified. On the other hand, whether a socket is a
datagram or stream socket matters a lot for the most datagram or stream socket matters a lot for the most
common program logics and should hence be common program logics and should be checked.</para>
checked.</para>
<para>This function call will set the FD_CLOEXEC flag <para>This function call will set the FD_CLOEXEC flag
for all passed file descriptors to avoid further for all passed file descriptors to avoid further
@ -111,9 +110,9 @@
errno-style error code. If errno-style error code. If
<varname>$LISTEN_FDS</varname>/<varname>$LISTEN_PID</varname> <varname>$LISTEN_FDS</varname>/<varname>$LISTEN_PID</varname>
was not set or not correctly set for this daemon and 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 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, starting with file descriptor SD_LISTEN_FDS_START,
i.e. file descriptor 3.</para> i.e. file descriptor 3.</para>
</refsect1> </refsect1>

10
man/sd_notify.xml
View file

@ -104,7 +104,7 @@
definition file has Type=notify definition file has Type=notify
set. The passed argument is a boolean set. The passed argument is a boolean
"1" or "0". Since there is little "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 only value daemons should send is
"READY=1".</para></listitem> "READY=1".</para></listitem>
</varlistentry> </varlistentry>
@ -115,7 +115,7 @@
<listitem><para>Passes a single-line <listitem><para>Passes a single-line
status string back to the init system status string back to the init system
that describes the daemon state. This 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 various purposes: general state
feedback, fsck-like programs could feedback, fsck-like programs could
pass completion percentages and pass completion percentages and
@ -177,11 +177,11 @@
<para>On failure, these calls return a negative <para>On failure, these calls return a negative
errno-style error code. If errno-style error code. If
<varname>$NOTIFY_SOCKET</varname> was not set and <varname>$NOTIFY_SOCKET</varname> 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 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 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.</para> value of this call.</para>
</refsect1> </refsect1>

10
man/systemctl.xml
View file

@ -178,7 +178,7 @@
cannot be used to reload unit cannot be used to reload unit
configuration. Use the configuration. Use the
<command>daemon-reload</command> <command>daemon-reload</command>
command for that. All in all this command for that. All in all, this
command is of little use except for command is of little use except for
debugging.</para> debugging.</para>
<para>This command should not be <para>This command should not be
@ -276,11 +276,11 @@
<term><command>snapshot [NAME]</command></term> <term><command>snapshot [NAME]</command></term>
<listitem><para>Create a snapshot. If <listitem><para>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 snapshot will be named after it. If
none is specified an automatic none is specified an automatic
snapshot name is generated. In either snapshot name is generated. In either
case the snapshot name used is printed case, the snapshot name used is printed
to STDOUT.</para> to STDOUT.</para>
<para>A snapshot refers to a saved <para>A snapshot refers to a saved
@ -308,8 +308,8 @@
configuration. This will reload all configuration. This will reload all
unit files and recreate the entire unit files and recreate the entire
dependency tree. While the daemon is dependency tree. While the daemon is
reloaded all sockets systemd listens reloaded, all sockets systemd listens
on on behalf of user configuration will on on behalf of user configuration, will
stay accessible.</para> <para>This stay accessible.</para> <para>This
command should not be confused with command should not be confused with
the <command>load</command> or the <command>load</command> or

26
man/systemd.service.xml
View file

@ -94,14 +94,14 @@
daemon process. This is the daemon process. This is the
behaviour of traditional UNIX behaviour of traditional UNIX
daemons. If this setting is daemons. If this setting is
used it is recommended to also used, it is recommended to also
use the use the
<varname>PIDFile=</varname> <varname>PIDFile=</varname>
option, so that systemd can option, so that systemd can
identify the main process of identify the main process of
the daemon. systemd will start the daemon. systemd will proceed
follow-up units as soon as the starting follow-up units as soon
parent process exited.</para> as the parent process exits.</para>
<para>If set to <para>If set to
<literal>simple</literal> (the <literal>simple</literal> (the
@ -110,12 +110,12 @@
configured with configured with
<varname>ExecStart=</varname> <varname>ExecStart=</varname>
is the main process of the is the main process of the
daemon. In this mode daemon. In this mode,
communication channels must be communication channels must be
available before the daemon is available before the daemon is
started up, as systemd will started up (sockets set up by systemd),
immediately start follow-up as systemd will immediately proceed
units.</para> starting follow-up units.</para>
<para>Behaviour of <para>Behaviour of
<literal>finish</literal> is <literal>finish</literal> is
@ -136,9 +136,9 @@
the daemon acquires a name on the daemon acquires a name on
the D-Bus bus, as configured the D-Bus bus, as configured
by by
<varname>BusName=</varname>. Follow-up <varname>BusName=</varname>. Systemd will
units will be started after proceed starting follow-up
the name has been units after the D-Bus bus name has been
acquired.</para> acquired.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -170,8 +170,8 @@
<varlistentry> <varlistentry>
<term><varname>BusName=</varname></term> <term><varname>BusName=</varname></term>
<listitem> <listitem>
<para>Takes a D-Bus bus name <para>Takes a D-Bus bus name,
that this service is reachable where this service is reachable
as. This option is mandatory as. This option is mandatory
for services where for services where
<varname>Type=</varname> is <varname>Type=</varname> is

12
man/systemd.special.xml.in
View file

@ -109,12 +109,12 @@
target unit to all SysV target unit to all SysV
service units configured for service units configured for
runlevel 1 to 5.</para> runlevel 1 to 5.</para>
<para>Usually this should pull <para>Usually this should pull-in
in all sockets, mount points, all sockets, mount points,
swap devices and other basic swap devices and other basic
initialization necessary for initialization necessary for
the general purpose the general purpose
daemons. Most normal daemon daemons. Most normal daemons
should have dependencies of should have dependencies of
type After and Requires on type After and Requires on
this unit.</para> this unit.</para>
@ -166,14 +166,14 @@
<para>The display manager <para>The display manager
service. Usually this should service. Usually this should
be aliased (symlinked) to be aliased (symlinked) to
<filename>gdm.service</filename> <filename>xdm.service</filename>
or a similar display manager or a similar display manager
service.</para> service.</para>
<para>systemd automatically <para>systemd automatically
adds dependencies of type adds dependencies of type
After for this target unit to After for this target unit to
all SysV init script service all SysV init script service
units with an LSB header units with a LSB header
referring to the referring to the
<literal>$x-display-manager</literal> <literal>$x-display-manager</literal>
facility, for compatibility facility, for compatibility
@ -265,7 +265,7 @@
<listitem> <listitem>
<para>The mail transfer agent <para>The mail transfer agent
(MTA) service. Usually this (MTA) service. Usually this
should pull in all units should pull-in all units
necessary for necessary for
sending/receiving mails on the sending/receiving mails on the
local host.</para> local host.</para>

4
man/systemd.unit.xml
View file

@ -413,14 +413,14 @@
<varlistentry> <varlistentry>
<term><varname>Alias=</varname></term> <term><varname>Alias=</varname></term>
<listitem><para>Additional names this <listitem><para>Additional names, this
unit shall be installed under. The unit shall be installed under. The
names listed here must have the same names listed here must have the same
suffix (i.e. type) as the unit file suffix (i.e. type) as the unit file
name. This option may be specified name. This option may be specified
more than once, in which case all more than once, in which case all
listed names are used. At installation listed names are used. At installation
time time,
<command>systemd-install</command> <command>systemd-install</command>
will create symlinks from these names will create symlinks from these names
to the unit file name. Note that this to the unit file name. Note that this

16
man/systemd.xml
View file

@ -62,12 +62,12 @@
<para>systemd is a system and session manager for <para>systemd is a system and session manager for
Linux operating systems. When run as first process on Linux operating systems. When run as first process on
boot (as PID 1) it may act as init system that brings boot (as PID 1), it acts as init system that brings
up and maintains userspace.</para> up and maintains userspace services.</para>
<para>For compatibility with SysV if systemd is called <para>For compatibility with SysV, if systemd is called
as <command>init</command> and a PID that is not as <command>init</command> and a PID that is not
1 it will execute <command>telinit</command> and pass 1, it will execute <command>telinit</command> and pass
all command line arguments unmodified. That means all command line arguments unmodified. That means
<command>init</command> and <command>telinit</command> <command>init</command> and <command>telinit</command>
are mostly equivalent when invoked from normal login sessions. See are mostly equivalent when invoked from normal login sessions. See
@ -142,7 +142,7 @@
D-Bus interfaces D-Bus interfaces
repository. Optionally the interface repository. Optionally the interface
name for the introspection data may be name for the introspection data may be
specified. If omitted the specified. If omitted, the
introspection data for all interfaces introspection data for all interfaces
is dumped.</para></listitem> is dumped.</para></listitem>
</varlistentry> </varlistentry>
@ -220,8 +220,8 @@
--variable=systemdsystemconfdir</command> --variable=systemdsystemconfdir</command>
returns the path of the system returns the path of the system
configuration directory. Packages configuration directory. Packages
should alter this directory only with should alter the content of these directories
the only with the
<citerefentry><refentrytitle>systemd-install</refentrytitle><manvolnum>1</manvolnum></citerefentry> <citerefentry><refentrytitle>systemd-install</refentrytitle><manvolnum>1</manvolnum></citerefentry>
tool.</para></listitem> tool.</para></listitem>
</varlistentry> </varlistentry>
@ -261,7 +261,7 @@
SysV init script directory varies SysV init script directory varies
between distributions. If systemd between distributions. If systemd
cannot find a native unit file for a 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 SysV init script of the same name
(with the (with the
<filename>.service</filename> suffix <filename>.service</filename> suffix