diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/sd-daemon.xml | 27 | ||||
| -rw-r--r-- | man/sd_booted.xml | 26 | ||||
| -rw-r--r-- | man/sd_is_fifo.xml | 20 | ||||
| -rw-r--r-- | man/sd_listen_fds.xml | 26 | ||||
| -rw-r--r-- | man/sd_notify.xml | 23 | ||||
| -rw-r--r-- | man/sd_readahead.xml | 26 | ||||
| -rw-r--r-- | man/systemctl.xml | 15 | ||||
| -rw-r--r-- | man/systemd.exec.xml | 5 | ||||
| -rw-r--r-- | man/systemd.path.xml | 6 | ||||
| -rw-r--r-- | man/systemd.service.xml | 36 | ||||
| -rw-r--r-- | man/systemd.special.xml.in | 26 | ||||
| -rw-r--r-- | man/systemd.unit.xml | 75 |
12 files changed, 223 insertions, 88 deletions
diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index cbfe28f842..cd67d9992a 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -52,6 +52,11 @@ <funcsynopsis> <funcsynopsisinfo>#include "sd-daemon.h"</funcsynopsisinfo> </funcsynopsis> + + <cmdsynopsis> + <command>pkg-config --cflags --libs libsystemd-daemon</command> + </cmdsynopsis> + </refsynopsisdiv> <refsect1> @@ -129,17 +134,20 @@ resp. <ulink url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para> <para>These APIs are implemented in the reference - implementation's drop-in - <filename>sd-daemon.c</filename> and - <filename>sd-daemon.h</filename> files. It is - recommended that applications consuming these APIs copy - the implementation into their source tree, either - verbatim or in excerpts. These interfaces are - currently not available in a dynamic library.</para> + implementation's <filename>sd-daemon.c</filename> and + <filename>sd-daemon.h</filename> files. These + interfaces are available as shared library, which can + be compiled and linked to with the + <literal>libsystemd-daemon</literal> + <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> + file. Alternatively, applications consuming these APIs + may copy the implementation into their source tree, + either verbatim or in excerpts.</para> <para>The functions directly related to new-style daemons become NOPs when -DDISABLE_SYSTEMD is set - during compilation. In addition, if + during compilation and the reference implementation is + used as drop-in files. In addition, if <filename>sd-daemon.c</filename> is compiled on non-Linux systems they become NOPs.</para> </refsect1> @@ -156,7 +164,8 @@ <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>fprintf</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>7</manvolnum></citerefentry>, + <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/sd_booted.xml b/man/sd_booted.xml index 841ee1d479..ebcde36b48 100644 --- a/man/sd_booted.xml +++ b/man/sd_booted.xml @@ -98,17 +98,23 @@ url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para> <para><function>sd_booted()</function> is implemented - in the reference implementation's drop-in + in the reference implementation's <filename>sd-daemon.c</filename> and - <filename>sd-daemon.h</filename> files. It is - recommended that applications consuming these APIs - copy the implementation into their source tree. For - more details about the reference implementation see - <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> - - <para>If -DDISABLE_SYSTEMD is set during compilation - this function will always return 0 and otherwise - become a NOP.</para> + <filename>sd-daemon.h</filename> files. These + interfaces are available as shared library, which can + be compiled and linked to with the + <literal>libsystemd-daemon</literal> + <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 + <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> + + <para>If the reference implementation is used as + drop-in files and -DDISABLE_SYSTEMD is set during + compilation this function will always return 0 and + otherwise become a NOP.</para> </refsect1> <refsect1> diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index 251f45ce0f..f6fafabc39 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -178,7 +178,7 @@ <filename>getsockname()</filename> to check the file descriptor type and where it is bound to.</para> - <para>For details about the algorithm check the + <para>For details about the algorithms check the liberally licensed reference implementation sources: <ulink url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.c"/> resp. <ulink @@ -186,13 +186,17 @@ <para><function>sd_is_fifo()</function> and the related functions are implemented in the reference - implementation's drop-in - <filename>sd-daemon.c</filename> and - <filename>sd-daemon.h</filename> files. It is - recommended that applications consuming these APIs - copy the implementation into their source tree. For - more details about the reference implementation see - <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> + implementation's <filename>sd-daemon.c</filename> and + <filename>sd-daemon.h</filename> files. These + interfaces are available as shared library, which can + be compiled and linked to with the + <literal>libsystemd-daemon</literal> + <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 + <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> <para>These functions continue to work as described, even if -DDISABLE_SYSTEMD is set during diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index 128d859b97..3276aff63d 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -145,17 +145,23 @@ url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para> <para><function>sd_listen_fds()</function> is - implemented in the reference implementation's drop-in + implemented in the reference implementation's <filename>sd-daemon.c</filename> and - <filename>sd-daemon.h</filename> files. It is - recommended that applications consuming these APIs - copy the implementation into their source tree. For - more details about the reference implementation see - <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> - - <para>If -DDISABLE_SYSTEMD is set during compilation - this function will always return 0 and otherwise - become a NOP.</para> + <filename>sd-daemon.h</filename> files. These + interfaces are available as shared library, which can + be compiled and linked to with the + <literal>libsystemd-daemon</literal> + <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 + <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> + + <para>If the reference implementation is used as + drop-in files and -DDISABLE_SYSTEMD is set during + compilation this function will always return 0 and + otherwise become a NOP.</para> </refsect1> <refsect1> diff --git a/man/sd_notify.xml b/man/sd_notify.xml index c060bbad27..dd0ba935d6 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -206,7 +206,7 @@ datagram is accompanied by the process credentials of the sending daemon, using SCM_CREDENTIALS.</para> - <para>For details about the algorithm check the + <para>For details about the algorithms check the liberally licensed reference implementation sources: <ulink url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.c"/> resp. <ulink @@ -214,17 +214,22 @@ <para><function>sd_notify()</function> and <function>sd_notifyf()</function> are implemented in - the reference implementation's drop-in + the reference implementation's <filename>sd-daemon.c</filename> and - <filename>sd-daemon.h</filename> files. It is - recommended that applications consuming these APIs - copy the implementation into their source tree. For + <filename>sd-daemon.h</filename> files. These + interfaces are available as shared library, which can + be compiled and linked to with the + <literal>libsystemd-daemon</literal> + <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 - <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> + <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> - <para>If -DDISABLE_SYSTEMD is set during compilation - this function will always return 0 and otherwise - become a NOP.</para> + <para>If the reference implementation is used as + drop-in files and -DDISABLE_SYSTEMD is set during + compilation these functions will always return 0 and + otherwise become a NOP.</para> </refsect1> <refsect1> diff --git a/man/sd_readahead.xml b/man/sd_readahead.xml index 004608dfba..88b135b7ec 100644 --- a/man/sd_readahead.xml +++ b/man/sd_readahead.xml @@ -134,17 +134,23 @@ url="http://cgit.freedesktop.org/systemd/tree/src/sd-readahead.h"/></para> <para><function>sd_readahead()</function> is - implemented in the reference implementation's drop-in + implemented in the reference implementation's <filename>sd-readahead.c</filename> and - <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 - <citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> - - <para>If -DDISABLE_SYSTEMD is set during compilation - this function will always return 0 and otherwise - become a NOP.</para> + <filename>sd-readahead.h</filename> files. These + interfaces are available as shared library, which can + be compiled and linked to with the + <literal>libsystemd-daemon</literal> + <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> + file. Alternatively, applications consuming this API + may copy the implementation into their source + tree. For more details about the reference + implementation see + <citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> + + <para>If the reference implementation is used as + drop-in files and -DDISABLE_SYSTEMD is set during + compilation this function will always return 0 and + otherwise become a NOP.</para> </refsect1> <refsect1> diff --git a/man/systemctl.xml b/man/systemctl.xml index 468141c2bd..5adee45163 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -198,6 +198,14 @@ </varlistentry> <varlistentry> + <term><option>--no-legend</option></term> + + <listitem><para>Do not print a legend, i.e. + the column headers and the footer with hints. + </para></listitem> + </varlistentry> + + <varlistentry> <term><option>--no-pager</option></term> <listitem><para>Do not pipe output into a @@ -595,6 +603,13 @@ </varlistentry> <varlistentry> + <term><command>list-unit-files</command></term> + + <listitem><para>List installed unit files. + </para></listitem> + </varlistentry> + + <varlistentry> <term><command>enable [NAME...]</command></term> <listitem><para>Enable one or more diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 609484b3a3..230c4a31f7 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -279,6 +279,11 @@ assignments. Empty lines and lines starting with ; or # will be ignored, which may be used for commenting. The + parser strips leading and + trailing whitespace from the values + of assignments, unless you use + double quotes ("). + The argument passed should be an absolute file name, optionally prefixed with "-", which indicates that if the file diff --git a/man/systemd.path.xml b/man/systemd.path.xml index f99931ab1e..10d8f73004 100644 --- a/man/systemd.path.xml +++ b/man/systemd.path.xml @@ -154,7 +154,11 @@ activated, then the configured unit is immediately activated as well. Something similar does not apply - to <varname>PathChanged=</varname>. + to + <varname>PathChanged=</varname>. The + latter is not activated on simple + writes but only if files with were + opened for writing are closed. </para></listitem> </varlistentry> <varlistentry> diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 4f1102021f..7b6f12d069 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -311,20 +311,28 @@ main process of the daemon. The command line accepts % specifiers as described in - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. On - top of that basic environment variable - substitution is supported, where - <literal>${FOO}</literal> is replaced - by the string value of the environment - variable of the same name. Also - <literal>$FOO</literal> may appear as - separate word on the command line in - which case the variable is replaced by - its value split at whitespaces. Note - that the first argument (i.e. the - binary to execute) may not be a - variable, and must be a literal and - absolute path name.</para></listitem> + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> + + <para>On top of that basic environment + variable substitution is + supported. Use + <literal>${FOO}</literal> as part of a + word, or as word of its own on the + command line, in which case it will be + replaced by the value of the + environment variable including all + whitespace it contains, resulting in a + single argument. Use + <literal>$FOO</literal> as a separate + word on the command line, in which + case it will be replaced by the value + of the environment variable split up + at whitespace, resulting in no or more + arguments. Note that the first + argument (i.e. the program to execute) + may not be a variable, and must be a + literal and absolute path + name.</para></listitem> </varlistentry> <varlistentry> diff --git a/man/systemd.special.xml.in b/man/systemd.special.xml.in index 218754051e..116a43ccfb 100644 --- a/man/systemd.special.xml.in +++ b/man/systemd.special.xml.in @@ -59,6 +59,7 @@ <filename>halt.target</filename>, <filename>kbrequest.target</filename>, <filename>local-fs.target</filename>, + <filename>local-fs-pre.target</filename>, <filename>mail-transfer-agent.target</filename>, <filename>multi-user.target</filename>, <filename>network.target</filename>, @@ -66,6 +67,7 @@ <filename>poweroff.target</filename>, <filename>reboot.target</filename>, <filename>remote-fs.target</filename>, + <filename>remote-fs-pre.target</filename>, <filename>rescue.target</filename>, <filename>rpcbind.target</filename>, <filename>runlevel2.target</filename>, @@ -261,6 +263,18 @@ </listitem> </varlistentry> <varlistentry> + <term><filename>local-fs-pre.target</filename></term> + <listitem> + <para>This target unit is + automatically ordered before + all local mount points marked + with <option>auto</option> + (see above). It can be used to + execute certain units before + all local mounts.</para> + </listitem> + </varlistentry> + <varlistentry> <term><filename>mail-transfer-agent.target</filename></term> <listitem> <para>The mail transfer agent @@ -374,6 +388,18 @@ </listitem> </varlistentry> <varlistentry> + <term><filename>remote-fs-pre.target</filename></term> + <listitem> + <para>This target unit is + automatically ordered before + all remote mount points marked + with <option>auto</option> + (see above). It can be used to + execute certain units before + all remote mounts.</para> + </listitem> + </varlistentry> + <varlistentry> <term><filename>rescue.target</filename></term> <listitem> <para>A special target unit diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index b222f9f064..897f99f24c 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -121,8 +121,9 @@ <para>If a line starts with <option>.include</option> followed by a file name, the specified file will be - read as if its contents were listed in place of the - <option>.include</option> directive.</para> + parsed at this point. Make sure that the file that is + included has the appropiate section headers before + any directives.</para> <para>Along with a unit file <filename>foo.service</filename> a directory @@ -665,11 +666,14 @@ <term><varname>ConditionPathExists=</varname></term> <term><varname>ConditionPathExistsGlob=</varname></term> <term><varname>ConditionPathIsDirectory=</varname></term> + <term><varname>ConditionPathIsSymbolicLink=</varname></term> + <term><varname>ConditionPathIsMountPoint=</varname></term> <term><varname>ConditionDirectoryNotEmpty=</varname></term> <term><varname>ConditionFileIsExecutable=</varname></term> <term><varname>ConditionKernelCommandLine=</varname></term> <term><varname>ConditionVirtualization=</varname></term> <term><varname>ConditionSecurity=</varname></term> + <term><varname>ConditionCapability=</varname></term> <term><varname>ConditionNull=</varname></term> <listitem><para>Before starting a unit @@ -679,7 +683,7 @@ a file existence condition can be checked before a unit is started. If the specified absolute path name does - not exist startup of a unit will not + not exist, startup of a unit will not actually happen, however the unit is still useful for ordering purposes in this case. The condition is checked at @@ -689,10 +693,11 @@ <varname>ConditionPathExists=</varname> is prefixed with an exclamation mark (!), the test is negated, and the unit - only started if the path does not - exist. <varname>ConditionPathExistsGlob=</varname> - work in a similar way, but checks for - the existance of at least one file or + is only started if the path does not + exist. + <varname>ConditionPathExistsGlob=</varname> + works in a similar way, but checks for + the existence of at least one file or directory matching the specified globbing pattern. <varname>ConditionPathIsDirectory=</varname> @@ -700,7 +705,17 @@ <varname>ConditionPathExists=</varname> but verifies whether a certain path exists and is a - directory. <varname>ConditionFileIsExecutable=</varname> + directory. <varname>ConditionPathIsSymbolicLink=</varname> + is similar to + <varname>ConditionPathExists=</varname> + but verifies whether a certain path + exists and is a symbolic + link. <varname>ConditionPathIsMountPoint=</varname> + is similar to + <varname>ConditionPathExists=</varname> + but verifies whether a certain path + exists and is a mount + point. <varname>ConditionFileIsExecutable=</varname> is similar to <varname>ConditionPathExists=</varname> but verifies whether a certain path @@ -733,25 +748,47 @@ whether it is a specific implementation. Takes either boolean value to check if being executed in - any virtual environment or one of the + any virtualized environment, or one of + <varname>vm</varname> and + <varname>container</varname> to test + against a specific type of + virtualization solution, or one of <varname>qemu</varname>, <varname>kvm</varname>, <varname>vmware</varname>, <varname>microsoft</varname>, <varname>oracle</varname>, <varname>xen</varname>, - <varname>pidns</varname>, - <varname>openvz</varname> to test - against a specific implementation. The - test may be negated by prepending an - exclamation mark. + <varname>bochs</varname>, + <varname>chroot</varname>, + <varname>openvz</varname>, + <varname>lxc</varname>, + <varname>systemd-nspawn</varname>, + <varname>pidns</varname> to test + against a specific implementation. If + multiple virtualization technologies + are nested only the innermost is + considered. The test may be negated by + prepending an exclamation mark. <varname>ConditionSecurity=</varname> may be used to check whether the given security module is enabled on the system. Currently the only recognized value is <varname>selinux</varname>. The test may be negated by prepending - an exclamation mark. Finally, + an exclamation + mark. <varname>ConditionCapability=</varname> + may be used to check whether the given + capability exists in the capability + bounding set of the service manager + (i.e. this does not check whether + capability is actually available in + the permitted or effective sets, see + <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> + for details). Pass a capability name + such as <literal>CAP_MKNOD</literal>, + possibly prefixed with an exclamation + mark to negate the check. Finally, <varname>ConditionNull=</varname> may be used to add a constant condition check value to the unit. It takes a @@ -773,7 +810,10 @@ prefix an argument with the pipe symbol and an exclamation mark the pipe symbol must be passed first, the - exclamation second.</para></listitem> + exclamation second. Except for + <varname>ConditionPathIsSymbolicLink=</varname>, + all path checks follow + symlinks.</para></listitem> </varlistentry> <varlistentry> @@ -905,7 +945,8 @@ <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.snapshot</refentrytitle><manvolnum>5</manvolnum></citerefentry> + <citerefentry><refentrytitle>systemd.snapshot</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> </para> </refsect1> |