<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
matching <replaceable>GLOB</replaceable>
instead of the default runtime and
system journal paths. May be specified
- multiple times, in which case, files will
+ multiple times, in which case files will
be suitably interleaved.</para></listitem>
</varlistentry>
<citerefentry><refentrytitle>sd_booted</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_is_fifo</refentrytitle><manvolnum>3</manvolnum></citerefentry>
for more information about the functions
- implemented. In addition to these functions a couple
+ implemented. In addition to these functions, a couple
of logging prefixes are defined as macros:</para>
<programlisting>#define SD_EMERG "<0>" /* system is unusable */
implementation. See the respective function man pages
for details.</para>
- <para>In addition, for details about the algorithms
+ <para>In addition, for details about the algorithms,
check the liberally licensed reference implementation
sources:
<ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/libsystemd-daemon/sd-daemon.c"/>
reference implementation. See the respective function
man pages for details.</para>
- <para>In addition, for details about the algorithms
+ <para>In addition, for details about the algorithms,
check the liberally licensed reference implementation
sources:
<ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/readahead/sd-readahead.c"/>
file. Alternatively, applications consuming these APIs
may copy the implementation into their source
tree. For more details about the reference
- implementation see
+ implementation, see
<citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
<para>If the reference implementation is used as
<para><function>sd_bus_message_get_reply_cookie()</function>
returns the transaction cookie of the message the
specified message is a response to. When a reply
- message is generated for a method call message its
+ message is generated for a method call message, its
cookie is copied over into this field. Note that while
every message that is transferred is identified by a
cookie, only response messages carry a reply cookie
integer. On failure, these calls return a negative
errno-style error code.</para>
- <para>On success the cookie/reply cookie is returned
+ <para>On success, the cookie/reply cookie is returned
in the specified 64bit unsigned integer variable.</para>
</refsect1>
<varname>SD_BUS_NAME_REPLACE_EXISTING</varname>
flag set. If
<varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname>
- is not set on the original request
+ is not set on the original request,
such a request by other peers will be
denied.</para></listitem>
</varlistentry>
errno-style error code.</para>
<para>If <varname>SD_BUS_NAME_QUEUE</varname> is
- specified <function>sd_bus_request_name()</function>
+ specified, <function>sd_bus_request_name()</function>
will return 0 when the name is already taken by
another peer and the client has been added to the
- queue for the name. In that case the caller can
+ queue for the name. In that case, the caller can
subscribe to <literal>NameOwnerChanged</literal>
signals to be notified when the name is successfully
acquired. <function>sd_bus_request_name()</function>
<refsect1>
<title>Return Value</title>
- <para>On success <function>sd_get_seats()</function>,
+ <para>On success, <function>sd_get_seats()</function>,
<function>sd_get_sessions()</function>,
<function>sd_get_uids()</function> and
<function>sd_get_machine_names()</function> return the
file. Alternatively, applications consuming these APIs
may copy the implementation into their source
tree. For more details about the reference
- implementation see
+ implementation, see
<citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
<para>These functions continue to work as described,
file. Alternatively, applications consuming these APIs
may copy the implementation into their source
tree. For more details about the reference
- implementation see
+ implementation, see
<citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
<para>If the reference implementation is used as
<refsect1>
<title>Return Value</title>
- <para>On success
+ <para>On success,
<function>sd_login_monitor_new()</function>,
<function>sd_login_monitor_flush()</function> and
<function>sd_login_monitor_get_timeout()</function>
- return 0 or a positive integer. On success
+ return 0 or a positive integer. On success,
<function>sd_login_monitor_get_fd()</function> returns
- a Unix file descriptor. On success
+ a Unix file descriptor. On success,
<function>sd_login_monitor_get_events()</function>
returns a combination of <constant>POLLIN</constant>,
<constant>POLLOUT</constant> and suchlike. On failure,
<constant>libsystemd-daemon</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
file. Alternatively, applications consuming these APIs
may copy the implementation into their source tree. For
- more details about the reference implementation see
+ more details about the reference implementation, see
<citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
<para>If the reference implementation is used as
<filename>sd-readahead.h</filename> files. It is
recommended that applications consuming this API copy
the implementation into their source tree. For more
- details about the reference implementation see
+ details about the reference implementation, see
<citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>3</manvolnum></citerefentry></para>
<para>If -DDISABLE_SYSTEMD is set during compilation,
<refsect1>
<title>Return Value</title>
- <para> On success
+ <para> On success,
<function>sd_seat_get_active()</function>
- returns 0 or a positive integer. On success
+ returns 0 or a positive integer. On success,
<function>sd_seat_get_sessions()</function> returns
the number of entries in the session identifier
array. If the test succeeds,
<para>If the test succeeds,
<function>sd_session_is_active()</function> and
<function>sd_session_is_remote()</function> return a
- positive integer, if it fails 0. On success
+ positive integer; if it fails, 0. On success,
<function>sd_session_get_state()</function>,
<function>sd_session_get_uid()</function>,
<function>sd_session_get_seat()</function>,
<refsect1>
<title>Return Value</title>
- <para>On success
+ <para>On success,
<function>sd_uid_get_state()</function> returns 0 or a
positive integer. If the test succeeds,
<function>sd_uid_is_on_seat()</function> returns a
- positive integer, if it fails
+ positive integer; if it fails,
0. <function>sd_uid_get_sessions()</function> and
<function>sd_uid_get_seats()</function> return the
number of entries in the returned arrays. On failure,
inherited by child processes.</para>
<para>If the <parameter>usec</parameter> parameter is
- non-NULL <function>sd_watchdog_enabled()</function>
+ non-NULL, <function>sd_watchdog_enabled()</function>
will return the timeout in µs for the watchdog
logic. The service manager will usually terminate a
service when it did not get a notification message
<literal>WATCHDOG=1</literal>.</para>
<para>To enable service supervision with the watchdog
- logic use <varname>WatchdogSec=</varname> in service
+ logic, use <varname>WatchdogSec=</varname> in service
files. See
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details.</para>
errno-style error code. If the service manager expects
watchdog keep-alive notification messages to be sent,
> 0 is returned, otherwise 0 is returned. Only if
- the return value is > 0 the
+ the return value is > 0, the
<parameter>usec</parameter> parameter is valid after
the call.</para>
</refsect1>
variable. The call will ignore these variables if
<varname>$WATCHDOG_PID</varname> does containe the PID
of the current process, under the assumption that in
- that case the variables were set for a different
+ that case, the variables were set for a different
process further up the process tree.</para>
- <para>For details about the algorithm check the
+ <para>For details about the algorithm, check the
liberally licensed reference implementation sources:
<ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/libsystemd-daemon/sd-daemon.c"/>
and <ulink
file. Alternatively, applications consuming these APIs
may copy the implementation into their source
tree. For more details about the reference
- implementation see
+ implementation, see
<citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
<para>If the reference implementation is used as
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
applications.</para>
<para><literal>ignore-requirements</literal> is similar to
- <literal>ignore-dependencies</literal> but only causes the
+ <literal>ignore-dependencies</literal>, but only causes the
requirement dependencies to be ignored, the ordering
dependencies will still be honoured.</para>
</listitem>
<refsect2>
<title>Parameter Syntax</title>
- <para>For unit commands the specified
+ <para>For unit commands, the specified
<replaceable>NAME</replaceable> should be the full name of the
unit, or an abbreviated name which is automatically extended with
the <literal>.service</literal> suffix.
<programlisting># systemctl status dev-sda.device
# systemctl status home.mount</programlisting></para>
- <para>For unit file commands the
+ <para>For unit file commands, the
specified <replaceable>NAME</replaceable> should be the full name
of the unit file, or the absolute path to the unit file.
<programlisting># systemctl link /path/to/foo.service</programlisting>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise. Not finding any matching coredumps is treated
as failure.
</para>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
udev tag (by default all block and network devices,
and a few others). This may be used to define
dependencies between devices and other units. To tag a
- udev device use <literal>TAG+="systemd"</literal> in
+ udev device, use <literal>TAG+="systemd"</literal> in
the udev rules file, see
<citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
for details.</para>
processes and mounts private
<filename>/tmp</filename> and
<filename>/var/tmp</filename>
- directories inside it, that are not
+ directories inside it that are not
shared by processes outside of the
namespace. This is useful to secure
access to temporary files of the
in a unit file
<filename>home-lennart.mount</filename>. For details
about the escaping logic used to convert a file system
- path to a unit name see
+ path to a unit name, see
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
<para>Optionally, a mount unit may be accompanied by
<literal>one</literal> and
<literal>two two</literal>,
respectively. Since two commands are
- specified
+ specified,
<varname>Type=oneshot</varname> must
be used.</para>
<filename>smartcard.target</filename>,
<filename>sound.target</filename>.</para>
- <para>In addition the following special unit is
+ <para>In addition, the following special unit is
understood only when systemd runs as service instance:</para>
<variablelist>
<filename noindex='true'>/dev/sda5</filename> must be configured in a
unit file <filename>dev-sda5.swap</filename>. For
details about the escaping logic used to convert a
- file system path to a unit name see
+ file system path to a unit name, see
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
<para>All swap units automatically get the appropriate
also include time units. Example:
"OnBootSec=5h 30min" means 5 hours and
30 minutes after boot-up. For details
- about the syntax of time spans see
+ about the syntax of time spans, see
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
<para>If a timer configured with
event expressions. See
<citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>
for more information on the syntax of
- calendar event expressions. Otherwise
+ calendar event expressions. Otherwise,
the semantics are similar to
<varname>OnActiveSec=</varname> and
related settings.</para>
<varname>OnUnitInactiveSec=</varname>
and ending the time configured with
<varname>AccuracySec=</varname>
- later. Within this time window the
+ later. Within this time window, the
expiry time will be placed at a
host-specific, randomized but stable
position, that is synchronized between
in networked installations, as well as
optimizing power consumption to
suppress unnecessary CPU wake-ups. To
- get best accuracy set this option to
+ get best accuracy, set this option to
1us. Note that the timer is still
subject to the timer slack configured
via
setting. See
<citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
for details. To optimize power
- consumption make sure to set this
+ consumption, make sure to set this
value as high as possible and as low
as necessary.</para></listitem>
</varlistentry>
what the unit's purpose is, followed
by how it is configured, followed by
any other related documentation. This
- option may be specified more than once
+ option may be specified more than once,
in which case the specified list of
URIs is merged. If the empty string is
assigned to this option, the list is
<varname>Requires=</varname> and
<varname>RequiresOverridable=</varname>,
respectively. However, if the units
- listed here are not started already
+ listed here are not started already,
they will not be started and the
transaction will fail immediately.
</para></listitem>
listed in this option will be started
if the configuring unit is. However,
if the listed units fail to start
- or cannot be added to the transaction
+ or cannot be added to the transaction,
this has no impact on the validity of
the transaction as a whole. This is
the recommended way to hook start-up
symlinks to a
<filename>.wants/</filename> directory
accompanying the unit file. For
- details see above.</para></listitem>
+ details, see above.</para></listitem>
</varlistentry>
<varlistentry>
<listitem><para>Configures requirement
dependencies, very similar in style to
<varname>Requires=</varname>, however
- in addition to this behavior it also
+ in addition to this behavior, it also
declares that this unit is stopped
when any of the units listed suddenly
disappears. Units can suddenly,
be modified to be fixed (in case one
or both jobs are not a required part
of the transaction). In the latter
- case the job that is not the required
+ case, the job that is not the required
will be removed, or in case both are
- not required the unit that conflicts
+ not required, the unit that conflicts
will be started and the unit that is
conflicted is
stopped.</para></listitem>
a common pattern to include a unit
name in both the
<varname>After=</varname> and
- <varname>Requires=</varname> option in
+ <varname>Requires=</varname> option, in
which case the unit listed will be
started before the unit that is
configured with these options. This
directives (see
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details). If a unit that has this
- setting set is started its processes
+ setting set is started, its processes
will see the same
<filename>/tmp</filename>,
<filename>/tmp/var</filename> and
network namespace as one listed unit
that is started. If multiple listed
- units are already started it is not
+ units are already started, it is not
defined which namespace is
joined. Note that this setting only
has an effect if
<row>
<entry><literal>%p</literal></entry>
<entry>Prefix name</entry>
- <entry>For instantiated units this refers to the string before the <literal>@</literal> character of the unit name. For non-instantiated units this refers to the name of the unit with the type suffix removed.</entry>
+ <entry>For instantiated units, this refers to the string before the <literal>@</literal> character of the unit name. For non-instantiated units, this refers to the name of the unit with the type suffix removed.</entry>
</row>
<row>
<entry><literal>%P</literal></entry>
<row>
<entry><literal>%h</literal></entry>
<entry>User home directory</entry>
- <entry>This is the home directory of the configured user of the unit, or (if none is set) the user running the systemd user instance. Similar to <literal>%U</literal> this specifier is not available for units run by the systemd system instance, unless the configured user is the root user.</entry>
+ <entry>This is the home directory of the configured user of the unit, or (if none is set) the user running the systemd user instance. Similar to <literal>%U</literal>, this specifier is not available for units run by the systemd system instance, unless the configured user is the root user.</entry>
</row>
<row>
<entry><literal>%s</literal></entry>
<entry>User shell</entry>
- <entry>This is the shell of the configured user of the unit, or (if none is set) the user running the systemd user instance. Similar to <literal>%U</literal> this specifier is not available for units run by the systemd system instance, unless the configured user is the root user.</entry>
+ <entry>This is the shell of the configured user of the unit, or (if none is set) the user running the systemd user instance. Similar to <literal>%U</literal>, this specifier is not available for units run by the systemd system instance, unless the configured user is the root user.</entry>
</row>
<row>
<entry><literal>%m</literal></entry>
<filename>/proc</filename>.</para>
<para>For more information about the concepts and
- ideas behind systemd please refer to the <ulink
+ ideas behind systemd
, please refer to the <ulink
url="http://0pointer.de/blog/projects/systemd.html">Original
Design Document</ulink>.</para>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
projects / thirdparty / systemd.git / commitdiff
