best done by iterating through the
available signals up to the limit of
_NSIG and resetting them to
- SIG_DFL.</para></listitem>
+ <constant>SIG_DFL</constant>.</para></listitem>
<listitem><para>Reset the signal mask
using
to implement the following:</para>
<orderedlist>
- <listitem><para>If SIGTERM is
+ <listitem><para>If <constant>SIGTERM</constant> is
received, shut down the daemon and
exit cleanly.</para></listitem>
- <listitem><para>If SIGHUP is received,
+ <listitem><para>If <constant>SIGHUP</constant> is received,
reload the configuration files, if
this applies.</para></listitem>
<listitem><para>Execute the operation
remotely. Specify a hostname, or
- username and hostname separated by @,
+ username and hostname separated by <literal>@</literal>,
to connect to. This will use SSH to
talk to a remote
system.</para></listitem>
hostname will be simplified in regards
to the character set used before the
latter are updated. This is done by
- replacing spaces with "-" and removing
+ replacing spaces with
+ <literal>-</literal> and removing
special characters. This ensures that
the pretty and the static hostname are
always closely related while still
following the validity rules of the
specific name. This simplification of
the hostname string is not done if
- only the transient and/or static
- hostnames are set, and the pretty
- hostname is left untouched. Pass the
- empty string "" as the hostname to
- reset the selected hostnames to their
- default (usually "localhost").
- </para></listitem>
+ only the transient and/or static host
+ names are set, and the pretty host
+ name is left untouched. Pass the empty
+ string <literal></literal> as the
+ hostname to reset the selected
+ hostnames to their default (usually
+ <literal>localhost</literal>).</para></listitem>
</varlistentry>
<varlistentry>
<listitem><para>Execute the operation
remotely. Specify a hostname, or
- username and hostname separated by @,
+ username and hostname separated by <literal>@</literal>,
to connect to. This will use SSH to
talk to a remote
system.</para></listitem>
which signal to send to selected
processes. Must be one of the well
known signal specifiers, such as
- SIGTERM, SIGINT or SIGSTOP. If omitted,
- defaults to
- <option>SIGTERM</option>.</para></listitem>
+ <constant>SIGTERM</constant>,
+ <constant>SIGINT</constant> or
+ <constant>SIGSTOP</constant>. If
+ omitted defaults to
+ <constant>SIGTERM</constant>.</para></listitem>
</varlistentry>
<varlistentry>
<listitem><para>Execute operation
remotely. Specify a hostname, or
- username and hostname separated by @,
+ username and hostname separated by <literal>@</literal>,
to connect to. This will use SSH to
talk to the remote login manager
instance.</para></listitem>
attach at least one graphics card to a
previously unused seat name. Seat
names may consist only of a-z, A-Z,
- 0-9, "-" and "_" and must be prefixed
- with "seat". To drop assignment of a
- device to a specific seat, just
- reassign it to a different seat, or
- use
- <command>flush-devices</command>.</para></listitem>
+ 0-9, <literal>-</literal> and
+ <literal>_</literal> and must be
+ prefixed with <literal>seat</literal>.
+ To drop assignment of a device to a
+ specific seat, just reassign it to a
+ different seat, or use
+ <command>flush-devices</command>.
+ </para></listitem>
</varlistentry>
<varlistentry>
formats a 128-bit ID as a character string. It expects
the ID and a string array capable of storing 33
characters. The ID will be formatted as 32 lowercase
- hexadecimal digits and be terminated by a NUL
- byte.</para>
+ hexadecimal digits and be terminated by a
+ <constant>NUL</constant> byte.</para>
<para><function>sd_id128_from_string()</function>
implements the reverse operation: it takes a 33
- character string with 32 hexadecimal digits
- (either lowercase or uppercase, terminated by NUL) and
- parses them back into a 128-bit ID returned in
+ character string with 32 hexadecimal digits (either
+ lowercase or uppercase, terminated by
+ <constant>NUL</constant>) and parses them back into a
+ 128-bit ID returned in
<parameter>ret</parameter>. Alternatively, this call
can also parse a 37-character string with a 128-bit ID
formatted as RFC UUID.</para>
<para><function>sd_is_fifo()</function> may be called
to check whether the specified file descriptor refers
to a FIFO or pipe. If the <parameter>path</parameter>
- parameter is not NULL, it is checked whether the FIFO
- is bound to the specified file system path.</para>
+ parameter is not <constant>NULL</constant>, it is
+ checked whether the FIFO is bound to the specified
+ file system path.</para>
<para><function>sd_is_socket()</function> may be
called to check whether the specified file descriptor
<para><function>sd_is_mq()</function> may be called to
check whether the specified file descriptor refers to
a POSIX message queue. If the
- <parameter>path</parameter> parameter is not NULL, it
- is checked whether the message queue is bound to the
- specified name.</para>
+ <parameter>path</parameter> parameter is not
+ <constant>NULL</constant>, it is checked whether the
+ message queue is bound to the specified name.</para>
</refsect1>
<refsect1>
<constant>AF_UNIX</constant> socket referenced in the
<varname>$NOTIFY_SOCKET</varname> environment
variable. If the first character of
- <varname>$NOTIFY_SOCKET</varname> is @ the string is
+ <varname>$NOTIFY_SOCKET</varname> is <literal>@</literal> the string is
understood as Linux abstract namespace socket. The
datagram is accompanied by the process credentials of
the sending daemon, using SCM_CREDENTIALS.</para>
a seat, if there is any. Returns the session
identifier and the user identifier of the Unix user
the session is belonging to. Either the session or the
- user identifier parameter can be passed NULL, in
- case only one of the parameters shall be queried. The
- returned string needs to be freed with the libc
+ user identifier parameter can be passed
+ <constant>NULL</constant>, in case only one of the
+ parameters shall be queried. The returned string needs
+ to be freed with the libc
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use.</para>
<listitem>
<para>When used with <command>kill</command>, choose which
signal to send to selected processes. Must be one of the
- well known signal specifiers such as SIGTERM, SIGINT or
- SIGSTOP. If omitted defaults to
+ well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
+ <constant>SIGSTOP</constant>. If omitted defaults to
<option>SIGTERM</option>.</para>
</listitem>
</varlistentry>
<listitem>
<para>Execute operation remotely. Specify a hostname, or
- username and hostname separated by @, to connect to. This
+ username and hostname separated by <literal>@</literal>, to connect to. This
will use SSH to talk to the remote systemd
instance.</para>
</listitem>
<para>The argument passed should be an
absolute filename or wildcard
expression, optionally prefixed with
- "-", which indicates that if the file
- does not exist it won't be read and no
- error or warning message is logged.
- This option may be specified more than
- once in which case all specified files
- are read. If the empty string is
- assigned to this option the list of
- file to read is reset, all prior
- assignments have no effect.</para>
+ <literal>-</literal>, which indicates
+ that if the file does not exist it
+ won't be read and no error or warning
+ message is logged. This option may be
+ specified more than once in which case
+ all specified files are read. If the
+ empty string is assigned to this
+ option the list of file to read is
+ reset, all prior assignments have no
+ effect.</para>
<para>The files listed with this
directive will be read shortly before
<term><varname>IgnoreSIGPIPE=</varname></term>
<listitem><para>Takes a boolean
- argument. If true, causes SIGPIPE to be
+ argument. If true, causes <constant>SIGPIPE</constant> to be
ignored in the executed
process. Defaults to true because
- SIGPIPE generally is useful only in
+ <constant>SIGPIPE</constant> generally is useful only in
shell pipelines.</para></listitem>
</varlistentry>
<option>control-group</option>.</para>
<para>Processes will first be
- terminated via SIGTERM (unless the
+ terminated via <constant>SIGTERM</constant> (unless the
signal to send is changed via
<varname>KillSignal=</varname>). If
then after a delay (configured via the
<varname>TimeoutSec=</varname> option)
processes still remain, the
termination request is repeated with
- the SIGKILL signal (unless this is
+ the <constant>SIGKILL</constant> signal (unless this is
disabled via the
<varname>SendSIGKILL=</varname>
option). See
<term><varname>KillSignal=</varname></term>
<listitem><para>Specifies which signal
to use when killing a
- service. Defaults to SIGTERM.
+ service. Defaults to <constant>SIGTERM</constant>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SendSIGKILL=</varname></term>
<listitem><para>Specifies whether to
- send SIGKILL to remaining processes
+ send <constant>SIGKILL</constant> to remaining processes
after a timeout, if the normal
shutdown procedure left processes of
the service around. Takes a boolean
will be considered failed and be shut
down again. All commands still running
will be terminated forcibly via
- SIGTERM, and after another delay of
- this time with SIGKILL. (See
+ <constant>SIGTERM</constant>, and after another delay of
+ this time with <constant>SIGKILL</constant>. (See
<option>KillMode=</option> in
<citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.)
Takes a unit-less value in seconds, or
wait for stop. If a service is asked
to stop but does not terminate in the
specified time, it will be terminated
- forcibly via SIGTERM, and after
+ forcibly via <constant>SIGTERM</constant>, and after
another delay of this time with
- SIGKILL (See
+ <constant>SIGKILL</constant> (See
<varname>KillMode=</varname>
in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
Takes a unit-less value in seconds, or a
exits cleanly.
In this context, a clean exit means
an exit code of 0, or one of the signals
- SIGHUP, SIGINT, SIGTERM, or SIGPIPE, and
+ <constant>SIGHUP</constant>, <constant>SIGINT</constant>, <constant>SIGTERM</constant>, or <constant>SIGPIPE</constant>, and
additionally, exit statuses and signals
specified in <varname>SuccessExitStatus=</varname>.
If set to <option>on-failure</option>
by the main service process will be
considered successful termination, in
addition to the normal successful exit
- code 0 and the signals SIGHUP, SIGINT,
- SIGTERM and SIGPIPE. Exit status
+ code 0 and the signals <constant>SIGHUP</constant>, <constant>SIGINT</constant>,
+ <constant>SIGTERM</constant> and <constant>SIGPIPE</constant>. Exit status
definitions can either be numeric exit
codes or termination signal names,
separated by spaces. Example:
<literal>SuccessExitStatus=1 2 8
- SIGKILL</literal>, ensures that exit
+ <constant>SIGKILL</constant></literal>, ensures that exit
codes 1, 2, 8 and the termination
- signal SIGKILL are considered clean
+ signal <constant>SIGKILL</constant> are considered clean
service terminations. This option may
appear more than once in which case
the list of successful exit statuses
can be written in various formats:</para>
<para>If the address starts with a
- slash (/), it is read as file system
+ slash (<literal>/</literal>), it is read as file system
socket in the <constant>AF_UNIX</constant> socket
family.</para>
- <para>If the address starts with an
- at symbol (@) it is read as abstract
- namespace socket in the <constant>AF_UNIX</constant>
- family. The @ is replaced with a NUL
- character before binding. For details
- see
+ <para>If the address starts with an at
+ symbol (<literal>@</literal>) it is read as abstract
+ namespace socket in the
+ <constant>AF_UNIX</constant>
+ family. The <literal>@</literal> is
+ replaced with a
+ <constant>NUL</constant> character
+ before binding. For details see
<citerefentry><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
<para>If the address string is a
will be considered failed and be shut
down again. All commands still running,
will be terminated forcibly via
- SIGTERM, and after another delay of
- this time with SIGKILL. (See
+ <constant>SIGTERM</constant>, and after another delay of
+ this time with <constant>SIGKILL</constant>. (See
<option>KillMode=</option> in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.)
Takes a unit-less value in seconds, or
a time span value such as "5min
terminate the user service
manager should start this
unit. If systemd receives
- SIGTERM or SIGINT when running
+ <constant>SIGTERM</constant> or <constant>SIGINT</constant> when running
as user service daemon it will
start this unit.</para>
will be considered failed and be shut
down again. All commands still running
will be terminated forcibly via
- SIGTERM, and after another delay of
- this time with SIGKILL. (See
+ <constant>SIGTERM</constant>, and after another delay of
+ this time with <constant>SIGKILL</constant>. (See
<option>KillMode=</option> in
<citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.)
Takes a unit-less value in seconds, or
specified, it should consist of one or more English
language weekday names, either in the abbreviated
(Wed) or non-abbreviated (Wednesday) form (case does
- not matter), separated by commas. Specifying two weekdays
- separated by "-" refers to a range of continuous
- weekdays. "," and "-" may be combined freely.</para>
+ not matter), separated by commas. Specifying two
+ weekdays separated by <literal>-</literal> refers to a
+ range of continuous weekdays. <literal>,</literal> and
+ <literal>-</literal> may be combined freely.</para>
<para>In the date and time specifications, any
- component may be specified as "*" in which case any
- value will match. Alternatively, each component can be
- specified as list of values separated by
- commas. Values may also be suffixed with "/" and a
- repetition value, which indicates that the value and
- all values plus multiples of the repetition value are
- matched.</para>
+ component may be specified as <literal>*</literal> in
+ which case any value will match. Alternatively, each
+ component can be specified as list of values separated
+ by commas. Values may also be suffixed with
+ <literal>/</literal> and a repetition value, which
+ indicates that the value and all values plus multiples
+ of the repetition value are matched.</para>
<para>Either time or date specification may be
omitted, in which case the current day and 00:00:00 is
implied, respectively. If the second component is not
- specified ":00" is assumed.</para>
+ specified <literal>:00</literal> is assumed.</para>
<para>Timezone names may not be specified.</para>
systemd looks for a unit configuration file it will
first search for the literal unit name in the
filesystem. If that yields no success and the unit
- name contains an @ character, systemd will look for a
+ name contains an <literal>@</literal> character, systemd will look for a
unit template that shares the same name but with the
- instance string (i.e. the part between the @ character
+ instance string (i.e. the part between the <literal>@</literal> character
and the suffix) removed. Example: if a service
<filename>getty@tty3.service</filename> is requested
and no file by that name is found, systemd will look
<row>
<entry><literal>%i</literal></entry>
<entry>Instance name</entry>
- <entry>For instantiated units: this is the string between the @ character and the suffix.</entry>
+ <entry>For instantiated units: this is the string between the <literal>@</literal> character and the suffix.</entry>
</row>
<row>
<entry><literal>%I</literal></entry>
<para>systemd user managers
treat this signal the same way as
- SIGTERM.</para></listitem>
+ <constant>SIGTERM</constant>.</para></listitem>
</varlistentry>
<varlistentry>
<listitem><para>Execute the operation
remotely. Specify a hostname, or
- username and hostname separated by @,
+ username and hostname separated by <literal>@</literal>,
to connect to. This will use SSH to
talk to a remote
system.</para></listitem>
~ianmdlvl / elogind.git / commitdiff