diff options
Diffstat (limited to 'man')
207 files changed, 3232 insertions, 1243 deletions
diff --git a/man/binfmt.d.xml b/man/binfmt.d.xml index 5b63cfb4c3..3aa5eb1859 100644 --- a/man/binfmt.d.xml +++ b/man/binfmt.d.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/bootchart.conf.xml b/man/bootchart.conf.xml index 8d9700d300..b383f6e24d 100644 --- a/man/bootchart.conf.xml +++ b/man/bootchart.conf.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -52,24 +55,23 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/bootchart.conf</filename></para> - <para><filename>/etc/systemd/bootchart.conf.d/*.conf</filename></para> + <para><filename>&pkgsysconfdir;/bootchart.conf</filename></para> + <para><filename>&pkgsysconfdir;/bootchart.conf.d/*.conf</filename></para> <para><filename>/run/systemd/bootchart.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/bootchart.conf.d/*.conf</filename></para> + <para><filename>&rootlibexecdir;/bootchart.conf.d/*.conf</filename></para> </refsynopsisdiv> <refsect1> <title>Description</title> <para>When starting, systemd-bootchart will read the configuration - file <filename>/etc/systemd/bootchart.conf</filename>, followed by + file <filename>&pkgsysconfdir;/bootchart.conf</filename>, followed by the files in the <filename>bootchart.conf.d</filename> directories. These configuration files determine logging parameters and graph output.</para> </refsect1> - <xi:include href="standard-conf.xml" xpointer="confd" /> - <xi:include href="standard-conf.xml" xpointer="conf" /> + <xi:include href="standard-conf.xml" xpointer="main-conf" /> <refsect1> <title>Options</title> @@ -123,10 +125,10 @@ <term><varname>Init=[path]</varname></term> <listitem><para>Configures bootchart to run a non-standard binary instead of - <filename>/usr/lib/systemd/systemd</filename>. This option is + <filename>&rootlibexecdir;/systemd</filename>. This option is only relevant if bootchart was invoked from the kernel command line with - init=/usr/lib/systemd/systemd-bootchart.</para></listitem> + init=&rootlibexecdir;/systemd-bootchart.</para></listitem> </varlistentry> <varlistentry> diff --git a/man/bootctl.xml b/man/bootctl.xml index 00f54c73fc..c7c65aa4b2 100644 --- a/man/bootctl.xml +++ b/man/bootctl.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -21,7 +24,6 @@ <refentry id="bootctl" conditional='ENABLE_EFI' xmlns:xi="http://www.w3.org/2001/XInclude"> - <refentryinfo> <title>bootctl</title> <productname>systemd</productname> @@ -48,65 +50,82 @@ <refsynopsisdiv> <cmdsynopsis> - <command>bootctl</command> - <arg choice="opt" rep="repeat">OPTIONS</arg> - <arg choice="req">COMMAND</arg> + <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg>status</command> + </cmdsynopsis> + <cmdsynopsis> + <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg>update</command> + </cmdsynopsis> + <cmdsynopsis> + <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg>install</command> + </cmdsynopsis> + <cmdsynopsis> + <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg>remove</command> </cmdsynopsis> </refsynopsisdiv> <refsect1> <title>Description</title> - <para><command>bootctl</command> may be used to query or (in the - future) change the firmware and boot manager settings.</para> - - <para>Firmware information is available only on EFI systems. - </para> - - <para>Currently, only the - <citerefentry project='gummiboot'><refentrytitle>gummiboot</refentrytitle><manvolnum>8</manvolnum></citerefentry> - boot manager implements the required boot loader interface to - provide complete boot manager information.</para> + <para><command>bootctl</command> checks, updates, + installs or removes the boot loader from the current + system.</para> + + <para><command>bootctl status</command> checks and prints the + currently installed versions of the boot loader binaries and the + all current EFI boot variables.</para> + + <para><command>bootctl update</command> updates all installed + versions of systemd-boot, if the current version is newer than the + version installed in the EFI system partition. This also includes + the EFI default/fallback loader at /EFI/Boot/boot*.efi. A + systemd-boot entry in the EFI boot variables is created, if there + is no current entry. The created entry will be added to the end of + the boot order list.</para> + + <para><command>bootctl install</command> installs systemd-boot into + the EFI system partition. A copy of systemd-boot will be stored as + the EFI default/fallback loader at /EFI/Boot/boot*.efi. A systemd-boot + entry in the EFI boot variables is created and added to the top + of the boot order list.</para> + + <para><command>bootctl remove</command> removes all installed + versions of systemd-boot from the EFI system partition, and removes + systemd-boot from the EFI boot variables.</para> + + <para>If no command is passed <command>status</command> is + implied.</para> </refsect1> <refsect1> <title>Options</title> - <para>The following options are understood:</para> <variablelist> <xi:include href="standard-options.xml" xpointer="help" /> <xi:include href="standard-options.xml" xpointer="version" /> - </variablelist> - - <para>The following commands are understood:</para> - - <variablelist> <varlistentry> - <term><command>status</command></term> + <term><option>--path</option></term> + <listitem><para>Path to the EFI system partition. The default is /boot.</para></listitem> + </varlistentry> - <listitem><para>Show firmware and boot manager information - about the system, including secure boot mode status and - selected firmware entry (where available).</para></listitem> + <varlistentry> + <term><option>--no-variables</option></term> + <listitem><para>Do not touch the EFI boot variables.</para></listitem> </varlistentry> </variablelist> - </refsect1> <refsect1> <title>Exit status</title> - - <para>On success, 0 is returned, a non-zero failure code - otherwise.</para> + <para>On success 0 is returned, a non-zero failure + code otherwise.</para> </refsect1> <refsect1> <title>See Also</title> <para> - <ulink url="http://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot loader interface</ulink>, - <ulink url="http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink>, - <ulink url="http://www.freedesktop.org/wiki/Software/gummiboot/">gummiboot</ulink> + <ulink url="http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink> + <ulink url="http://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Systemd boot loader interface</ulink> </para> </refsect1> - </refentry> diff --git a/man/bootup.xml b/man/bootup.xml index d97d550236..de34a59a72 100644 --- a/man/bootup.xml +++ b/man/bootup.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -134,7 +137,7 @@ v v | v <emphasis>rescue.target</emphasis> timers.target paths.target | sockets.target | | | | - v |_________________ | ___________________/ + v \_________________ | ___________________/ \|/ v basic.target diff --git a/man/busctl.xml b/man/busctl.xml index 251233bb96..08303b4dd8 100644 --- a/man/busctl.xml +++ b/man/busctl.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -288,7 +291,7 @@ url="http://wiki.wireshark.org/Development/LibpcapFileFormat">Libpcap File Format</ulink> description. Make sure to redirect the output to STDOUT to a file. Tools like - <citerefentry><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry> may be used to dissect and view the generated files.</para></listitem> </varlistentry> @@ -465,14 +468,14 @@ o "/org/freedesktop/systemd1/job/42684"</programlisting> <title>See Also</title> <para> - <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='dbus'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>, <ulink url="https://code.google.com/p/d-bus/">kdbus</ulink>, <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-bus-proxyd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> </refentry> diff --git a/man/coredump.conf.xml b/man/coredump.conf.xml index 3d325e6ad7..4c65c1cf03 100644 --- a/man/coredump.conf.xml +++ b/man/coredump.conf.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -49,10 +52,10 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/coredump.conf</filename></para> - <para><filename>/etc/systemd/coredump.conf.d/*.conf</filename></para> + <para><filename>&pkgsysconfdir;/coredump.conf</filename></para> + <para><filename>&pkgsysconfdir;/coredump.conf.d/*.conf</filename></para> <para><filename>/run/systemd/coredump.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/coredump.conf.d/*.conf</filename></para> + <para><filename>&rootlibexecdir;/coredump.conf.d/*.conf</filename></para> </refsynopsisdiv> <refsect1> @@ -63,8 +66,7 @@ a handler for core dumps invoked by the kernel.</para> </refsect1> - <xi:include href="standard-conf.xml" xpointer="confd" /> - <xi:include href="standard-conf.xml" xpointer="conf" /> + <xi:include href="standard-conf.xml" xpointer="main-conf" /> <refsect1> <title>Options</title> @@ -135,7 +137,9 @@ by coredumps might temporarily exceed these limits while coredumps are processed. Note that old coredumps are also removed based on time via - <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem> + <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>. Set + either value to 0 to turn off size based + clean-up.</para></listitem> </varlistentry> </variablelist> diff --git a/man/coredumpctl.xml b/man/coredumpctl.xml index efbc655a76..4bd1a7e67f 100644 --- a/man/coredumpctl.xml +++ b/man/coredumpctl.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/crypttab.xml b/man/crypttab.xml index aeacc57973..d403e71bef 100644 --- a/man/crypttab.xml +++ b/man/crypttab.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -75,7 +78,7 @@ <para>Setting up encrypted block devices using this file supports three encryption modes: LUKS, TrueCrypt and plain. See - <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> for more information about each mode. When no mode is specified in the options field and the block device contains a LUKS signature, it is opened as a LUKS device; otherwise, it is assumed to be in @@ -117,7 +120,7 @@ <term><option>cipher=</option></term> <listitem><para>Specifies the cipher to use. See - <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> for possible values and the default value of this option. A cipher with unpredictable IV values, such as <literal>aes-cbc-essiv:sha256</literal>, is @@ -129,7 +132,7 @@ <listitem><para>Specifies the hash to use for password hashing. See - <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> for possible values and the default value of this option.</para></listitem> </varlistentry> @@ -140,17 +143,41 @@ <listitem><para>Use a detached (separated) metadata device or file where the LUKS header is stored. This option is only relevant for LUKS devices. See - <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> for possible values and the default value of this option.</para></listitem> </varlistentry> <varlistentry> + <term><option>offset=</option></term> + + <listitem><para>Start offset in the backend device, in 512-byte sectors. + This option is only relevant for plain devices. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>skip=</option></term> + + <listitem><para>How many 512-byte sectors of the encrypted data to skip + at the beginning. This is different from the <option>--offset</option> + option with respect to the sector numbers used in initialization vector + (IV) calculation. Using <option>--offset</option> will shift the IV + calculation by the same negative amount. Hence, if <option>--offset n</option>, + sector n will get a sector number of 0 for the IV calculation. + Using <option>--skip</option> causes sector n to also be the first + sector of the mapped device, but with its number for IV generation is n.</para> + + <para>This option is only relevant for plain devices.</para> + </listitem> + </varlistentry> + + <varlistentry> <term><option>keyfile-offset=</option></term> <listitem><para>Specifies the number of bytes to skip at the start of the key file. See - <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> for possible values and the default value of this option.</para></listitem> </varlistentry> @@ -160,7 +187,7 @@ <listitem><para>Specifies the maximum number of bytes to read from the key file. See - <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> for possible values and the default value of this option. This option is ignored in plain encryption mode, as the key file size is then given by the key size.</para></listitem> @@ -174,7 +201,7 @@ given passphrase or key, but another would, the setup of the device will fail regardless. This option implies <option>luks</option>. See - <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> for possible values. The default is to try all key slots in sequential order.</para></listitem> </varlistentry> @@ -221,7 +248,7 @@ <term><option>size=</option></term> <listitem><para>Specifies the key size in bits. See - <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> for possible values and the default value of this option.</para></listitem> </varlistentry> @@ -278,7 +305,7 @@ volume provided in the second field. Please note that there is no protection for the hidden volume if the outer volume is mounted instead. See - <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> for more information on this limitation.</para></listitem> </varlistentry> @@ -383,7 +410,7 @@ hidden /mnt/tc_hidden /dev/null tcrypt-hidden,tcrypt-keyfile=/etc/keyfil <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>mkswap</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>mke2fs</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> diff --git a/man/custom-html.xsl b/man/custom-html.xsl index 32299db710..0856c1f29c 100644 --- a/man/custom-html.xsl +++ b/man/custom-html.xsl @@ -87,8 +87,30 @@ </a> </xsl:template> -<xsl:template match="citerefentry[@project='gummiboot']"> - <xsl:call-template name="inline.charseq"/> +<xsl:template match="citerefentry[@project='freebsd']"> + <a> + <xsl:attribute name="href"> + <xsl:text>https://www.freebsd.org/cgi/man.cgi?</xsl:text> + <xsl:value-of select="refentrytitle"/> + <xsl:text>(</xsl:text> + <xsl:value-of select="manvolnum"/> + <xsl:text>)</xsl:text> + </xsl:attribute> + <xsl:call-template name="inline.charseq"/> + </a> +</xsl:template> + +<xsl:template match="citerefentry[@project='dbus']"> + <a> + <xsl:attribute name="href"> + <xsl:text>http://dbus.freedesktop.org/doc/</xsl:text> + <xsl:value-of select="refentrytitle"/> + <xsl:text>.</xsl:text> + <xsl:value-of select="manvolnum"/> + <xsl:text>.html</xsl:text> + </xsl:attribute> + <xsl:call-template name="inline.charseq"/> + </a> </xsl:template> <xsl:template match="refsect1/title|refsect1/info/title"> @@ -210,18 +232,6 @@ </xsl:attribute> <xsl:text>Python </xsl:text> </a>· - <a> - <xsl:attribute name="href"> - <xsl:text>../libudev/index.html</xsl:text> - </xsl:attribute> - <xsl:text>libudev </xsl:text> - </a>· - <a> - <xsl:attribute name="href"> - <xsl:text>../libudev/index.html</xsl:text> - </xsl:attribute> - <xsl:text>gudev </xsl:text> - </a> <span style="float:right"> <xsl:text>systemd </xsl:text> diff --git a/man/daemon.xml b/man/daemon.xml index a8bbfc055b..38d458e05d 100644 --- a/man/daemon.xml +++ b/man/daemon.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/file-hierarchy.xml b/man/file-hierarchy.xml index e9c894f5c8..f73a3edc06 100644 --- a/man/file-hierarchy.xml +++ b/man/file-hierarchy.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -256,9 +259,8 @@ used for package-specific data, unless this data is architecture-dependent, too. To query <varname>$libdir</varname> for the primary architecture of the - system, invoke: <programlisting># pkg-config --variable=libdir - systemd</programlisting> or <programlisting># systemd-path - system-library-arch</programlisting> </para></listitem> + system, invoke: + <programlisting># systemd-path system-library-arch</programlisting></para></listitem> </varlistentry> @@ -397,7 +399,7 @@ <term><filename>/dev/shm</filename></term> <listitem><para>Place for POSIX shared memory segments, as created via - <citerefentry><refentrytitle>shm_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>. + <citerefentry project='die-net'><refentrytitle>shm_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>. This directory is flushed on boot, and is a <literal>tmpfs</literal> file system. Since all users have write access to this directory, special care should be taken diff --git a/man/halt.xml b/man/halt.xml index a06dbd0097..f425ebdb8e 100644 --- a/man/halt.xml +++ b/man/halt.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/hostname.xml b/man/hostname.xml index 5d3d46d8ce..34aaca1acd 100644 --- a/man/hostname.xml +++ b/man/hostname.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -57,11 +60,12 @@ name of the local system that is set during boot using the <citerefentry><refentrytitle>sethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call. It should contain a single newline-terminated - hostname string. The hostname may be a free-form string up to 64 - characters in length; however, it is recommended that it consists - only of 7-bit ASCII lower-case characters and no spaces or dots, - and limits itself to the format allowed for DNS domain name - labels, even though this is not a strict requirement.</para> + hostname string. Comments (lines starting with a `#') are ignored. + The hostname may be a free-form string up to 64 characters in length; + however, it is recommended that it consists only of 7-bit ASCII lower-case + characters and no spaces or dots, and limits itself to the format allowed + for DNS domain name labels, even though this is not a strict + requirement.</para> <para>Depending on the operating system, other configuration files might be checked for configuration of the hostname as well, diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml index b1f038156d..93934668cc 100644 --- a/man/hostnamectl.xml +++ b/man/hostnamectl.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/hwdb.xml b/man/hwdb.xml index b4460c1aee..e6215df738 100644 --- a/man/hwdb.xml +++ b/man/hwdb.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <refentry id="hwdb" conditional="ENABLE_HWDB"> <refentryinfo> @@ -40,17 +43,17 @@ <refsect1><title>Hardware Database Files</title> <para>The hwdb files are read from the files located in the - system hwdb directory <filename>/usr/lib/udev/hwdb.d</filename>, + system hwdb directory <filename>&udevlibexecdir;/hwdb.d</filename>, the volatile runtime directory <filename>/run/udev/hwdb.d</filename> and the local administration directory <filename>/etc/udev/hwdb.d</filename>. All hwdb files are collectively sorted and processed in lexical order, regardless of the directories in which they live. However, files with identical filenames replace each other. Files in <filename>/etc</filename> have the highest priority, files in <filename>/run</filename> take precedence - over files with the same name in <filename>/usr/lib</filename>. This can be + over files with the same name in <filename>&rootprefix;/lib</filename>. This can be used to override a system-supplied hwdb file with a local file if needed; a symlink in <filename>/etc</filename> with the same name as a hwdb file in - <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>, + <filename>&rootprefix;/lib</filename>, pointing to <filename>/dev/null</filename>, disables the hwdb file entirely. hwdb files must have the extension <filename>.hwdb</filename>; other extensions are ignored.</para> @@ -58,7 +61,7 @@ associated key-value pairs. Every record in the hwdb starts with one or more match string, specifying a shell glob to compare the database lookup string against. Multiple match lines are specified in additional - consecutive lines. Every match line is compared indivdually, they are + consecutive lines. Every match line is compared individually, they are combined by OR. Every match line must start at the first character of the line.</para> @@ -70,7 +73,7 @@ <para>The content of all hwdb files is read by <citerefentry><refentrytitle>systemd-hwdb</refentrytitle><manvolnum>8</manvolnum></citerefentry> and compiled to a binary database located at <filename>/etc/udev/hwdb.bin</filename>, - or alternatively <filename>/usr/lib/udev/hwdb.bin</filename> if you want ship the compiled + or alternatively <filename>&udevlibexecdir;/hwdb.bin</filename> if you want ship the compiled database in an immutable image. During runtime only the binary database is used.</para> </refsect1> diff --git a/man/journal-remote.conf.xml b/man/journal-remote.conf.xml new file mode 100644 index 0000000000..948dfa531d --- /dev/null +++ b/man/journal-remote.conf.xml @@ -0,0 +1,117 @@ +<?xml version='1.0'?> <!--*-nxml-*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> + +<!-- + This file is part of systemd. + + Copyright 2015 Chris Morgan + + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. + + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. +--> + +<refentry id="journal-remote.conf" conditional='HAVE_MICROHTTPD' + xmlns:xi="http://www.w3.org/2001/XInclude"> + <refentryinfo> + <title>journal-remote.conf</title> + <productname>systemd</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Chris</firstname> + <surname>Morgan</surname> + <email>chmorgan@gmail.com</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>journal-remote.conf</refentrytitle> + <manvolnum>5</manvolnum> + </refmeta> + + <refnamediv> + <refname>journal-remote.conf</refname> + <refname>journal-remote.conf.d</refname> + <refpurpose>Journal remote service configuration files</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <para><filename>&pkgsysconfdir;/journal-remote.conf</filename></para> + <para><filename>&pkgsysconfdir;/journald.conf.d/*.conf</filename></para> + <para><filename>/run/systemd/journald.conf.d/*.conf</filename></para> + <para><filename>&rootlibexecdir;/journald.conf.d/*.conf</filename></para> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para>These files configure various parameters of the systemd-remote-journal + application, + <citerefentry><refentrytitle>systemd-journal-remote</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> + </refsect1> + + <xi:include href="standard-conf.xml" xpointer="main-conf" /> + + <refsect1> + <title>Options</title> + + <para>All options are configured in the + <literal>[Remote]</literal> section:</para> + + <variablelist> + + <varlistentry> + <term><varname>SplitMode=</varname></term> + + <listitem><para>One of <literal>host</literal> or <literal>none</literal>. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><varname>ServerKeyFile=</varname></term> + + <listitem><para>SSL key in PEM format.</para></listitem> + </varlistentry> + + <varlistentry> + <term><varname>ServerCertificateFile=</varname></term> + + <listitem><para>SSL CA certificate in PEM format.</para></listitem> + </varlistentry> + + <varlistentry> + <term><varname>TrustedCertificateFile=</varname></term> + + <listitem><para>SSL CA certificate.</para></listitem> + </varlistentry> + + </variablelist> + + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>systemd-journal-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> diff --git a/man/journalctl.xml b/man/journalctl.xml index 770cf9bb29..d67d9606be 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -817,11 +820,6 @@ <programlisting>journalctl /usr/bin/dbus-daemon</programlisting> - <para>Show all logs of the kernel device node - <filename noindex='true'>/dev/sda</filename>:</para> - - <programlisting>journalctl /dev/sda</programlisting> - <para>Show all kernel logs from previous boot:</para> <programlisting>journalctl -k -b -1</programlisting> diff --git a/man/journald.conf.xml b/man/journald.conf.xml index 364b58f07e..8d0dbb0133 100644 --- a/man/journald.conf.xml +++ b/man/journald.conf.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -49,10 +52,10 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/journald.conf</filename></para> - <para><filename>/etc/systemd/journald.conf.d/*.conf</filename></para> + <para><filename>&pkgsysconfdir;/journald.conf</filename></para> + <para><filename>&pkgsysconfdir;/journald.conf.d/*.conf</filename></para> <para><filename>/run/systemd/journald.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/journald.conf.d/*.conf</filename></para> + <para><filename>&rootlibexecdir;/journald.conf.d/*.conf</filename></para> </refsynopsisdiv> <refsect1> @@ -64,8 +67,7 @@ </refsect1> - <xi:include href="standard-conf.xml" xpointer="confd" /> - <xi:include href="standard-conf.xml" xpointer="conf" /> + <xi:include href="standard-conf.xml" xpointer="main-conf" /> <refsect1> <title>Options</title> @@ -98,7 +100,7 @@ needed, so that its existence controls where log data goes. <literal>none</literal> turns off all storage, all log data received will be dropped. Forwarding to other targets, such as - the console, the kernel log buffer or a syslog daemon will + the console, the kernel log buffer, or a syslog socket will still work however. Defaults to <literal>auto</literal>.</para></listitem> </varlistentry> @@ -221,27 +223,19 @@ journald will stop using more space, but it will not be removing existing files to go reduce footprint either.</para> - <para><varname>SystemMaxFileSize=</varname> - and - <varname>RuntimeMaxFileSize=</varname> - control how large individual journal - files may grow at maximum. This - influences the granularity in which - disk space is made available through - rotation, i.e. deletion of historic - data. Defaults to one eighth of the - values configured with + <para><varname>SystemMaxFileSize=</varname> and + <varname>RuntimeMaxFileSize=</varname> control how large + individual journal files may grow at maximum. This influences + the granularity in which disk space is made available through + rotation, i.e. deletion of historic data. Defaults to one + eighth of the values configured with <varname>SystemMaxUse=</varname> and - <varname>RuntimeMaxUse=</varname>, so - that usually seven rotated journal - files are kept as history. Specify - values in bytes or use K, M, G, T, P, - E as units for the specified sizes - (equal to 1024, 1024²,... bytes). - Note that size limits are enforced - synchronously when journal files are - extended, and no explicit rotation - step triggered by time is + <varname>RuntimeMaxUse=</varname>, so that usually seven + rotated journal files are kept as history. Specify values in + bytes or use K, M, G, T, P, E as units for the specified sizes + (equal to 1024, 1024²,... bytes). Note that size limits are + enforced synchronously when journal files are extended, and no + explicit rotation step triggered by time is needed.</para></listitem> </varlistentry> @@ -309,13 +303,13 @@ daemon, to the kernel log buffer (kmsg), to the system console, or sent as wall messages to all logged-in users. These options take boolean arguments. If forwarding to syslog - is enabled but no syslog daemon is running, the respective - option has no effect. By default, only forwarding wall is - enabled. These settings may be overridden at boot time with - the kernel command line options + is enabled but nothing reads messages from the socket, + forwarding to syslog has no effect. By default, only + forwarding to wall is enabled. These settings may be + overridden at boot time with the kernel command line options <literal>systemd.journald.forward_to_syslog=</literal>, <literal>systemd.journald.forward_to_kmsg=</literal>, - <literal>systemd.journald.forward_to_console=</literal> and + <literal>systemd.journald.forward_to_console=</literal>, and <literal>systemd.journald.forward_to_wall=</literal>. When forwarding to the console, the TTY to log to can be changed with <varname>TTYPath=</varname>, described @@ -367,6 +361,32 @@ </refsect1> <refsect1> + <title>Forwarding to traditional syslog daemons</title> + + <para> + Journal events can be transferred to a different logging daemon + in two different ways. In the first method, messages are + immediately forwarded to a socket + (<filename>/run/systemd/journal/syslog</filename>), where the + traditional syslog daemon can read them. This method is + controlled by <varname>ForwardToSyslog=</varname> option. In a + second method, a syslog daemon behaves like a normal journal + client, and reads messages from the journal files, similarly to + <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. + In this method, messages do not have to be read immediately, + which allows a logging daemon which is only started late in boot + to access all messages since the start of the system. In + addition, full structured meta-data is available to it. This + method of course is available only if the messages are stored in + a journal file at all. So it will not work if + <varname>Storage=none</varname> is set. It should be noted that + usually the <emphasis>second</emphasis> method is used by syslog + daemons, so the <varname>Storage=</varname> option, and not the + <varname>ForwardToSyslog=</varname> option, is relevant for them. + </para> + </refsect1> + + <refsect1> <title>See Also</title> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, diff --git a/man/kernel-command-line.xml b/man/kernel-command-line.xml index 3741cf9cc2..6490123a53 100644 --- a/man/kernel-command-line.xml +++ b/man/kernel-command-line.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -295,7 +298,7 @@ <varlistentry> <term><varname>root=</varname></term> <term><varname>rootfstype=</varname></term> - <term><varname>rootfsflags=</varname></term> + <term><varname>rootflags=</varname></term> <term><varname>ro</varname></term> <term><varname>rw</varname></term> @@ -336,7 +339,7 @@ <listitem> <para>Enables resume from hibernation using the specified device. All - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-like + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-like paths are supported. For details, see <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> </listitem> diff --git a/man/kernel-install.xml b/man/kernel-install.xml index d4d01807a4..8891bae71e 100644 --- a/man/kernel-install.xml +++ b/man/kernel-install.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2013 Harald Hoyer + Copyright 2013 Harald Hoyer -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="kernel-install"> diff --git a/man/less-variables.xml b/man/less-variables.xml index 0fb4d7fbcf..e344c62e1a 100644 --- a/man/less-variables.xml +++ b/man/less-variables.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <refsect1> <title>Environment</title> diff --git a/man/libsystemd-pkgconfig.xml b/man/libsystemd-pkgconfig.xml index 272da64cd7..3620f47316 100644 --- a/man/libsystemd-pkgconfig.xml +++ b/man/libsystemd-pkgconfig.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <refsect1> <title>Notes</title> diff --git a/man/locale.conf.xml b/man/locale.conf.xml index 48c0006db2..8af49af7f2 100644 --- a/man/locale.conf.xml +++ b/man/locale.conf.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -91,7 +94,7 @@ might be checked for locale configuration as well, however only as fallback.</para> - <para><citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <para><citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> may be used to alter the settings in this file during runtime from the command line. Use <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> @@ -121,7 +124,7 @@ Note that <varname>LC_ALL</varname> may not be configured in this file. For details about the meaning and semantics of these settings, refer to - <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> + <citerefentry project='man-pages'><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> </refsect1> <refsect1> @@ -142,8 +145,8 @@ LC_MESSAGES=en_US.UTF-8</programlisting> <title>See Also</title> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> diff --git a/man/localectl.xml b/man/localectl.xml index aae6e0629c..caf963ae5e 100644 --- a/man/localectl.xml +++ b/man/localectl.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -124,7 +127,7 @@ <listitem><para>Set the system locale. This takes one or more assignments such as "LANG=de_DE.utf8", "LC_MESSAGES=en_GB.utf8", and so on. See - <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details on the available settings and their meanings. Use <command>list-locales</command> for a list of available locales (see below). </para></listitem> @@ -204,10 +207,10 @@ <title>See Also</title> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>kbd</refentrytitle><manvolnum>4</manvolnum></citerefentry>, <ulink url="http://www.x.org/releases/current/doc/xorg-docs/input/XKB-Config.html"> The XKB Configuration Guide diff --git a/man/localtime.xml b/man/localtime.xml index 2827da6e93..1740dde9eb 100644 --- a/man/localtime.xml +++ b/man/localtime.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/loginctl.xml b/man/loginctl.xml index 9dda14d454..d0529c160e 100644 --- a/man/loginctl.xml +++ b/man/loginctl.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/logind.conf.xml b/man/logind.conf.xml index ffaec50351..96ebd6eed0 100644 --- a/man/logind.conf.xml +++ b/man/logind.conf.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -49,20 +52,22 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/logind.conf</filename></para> - <para><filename>/etc/systemd/logind.conf.d/*.conf</filename></para> + <para><filename>&pkgsysconfdir;/logind.conf</filename></para> + <para><filename>&pkgsysconfdir;/logind.conf.d/*.conf</filename></para> <para><filename>/run/systemd/logind.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/logind.conf.d/*.conf</filename></para> + <para><filename>&rootlibexecdir;/logind.conf.d/*.conf</filename></para> </refsynopsisdiv> <refsect1> <title>Description</title> - <para>These files configure various parameters of the systemd login manager, <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> + <para>These files configure various parameters of the systemd + login manager, + <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + </para> </refsect1> - <xi:include href="standard-conf.xml" xpointer="confd" /> - <xi:include href="standard-conf.xml" xpointer="conf" /> + <xi:include href="standard-conf.xml" xpointer="main-conf" /> <refsect1> <title>Options</title> @@ -124,7 +129,7 @@ <para>Note that setting <varname>KillUserProcesses=1</varname> will break tools like - <citerefentry><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem> + <citerefentry project='die-net'><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem> </varlistentry> <varlistentry> @@ -249,6 +254,21 @@ </varlistentry> <varlistentry> + <term><varname>HoldoffTimeoutSec=</varname></term> + + <listitem><para>Specifies the timeout after system startup or + system resume in which systemd will hold off on reacting to + LID events. This is required for the system to properly + detect any hotplugged devices so systemd can ignore LID events + if external monitors, or docks, are connected. If set to 0, + systemd will always react immediately, possibly before the + kernel fully probed all hotplugged devices. This is safe, as + long as you do not care for systemd to account for devices + that have been plugged or unplugged while the system was off. + Defaults to 30s.</para></listitem> + </varlistentry> + + <varlistentry> <term><varname>RuntimeDirectorySize=</varname></term> <listitem><para>Sets the size limit on the diff --git a/man/machine-id.xml b/man/machine-id.xml index 83e0b26ced..bb7cd7f060 100644 --- a/man/machine-id.xml +++ b/man/machine-id.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -75,7 +78,7 @@ globally unique ID in the network, which does not change even if the local network configuration changes. Due to this and its greater length, it is a more useful replacement for the - <citerefentry><refentrytitle>gethostid</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>gethostid</refentrytitle><manvolnum>3</manvolnum></citerefentry> call that POSIX specifies.</para> <para>The @@ -127,7 +130,7 @@ id[8] = (id[8] & 0x3F) | 0x80;</programlisting> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>gethostid</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>gethostid</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>, diff --git a/man/machine-info.xml b/man/machine-info.xml index 916f1dab66..a6db1e0317 100644 --- a/man/machine-info.xml +++ b/man/machine-info.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/machinectl.xml b/man/machinectl.xml index 9b07af4226..18ef6a5780 100644 --- a/man/machinectl.xml +++ b/man/machinectl.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -214,6 +217,18 @@ URL.</para></listitem> </varlistentry> + <varlistentry> + <term><option>--format=</option></term> + + <listitem><para>When used with the <option>export-tar</option> + or <option>export-raw</option> commands specifies the + compression format to use for the resulting file. Takes one of + <literal>uncompressed</literal>, <literal>xz</literal>, + <literal>gzip</literal>, <literal>bzip2</literal>. By default + the format is determined automatically from the image file + name passed.</para></listitem> + </varlistentry> + <xi:include href="user-system-options.xml" xpointer="host" /> <xi:include href="user-system-options.xml" xpointer="machine" /> @@ -469,19 +484,25 @@ <varlistentry> <term><command>clone</command> <replaceable>NAME</replaceable> <replaceable>NAME</replaceable></term> - <listitem><para>Clones a container or disk image. The + <listitem><para>Clones a container or VM image. The arguments specify the name of the image to clone and the name of the newly cloned image. Note that plain directory container images are cloned into subvolume images with this command. Note that cloning a container or VM image is optimized for btrfs file systems, and might not be efficient on others, due - to file system limitations.</para></listitem> + to file system limitations.</para> + + <para>Note that this command leaves host name, machine ID and + all other settings that could identify the instance + unmodified. The original image and the cloned copy will hence + share these credentials, and it might be necessary to manually + change them in the copy.</para></listitem> </varlistentry> <varlistentry> <term><command>rename</command> <replaceable>NAME</replaceable> <replaceable>NAME</replaceable></term> - <listitem><para>Renames a container or disk image. The + <listitem><para>Renames a container or VM image. The arguments specify the name of the image to rename and the new name of the image.</para></listitem> </varlistentry> @@ -489,22 +510,53 @@ <varlistentry> <term><command>read-only</command> <replaceable>NAME</replaceable> [<replaceable>BOOL</replaceable>]</term> - <listitem><para>Marks or (unmarks) a container or disk image + <listitem><para>Marks or (unmarks) a container or VM image read-only. Takes a VM or container image name, followed by a boolean as arguments. If the boolean is omitted, positive is implied, i.e. the image is marked read-only.</para></listitem> </varlistentry> - <varlistentry> <term><command>remove</command> <replaceable>NAME</replaceable>...</term> - <listitem><para>Removes one or more container or disk images. + <listitem><para>Removes one or more container or VM images. The special image <literal>.host</literal>, which refers to the host's own directory tree may not be removed.</para></listitem> </varlistentry> + <varlistentry> + <term><command>set-limit</command> [<replaceable>NAME</replaceable>] <replaceable>BYTES</replaceable></term> + + <listitem><para>Sets the maximum size in bytes a specific + container or VM image, or all images may grow up to on disk + (disk quota). Takes either one or two parameters. The first, + optional parameter refers to a container or VM image name. If + specified the size limit of the specified image is changed. If + omitted the overall size limit of the sum of all images stored + locally is changed. The final argument specifies the size + limit in bytes, possibly suffixed by the usual K, M, G, T + units. If the size limit shall be disabled, specify + <literal>-</literal> as size.</para> + + <para>Note that per-container size limits are only supported + on btrfs file systems. Also note that if + <command>set-limit</command> is invoked without image + parameter, and <filename>/var/lib/machines</filename> is + empty, and the directory is not located on btrfs, a btrfs + loopback file is implicitly created as + <filename>/var/lib/machines.raw</filename> with the given + size, and mounted to + <filename>/var/lib/machines</filename>. The size of the + loopback may later be readjusted with + <command>set-limit</command>, as well. If such a + loopback-mounted <filename>/var/lib/machines</filename> + directory is used <command>set-limit</command> without image + name alters both the quota setting within the file system as + well as the loopback file and file system size + itself.</para></listitem> + </varlistentry> + </variablelist></refsect2> <refsect2><title>Image Transfer Commands</title><variablelist> @@ -519,7 +571,7 @@ <literal>https://</literal>, and must refer to a <filename>.tar</filename>, <filename>.tar.gz</filename>, <filename>.tar.xz</filename> or <filename>.tar.bz2</filename> - archive file. If the local machine name is omitted the name it + archive file. If the local machine name is omitted it is automatically derived from the last component of the URL, with its suffix removed.</para> @@ -536,8 +588,8 @@ first verified with detached GPG signature file <filename>SHA256SUMS.gpg</filename>. The public key for this verification step needs to be available in - <filename>/usr/lib/systemd/import-pubring.gpg</filename> or - <filename>/etc/systemd/import-pubring.gpg</filename>.</para> + <filename>&rootlibexecdir;/import-pubring.gpg</filename> or + <filename>&pkgsysconfdir;/import-pubring.gpg</filename>.</para> <para>The container image will be downloaded and stored in a read-only subvolume in @@ -551,7 +603,7 @@ specify <literal>-</literal> as local machine name.</para> <para>Note that the read-only subvolume is prefixed with - <filename>.tar-</filename>, and is thus now shown by + <filename>.tar-</filename>, and is thus not shown by <command>list-images</command>, unless <option>--all</option> is passed.</para> @@ -572,7 +624,7 @@ be a <filename>.qcow2</filename> or raw disk image, optionally compressed as <filename>.gz</filename>, <filename>.xz</filename>, or <filename>.bz2</filename>. If the - local machine name is omitted the name it is automatically + local machine name is omitted it is automatically derived from the last component of the URL, with its suffix removed.</para> @@ -580,7 +632,7 @@ (see above).</para> <para>If the the downloaded image is in - <filename>.qcow2</filename> format it es converted into a raw + <filename>.qcow2</filename> format it is converted into a raw image file before it is made available.</para> <para>Downloaded images of this type will be placed as @@ -592,7 +644,7 @@ <para>Similar to the behaviour of <command>pull-tar</command>, the read-only image is prefixed with - <filename>.raw-</filename>, and thus now shown by + <filename>.raw-</filename>, and thus not shown by <command>list-images</command>, unless <option>--all</option> is passed.</para> @@ -624,7 +676,7 @@ <literal>-</literal> as local machine name.</para> <para>The read-only layer subvolumes are prefixed with - <filename>.dkr-</filename>, and thus now shown by + <filename>.dkr-</filename>, and thus not shown by <command>list-images</command>, unless <option>--all</option> is passed.</para> @@ -639,18 +691,77 @@ </varlistentry> <varlistentry> + <term><command>import-tar</command> <replaceable>FILE</replaceable> [<replaceable>NAME</replaceable>]</term> + <term><command>import-raw</command> <replaceable>FILE</replaceable> [<replaceable>NAME</replaceable>]</term> + <listitem><para>Imports a TAR or RAW container or VM image, + and places it under the specified name in + <filename>/var/lib/machines/</filename>. When + <command>import-tar</command> is used the file specified as + first argument should be a tar archive, possibly compressed + with xz, gzip or bzip2. It will then be unpacked into its own + subvolume in <filename>/var/lib/machines</filename>. When + <command>import-raw</command> is used the file should be a + qcow2 or raw disk image, possibly compressed with xz, gzip or + bzip2. If the second argument (the resulting image name) is + not specified it is automatically derived from the file + name. If the file name is passed as <literal>-</literal> the + image is read from standard input, in which case the second + argument is mandatory.</para> + + <para>Similar as with <command>pull-tar</command>, + <command>pull-raw</command> the file system + <filename>/var/lib/machines.raw</filename> is increased in + size of necessary and appropriate. Optionally the + <option>--read-only</option> switch may be used to create a + read-only container or VM image. No cryptographic validation + is done when importing the images.</para> + + <para>Much like image downloads, ongoing imports may be listed + with <command>list-transfers</command> and aborted with + <command>cancel-transfer</command>.</para></listitem> + </varlistentry> + + <varlistentry> + <term><command>export-tar</command> <replaceable>NAME</replaceable> [<replaceable>FILE</replaceable>]</term> + <term><command>export-raw</command> <replaceable>NAME</replaceable> [<replaceable>FILE</replaceable>]</term> + <listitem><para>Exports a TAR or RAW container or VM image and + stores it in the specified file. The first parameter should be + a VM or container image name. The second parameter should be a + file path the TAR or RAW image is written to. If the path ends + in <literal>.gz</literal> the file is compressed with gzip, if + it ends in <literal>.xz</literal> with xz, and if it ends in + <literal>.bz2</literal> with bzip2. If the path ends in + neither the file is left uncompressed. If the second argument + is missing the image is written to standard output. The + compression may also be explicitly selected with the + <option>--format=</option> switch. This is in particular + useful if the second parameter is left unspecified.</para> + + <para>Much like image downloads and imports, ongoing exports + may be listed with <command>list-transfers</command> and + aborted with + <command>cancel-transfer</command>.</para> + + <para>Note that currently only directory and subvolume images + may be exported as TAR images, and only raw disk images as RAW + images.</para></listitem> + </varlistentry> + + <varlistentry> <term><command>list-transfers</command></term> <listitem><para>Shows a list of container or VM image - downloads that are currently in progress.</para></listitem> + downloads, imports and exports that are currently in + progress.</para></listitem> </varlistentry> <varlistentry> <term><command>cancel-transfers</command> <replaceable>ID</replaceable>...</term> - <listitem><para>Aborts download of the container or VM image - with the specified ID. To list ongoing transfers and their - IDs, use <command>list-transfers</command>. </para></listitem> + <listitem><para>Aborts a download, import or export of the + container or VM image with the specified ID. To list ongoing + transfers and their IDs, use + <command>list-transfers</command>. </para></listitem> </varlistentry> </variablelist></refsect2> @@ -671,6 +782,19 @@ <filename>/var/lib/machines/</filename> to make them available for control with <command>machinectl</command>.</para> + <para>Note that many image operations are only supported, + efficient or atomic on btrfs file systems. Due to this, if the + <command>pull-tar</command>, <command>pull-raw</command>, + <command>pull-dkr</command>, <command>import-tar</command>, + <command>import-raw</command> and <command>set-limit</command> + commands notice that <filename>/var/lib/machines</filename> is + empty and not located on btrfs, they will implicitly set up a + loopback file <filename>/var/lib/machines.raw</filename> + containing a btrfs file system that is mounted to + <filename>/var/lib/machines</filename>. The size of this loopback + file may be controlled dynamically with + <command>set-limit</command>.</para> + <para>Disk images are understood by <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> and <command>machinectl</command> in three formats:</para> @@ -715,11 +839,12 @@ <title>Download a Fedora image, set a root password in it, start it as service</title> - <programlisting># machinectl pull-raw --verify=no - http://ftp.halifax.rwth-aachen.de/fedora/linux/releases/21/Cloud/Images/x86_64/Fedora-Cloud-Base-20141203-21.x86_64.raw.xz - # systemd-nspawn -M Fedora-Cloud-Base-20141203-21 # passwd # - exit # machinectl start Fedora-Cloud-Base-20141203-21 # - machinectl login Fedora-Cloud-Base-20141203-21</programlisting> + <programlisting># machinectl pull-raw --verify=no http://ftp.halifax.rwth-aachen.de/fedora/linux/releases/21/Cloud/Images/x86_64/Fedora-Cloud-Base-20141203-21.x86_64.raw.xz +# systemd-nspawn -M Fedora-Cloud-Base-20141203-21 +# passwd +# exit +# machinectl start Fedora-Cloud-Base-20141203-21 +# machinectl login Fedora-Cloud-Base-20141203-21</programlisting> <para>This downloads the specified <filename>.raw</filename> image with verification disabled. Then a shell is opened in it @@ -739,6 +864,17 @@ index server to be specified with the <literal>--dkr-index-url=</literal>.</para> </example> + + <example> + <title>Exports a container image as tar file</title> + + <programlisting># machinectl export-tar fedora myfedora.tar.xz</programlisting> + + <para>Exports the container <literal>fedora</literal> in an + xz-compress tar file <filename>myfedora.tar.xz</filename> in the + current directory.</para> + </example> + </refsect1> <refsect1> @@ -755,7 +891,11 @@ <para> <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>tar</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>xz</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>gzip</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>bzip2</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/modules-load.d.xml b/man/modules-load.d.xml index 34a937db68..82a98be666 100644 --- a/man/modules-load.d.xml +++ b/man/modules-load.d.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -94,7 +97,7 @@ virtio-net</programlisting> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/networkctl.xml b/man/networkctl.xml index d11d60f2a9..402698cb12 100644 --- a/man/networkctl.xml +++ b/man/networkctl.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/nss-myhostname.xml b/man/nss-myhostname.xml index cf2b0200f2..7379213f81 100644 --- a/man/nss-myhostname.xml +++ b/man/nss-myhostname.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -90,7 +93,7 @@ requires a writable <filename>/etc</filename> file system and is fragile because the file might be edited by the administrator at the same time. With <command>nss-myhostname</command> enabled - changing <filename>/etc/hosts</filename> is unncessary, and on + changing <filename>/etc/hosts</filename> is unnecessary, and on many systems the file becomes entirely optional.</para> <para>To activate the NSS modules, <literal>myhostname</literal> diff --git a/man/nss-mymachines.xml b/man/nss-mymachines.xml index eb1ed2592b..a3e6c75d1b 100644 --- a/man/nss-mymachines.xml +++ b/man/nss-mymachines.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/os-release.xml b/man/os-release.xml index 1b71a49d05..6ce5885812 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -104,8 +107,7 @@ <para>For a longer rationale for <filename>os-release</filename> please refer to the <ulink - url="http://0pointer.de/blog/projects/os-release">Announcement of - <filename>/etc/os-release</filename></ulink>.</para> + url="http://0pointer.de/blog/projects/os-release">Announcement of <filename>/etc/os-release</filename></ulink>.</para> </refsect1> <refsect1> @@ -274,6 +276,41 @@ </para></listitem> </varlistentry> + <varlistentry> + <term><varname>VARIANT=</varname></term> + + <listitem><para> + A string identifying a specific variant or edition of the + operating system suitable for presentation to the user. This + field may be used to inform the user that the configuration of + this system is subject to a specific divergent set of rules or + default configuration settings. This field is optional and may + not be implemented on all systems. + Examples: + <literal>VARIANT="Server Edition"</literal>, + <literal>VARIANT="Smart Refrigerator Edition"</literal> + Note: this field is for display purposes only. The + <varname>VARIANT_ID</varname> field should be used for making + programmatic decisions. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><varname>VARIANT_ID=</varname></term> + + <listitem><para> + A lower-case string (no spaces or other characters outside of + 0-9, a-z, ".", "_" and "-"), identifying a specific variant or + edition of the operating system. This may be interpreted by + other packages in order to determine a divergent default + configuration. This field is optional and may not be + implemented on all systems. + Examples: + <literal>VARIANT_ID=server</literal>, + <literal>VARIANT_ID=embedded</literal> + </para></listitem> + </varlistentry> + </variablelist> <para>If you are reading this file from C code or a shell script @@ -316,7 +353,7 @@ BUG_REPORT_URL="https://bugzilla.redhat.com/"</programlisting> <title>See Also</title> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>lsb_release</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>lsb_release</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry> diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index b4a3f502b4..6fdbcf91e0 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/resolved.conf.xml b/man/resolved.conf.xml index 36cae2706c..52329eba56 100644 --- a/man/resolved.conf.xml +++ b/man/resolved.conf.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -49,10 +52,10 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/resolved.conf</filename></para> - <para><filename>/etc/systemd/resolved.conf.d/*.conf</filename></para> + <para><filename>&pkgsysconfdir;/resolved.conf</filename></para> + <para><filename>&pkgsysconfdir;/resolved.conf.d/*.conf</filename></para> <para><filename>/run/systemd/resolved.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/resolved.conf.d/*.conf</filename></para> + <para><filename>&rootlibexecdir;/resolved.conf.d/*.conf</filename></para> </refsynopsisdiv> <refsect1> @@ -63,8 +66,7 @@ </refsect1> - <xi:include href="standard-conf.xml" xpointer="confd" /> - <xi:include href="standard-conf.xml" xpointer="conf" /> + <xi:include href="standard-conf.xml" xpointer="main-conf" /> <refsect1> <title>Options</title> diff --git a/man/runlevel.xml b/man/runlevel.xml index fc1f523855..f34f9583e8 100644 --- a/man/runlevel.xml +++ b/man/runlevel.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index b7ba363656..686ba0cefe 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd-id128.xml b/man/sd-id128.xml index ea7972055d..067d43b432 100644 --- a/man/sd-id128.xml +++ b/man/sd-id128.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd-journal.xml b/man/sd-journal.xml index 9b1a52207f..165284c0ae 100644 --- a/man/sd-journal.xml +++ b/man/sd-journal.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd-login.xml b/man/sd-login.xml index 328f71164d..4c4e5f0077 100644 --- a/man/sd-login.xml +++ b/man/sd-login.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_booted.xml b/man/sd_booted.xml index 4dd674b8ea..235e78d083 100644 --- a/man/sd_booted.xml +++ b/man/sd_booted.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_bus_creds_get_pid.xml b/man/sd_bus_creds_get_pid.xml index d61ec19cb8..54714dea1d 100644 --- a/man/sd_bus_creds_get_pid.xml +++ b/man/sd_bus_creds_get_pid.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2014 Zbigniew Jędrzejewski-Szmek + Copyright 2014 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="sd_bus_creds_get_pid" conditional="ENABLE_KDBUS"> @@ -44,9 +47,17 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <refnamediv> <refname>sd_bus_creds_get_pid</refname> + <refname>sd_bus_creds_get_ppid</refname> <refname>sd_bus_creds_get_tid</refname> <refname>sd_bus_creds_get_uid</refname> + <refname>sd_bus_creds_get_euid</refname> + <refname>sd_bus_creds_get_suid</refname> + <refname>sd_bus_creds_get_fsuid</refname> <refname>sd_bus_creds_get_gid</refname> + <refname>sd_bus_creds_get_egid</refname> + <refname>sd_bus_creds_get_sgid</refname> + <refname>sd_bus_creds_get_fsgid</refname> + <refname>sd_bus_creds_get_supplementary_gids</refname> <refname>sd_bus_creds_get_comm</refname> <refname>sd_bus_creds_get_tid_comm</refname> <refname>sd_bus_creds_get_exe</refname> @@ -64,9 +75,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <refname>sd_bus_creds_get_selinux_context</refname> <refname>sd_bus_creds_get_audit_session_id</refname> <refname>sd_bus_creds_get_audit_login_uid</refname> + <refname>sd_bus_creds_get_tty</refname> <refname>sd_bus_creds_get_unique_name</refname> <refname>sd_bus_creds_get_well_known_names</refname> - <refname>sd_bus_creds_get_connection_name</refname> + <refname>sd_bus_creds_get_description</refname> <refpurpose>Retrieve fields from a credentials object</refpurpose> </refnamediv> @@ -82,13 +94,37 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. </funcprototype> <funcprototype> + <funcdef>int <function>sd_bus_creds_get_ppid</function></funcdef> + <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> + <paramdef>pid_t *<parameter>ppid</parameter></paramdef> + </funcprototype> + + <funcprototype> <funcdef>int <function>sd_bus_creds_get_tid</function></funcdef> <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> <paramdef>pid_t *<parameter>tid</parameter></paramdef> </funcprototype> <funcprototype> - <funcdef>int <function>sd_bus_creds_get_pid</function></funcdef> + <funcdef>int <function>sd_bus_creds_get_uid</function></funcdef> + <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> + <paramdef>uid_t *<parameter>uid</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef>int <function>sd_bus_creds_get_euid</function></funcdef> + <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> + <paramdef>uid_t *<parameter>uid</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef>int <function>sd_bus_creds_get_suid</function></funcdef> + <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> + <paramdef>uid_t *<parameter>uid</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef>int <function>sd_bus_creds_get_fsuid</function></funcdef> <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> <paramdef>uid_t *<parameter>uid</parameter></paramdef> </funcprototype> @@ -100,6 +136,30 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. </funcprototype> <funcprototype> + <funcdef>int <function>sd_bus_creds_get_egid</function></funcdef> + <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> + <paramdef>gid_t *<parameter>gid</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef>int <function>sd_bus_creds_get_sgid</function></funcdef> + <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> + <paramdef>gid_t *<parameter>gid</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef>int <function>sd_bus_creds_get_fsgid</function></funcdef> + <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> + <paramdef>gid_t *<parameter>gid</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef>int <function>sd_bus_creds_get_supplementary_gids</function></funcdef> + <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> + <paramdef>const gid_t **<parameter>gids</parameter></paramdef> + </funcprototype> + + <funcprototype> <funcdef>int <function>sd_bus_creds_get_comm</function></funcdef> <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> <paramdef>const char **<parameter>comm</parameter></paramdef> @@ -202,6 +262,12 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. </funcprototype> <funcprototype> + <funcdef>int <function>sd_bus_creds_get_tty</function></funcdef> + <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> + <paramdef>const char **<parameter>tty</parameter></paramdef> + </funcprototype> + + <funcprototype> <funcdef>int <function>sd_bus_creds_get_unique_name</function></funcdef> <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> <paramdef>const char **<parameter>name</parameter></paramdef> @@ -214,7 +280,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. </funcprototype> <funcprototype> - <funcdef>int <function>sd_bus_creds_get_connection_name</function></funcdef> + <funcdef>int <function>sd_bus_creds_get_description</function></funcdef> <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> <paramdef>const char **<parameter>name</parameter></paramdef> </funcprototype> @@ -226,26 +292,43 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <title>Description</title> <para>These functions return information from an - <parameter>sd_bus_creds</parameter> object. It may be created with + <parameter>sd_bus_creds</parameter> credential object. Credential + objects may be created with <citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - in which case it will describe the specified process, or it may be - created by + in which case they describe the credentials of the process + identified by the specified PID, with + <citerefentry><refentrytitle>sd_bus_get_name_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + in which case they describe the credentials of a bus peer + identified by the specified bus name, or with <citerefentry><refentrytitle>sd_bus_get_owner_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - in which case it will describe the process at the other endpoint - of a connection. - </para> + in which case they describe the credentials of the creator of a + bus.</para> - <para><function>sd_bus_creds_get_pid()</function> will retrieve the - PID (process identifier).</para> + <para><function>sd_bus_creds_get_pid()</function> will retrieve + the PID (process identifier). Similar, + <function>sd_bus_creds_get_ppid()</function> will retrieve the + parent PID. Note that PID 1 has no parent process, in which case + -ENXIO is returned.</para> <para><function>sd_bus_creds_get_tid()</function> will retrieve the TID (thread identifier).</para> - <para><function>sd_bus_creds_get_uid()</function> will retrieve the - numeric UID (user identifier).</para> + <para><function>sd_bus_creds_get_uid()</function> will retrieve + the numeric UID (user identifier). Similar, + <function>sd_bus_creds_get_euid()</function> returns the effective + UID, <function>sd_bus_creds_get_suid()</function> the saved UID + and <function>sd_bus_creds_get_fsuid()</function> the file system + UID.</para> <para><function>sd_bus_creds_get_gid()</function> will retrieve the - numeric GID (group identifier).</para> + numeric GID (group identifier). Similar, + <function>sd_bus_creds_get_egid()</function> returns the effective + GID, <function>sd_bus_creds_get_sgid()</function> the saved GID + and <function>sd_bus_creds_get_fsgid()</function> the file system + GID.</para> + + <para><function>sd_bus_creds_get_supplementary_gids()</function> + will retrieve the supplementary GIDs list.</para> <para><function>sd_bus_creds_get_comm()</function> will retrieve the comm field (truncated name of the executable, as stored in @@ -257,32 +340,36 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <filename>/proc/<replaceable>pid</replaceable>/task/<replaceable>tid</replaceable>/comm</filename>). </para> - <para><function>sd_bus_creds_get_exe()</function> will retrieve the - path to the program (as stored in the + <para><function>sd_bus_creds_get_exe()</function> will retrieve + the path to the program executable (as stored in the <filename>/proc/<replaceable>pid</replaceable>/exe</filename> - link, but with <literal> (deleted)</literal> suffix removed). - </para> + link, but with <literal> (deleted)</literal> suffix removed). Note + that kernel threads do not have an executable path, in which case + -ENXIO is returned.</para> - <para><function>sd_bus_creds_get_cmdline()</function> will retrieve - an array of command line arguments (as stored in - <filename>/proc/<replaceable>pid</replaceable>/cmdline</filename>). - </para> + <para><function>sd_bus_creds_get_cmdline()</function> will + retrieve an array of command line arguments (as stored in + <filename>/proc/<replaceable>pid</replaceable>/cmdline</filename>). Note + that kernel threads do not have a command line, in which case + -ENXIO is returned.</para> <para><function>sd_bus_creds_get_cgroup()</function> will retrieve the cgroup path. See <ulink url="https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>. </para> - <para><function>sd_bus_creds_get_unit()</function> will retrieve the - systemd unit name (in the system instance of systemd) that the + <para><function>sd_bus_creds_get_unit()</function> will retrieve + the systemd unit name (in the system instance of systemd) that the process is part of. See - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. For + processes that are not part of a unit returns -ENXIO. </para> <para><function>sd_bus_creds_get_user_unit()</function> will retrieve the systemd unit name (in the user instance of systemd) that the process is part of. See - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. For + processes that are not part of a user unit returns -ENXIO. </para> <para><function>sd_bus_creds_get_slice()</function> will retrieve @@ -291,17 +378,17 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>. </para> - <para><function>sd_bus_creds_get_session()</function> will retrieve - the logind session that the process is part of. See - <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + <para><function>sd_bus_creds_get_session()</function> will + retrieve the logind session that the process is part of. See + <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. For + processes that are not part of a session returns -ENXIO. </para> - <para><function>sd_bus_creds_get_owner_uid()</function> will retrieve - the numeric UID (user identifier) of the user who owns the slice - that the process is part of. See + <para><function>sd_bus_creds_get_owner_uid()</function> will + retrieve the numeric UID (user identifier) of the user who owns + the session that the process is part of. See <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry> - <!-- and - <citerefentry><refentrytitle>systemd-user-sessions.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> -->. + For processes that are not part of a session returns -ENXIO. </para> <para><function>sd_bus_creds_has_effective_cap()</function> will @@ -331,12 +418,18 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <para><function>sd_bus_creds_get_selinux_context()</function> will retrieve the SELinux security context (label) of the process.</para> - <para><function>sd_bus_creds_get_audit_session_id()</function> will - retrieve the audit session identifier of the process.</para> + <para><function>sd_bus_creds_get_audit_session_id()</function> + will retrieve the audit session identifier of the process. Returns + -ENXIO for processes that are not part of an audit session.</para> <para><function>sd_bus_creds_get_audit_login_uid()</function> will retrieve the audit user login identifier (the identifier of the - user who is "responsible" for the session).</para> + user who is "responsible" for the session). Returns -ENXIO for + processes that are not part of an audit session.</para> + + <para><function>sd_bus_creds_get_tty()</function> will retrieve + the controlling TTY. Returns -ENXIO for processes that have no + controlling TTY.</para> <para><function>sd_bus_creds_get_unique_name()</function> will retrieve the D-Bus unique name. See <ulink @@ -348,11 +441,11 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-bus">The D-Bus specification</ulink>.</para> - <para><function>sd_bus_creds_get_connection_name()</function> will + <para><function>sd_bus_creds_get_description()</function> will retrieve a descriptive name of the bus connection of the peer. This name is useful to discern multiple bus connections by the same peer, and may be altered by the peer with the - <citerefentry><refentrytitle>sd_bus_set_name()</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry><refentrytitle>sd_bus_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry> call.</para> <para>All functions that take a <parameter>const @@ -363,7 +456,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <para>All functions that take a <parameter>char***</parameter> parameter will store the answer there as an address of a an array - of strings. Each invidividual string is NUL-terminated, and the + of strings. Each individual string is NUL-terminated, and the array is NULL-terminated as a whole. It will be valid as long as <parameter>c</parameter> remains valid, and should not be freed or modified by the caller.</para> @@ -386,34 +479,37 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <varlistentry> <term><constant>-ENODATA</constant></term> - <listitem><para>Given field is not available in - <parameter>c</parameter>.</para> + <listitem><para>Given field is not available in the + credentials object <parameter>c</parameter>.</para> </listitem> </varlistentry> <varlistentry> - <term><constant>-ENOENT</constant></term> + <term><constant>-ENXIO</constant></term> - <listitem><para>Given field is not specified for the sender. - This will be returned by <function>sd_bus_get_unit()</function>, + <listitem><para>Given field is not specified for the described + process or peer. This will be returned by + <function>sd_bus_get_unit()</function>, <function>sd_bus_get_user_unit()</function>, <function>sd_bus_get_slice()</function>, <function>sd_bus_get_session()</function>, and - <function>sd_bus_get_name_creds_uid()</function> if the sender is not - part of a systemd system unit, systemd user unit, systemd - slice, logind session, or a systemd user session.</para> + <function>sd_bus_get_owner_uid()</function> if the process is + not part of a systemd system unit, systemd user unit, systemd + slice, or logind session. It will also be returned by + <function>sd_bus_creds_get_exe()</function> and + <function>sd_bus_creds_get_cmdline()</function> for kernel + threads (since these aren't started from an executable binary + or have a command line), + <function>sd_bus_creds_get_audit_session_id()</function> and + <function>sd_bus_creds_get_audit_login_uid()</function> when + the process is not part of an audit session, and + <function>sd_bus_creds_get_tty()</function> if the process has + no controlling TTY. + </para> </listitem> </varlistentry> <varlistentry> - <term><constant>-ENXIO</constant></term> - - <listitem><para>An error occurred in parsing cgroup paths. - <filename>libsystemd</filename> might be out of sync with - the running systemd version.</para></listitem> - </varlistentry> - - <varlistentry> <term><constant>-EINVAL</constant></term> <listitem><para>Specified pointer parameter is <constant>NULL</constant>. @@ -449,7 +545,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <citerefentry project='man-pages'><refentrytitle>credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.journald-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/sd_bus_creds_new_from_pid.xml b/man/sd_bus_creds_new_from_pid.xml index 518a95abd0..695d4e1f5a 100644 --- a/man/sd_bus_creds_new_from_pid.xml +++ b/man/sd_bus_creds_new_from_pid.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_bus_open_user.xml b/man/sd_bus_default.xml index e7a765962a..55f1b8bb69 100644 --- a/man/sd_bus_open_user.xml +++ b/man/sd_bus_default.xml @@ -1,30 +1,33 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2014 Zbigniew Jędrzejewski-Szmek + Copyright 2014 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> -<refentry id="sd_bus_open_user" conditional="ENABLE_KDBUS"> +<refentry id="sd_bus_default" conditional="ENABLE_KDBUS"> <refentryinfo> - <title>sd_bus_open_user</title> + <title>sd_bus_default</title> <productname>systemd</productname> <authorgroup> @@ -38,20 +41,22 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. </refentryinfo> <refmeta> - <refentrytitle>sd_bus_open_user</refentrytitle> + <refentrytitle>sd_bus_default</refentrytitle> <manvolnum>3</manvolnum> </refmeta> <refnamediv> + <refname>sd_bus_default</refname> + <refname>sd_bus_default_user</refname> + <refname>sd_bus_default_system</refname> + + <refname>sd_bus_open</refname> <refname>sd_bus_open_user</refname> <refname>sd_bus_open_system</refname> <refname>sd_bus_open_system_remote</refname> - <refname>sd_bus_open_system_container</refname> - - <refname>sd_bus_default_user</refname> - <refname>sd_bus_default_system</refname> + <refname>sd_bus_open_system_machine</refname> - <refpurpose>Open a connection to the system or user bus</refpurpose> + <refpurpose>Acquire a connection to a system or user bus</refpurpose> </refnamediv> <refsynopsisdiv> @@ -59,47 +64,90 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo> <funcprototype> - <funcdef>int <function>sd_bus_open_user</function></funcdef> + <funcdef>int <function>sd_bus_default</function></funcdef> <paramdef>sd_bus **<parameter>bus</parameter></paramdef> </funcprototype> <funcprototype> - <funcdef>int <function>sd_bus_open_system</function></funcdef> + <funcdef>int <function>sd_bus_default_user</function></funcdef> <paramdef>sd_bus **<parameter>bus</parameter></paramdef> </funcprototype> <funcprototype> - <funcdef>int <function>sd_bus_open_system_remote</function></funcdef> - <paramdef>const char *<parameter>host</parameter></paramdef> + <funcdef>int <function>sd_bus_default_system</function></funcdef> <paramdef>sd_bus **<parameter>bus</parameter></paramdef> </funcprototype> <funcprototype> - <funcdef>int <function>sd_bus_open_system_container</function></funcdef> - <paramdef>const char *<parameter>machine</parameter></paramdef> + <funcdef>int <function>sd_bus_open</function></funcdef> <paramdef>sd_bus **<parameter>bus</parameter></paramdef> </funcprototype> <funcprototype> - <funcdef>int <function>sd_bus_default_user</function></funcdef> + <funcdef>int <function>sd_bus_open_user</function></funcdef> <paramdef>sd_bus **<parameter>bus</parameter></paramdef> </funcprototype> <funcprototype> - <funcdef>int <function>sd_bus_default_system</function></funcdef> + <funcdef>int <function>sd_bus_open_system</function></funcdef> <paramdef>sd_bus **<parameter>bus</parameter></paramdef> </funcprototype> + + <funcprototype> + <funcdef>int <function>sd_bus_open_system_remote</function></funcdef> + <paramdef>sd_bus **<parameter>bus</parameter></paramdef> + <paramdef>const char *<parameter>host</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef>int <function>sd_bus_open_system_machine</function></funcdef> + <paramdef>sd_bus **<parameter>bus</parameter></paramdef> + <paramdef>const char *<parameter>machine</parameter></paramdef> + </funcprototype> + </funcsynopsis> </refsynopsisdiv> <refsect1> <title>Description</title> - <para><function>sd_bus_open_user()</function> creates a new bus - object and opens a connection to the user bus. - <function>sd_bus_open_system()</function> does the same, but + <para><function>sd_bus_default()</function> acquires a bus + connection object to the user bus when invoked in user context or + to the system bus otherwise. The connection object is associated + to the calling thread. Each time the function is invoked from the + same thread the same object is returned, but its reference count + increased by one, as long as at least one reference is kept. When + the last reference to the connection is dropped (using the + <function>sd_bus_unref()</function> call), the connection is + terminated. Note that the connection is not automatically + terminated when the associated thread ends. It is important to + drop the last reference to the bus connection explicitly before + the thread ends or otherwise the connection will be leaked.</para> + + <para><function>sd_bus_default_user()</function> returns a user + bus connection object associated to the calling thread. + <function>sd_bus_default_system()</function> is similar, but connects to the system bus.</para> + <para><function>sd_bus_open()</function> creates a new, + independent bus connection to the user bus when invoked in user + context or the system bus + otherwise. <function>sd_bus_open_user()</function> is similar, but + connects only to the user bus. + <function>sd_bus_open_system()</function> does the same, but + connects to the system bus. In contrast to + <function>sd_bus_default()</function>, + <function>sd_bus_default_user()</function>, + <function>sd_bus_default_system()</function> these calls return + new, independent connection objects that are not associated with + the invoking thread and are not shared between multiple + invocations. It is recommended to share connections per thread to + efficiently make use the available resources. Thus, it is + recommended to use <function>sd_bus_default()</function>, + <function>sd_bus_default_user()</function>, + <function>sd_bus_default_system()</function> to connect to the + user or system buses.</para> + <para>If the <varname>$DBUS_SESSION_BUS_ADDRESS</varname> environment variable is set (cf. <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>), @@ -108,10 +156,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. this variable is not set, a suitable default for the default user D-Bus instance will be used.</para> - <para>If the <varname>$DBUS_SYSTEM_BUS_ADDRESS</varname> environment - variable is set, it will be used as the address of the system - bus. This variable uses the same syntax as - <varname>$DBUS_SESSION_BUS_ADDRESS</varname>/. If this variable is + <para>If the <varname>$DBUS_SYSTEM_BUS_ADDRESS</varname> + environment variable is set, it will be used as the address of the + system bus. This variable uses the same syntax as + <varname>$DBUS_SESSION_BUS_ADDRESS</varname>. If this variable is not set, a suitable default for the default system D-Bus instance will be used.</para> @@ -123,20 +171,11 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <para><function>sd_bus_open_system_container()</function> connects to the system bus in the specified <parameter>machine</parameter>, - where <parameter>machine</parameter> is the name of a container. - See + where <parameter>machine</parameter> is the name of a local + container. See <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> for more information about "machines".</para> - <para><function>sd_bus_default_user()</function> returns a bus - object connected to the user bus. Each thread has its own object, but it - may be passed around. It is created on the first invocation of - <function>sd_bus_default_user()</function>, and subsequent - invocations returns a reference to the same object.</para> - - <para><function>sd_bus_default_system()</function> is similar to - <function>sd_bus_default_user()</function>, but connects to the - system bus.</para> </refsect1> <refsect1> @@ -149,7 +188,8 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <refsect1> <title>Reference ownership</title> - <para>Functions <function>sd_bus_open_user()</function>, + <para>The functions <function>sd_bus_open_user()</function>, + <function>sd_bus_open()</function>, <function>sd_bus_open_system()</function>, <function>sd_bus_open_system_remote()</function>, and <function>sd_bus_open_system_machine()</function> return a new @@ -158,9 +198,13 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <citerefentry><refentrytitle>sd_bus_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>. </para> - <para>The functions <function>sd_bus_default_user()</function> and - <function>sd_bus_default_system()</function> do not create a new - reference.</para> + <para>The functions <function>sd_bus_default()</function>, + <function>sd_bus_default_user()</function> and + <function>sd_bus_default_system()</function> do not necessarily + create a new object, but increase the connection reference by + one. Use + <citerefentry><refentrytitle>sd_bus_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry> + to drop the reference.</para> </refsect1> <refsect1> @@ -173,9 +217,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <varlistentry> <term><constant>-EINVAL</constant></term> - <listitem><para>Specified parameter is invalid - (<constant>NULL</constant> in case of output - parameters).</para></listitem> + <listitem><para>The specified parameters are invalid.</para></listitem> </varlistentry> <varlistentry> @@ -184,18 +226,25 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <listitem><para>Memory allocation failed.</para></listitem> </varlistentry> - <para>In addition, any further connection-related errors may be - by returned. See <citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> + <varlistentry> + <term><constant>-ESOCKTNOSUPPORT</constant></term> + + <listitem><para>The protocol version required to connect to the selected bus is not supported.</para></listitem> + </varlistentry> </variablelist> + + <para>In addition, any further connection-related errors may be + by returned. See <citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> </refsect1> <refsect1> <title>Notes</title> - <para><function>sd_bus_open_user()</function> and other functions - described here are available as a shared library, which can be - compiled and linked to with the - <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <para><function>sd_bus_open_user()</function> and the other + functions described here are available as a shared library, which + can be compiled and linked to with the + <constant>libsystemd</constant> <citerefentry + project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> @@ -208,7 +257,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> diff --git a/man/sd_bus_error.xml b/man/sd_bus_error.xml index d1929c217a..bd2a27984c 100644 --- a/man/sd_bus_error.xml +++ b/man/sd_bus_error.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2014 Zbigniew Jędrzejewski-Szmek + Copyright 2014 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="sd_bus_error" conditional="ENABLE_KDBUS"> @@ -281,7 +284,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <para><function>sd_bus_error_set_errno</function> will set <structfield>name</structfield> based on an errno-like value. - <citerefentry><refentrytitle>strerror</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>strerror</refentrytitle><manvolnum>3</manvolnum></citerefentry> will be used to set <structfield>message</structfield>. Well-known D-Bus error names will be used for <structfield>name</structfield> if available, otherwise a name in the @@ -408,7 +411,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>strerror</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>strerror</refentrytitle><manvolnum>3</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/sd_bus_message_append.xml b/man/sd_bus_message_append.xml index 0c49a0c7c9..91a80792e1 100644 --- a/man/sd_bus_message_append.xml +++ b/man/sd_bus_message_append.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -87,7 +90,7 @@ Arguments corresponding to this nested sequence follow the same rules as if they were not nested.</para> - <para>A variant is denoted by <literal>v</literal>. Correspoding + <para>A variant is denoted by <literal>v</literal>. Corresponding arguments must include a format string denoting a complete type, and following that, arguments corresponding to the specified type. </para> @@ -245,7 +248,7 @@ sd_bus_message_append(m, "ynqiuxtd", y, n, q, i, u, x, t, d);</programlisting> <citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> diff --git a/man/sd_bus_message_append_array.xml b/man/sd_bus_message_append_array.xml index fe81affdc4..5409893374 100644 --- a/man/sd_bus_message_append_array.xml +++ b/man/sd_bus_message_append_array.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2014 Zbigniew Jędrzejewski-Szmek + Copyright 2014 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="sd_bus_message_append_array" conditional="ENABLE_KDBUS" diff --git a/man/sd_bus_message_append_basic.xml b/man/sd_bus_message_append_basic.xml index 344b7791fa..81ac6de952 100644 --- a/man/sd_bus_message_append_basic.xml +++ b/man/sd_bus_message_append_basic.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_bus_message_append_string_memfd.xml b/man/sd_bus_message_append_string_memfd.xml index 5b4a792cd7..1fecbd5773 100644 --- a/man/sd_bus_message_append_string_memfd.xml +++ b/man/sd_bus_message_append_string_memfd.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2014 Zbigniew Jędrzejewski-Szmek + Copyright 2014 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="sd_bus_message_append_string_memfd" conditional="ENABLE_KDBUS" diff --git a/man/sd_bus_message_append_strv.xml b/man/sd_bus_message_append_strv.xml index b91406f275..d986b06a41 100644 --- a/man/sd_bus_message_append_strv.xml +++ b/man/sd_bus_message_append_strv.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_bus_message_get_cookie.xml b/man/sd_bus_message_get_cookie.xml index 02374d7508..7795acfec3 100644 --- a/man/sd_bus_message_get_cookie.xml +++ b/man/sd_bus_message_get_cookie.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_bus_message_get_monotonic_usec.xml b/man/sd_bus_message_get_monotonic_usec.xml index 42842116a0..c109fe10a3 100644 --- a/man/sd_bus_message_get_monotonic_usec.xml +++ b/man/sd_bus_message_get_monotonic_usec.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -94,7 +97,7 @@ a global, monotonically increasing sequence number to all messages transmitted on the local system, at the time the message was sent. This sequence number is useful for determining message send order, - even across different busses of the local system. The sequence + even across different buses of the local system. The sequence number combined with the boot ID of the system (as returned by <citerefentry><refentrytitle>sd_id128_get_boot</refentrytitle><manvolnum>3</manvolnum></citerefentry>) is a suitable globally unique identifier for bus messages.</para> diff --git a/man/sd_bus_negotiate_fds.xml b/man/sd_bus_negotiate_fds.xml index 4babae5e2b..4f9204e7bc 100644 --- a/man/sd_bus_negotiate_fds.xml +++ b/man/sd_bus_negotiate_fds.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2014 Lennart Poettering + Copyright 2014 Lennart Poettering -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="sd_bus_negotiate_fds" conditional="ENABLE_KDBUS"> @@ -105,7 +108,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. this is disabled, <citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_get_seqno</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry><refentrytitle>sd_bus_message_get_seqnum</refentrytitle><manvolnum>3</manvolnum></citerefentry> fail with <constant>-ENODATA</constant> on incoming messages. Note that not all transports support timestamping of messages. On local transports, the timestamping is applied by the kernel and cannot diff --git a/man/sd_bus_new.xml b/man/sd_bus_new.xml index 91ca8161dc..bc91dd2665 100644 --- a/man/sd_bus_new.xml +++ b/man/sd_bus_new.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_bus_path_encode.xml b/man/sd_bus_path_encode.xml index 69cda53bf4..0a6ac80473 100644 --- a/man/sd_bus_path_encode.xml +++ b/man/sd_bus_path_encode.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_bus_request_name.xml b/man/sd_bus_request_name.xml index 6aa132bb26..78b440b7db 100644 --- a/man/sd_bus_request_name.xml +++ b/man/sd_bus_request_name.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_event_add_child.xml b/man/sd_event_add_child.xml index cf8ed0af6c..7de9f409e9 100644 --- a/man/sd_event_add_child.xml +++ b/man/sd_event_add_child.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2014 Zbigniew Jędrzejewski-Szmek + Copyright 2014 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="sd_event_add_child" conditional="ENABLE_KDBUS"> diff --git a/man/sd_event_add_defer.xml b/man/sd_event_add_defer.xml index dd5d19b519..4aabc0793a 100644 --- a/man/sd_event_add_defer.xml +++ b/man/sd_event_add_defer.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_event_add_signal.xml b/man/sd_event_add_signal.xml index 0299aa5a53..e84d5c7200 100644 --- a/man/sd_event_add_signal.xml +++ b/man/sd_event_add_signal.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2014 Zbigniew Jędrzejewski-Szmek + Copyright 2014 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="sd_event_add_signal" conditional="ENABLE_KDBUS"> @@ -86,7 +89,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. the <parameter>source</parameter> parameter. The <parameter>signal</parameter> parameter specifies the signal to be handled (see - <citerefentry><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>). + <citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>). The <parameter>handler</parameter> must reference a function to call when the signal is delivered or be <constant>NULL</constant>. The handler function will be passed the @@ -94,7 +97,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. freely by the caller. The handler also receives a pointer to a <structname>const struct signalfd_siginfo</structname> containing the information about the received signal. See - <citerefentry><refentrytitle>signalfd</refentrytitle><manvolnum>2</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>signalfd</refentrytitle><manvolnum>2</manvolnum></citerefentry> for further information.</para> <para>Only a single handler may be installed for a specific diff --git a/man/sd_event_add_time.xml b/man/sd_event_add_time.xml index c975f07de5..3c5de48cab 100644 --- a/man/sd_event_add_time.xml +++ b/man/sd_event_add_time.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -223,7 +226,7 @@ </varlistentry> <varlistentry> - <term><constant>-ENOTSUP</constant></term> + <term><constant>-EOPNOTSUPP</constant></term> <listitem><para>The selected clock is not supported by the event loop implementation.</para></listitem> diff --git a/man/sd_event_get_fd.xml b/man/sd_event_get_fd.xml index ff2f5f8668..8f74c1e5c4 100644 --- a/man/sd_event_get_fd.xml +++ b/man/sd_event_get_fd.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2014 Zbigniew Jędrzejewski-Szmek + Copyright 2014 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="sd_event_get_fd" conditional="ENABLE_KDBUS" diff --git a/man/sd_event_new.xml b/man/sd_event_new.xml index 854a887bce..d225330023 100644 --- a/man/sd_event_new.xml +++ b/man/sd_event_new.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_event_run.xml b/man/sd_event_run.xml new file mode 100644 index 0000000000..036887d9f0 --- /dev/null +++ b/man/sd_event_run.xml @@ -0,0 +1,186 @@ +<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> + +<!-- + This file is part of systemd. + + Copyright 2015 Zbigniew Jędrzejewski-Szmek + + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. + + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. +--> + +<refentry id="sd_event_run" conditional="ENABLE_KDBUS"> + + <refentryinfo> + <title>sd_event_run</title> + <productname>systemd</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Tom</firstname> + <surname>Gundersen</surname> + <email>teg@jklm.no</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>sd_event_run</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + + <refnamediv> + <refname>sd_event_run</refname> + <refname>sd_event_loop</refname> + + <refpurpose>Run libsystemd event loop</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo>#include <systemd/sd-event.h></funcsynopsisinfo> + + <funcprototype> + <funcdef>int <function>sd_event_run</function></funcdef> + <paramdef>sd_event *<parameter>event</parameter></paramdef> + <paramdef>uint64_t <parameter>timeout</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef>int <function>sd_event_loop</function></funcdef> + <paramdef>sd_event *<parameter>event</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><function>sd_event_run()</function> can be used to run one + iteration of the event loop of libsystemd. This function waits + until an event to process is available and dispatches a handler + for it. Parameter <parameter>timeout</parameter> specifices the + maximum time (in microseconds) to wait. <constant>(uint64_t) + -1</constant> may be used to specify an infinite timeout.</para> + + <para><function>sd_event_loop</function> runs + <function>sd_event_wait</function> in a loop with a timeout of + infinity. This makes it suitable for the main event loop of a + program.</para> + + <para>The event loop object <parameter>event</parameter> is + created with + <function>sd_event_new</function>. + Events to wait for and their handlers can be registered with + <function>sd_event_add_time</function>, + <function>sd_event_add_child</function>, + <function>sd_event_add_signal</function>, + <function>sd_event_add_defer</function>, + <function>sd_event_add_exit</function>, + and + <function>sd_event_add_post</function>. + </para> + + <para>For more fine-grained control, + <function>sd_event_prepare</function>, + <function>sd_event_wait</function>, and + <function>sd_event_dispatch</function> may be used. Along with + <function>sd_event_get_fd</function>, those functions make it + possible to integrate the libsystemd loop inside of another event + loop.</para> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para>On success, these functions return 0 or a positive integer. + On failure, they return a negative errno-style error code. + <function>sd_event_run</function> returns 0 if the event loop is + finished, and a positive value if it can be continued.</para> + </refsect1> + + <refsect1> + <title>Errors</title> + + <para>Returned errors may indicate the following problems:</para> + + <variablelist> + <varlistentry> + <term><constant>-EINVAL</constant></term> + + <listitem><para>Parameter <parameter>event</parameter> is + <constant>NULL</constant>.</para></listitem> + </varlistentry> + + <varlistentry> + <term><constant>-EBUSY</constant></term> + + <listitem><para>The event loop object is not in the right + state (see + <citerefentry><refentrytitle>sd_event_prepare</refentrytitle><manvolnum>3</manvolnum></citerefentry> + for an explanation of possible states).</para></listitem> + </varlistentry> + + <varlistentry> + <term><constant>-ESTALE</constant></term> + + <listitem><para>The event loop is already terminated.</para></listitem> + + </varlistentry> + + <varlistentry> + <term><constant>-ECHILD</constant></term> + + <listitem><para>The event loop has been created in a different process.</para></listitem> + + </varlistentry> + + </variablelist> + + <para>Other errors are possible too.</para> + </refsect1> + + <refsect1> + <title>Notes</title> + + <para><function>sd_event_run()</function> and + <function>sd_event_loop()</function> are available + as a shared library, which can be compiled and linked to with the + <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> + file.</para> + </refsect1> + + <refsect1> + <title>See Also</title> + + <para> + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_add_post</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <ulink url="https://developer.gnome.org/glib/unstable/glib-The-Main-Event-Loop.html">GLIb Main Event Loop</ulink>. + </para> + </refsect1> + +</refentry> diff --git a/man/sd_event_set_name.xml b/man/sd_event_set_name.xml index 627ebe479e..0b46414bba 100644 --- a/man/sd_event_set_name.xml +++ b/man/sd_event_set_name.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2014 Zbigniew Jędrzejewski-Szmek + Copyright 2014 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="sd_event_set_name" conditional="ENABLE_KDBUS" diff --git a/man/sd_event_wait.xml b/man/sd_event_wait.xml new file mode 100644 index 0000000000..db74a96e8e --- /dev/null +++ b/man/sd_event_wait.xml @@ -0,0 +1,216 @@ +<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> + +<!-- + This file is part of systemd. + + Copyright 2015 Zbigniew Jędrzejewski-Szmek + + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. + + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. +--> + +<refentry id="sd_event_wait" conditional="ENABLE_KDBUS"> + + <refentryinfo> + <title>sd_event_wait</title> + <productname>systemd</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Tom</firstname> + <surname>Gundersen</surname> + <email>teg@jklm.no</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>sd_event_wait</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + + <refnamediv> + <refname>sd_event_wait</refname> + <refname>sd_event_prepare</refname> + <refname>sd_event_dispatch</refname> + + <refpurpose>Run parts of libsystemd event loop</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo>#include <systemd/sd-event.h></funcsynopsisinfo> + + <funcprototype> + <funcdef>int <function>sd_event_prepare</function></funcdef> + <paramdef>sd_event *<parameter>event</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef>int <function>sd_event_wait</function></funcdef> + <paramdef>sd_event *<parameter>event</parameter></paramdef> + <paramdef>uint64_t <parameter>timeout</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef>int <function>sd_event_dispatch</function></funcdef> + <paramdef>sd_event *<parameter>event</parameter></paramdef> + </funcprototype> + + </funcsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para>Functions described here form parts of an event loop.</para> + + <para><function>sd_event_prepare</function> checks for pending + events and arms necessary timers. If any events are ready to be + processed, it returns a positive value, and the events should be + processed with <function>sd_event_dispatch</function>. + <function>sd_event_dispatch</function> runs a handler for one of + the events from the sources with the highest priority. On success, + <function>sd_event_dispatch</function> returns either 0, which + means that the loop is finished, or a positive value, which means + that the loop is again in the initial state and + <function>sd_event_prepare</function> should be called again. + </para> + + <para>In case <function>sd_event_prepare</function> returned 0, + <function>sd_event_wait</function> should be called to wait for + events or a timeout. If any events are ready to be processed, it + returns a positive value, and the events should be processed with + <function>sd_event_dispatch</function>. Otherwise, the loop is + back in the initial state and <function>sd_event_prepare</function> + should be called again.</para> + + <programlisting> + ┌──────────┐ + │ initial ├──←←←←←←←←←←←←←←←←←←←─┐ + └───┬──────┘ ↑ + │ ↑ + sd_event_prepare ┌─────────┐ ↑ + ├ 0 →→→→→→→──┤ armed │ ↑ + 1 └───┬─────┘ ↑ + ↓ │ ↑ + ↓ sd_event_wait ↑ + ├───←←←←←←←─── 1 ┴─ 0 →→→→→→→─┘ + ┌───┴──────┐ ↑ + │ pending │ ↑ + └───┬──────┘ ↑ + │ ↑ + sd_event_dispatch ↑ + ↓ ↑ + ├ 1 ──────────→→→→→→→─────────┘ + 0 + ↓ + ┌───┴──────┐ + │ finished │ + └──────────┘ + </programlisting> + + <para>All three functions as the first argument take the event + loop object <parameter>event</parameter> that is created with with + <function>sd_event_new</function>. The timeout for + <function>sd_event_wait</function> is specified with + <parameter>timeout</parameter> in milliseconds. + <constant>(uint64_t) -1</constant> may be used to specify an + infinite timeout.</para> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para>On success, these functions return 0 or a positive integer. + On failure, they return a negative errno-style error code. In case + of <function>sd_event_prepare</function> and + <function>sd_event_wait</function> a positive value means that + events are ready to be processed and 0 means that no events are + ready. In case of <function>sd_event_dispatch</function> a + positive value means that the loop is again in the initial state + and 0 means the loop is finished. For any of those functions, a + negative return value means the loop must be aborted.</para> + </refsect1> + + <refsect1> + <title>Errors</title> + + <para>Returned errors may indicate the following problems:</para> + + <variablelist> + <varlistentry> + <term><constant>-EINVAL</constant></term> + + <listitem><para>Parameter <parameter>event</parameter> is + <constant>NULL</constant>.</para></listitem> + </varlistentry> + + <varlistentry> + <term><constant>-EBUSY</constant></term> + + <listitem><para>The event loop object is not in the right + state.</para></listitem> + </varlistentry> + + <varlistentry> + <term><constant>-ESTALE</constant></term> + + <listitem><para>The event loop is already terminated.</para></listitem> + + </varlistentry> + + <varlistentry> + <term><constant>-ECHILD</constant></term> + + <listitem><para>The event loop has been created in a different process.</para></listitem> + + </varlistentry> + + </variablelist> + + <para>Other errors are possible too.</para> + </refsect1> + + <refsect1> + <title>Notes</title> + + <para>Functions described here are available + as a shared library, which can be compiled and linked to with the + <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> + file.</para> + </refsect1> + + <refsect1> + <title>See Also</title> + + <para> + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_run</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_event_add_post</refentrytitle><manvolnum>3</manvolnum></citerefentry>. + </para> + </refsect1> + +</refentry> diff --git a/man/sd_get_seats.xml b/man/sd_get_seats.xml index 4390d36ebe..3f2c666c61 100644 --- a/man/sd_get_seats.xml +++ b/man/sd_get_seats.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_id128_get_machine.xml b/man/sd_id128_get_machine.xml index 2ad1f8f728..02fa2da283 100644 --- a/man/sd_id128_get_machine.xml +++ b/man/sd_id128_get_machine.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_id128_randomize.xml b/man/sd_id128_randomize.xml index ab449d2937..c4d7c42106 100644 --- a/man/sd_id128_randomize.xml +++ b/man/sd_id128_randomize.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_id128_to_string.xml b/man/sd_id128_to_string.xml index e70c80892e..988a646d84 100644 --- a/man/sd_id128_to_string.xml +++ b/man/sd_id128_to_string.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index 627cb87aaf..57dd6afc89 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_journal_add_match.xml b/man/sd_journal_add_match.xml index 420f56356a..fe89cbf75c 100644 --- a/man/sd_journal_add_match.xml +++ b/man/sd_journal_add_match.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_journal_get_catalog.xml b/man/sd_journal_get_catalog.xml index 1dcbadd186..2ff3fc2826 100644 --- a/man/sd_journal_get_catalog.xml +++ b/man/sd_journal_get_catalog.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -130,7 +133,7 @@ <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>malloc</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>malloc</refentrytitle><manvolnum>3</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/sd_journal_get_cursor.xml b/man/sd_journal_get_cursor.xml index 2b7f443f29..1d38bac7fb 100644 --- a/man/sd_journal_get_cursor.xml +++ b/man/sd_journal_get_cursor.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -84,7 +87,7 @@ time) available entry. The call takes two arguments: a journal context object and a pointer to a string pointer where the cursor string will be placed. The string is allocated via libc - <citerefentry><refentrytitle>malloc</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>malloc</refentrytitle><manvolnum>3</manvolnum></citerefentry> and should be freed after use with <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> diff --git a/man/sd_journal_get_cutoff_realtime_usec.xml b/man/sd_journal_get_cutoff_realtime_usec.xml index 23e7cc65e8..ae5e638d70 100644 --- a/man/sd_journal_get_cutoff_realtime_usec.xml +++ b/man/sd_journal_get_cutoff_realtime_usec.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_journal_get_data.xml b/man/sd_journal_get_data.xml index 1afbd7371c..b395fe01c9 100644 --- a/man/sd_journal_get_data.xml +++ b/man/sd_journal_get_data.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_journal_get_fd.xml b/man/sd_journal_get_fd.xml index 3a38f733ab..51dcb1aeeb 100644 --- a/man/sd_journal_get_fd.xml +++ b/man/sd_journal_get_fd.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_journal_get_realtime_usec.xml b/man/sd_journal_get_realtime_usec.xml index 607d74666b..921aa77ab6 100644 --- a/man/sd_journal_get_realtime_usec.xml +++ b/man/sd_journal_get_realtime_usec.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_journal_get_usage.xml b/man/sd_journal_get_usage.xml index 72c804d834..a89b77907c 100644 --- a/man/sd_journal_get_usage.xml +++ b/man/sd_journal_get_usage.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_journal_next.xml b/man/sd_journal_next.xml index 115fe26661..216d9a59c6 100644 --- a/man/sd_journal_next.xml +++ b/man/sd_journal_next.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_journal_open.xml b/man/sd_journal_open.xml index fb572802a3..f6aac75546 100644 --- a/man/sd_journal_open.xml +++ b/man/sd_journal_open.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_journal_print.xml b/man/sd_journal_print.xml index 068b10e7ca..6dbf73f9c1 100644 --- a/man/sd_journal_print.xml +++ b/man/sd_journal_print.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -119,7 +122,7 @@ <function>sd_journal_print()</function> but takes a variable argument list encapsulated in an object of type <varname>va_list</varname> (see - <citerefentry><refentrytitle>stdarg</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>stdarg</refentrytitle><manvolnum>3</manvolnum></citerefentry> for more information) instead of the format string. It is otherwise equivalent in behavior.</para> @@ -145,7 +148,7 @@ <function>sd_journal_send()</function> but takes an array of <varname>struct iovec</varname> (as defined in <filename>uio.h</filename>, see - <citerefentry><refentrytitle>readv</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>readv</refentrytitle><manvolnum>3</manvolnum></citerefentry> for details) instead of the format string. Each structure should reference one field of the entry to submit. The second argument specifies the number of structures in the array. @@ -154,7 +157,7 @@ necessary.</para> <para><function>sd_journal_perror()</function> is a similar to - <citerefentry><refentrytitle>perror</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>perror</refentrytitle><manvolnum>3</manvolnum></citerefentry> and writes a message to the journal that consists of the passed string, suffixed with ": " and a human readable representation of the current error code stored in @@ -219,7 +222,7 @@ sd_journal_send("MESSAGE=Hello World, this is PID %lu!", (unsigned long) getpid( <title>Async signal safety</title> <para><function>sd_journal_sendv()</function> is "async signal safe" in the meaning of - <citerefentry><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>. + <citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>. </para> <para><function>sd_journal_print</function>, @@ -249,11 +252,11 @@ sd_journal_send("MESSAGE=Hello World, this is PID %lu!", (unsigned long) getpid( <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>perror</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>perror</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/sd_journal_query_unique.xml b/man/sd_journal_query_unique.xml index ac0e5f633f..5c92f8972e 100644 --- a/man/sd_journal_query_unique.xml +++ b/man/sd_journal_query_unique.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_journal_seek_head.xml b/man/sd_journal_seek_head.xml index d74c2d5bbc..d4c13c21f8 100644 --- a/man/sd_journal_seek_head.xml +++ b/man/sd_journal_seek_head.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_journal_stream_fd.xml b/man/sd_journal_stream_fd.xml index 2ea7731b48..ae7990e212 100644 --- a/man/sd_journal_stream_fd.xml +++ b/man/sd_journal_stream_fd.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index 9b9705eb2e..38e159bb42 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_login_monitor_new.xml b/man/sd_login_monitor_new.xml index a7b47a3207..ef97dae1d0 100644 --- a/man/sd_login_monitor_new.xml +++ b/man/sd_login_monitor_new.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_machine_get_class.xml b/man/sd_machine_get_class.xml index 5b881ccea1..68babd1981 100644 --- a/man/sd_machine_get_class.xml +++ b/man/sd_machine_get_class.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 87e59c9cc2..d563bcf2aa 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_pid_get_session.xml b/man/sd_pid_get_session.xml index f708d0d5e1..05a396157a 100644 --- a/man/sd_pid_get_session.xml +++ b/man/sd_pid_get_session.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -148,9 +151,10 @@ not all processes are part of a login session (e.g. system service processes, user processes that are shared between multiple sessions of the same user, or kernel threads). For processes not - being part of a login session this function will fail. The - returned string needs to be freed with the libc - <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> + being part of a login session this function will fail with + -ENXIO. The returned string needs to be freed with the libc + <citerefentry + project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> call after use.</para> <para><function>sd_pid_get_unit()</function> may be used to @@ -159,11 +163,12 @@ short string, suitable for usage in file system paths. Note that not all processes are part of a system unit/service (e.g. user processes, or kernel threads). For processes not being part of a - systemd system unit this function will fail. (More specifically: - this call will not work for processes that are part of user units, - use <function>sd_pid_get_user_unit()</function> for that.) The - returned string needs to be freed with the libc - <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> + systemd system unit this function will fail with -ENXIO (More + specifically: this call will not work for processes that are part + of user units, use <function>sd_pid_get_user_unit()</function> for + that.) The returned string needs to be freed with the libc + <citerefentry + project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> call after use.</para> <para><function>sd_pid_get_user_unit()</function> may be used to @@ -179,14 +184,16 @@ login sessions of the same user, where <function>sd_pid_get_session()</function> will fail. For processes not being part of a login session and not being a shared process - of a user this function will fail.</para> + of a user this function will fail with -ENXIO.</para> <para><function>sd_pid_get_machine_name()</function> may be used to determine the name of the VM or container is a member of. The machine name is a short string, suitable for usage in file system paths. The returned string needs to be freed with the libc - <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> - call after use.</para> + <citerefentry + project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> + call after use. For processes not part of a VM or containers this + function fails with -ENXIO.</para> <para><function>sd_pid_get_slice()</function> may be used to determine the slice unit the process is a member of. See @@ -219,6 +226,37 @@ </refsect1> <refsect1> + <title>Errors</title> + + <para>Returned errors may indicate the following problems:</para> + + <variablelist> + + <varlistentry> + <term><constant>-ENXIO</constant></term> + + <listitem><para>Given field is not specified for the described + process or peer.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><constant>-ESRCH</constant></term> + + <listitem><para>The specified PID does not refer to a running + process.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><constant>-ENOMEM</constant></term> + + <listitem><para>Memory allocation failed.</para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> <title>Notes</title> <para>The <function>sd_pid_get_session()</function>, diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml index 3c57ec9ea4..74b4ed5fc1 100644 --- a/man/sd_seat_get_active.xml +++ b/man/sd_seat_get_active.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml index 4ca3a6c150..e3af2b39c9 100644 --- a/man/sd_session_is_active.xml +++ b/man/sd_session_is_active.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml index b158f3528c..18a3427026 100644 --- a/man/sd_uid_get_state.xml +++ b/man/sd_uid_get_state.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/sd_watchdog_enabled.xml b/man/sd_watchdog_enabled.xml index 991431f33b..41850106e6 100644 --- a/man/sd_watchdog_enabled.xml +++ b/man/sd_watchdog_enabled.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/shutdown.xml b/man/shutdown.xml index a8af387c67..9bf599b372 100644 --- a/man/shutdown.xml +++ b/man/shutdown.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/standard-conf.xml b/man/standard-conf.xml index b87d7e955b..123877a0a5 100644 --- a/man/standard-conf.xml +++ b/man/standard-conf.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refsection PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <refsection> <refsection id='confd'> @@ -33,13 +36,39 @@ configuration file.</para> </refsection> - <refsection id='conf'> - <title>Configuration File</title> + <refsection id='main-conf'> + <title>Configuration Directories and Precedence</title> + + <para>Default configuration is defined during compilation, so a + configuration file is only needed when it is necessary to deviate + from those defaults. By default the configuration file in + <filename>&pkgsysconfdir;/</filename> contains commented out entries + showing the defaults as a guide to the administrator. This file + can be edited to create local overrides. + </para> + + <para>When packages need to customize the configuration, they can + install configuration snippets in + <filename>&rootlibexecdir;/*.conf.d/</filename>. Files in + <filename>/etc/</filename> are reserved for the local + administrator, who may use this logic to override the + configuration files installed by vendor packages. The main + configuration file is read before any of the configuration + directories, and has the lowest precedence; entries in a file in + any configuration directory override entries in the single + configuration file. Files in the + <filename>*.conf.d/</filename> configuration subdirectories + are sorted by their filename in lexicographic order, regardless of + which of the subdirectories they reside in. If multiple files + specify the same option, the entry in the file with the + lexicographically latest name takes precedence. It is recommended + to prefix all filenames in those subdirectories with a two-digit + number and a dash, to simplify the ordering of the files.</para> - <para>Configuration is also read from a single configuration file in - <filename>/etc/</filename>. This file is read before any of the - configuration directories, and has the lowest precedence; entries in a file - in any configuration directory override entries in the single configuration - file.</para> + <para>To disable a configuration file supplied by the vendor, the + recommended way is to place a symlink to + <filename>/dev/null</filename> in the configuration directory in + <filename>/etc/</filename>, with the same filename as the vendor + configuration file.</para> </refsection> </refsection> diff --git a/man/standard-options.xml b/man/standard-options.xml index f214463392..5adda7c670 100644 --- a/man/standard-options.xml +++ b/man/standard-options.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <variablelist> <varlistentry id='help'> diff --git a/man/sysctl.d.xml b/man/sysctl.d.xml index 5a35cfe2c8..841cedba3a 100644 --- a/man/sysctl.d.xml +++ b/man/sysctl.d.xml @@ -1,5 +1,8 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -57,7 +60,7 @@ <para>At boot, <citerefentry><refentrytitle>systemd-sysctl.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> reads configuration files from the above directories to configure - <citerefentry><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> kernel parameters.</para> </refsect1> @@ -127,7 +130,7 @@ <para><filename>/etc/udev/rules.d/99-bridge.rules</filename>: </para> - <programlisting>ACTION=="add", SUBSYSTEM=="module", KERNEL=="bridge", RUN+="/usr/lib/systemd/systemd-sysctl --prefix=/net/bridge" + <programlisting>ACTION=="add", SUBSYSTEM=="module", KERNEL=="bridge", RUN+="&rootlibexecdir;/systemd-sysctl --prefix=/net/bridge" </programlisting> <para><filename>/etc/sysctl.d/bridge.conf</filename>: @@ -162,9 +165,9 @@ net.bridge.bridge-nf-call-arptables = 0 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-sysctl.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sysctl.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>sysctl.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemctl.xml b/man/systemctl.xml index 338c1d3280..409b6f0895 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -154,7 +157,7 @@ <command>list-dependencies</command>, i.e. follow dependencies of type <varname>WantedBy=</varname>, <varname>RequiredBy=</varname>, - <varname>RequiredByOverrridable=</varname>, + <varname>RequiredByOverridable=</varname>, <varname>PartOf=</varname>, <varname>BoundBy=</varname>, instead of <varname>Wants=</varname> and similar. </para> @@ -316,8 +319,8 @@ <para>Do not synchronously wait for the requested operation to finish. If this is not specified, the job will be verified, enqueued and <command>systemctl</command> will - wait until it is completed. By passing this argument, it is - only verified and enqueued.</para> + wait until the unit's start-up is completed. By passing this + argument, it is only verified and enqueued.</para> </listitem> </varlistentry> @@ -410,8 +413,8 @@ processes. Not all unit types manage processes of these types however. For example, for mount units, control processes are defined (which are the invocations of - <filename>/usr/bin/mount</filename> and - <filename>/usr/bin/umount</filename>), but no main process + <filename>&MOUNT_PATH;</filename> and + <filename>&UMOUNT_PATH;</filename>), but no main process is defined. If omitted, defaults to <option>all</option>.</para> </listitem> @@ -456,6 +459,18 @@ </varlistentry> <varlistentry> + <term><option>--now</option></term> + + <listitem> + <para>When used with <command>enable</command>, the units + will also be started. When used with <command>disable</command> or + <command>mask</command>, the units will also be stopped. The start + or stop operation is only carried out when the respective enable or + disable operation has been successful.</para> + </listitem> + </varlistentry> + + <varlistentry> <term><option>--root=</option></term> <listitem> @@ -527,6 +542,18 @@ </varlistentry> <varlistentry> + <term><option>--firmware-setup</option></term> + + <listitem> + <para>When used with the <command>reboot</command> command, + indicate to the system's firmware to boot into setup + mode. Note that this is currently only supported on some EFI + systems and only if the system was booted in EFI + mode.</para> + </listitem> + </varlistentry> + + <varlistentry> <term><option>--plain</option></term> <listitem> @@ -909,11 +936,12 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service the changes are taken into account immediately. Note that this does <emphasis>not</emphasis> have the effect of also starting any of the units being enabled. If this - is desired, a separate <command>start</command> command must - be invoked for the unit. Also note that in case of instance - enablement, symlinks named the same as instances are created in - the install location, however they all point to the same - template unit file.</para> + is desired, either <option>--now</option> should be used + together with this command, or an additional <command>start</command> + command must be invoked for the unit. Also note that in case of + instance enablement, symlinks named the same as instances + are created in the install location, however they all point to the + same template unit file.</para> <para>This command will print the actions executed. This output may be suppressed by passing <option>--quiet</option>. @@ -968,9 +996,10 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service <command>enable</command>. This call implicitly reloads the systemd daemon configuration after completing the disabling of the units. Note that this command does not implicitly - stop the units that are being disabled. If this is desired, - an additional <command>stop</command> command should be - executed afterwards.</para> + stop the units that are being disabled. If this is desired, either + <option>--now</option> should be used together with this command, or + an additional <command>stop</command> command should be executed + afterwards.</para> <para>This command will print the actions executed. This output may be suppressed by passing <option>--quiet</option>. @@ -1116,7 +1145,8 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service activation of the unit, including enablement and manual activation. Use this option with care. This honors the <option>--runtime</option> option to only mask temporarily - until the next reboot of the system.</para> + until the next reboot of the system. The <option>--now</option> + option can be used to ensure that the units are also stopped.</para> </listitem> </varlistentry> @@ -1495,7 +1525,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service <listitem> <para>Shut down and halt the system. This is mostly equivalent to - <command>start halt.target --irreversible</command>, but also + <command>start halt.target --job-mode=replace-irreversibly</command>, but also prints a wall message to all users. If combined with <option>--force</option>, shutdown of all running services is skipped, however all processes are killed and all file @@ -1511,7 +1541,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service <listitem> <para>Shut down and power-off the system. This is mostly - equivalent to <command>start poweroff.target --irreversible</command>, + equivalent to <command>start poweroff.target --job-mode=replace-irreversibly</command>, but also prints a wall message to all users. If combined with <option>--force</option>, shutdown of all running services is skipped, however all processes are killed and all file @@ -1527,7 +1557,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service <listitem> <para>Shut down and reboot the system. This is mostly - equivalent to <command>start reboot.target --irreversible</command>, + equivalent to <command>start reboot.target --job-mode=replace-irreversibly</command>, but also prints a wall message to all users. If combined with <option>--force</option>, shutdown of all running services is skipped, however all processes are killed and all file @@ -1554,7 +1584,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service <listitem> <para>Shut down and reboot the system via kexec. This is - mostly equivalent to <command>start kexec.target --irreversible</command>, + mostly equivalent to <command>start kexec.target --job-mode=replace-irreversibly</command>, but also prints a wall message to all users. If combined with <option>--force</option>, shutdown of all running services is skipped, however all processes are killed and @@ -1703,9 +1733,10 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service <varname>$VISUAL</varname> are present or if it is set to an empty string or if their execution failed, systemctl will try to execute well known editors in this order: - <citerefentry><refentrytitle>nano</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>vim</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>vi</refentrytitle><manvolnum>1</manvolnum></citerefentry>. + <citerefentry project='die-net'><refentrytitle>editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>nano</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>vim</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>vi</refentrytitle><manvolnum>1</manvolnum></citerefentry>. </para></listitem> </varlistentry> </variablelist> @@ -1721,7 +1752,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-management</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>, diff --git a/man/systemd-activate.xml b/man/systemd-activate.xml index e64894a28b..3aecc40b60 100644 --- a/man/systemd-activate.xml +++ b/man/systemd-activate.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -50,7 +53,7 @@ <refsynopsisdiv> <cmdsynopsis> - <command>/usr/lib/systemd/systemd-activate</command> + <command>&rootlibexecdir;/systemd-activate</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="plain"><replaceable>daemon</replaceable></arg> <arg choice="opt" rep="repeat">OPTIONS</arg> @@ -66,7 +69,7 @@ of the daemon per connection (inetd-style). </para> - <para>The daemon to launch and its options should be specifed + <para>The daemon to launch and its options should be specified after options intended for <command>systemd-activate</command>. </para> @@ -76,7 +79,7 @@ inherited, and sockets will be passed through file descriptors 3 and higher. Sockets passed through <varname>$LISTEN_FDS</varname> to <command>systemd-activate</command> will be passed through to - the dameon, in the original positions. Other sockets specified + the daemon, in the original positions. Other sockets specified with <option>--listen</option> will use consecutive descriptors. </para> </refsect1> @@ -149,13 +152,13 @@ <example> <title>Run an echo server on port 2000</title> - <programlisting>$ /usr/lib/systemd/systemd-activate -l 2000 -a cat</programlisting> + <programlisting>$ &rootlibexecdir;/systemd-activate -l 2000 -a cat</programlisting> </example> <example> <title>Run a socket activated instance of <citerefentry><refentrytitle>systemd-journal-gatewayd</refentrytitle><manvolnum>8</manvolnum></citerefentry></title> - <programlisting>$ /usr/lib/systemd/systemd-activate -l 19531 /usr/lib/systemd/systemd-journal-gatewayd</programlisting> + <programlisting>$ &rootlibexecdir;/systemd-activate -l 19531 &rootlibexecdir;/systemd-journal-gatewayd</programlisting> </example> </refsect1> @@ -165,7 +168,7 @@ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>cat</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>cat</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> </refentry> diff --git a/man/systemd-analyze.xml b/man/systemd-analyze.xml index 1ff81d3d5a..3509d155d3 100644 --- a/man/systemd-analyze.xml +++ b/man/systemd-analyze.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -145,7 +148,7 @@ <para><command>systemd-analyze dot</command> generates textual dependency graph description in dot format for further processing with the GraphViz - <citerefentry><refentrytitle>dot</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>dot</refentrytitle><manvolnum>1</manvolnum></citerefentry> tool. Use a command line like <command>systemd-analyze dot | dot -Tsvg > systemd.svg</command> to generate a graphical dependency tree. Unless <option>--order</option> or @@ -229,7 +232,7 @@ <command>dot</command> command (see above), this selects which relationships are shown in the dependency graph. Both options require a - <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry> pattern as an argument, which will be matched against the left-hand and the right-hand, respectively, nodes of a relationship.</para> diff --git a/man/systemd-ask-password-console.service.xml b/man/systemd-ask-password-console.service.xml index 479e5f2e5b..488a8793dd 100644 --- a/man/systemd-ask-password-console.service.xml +++ b/man/systemd-ask-password-console.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd-ask-password.xml b/man/systemd-ask-password.xml index 877c71af53..2402103719 100644 --- a/man/systemd-ask-password.xml +++ b/man/systemd-ask-password.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd-backlight@.service.xml b/man/systemd-backlight@.service.xml index a259f5d583..123576255d 100644 --- a/man/systemd-backlight@.service.xml +++ b/man/systemd-backlight@.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,7 +51,7 @@ <refsynopsisdiv> <para><filename>systemd-backlight@.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-backlight</filename></para> + <para><filename>&rootlibexecdir;/systemd-backlight</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-binfmt.service.xml b/man/systemd-binfmt.service.xml index 66d264389e..8659e63ebc 100644 --- a/man/systemd-binfmt.service.xml +++ b/man/systemd-binfmt.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,7 +51,7 @@ <refsynopsisdiv> <para><filename>systemd-binfmt.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-binfmt</filename></para> + <para><filename>&rootlibexecdir;/systemd-binfmt</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-bootchart.xml b/man/systemd-bootchart.xml index 538666760a..ea8a783601 100644 --- a/man/systemd-bootchart.xml +++ b/man/systemd-bootchart.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -60,7 +63,7 @@ usage, as well as per-process information from a running system. Collected results are output as an SVG graph. Normally, systemd-bootchart is invoked by the kernel by passing - <option>init=<filename>/usr/lib/systemd/systemd-bootchart</filename></option> + <option>init=<filename>&rootlibexecdir;/systemd-bootchart</filename></option> on the kernel command line. systemd-bootchart will then fork the real init off to resume normal system startup, while monitoring and logging startup information in the background. @@ -106,7 +109,7 @@ <listitem><para>The kernel can invoke <command>systemd-bootchart</command> instead of the init process. In turn, <command>systemd-bootchart</command> will - invoke <command>/usr/lib/systemd/systemd</command>. + invoke <command>&rootlibexecdir;/systemd</command>. </para></listitem> </varlistentry> @@ -128,7 +131,7 @@ <title>Options</title> <para>These options can also be set in the - <filename>/etc/systemd/bootchart.conf</filename> file. See + <filename>&pkgsysconfdir;/bootchart.conf</filename> file. See <citerefentry project='man-pages'><refentrytitle>bootchart.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. </para> @@ -201,7 +204,7 @@ <term><option>-i</option></term> <term><option>--init <replaceable>path</replaceable></option></term> <listitem><para>Use this init binary. Defaults to - <command>/usr/lib/systemd/systemd</command>. + <command>&rootlibexecdir;/systemd</command>. </para></listitem> </varlistentry> diff --git a/man/systemd-bus-proxyd.xml b/man/systemd-bus-proxyd.xml index 2c7764047b..bbcf3d0981 100644 --- a/man/systemd-bus-proxyd.xml +++ b/man/systemd-bus-proxyd.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2013 Zbigniew Jędrzejewski-Szmek + Copyright 2013 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="systemd-bus-proxyd" conditional="ENABLE_KDBUS" @@ -50,7 +53,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <refsynopsisdiv> <cmdsynopsis> - <command>/usr/lib/systemd/systemd-bus-proxyd</command> + <command>&rootlibexecdir;/systemd-bus-proxyd</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt"><replaceable>PLACEHOLDER</replaceable></arg> </cmdsynopsis> @@ -101,7 +104,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <title>See Also</title> <para> - <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='dbus'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>, <ulink url="https://code.google.com/p/d-bus/">kdbus</ulink> </para> diff --git a/man/systemd-bus-proxyd@.service.xml b/man/systemd-bus-proxyd@.service.xml index 141b43f6d9..9dabc4dd5f 100644 --- a/man/systemd-bus-proxyd@.service.xml +++ b/man/systemd-bus-proxyd@.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -73,7 +76,7 @@ <para> <citerefentry><refentrytitle>systemd-bus-proxyd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='dbus'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <ulink url="http://freedesktop.org/wiki/Software/dbus">D-Bus</ulink>, <ulink url="https://code.google.com/p/d-bus/">kdbus</ulink> </para> diff --git a/man/systemd-cat.xml b/man/systemd-cat.xml index 38ddf66d27..d51acd7cf8 100644 --- a/man/systemd-cat.xml +++ b/man/systemd-cat.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -171,7 +174,7 @@ <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>logger</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>logger</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd-cgls.xml b/man/systemd-cgls.xml index e8f0368f48..d3b2404a76 100644 --- a/man/systemd-cgls.xml +++ b/man/systemd-cgls.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml index f1ff218c39..b0c88001d4 100644 --- a/man/systemd-cgtop.xml +++ b/man/systemd-cgtop.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd-coredump.xml b/man/systemd-coredump.xml index 6a7ced19a6..d40562b5e1 100644 --- a/man/systemd-coredump.xml +++ b/man/systemd-coredump.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -49,7 +52,7 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/usr/lib/systemd/systemd-coredump</filename></para> + <para><filename>&rootlibexecdir;/systemd-coredump</filename></para> </refsynopsisdiv> <refsect1> @@ -64,7 +67,7 @@ <filename>/usr/lib/sysctl.d/50-coredump.conf</filename> which configures <varname>kernel.core_pattern</varname> to invoke <command>systemd-coredump</command>. This file may be masked or - overriden to use a different setting following normal + overridden to use a different setting following normal <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> rules.</para> <para>The behaviour of a specific program upon reception of a diff --git a/man/systemd-cryptsetup-generator.xml b/man/systemd-cryptsetup-generator.xml index 0e48e79346..c4747f72d3 100644 --- a/man/systemd-cryptsetup-generator.xml +++ b/man/systemd-cryptsetup-generator.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -46,7 +49,7 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/usr/lib/systemd/system-generators/systemd-cryptsetup-generator</filename></para> + <para><filename>&rootlibexecdir;/system-generators/systemd-cryptsetup-generator</filename></para> </refsynopsisdiv> <refsect1> @@ -59,10 +62,8 @@ <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> units as necessary.</para> - <para><filename>systemd-cryptsetup-generator</filename> - implements the <ulink - url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator - specification</ulink>.</para> + <para><filename>systemd-cryptsetup-generator</filename> implements + <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> </refsect1> <refsect1> @@ -187,7 +188,7 @@ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd-cryptsetup@.service.xml b/man/systemd-cryptsetup@.service.xml index bd03637deb..efc213a917 100644 --- a/man/systemd-cryptsetup@.service.xml +++ b/man/systemd-cryptsetup@.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,7 +51,7 @@ <refsynopsisdiv> <para><filename>systemd-cryptsetup@.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-cryptsetup</filename></para> + <para><filename>&rootlibexecdir;/systemd-cryptsetup</filename></para> </refsynopsisdiv> <refsect1> @@ -78,7 +81,7 @@ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd-debug-generator.xml b/man/systemd-debug-generator.xml index 74c3b2620e..075ec58e7e 100644 --- a/man/systemd-debug-generator.xml +++ b/man/systemd-debug-generator.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -47,7 +50,7 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/usr/lib/systemd/system-generators/systemd-debug-generator</filename></para> + <para><filename>&rootlibexecdir;/system-generators/systemd-debug-generator</filename></para> </refsynopsisdiv> <refsect1> @@ -79,10 +82,8 @@ <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s <command>enable</command> command.</para> - <para><filename>systemd-debug-generator</filename> implements the - <ulink - url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator - specification</ulink>.</para> + <para><filename>systemd-debug-generator</filename> implements + <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> </refsect1> <refsect1> diff --git a/man/systemd-delta.xml b/man/systemd-delta.xml index fd81b2c907..69ea0411e6 100644 --- a/man/systemd-delta.xml +++ b/man/systemd-delta.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -69,7 +72,7 @@ certain configuration files can have <literal>.d</literal> directories which contain "drop-in" files with configuration snippets which augment the main configuration file. "Drop-in" - files can be overriden in the same way by placing files with the + files can be overridden in the same way by placing files with the same name in a directory of higher priority (except that in case of "drop-in" files, both the "drop-in" file name and the name of the containing directory, which corresponds to the name of the diff --git a/man/systemd-detect-virt.xml b/man/systemd-detect-virt.xml index 40755a24d0..16ac4f3091 100644 --- a/man/systemd-detect-virt.xml +++ b/man/systemd-detect-virt.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd-efi-boot-generator.xml b/man/systemd-efi-boot-generator.xml index b2d8d65e3d..1f8194dd62 100644 --- a/man/systemd-efi-boot-generator.xml +++ b/man/systemd-efi-boot-generator.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,7 +51,7 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/usr/lib/systemd/system-generators/systemd-efi-boot-generator</filename></para> + <para><filename>&rootlibexecdir;/system-generators/systemd-efi-boot-generator</filename></para> </refsynopsisdiv> <refsect1> @@ -62,15 +65,13 @@ does not communicate the used ESP to the OS, on systems where <filename>/boot</filename> is an explicitly configured mount (for example, listed in - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>) + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>) or where the <filename>/boot</filename> mount point is non-empty. Since this generator creates an automount unit, the mount will only be activated on-demand, when accessed.</para> <para><filename>systemd-efi-boot-generator</filename> implements - the <ulink - url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator - specification</ulink>.</para> + <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> </refsect1> <refsect1> @@ -80,8 +81,7 @@ <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>gummiboot</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd-escape.xml b/man/systemd-escape.xml index 0c3b230526..6680bcf963 100644 --- a/man/systemd-escape.xml +++ b/man/systemd-escape.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd-firstboot.xml b/man/systemd-firstboot.xml index 67d38ba31f..6ec54bf1c3 100644 --- a/man/systemd-firstboot.xml +++ b/man/systemd-firstboot.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -91,7 +94,7 @@ <para>Note that this tool operates directly on the file system and does not involve any running system services, unlike - <citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> or <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. @@ -125,7 +128,7 @@ <varname>LANG=</varname> and <varname>LC_MESSAGES</varname> settings. The argument should be a valid locale identifier, such as <literal>de_DE.UTF-8</literal>. This controls the - <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> configuration file.</para></listitem> </varlistentry> @@ -163,7 +166,7 @@ <listitem><para>Sets the password of the system's root user. This creates a - <citerefentry><refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum></citerefentry> file. This setting exists in two forms: <option>--root-password=</option> accepts the password to set directly on the command line, @@ -171,7 +174,7 @@ Note that it is not recommended specifying passwords on the command line as other users might be able to see them simply by invoking - <citerefentry><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem> + <citerefentry project='die-net'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem> </varlistentry> <varlistentry> @@ -244,13 +247,13 @@ <title>See Also</title> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> diff --git a/man/systemd-fsck@.service.xml b/man/systemd-fsck@.service.xml index 88e11e89d4..7286cd8803 100644 --- a/man/systemd-fsck@.service.xml +++ b/man/systemd-fsck@.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -50,7 +53,7 @@ <refsynopsisdiv> <para><filename>systemd-fsck@.service</filename></para> <para><filename>systemd-fsck-root.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-fsck</filename></para> + <para><filename>&rootlibexecdir;/systemd-fsck</filename></para> </refsynopsisdiv> <refsect1> @@ -80,11 +83,9 @@ the filesystem should actually be checked based on the time since last check, number of mounts, unclean unmount, etc.</para> - <para><filename>systemd-fsck</filename> will forward file system - checking progress to the console. If a file system check fails for - a service without <option>nofail</option>, emergency mode is - activated, by isolating to - <filename>emergency.target</filename>.</para> + <para>If a file system check fails for a service without + <option>nofail</option>, emergency mode is activated, by isolating + to <filename>emergency.target</filename>.</para> </refsect1> <refsect1> @@ -125,16 +126,16 @@ <title>See Also</title> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fsck.btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fsck.cramfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fsck.ext4</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fsck.fat</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fsck.hfsplus</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fsck.minix</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fsck.ntfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fsck.xfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>fsck.btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>fsck.cramfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>fsck.ext4</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>fsck.fat</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>fsck.hfsplus</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>fsck.minix</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>fsck.ntfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>fsck.xfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd-fstab-generator.xml b/man/systemd-fstab-generator.xml index 8f82e33304..383aab70ff 100644 --- a/man/systemd-fstab-generator.xml +++ b/man/systemd-fstab-generator.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -46,7 +49,7 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/usr/lib/systemd/system-generators/systemd-fstab-generator</filename></para> + <para><filename>&rootlibexecdir;/system-generators/systemd-fstab-generator</filename></para> </refsynopsisdiv> <refsect1> @@ -54,7 +57,7 @@ <para><filename>systemd-fstab-generator</filename> is a generator that translates <filename>/etc/fstab</filename> (see - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details) into native systemd units early at boot and when configuration of the system manager is reloaded. This will instantiate mount and swap units as necessary.</para> @@ -71,10 +74,8 @@ for more information about special <filename>/etc/fstab</filename> mount options this generator understands.</para> - <para><filename>systemd-fstab-generator</filename> implements the - <ulink - url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator - specification</ulink>.</para> + <para><filename>systemd-fstab-generator</filename> implements + <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> </refsect1> <refsect1> @@ -158,7 +159,7 @@ <listitem><para>Takes the <filename>/usr</filename> filesystem mount options to use. If <varname>mount.usr=</varname> or <varname>mount.usrfstype=</varname> is set, then - <varname>mount.usrflages=</varname> will default to the value + <varname>mount.usrflags=</varname> will default to the value set in <varname>rootflags=</varname>.</para> <para>Otherwise this value will be read from the @@ -175,7 +176,7 @@ <title>See Also</title> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> diff --git a/man/systemd-getty-generator.xml b/man/systemd-getty-generator.xml index 0b5b2f2a71..12127d9c2a 100644 --- a/man/systemd-getty-generator.xml +++ b/man/systemd-getty-generator.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -47,7 +50,7 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/usr/lib/systemd/system-generators/systemd-getty-generator</filename></para> + <para><filename>&rootlibexecdir;/system-generators/systemd-getty-generator</filename></para> </refsynopsisdiv> <refsect1> @@ -75,9 +78,8 @@ for more information on the <varname>console=</varname> kernel parameter.</para> - <para><filename>systemd-getty-generator</filename> implements the - <ulink url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator - specification</ulink>.</para> + <para><filename>systemd-getty-generator</filename> implements + <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> <para>Further information about configuration of gettys you may find in diff --git a/man/systemd-gpt-auto-generator.xml b/man/systemd-gpt-auto-generator.xml index 9c706df246..16ff100d73 100644 --- a/man/systemd-gpt-auto-generator.xml +++ b/man/systemd-gpt-auto-generator.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -50,7 +53,7 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/usr/lib/systemd/system-generators/systemd-gpt-auto-generator</filename></para> + <para><filename>&rootlibexecdir;/system-generators/systemd-gpt-auto-generator</filename></para> </refsynopsisdiv> <refsect1> @@ -66,7 +69,7 @@ Partitions Specification</ulink>. Note that this generator has no effect on non-GPT systems, on systems where the units are explicitly configured (for example, listed in - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>), + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>), or where the mount points are non-empty.</para> <para>This generator will only look for root partitions on the @@ -157,9 +160,7 @@ using <command>btrfs subvolume set-default</command>.</para> <para><filename>systemd-gpt-auto-generator</filename> implements - the - <ulink url="http://www.freedesktop.org/wiki/Software/systemd/Generators">Generator - Specification</ulink>.</para> + <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> </refsect1> <refsect1> @@ -171,9 +172,9 @@ <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-efi-boot-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd-halt.service.xml b/man/systemd-halt.service.xml index c94e2a1820..7e83a88fab 100644 --- a/man/systemd-halt.service.xml +++ b/man/systemd-halt.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -56,7 +59,7 @@ <para><filename>systemd-poweroff.service</filename></para> <para><filename>systemd-reboot.service</filename></para> <para><filename>systemd-kexec.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-shutdown</filename></para> + <para><filename>&rootlibexecdir;/systemd-shutdown</filename></para> </refsynopsisdiv> <refsect1> @@ -75,7 +78,7 @@ <para>When these services are run, they ensure that PID 1 is replaced by the - <filename>/usr/lib/systemd/systemd-shutdown</filename> tool which + <filename>&rootlibexecdir;/systemd-shutdown</filename> tool which is then responsible for the actual shutdown. Before shutting down, this binary will try to unmount all remaining file systems, disable all remaining swap devices, detach all remaining storage @@ -90,7 +93,7 @@ <para>Immediately before executing the actual system halt/poweroff/reboot/kexec <filename>systemd-shutdown</filename> will run all executables in - <filename>/usr/lib/systemd/system-shutdown/</filename> and pass + <filename>&rootlibexecdir;/system-shutdown/</filename> and pass one arguments to them: either <literal>halt</literal>, <literal>poweroff</literal>, <literal>reboot</literal> or <literal>kexec</literal>, depending on the chosen action. All diff --git a/man/systemd-hibernate-resume-generator.xml b/man/systemd-hibernate-resume-generator.xml index a21782cbf9..52837bc3f0 100644 --- a/man/systemd-hibernate-resume-generator.xml +++ b/man/systemd-hibernate-resume-generator.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -46,7 +49,7 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/usr/lib/systemd/system-generators/systemd-hibernate-resume-generator</filename></para> + <para><filename>&rootlibexecdir;/system-generators/systemd-hibernate-resume-generator</filename></para> </refsynopsisdiv> <refsect1> @@ -73,7 +76,7 @@ <listitem><para>Takes a path to the resume device. Both persistent block device paths like <filename>/dev/disk/by-foo/bar</filename> and - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-style + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-style specifiers like <literal>FOO=bar</literal> are supported.</para></listitem> </varlistentry> diff --git a/man/systemd-hibernate-resume@.service.xml b/man/systemd-hibernate-resume@.service.xml index 7d00827447..bca08b5fd5 100644 --- a/man/systemd-hibernate-resume@.service.xml +++ b/man/systemd-hibernate-resume@.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,7 +51,7 @@ <refsynopsisdiv> <para><filename>systemd-hibernate-resume@.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-hibernate-resume</filename></para> + <para><filename>&rootlibexecdir;/systemd-hibernate-resume</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-hostnamed.service.xml b/man/systemd-hostnamed.service.xml index 6990d41b02..2db1d035b1 100644 --- a/man/systemd-hostnamed.service.xml +++ b/man/systemd-hostnamed.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -50,7 +53,7 @@ <refsynopsisdiv> <para><filename>systemd-hostnamed.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-hostnamed</filename></para> + <para><filename>&rootlibexecdir;/systemd-hostnamed</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-hwdb.xml b/man/systemd-hwdb.xml index f1a14025b0..9a58776af2 100644 --- a/man/systemd-hwdb.xml +++ b/man/systemd-hwdb.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <refentry id="systemd-hwdb" conditional="ENABLE_HWDB"> <refentryinfo> @@ -57,7 +60,7 @@ <varlistentry> <term><option>--usr</option></term> <listitem> - <para>Generate in /usr/lib/udev instead of /etc/udev.</para> + <para>Generate in &udevlibexecdir; instead of /etc/udev.</para> </listitem> </varlistentry> <varlistentry> diff --git a/man/systemd-inhibit.xml b/man/systemd-inhibit.xml index 9d85908f97..6ff07210d3 100644 --- a/man/systemd-inhibit.xml +++ b/man/systemd-inhibit.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd-initctl.service.xml b/man/systemd-initctl.service.xml index 5c7f9a4a16..95288d068f 100644 --- a/man/systemd-initctl.service.xml +++ b/man/systemd-initctl.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -52,7 +55,7 @@ <refsynopsisdiv> <para><filename>systemd-initctl.service</filename></para> <para><filename>systemd-initctl.socket</filename></para> - <para><filename>/usr/lib/systemd/systemd-initctl</filename></para> + <para><filename>&rootlibexecdir;/systemd-initctl</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-journal-gatewayd.service.xml b/man/systemd-journal-gatewayd.service.xml index 7420b59c95..f7588794cd 100644 --- a/man/systemd-journal-gatewayd.service.xml +++ b/man/systemd-journal-gatewayd.service.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2012 Zbigniew Jędrzejewski-Szmek + Copyright 2012 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="systemd-journal-gatewayd.service" conditional='HAVE_MICROHTTPD' @@ -54,7 +57,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <para><filename>systemd-journal-gatewayd.service</filename></para> <para><filename>systemd-journal-gatewayd.socket</filename></para> <cmdsynopsis> - <command>/usr/lib/systemd/systemd-journal-gatewayd</command> + <command>&rootlibexecdir;/systemd-journal-gatewayd</command> <arg choice="opt" rep="repeat">OPTIONS</arg> </cmdsynopsis> </refsynopsisdiv> diff --git a/man/systemd-journal-remote.xml b/man/systemd-journal-remote.xml index 2687662a14..596479edb1 100644 --- a/man/systemd-journal-remote.xml +++ b/man/systemd-journal-remote.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -156,7 +159,7 @@ <varname>$LISTEN_FDS</varname>/<varname>$LISTEN_PID</varname>. In the second case, an HTTP or HTTPS server will be spawned on this port, respectively for <option>--listen-http</option> and - <option>--listen-https</option>. Currenntly, only POST requests + <option>--listen-https</option>. Currently, only POST requests to <filename>/upload</filename> with <literal>Content-Type: application/vnd.fdo.journal</literal> are supported.</para> </listitem> @@ -310,6 +313,7 @@ systemd-journal-remote --url http://some.host:19531/ <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-journal-gatewayd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry><refentrytitle>journal-remote.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> </para> </refsect1> </refentry> diff --git a/man/systemd-journal-upload.xml b/man/systemd-journal-upload.xml index 607167d274..5398ff42e2 100644 --- a/man/systemd-journal-upload.xml +++ b/man/systemd-journal-upload.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2014 Zbigniew Jędrzejewski-Szmek + Copyright 2014 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="systemd-journal-upload" conditional='HAVE_MICROHTTPD' @@ -243,8 +246,8 @@ openssl ca -batch -config ca.conf -notext -in $CLIENT.csr -out $CLIENT.pem <varname>TrustedCertificateFile=</varname>, <varname>ServerCertificateFile=</varname>, <varname>ServerKeyFile=</varname>, in - <filename>/etc/systemd/journal-remote.conf</filename> and - <filename>/etc/systemd/journal-upload.conf</filename> + <filename>&pkgsysconfdir;/journal-remote.conf</filename> and + <filename>&pkgsysconfdir;/journal-upload.conf</filename> respectively. The default locations can be queried by using <command>systemd-journal-remote --help</command> and <command>systemd-journal-upload --help</command>.</para> diff --git a/man/systemd-journald.service.xml b/man/systemd-journald.service.xml index 6b250b65e6..ead1eee3fb 100644 --- a/man/systemd-journald.service.xml +++ b/man/systemd-journald.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -54,7 +57,7 @@ <para><filename>systemd-journald.service</filename></para> <para><filename>systemd-journald.socket</filename></para> <para><filename>systemd-journald-dev-log.socket</filename></para> - <para><filename>/usr/lib/systemd/systemd-journald</filename></para> + <para><filename>&rootlibexecdir;/systemd-journald</filename></para> </refsynopsisdiv> <refsect1> @@ -199,7 +202,7 @@ <variablelist> <varlistentry> - <term><filename>/etc/systemd/journald.conf</filename></term> + <term><filename>&pkgsysconfdir;/journald.conf</filename></term> <listitem><para>Configure <command>systemd-journald</command> @@ -241,7 +244,7 @@ <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>setfacl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>setfacl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>4</manvolnum></citerefentry>, <command>pydoc systemd.journal</command>. </para> diff --git a/man/systemd-localed.service.xml b/man/systemd-localed.service.xml index 8999166383..1628054a3b 100644 --- a/man/systemd-localed.service.xml +++ b/man/systemd-localed.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -50,7 +53,7 @@ <refsynopsisdiv> <para><filename>systemd-localed.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-localed</filename></para> + <para><filename>&rootlibexecdir;/systemd-localed</filename></para> </refsynopsisdiv> <refsect1> @@ -64,7 +67,7 @@ unused.</para> <para>The tool - <citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> is a command line client to this service.</para> <para>See the <ulink @@ -77,10 +80,10 @@ <title>See Also</title> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd-logind.service.xml b/man/systemd-logind.service.xml index 5733e42cd1..1416d884ce 100644 --- a/man/systemd-logind.service.xml +++ b/man/systemd-logind.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -50,7 +53,7 @@ <refsynopsisdiv> <para><filename>systemd-logind.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-logind</filename></para> + <para><filename>&rootlibexecdir;/systemd-logind</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-machine-id-commit.service.xml b/man/systemd-machine-id-commit.service.xml index 7c8fc0874e..7bda76c4e5 100644 --- a/man/systemd-machine-id-commit.service.xml +++ b/man/systemd-machine-id-commit.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -47,7 +50,7 @@ <refsynopsisdiv> <para><filename>systemd-machine-id-commit.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-machine-id-commit</filename></para> + <para><filename>&rootlibexecdir;/systemd-machine-id-commit</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-machine-id-commit.xml b/man/systemd-machine-id-commit.xml index cfb1722063..0ebbfe7f07 100644 --- a/man/systemd-machine-id-commit.xml +++ b/man/systemd-machine-id-commit.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd-machine-id-setup.xml b/man/systemd-machine-id-setup.xml index 22bad3e5f4..5a84a3b36c 100644 --- a/man/systemd-machine-id-setup.xml +++ b/man/systemd-machine-id-setup.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -122,7 +125,7 @@ <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='dbus'><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd-machined.service.xml b/man/systemd-machined.service.xml index 999aeee1c6..a62e42c35b 100644 --- a/man/systemd-machined.service.xml +++ b/man/systemd-machined.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -50,7 +53,7 @@ <refsynopsisdiv> <para><filename>systemd-machined.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-machined</filename></para> + <para><filename>&rootlibexecdir;/systemd-machined</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-modules-load.service.xml b/man/systemd-modules-load.service.xml index dacd083bad..dc9e2a8554 100644 --- a/man/systemd-modules-load.service.xml +++ b/man/systemd-modules-load.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,7 +51,7 @@ <refsynopsisdiv> <para><filename>systemd-modules-load.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-modules-load</filename></para> + <para><filename>&rootlibexecdir;/systemd-modules-load</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-networkd-wait-online.service.xml b/man/systemd-networkd-wait-online.service.xml index f53b337daa..157671d6b2 100644 --- a/man/systemd-networkd-wait-online.service.xml +++ b/man/systemd-networkd-wait-online.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -50,7 +53,7 @@ <refsynopsisdiv> <para><filename>systemd-networkd-wait-online.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-networkd-wait-online</filename></para> + <para><filename>&rootlibexecdir;/systemd-networkd-wait-online</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-networkd.service.xml b/man/systemd-networkd.service.xml index 0bfe5519bc..1eef5b745b 100644 --- a/man/systemd-networkd.service.xml +++ b/man/systemd-networkd.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -50,7 +53,7 @@ <refsynopsisdiv> <para><filename>systemd-networkd.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-networkd</filename></para> + <para><filename>&rootlibexecdir;/systemd-networkd</filename></para> </refsynopsisdiv> <refsect1> @@ -75,10 +78,10 @@ <refsect1><title>Configuration Files</title> <para>The configuration files are read from the files located in the - system network directory <filename>/usr/lib/systemd/network</filename>, + system network directory <filename>&rootlibexecdir;/network</filename>, the volatile runtime network directory <filename>/run/systemd/network</filename> and the local administration - network directory <filename>/etc/systemd/network</filename>.</para> + network directory <filename>&pkgsysconfdir;/network</filename>.</para> <para>Networks are configured in <filename>.network</filename> files, see diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml index 06d5ae5319..1158473117 100644 --- a/man/systemd-notify.xml +++ b/man/systemd-notify.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index 4a936d326f..218c7291e0 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -84,13 +87,10 @@ kernel modules may not be loaded from within the container.</para> <para>Note that even though these security precautions are taken - <command>systemd-nspawn</command> is not suitable for secure + <command>systemd-nspawn</command> is not suitable for fully secure container setups. Many of the security features may be circumvented and are hence primarily useful to avoid accidental - changes to the host system from the container. The intended use of - this program is debugging and testing as well as building of - packages, distributions and software involved with boot and - systems management.</para> + changes to the host system from the container.</para> <para>In contrast to <citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>1</manvolnum></citerefentry> <command>systemd-nspawn</command> @@ -144,7 +144,7 @@ <replaceable>COMMAND</replaceable> specifies the program to launch in the container, and the remaining arguments are used as arguments for this program. If <option>-b</option> is not used and - no arguments are specifed, a shell is launched in the + no arguments are specified, a shell is launched in the container.</para> <para>The following options are understood:</para> @@ -190,7 +190,11 @@ system, so that the <literal>btrfs</literal> subvolume may be created. May not be specified together with <option>--image=</option> or - <option>--ephemeral</option>.</para></listitem> + <option>--ephemeral</option>.</para> + + <para>Note that this switch leaves host name, machine ID and + all other settings that could identify the instance + unmodified.</para></listitem> </varlistentry> <varlistentry> @@ -204,7 +208,10 @@ This option is only supported if the root file system is <literal>btrfs</literal>. May not be specified together with <option>--image=</option> or - <option>--template=</option>.</para></listitem> + <option>--template=</option>.</para> + <para>Note that this switch leaves host name, machine ID and + all other settings that could identify the instance + unmodified.</para></listitem> </varlistentry> <varlistentry> @@ -297,11 +304,62 @@ <listitem><para>Make the container part of the specified slice, instead of the default - <filename>machine.slice</filename>.</para> + <filename>machine.slice</filename>. This is only applies if + the machine is run in its own scope unit, i.e. if + <option>--keep-unit</option> is not used.</para> </listitem> </varlistentry> <varlistentry> + <term><option>--property=</option></term> + + <listitem><para>Set a unit property on the scope unit to + register for the machine. This only applies if the machine is + run in its own scope unit, i.e. if + <option>--keep-unit</option> is not used. Takes unit property + assignments in the same format as <command>systemctl + set-property</command>. This is useful to set memory limits + and similar for machines.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--private-users=</option></term> + + <listitem><para>Enables user namespacing. If enabled the + container will run with its own private set of Unix user and + group ids (UIDs and GIDs). Takes none, one or two + colon-separated parameters: the first parameter specifies the + first host UID to assign to the container, the second + parameter specifies the number of host UIDs to assign to the + container. If the second parameter is omitted, 65536 UIDs are + assigned. If the first parameter is also omitted (and hence + no parameter passed at all), the first UID assigned to the + container is read from the owner of the root directory of the + container's directory tree. By default no user namespacing is + applied.</para> + + <para>Note that user namespacing currently requires OS trees + that are prepared for the UID shift that is being applied: + UIDs and GIDs used for file ownership or in file ACL entries + must be shifted to the container UID base that is + used during container runtime.</para> + + <para>It is recommended to assign as least 65536 UIDs to each + container, so that the usable UID range in the container + covers 16bit. For best security do not assign overlapping UID + ranges to multiple containers. It is hence a good idea to use + the upper 16bit of the host 32bit UIDs as container + identifier, while the lower 16bit encode the container UID + used.</para> + + <para>When user namespaces are used the GID range assigned to + each container is always chosen identical to the UID + range.</para></listitem> + </varlistentry> + + + <varlistentry> <term><option>--private-network</option></term> <listitem><para>Disconnect networking of the container from @@ -399,7 +457,7 @@ container port number in the range from 1 to 65535. The protocol specifier and its separating colon may be omitted, in which case <literal>tcp</literal> is assumed. The container - port number and its colon may be ommitted, in which case the + port number and its colon may be omitted, in which case the same port as the host port is implied. This option is only supported if private networking is used, such as <option>--network-veth</option> or @@ -456,6 +514,19 @@ </varlistentry> <varlistentry> + <term><option>--kill-signal=</option></term> + + <listitem><para>Specify the process signal to send to the + container's PID 1 when nspawn itself receives SIGTERM, in + order to trigger an orderly shutdown of the + container. Defaults to SIGRTMIN+3 if <option>--boot</option> + is used (on systemd-compatible init systems SIGRTMIN+3 + triggers an orderly shutdown). Takes a signal name like + <literal>SIGHUP</literal>, <literal>SIGTERM</literal> or + similar as argument.</para></listitem> + </varlistentry> + + <varlistentry> <term><option>--link-journal=</option></term> <listitem><para>Control whether the container's journal shall @@ -510,8 +581,10 @@ same path in the container --, or a colon-separated pair of paths -- in which case the first specified path is the source in the host, and the second path is the destination in the - container. The <option>--bind-ro=</option> option creates - read-only bind mounts.</para></listitem> + container. This option may be specified multiple times for + creating multiple independent bind mount points. The + <option>--bind-ro=</option> option creates read-only bind + mounts.</para></listitem> </varlistentry> <varlistentry> @@ -531,6 +604,52 @@ </varlistentry> <varlistentry> + <term><option>--overlay=</option></term> + <term><option>--overlay-ro=</option></term> + + <listitem><para>Combine multiple directory trees into one + overlay file system and mount it into the container. Takes a + list of colon-separated paths to the directory trees to + combine and the destination mount point.</para> + + <para>If three or more paths are specified, then the last + specified path is the destination mount point in the + container, all paths specified before refer to directory trees + on the host and are combined in the specified order into one + overlay file system. The left-most path is hence the lowest + directory tree, the second-to-last path the highest directory + tree in the stacking order. If <option>--overlay-ro=</option> + is used instead of <option>--overlay=</option> a read-only + overlay file system is created. If a writable overlay file + system is created all changes made to it are written to the + highest directory tree in the stacking order, i.e. the + second-to-last specified.</para> + + <para>If only two paths are specified, then the second + specified path is used both as the top-level directory tree in + the stacking order as seen from the host, as well as the mount + point for the overlay file system in the container. At least + two paths have to be specified.</para> + + <para>For details about overlay file systems, see <ulink + url="https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt">overlayfs.txt</ulink>. Note + that the semantics of overlay file systems are substantially + different from normal file systems, in particular regarding + reported device and inode information. Device and inode + information may change for a file while it is being written + to, and processes might see out-of-date versions of files at + times. Note that this switch automatically derives the + <literal>workdir=</literal> mount option for the overlay file + system from the top-level directory tree, making it a sibling + of it. It is hence essential that the top-level directory tree + is not a mount point itself (since the working directory must + be on the same file system as the top-most directory + tree). Also note that the <literal>lowerdir=</literal> mount + option receives the paths to stack in the opposite order of + this switch.</para></listitem> + </varlistentry> + + <varlistentry> <term><option>--setenv=</option></term> <listitem><para>Specifies an environment variable assignment @@ -598,7 +717,7 @@ <listitem><para>Control the architecture ("personality") reported by - <citerefentry><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> in the container. Currently, only <literal>x86</literal> and <literal>x86-64</literal> are supported. This is useful when running a 32-bit container on a 64-bit host. If this setting @@ -693,7 +812,7 @@ <programlisting># pacstrap -c -d ~/arch-tree/ base # systemd-nspawn -bD ~/arch-tree/</programlisting> - <para>This installs a mimimal Arch Linux distribution into the + <para>This installs a minimal Arch Linux distribution into the directory <filename>~/arch-tree/</filename> and then boots an OS in a namespace container in it.</para> </example> @@ -735,7 +854,7 @@ <citerefentry project='archlinux'><refentrytitle>pacman</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd-path.xml b/man/systemd-path.xml index dfc75ee0ff..185a0cc901 100644 --- a/man/systemd-path.xml +++ b/man/systemd-path.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd-quotacheck.service.xml b/man/systemd-quotacheck.service.xml index 2179f11e95..7673635a68 100644 --- a/man/systemd-quotacheck.service.xml +++ b/man/systemd-quotacheck.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,7 +51,7 @@ <refsynopsisdiv> <para><filename>systemd-quotacheck.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-quotacheck</filename></para> + <para><filename>&rootlibexecdir;/systemd-quotacheck</filename></para> </refsynopsisdiv> <refsect1> @@ -86,7 +89,7 @@ <title>See Also</title> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>quotacheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>quotacheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd-random-seed.service.xml b/man/systemd-random-seed.service.xml index 8c836688fe..580c3518c3 100644 --- a/man/systemd-random-seed.service.xml +++ b/man/systemd-random-seed.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,7 +51,7 @@ <refsynopsisdiv> <para><filename>systemd-random-seed.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-random-seed</filename></para> + <para><filename>&rootlibexecdir;/systemd-random-seed</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-remount-fs.service.xml b/man/systemd-remount-fs.service.xml index 7b88ac3f3c..c8c3d16157 100644 --- a/man/systemd-remount-fs.service.xml +++ b/man/systemd-remount-fs.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,7 +51,7 @@ <refsynopsisdiv> <para><filename>systemd-remount-fs.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-remount-fs</filename></para> + <para><filename>&rootlibexecdir;/systemd-remount-fs</filename></para> </refsynopsisdiv> <refsect1> @@ -56,12 +59,12 @@ <para><filename>systemd-remount-fs.service</filename> is an early-boot service that applies mount options listed in - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> - to the root file system, the <filename>/usr</filename> file system + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> + to the root file system, the <filename>/usr</filename> file system, and the kernel API file systems. This is required so that the - mount options of these file systems -- which are pre-mounted by + mount options of these file systems — which are pre-mounted by the kernel, the initial RAM disk, container environments or system - manager code -- are updated to those listed in + manager code — are updated to those listed in <filename>/etc/fstab</filename>. This service ignores normal file systems and only changes the root file system (i.e. <filename>/</filename>), <filename>/usr</filename> and the virtual @@ -80,8 +83,8 @@ <title>See Also</title> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd-resolved.service.xml b/man/systemd-resolved.service.xml index 89ec5f8b19..892ebff7ad 100644 --- a/man/systemd-resolved.service.xml +++ b/man/systemd-resolved.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -50,7 +53,7 @@ <refsynopsisdiv> <para><filename>systemd-resolved.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-resolved</filename></para> + <para><filename>&rootlibexecdir;/systemd-resolved</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-rfkill@.service.xml b/man/systemd-rfkill@.service.xml index 709b09d818..befe001f29 100644 --- a/man/systemd-rfkill@.service.xml +++ b/man/systemd-rfkill@.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,7 +51,7 @@ <refsynopsisdiv> <para><filename>systemd-rfkill@.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-rfkill</filename></para> + <para><filename>&rootlibexecdir;/systemd-rfkill</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-run.xml b/man/systemd-run.xml index febcdb0262..ddd08e5b51 100644 --- a/man/systemd-run.xml +++ b/man/systemd-run.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -294,6 +297,18 @@ <command>set-property</command> command.</para> </listitem> </varlistentry> + <varlistentry> + <term><option>--no-block</option></term> + + <listitem> + <para>Do not synchronously wait for the requested operation + to finish. If this is not specified, the job will be + verified, enqueued and <command>systemd-run</command> will + wait until the unit's start-up is completed. By passing this + argument, it is only verified and enqueued.</para> + </listitem> + </varlistentry> + <xi:include href="user-system-options.xml" xpointer="user" /> <xi:include href="user-system-options.xml" xpointer="system" /> <xi:include href="user-system-options.xml" xpointer="host" /> @@ -346,11 +361,11 @@ Sep 08 07:37:21 bupkis env[19948]: BOOT_IMAGE=/vmlinuz-3.11.0-0.rc5.git6.2.fc20. Mon Dec 8 20:44:24 KST 2014 Running as unit run-71.timer. Will run as unit run-71.service. -# journalctl -b -u run-73.timer +# journalctl -b -u run-71.timer -- Logs begin at Fri 2014-12-05 19:09:21 KST, end at Mon 2014-12-08 20:44:54 KST. -- Dec 08 20:44:38 container systemd[1]: Starting /bin/touch /tmp/foo. Dec 08 20:44:38 container systemd[1]: Started /bin/touch /tmp/foo. -# journalctl -b -u run-73.service +# journalctl -b -u run-71.service -- Logs begin at Fri 2014-12-05 19:09:21 KST, end at Mon 2014-12-08 20:44:54 KST. -- Dec 08 20:44:48 container systemd[1]: Starting /bin/touch /tmp/foo... Dec 08 20:44:48 container systemd[1]: Started /bin/touch /tmp/foo.</programlisting> diff --git a/man/systemd-shutdownd.service.xml b/man/systemd-shutdownd.service.xml deleted file mode 100644 index 756949ce55..0000000000 --- a/man/systemd-shutdownd.service.xml +++ /dev/null @@ -1,77 +0,0 @@ -<?xml version='1.0'?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - -<!-- - This file is part of systemd. - - Copyright 2012 Lennart Poettering - - systemd is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as published by - the Free Software Foundation; either version 2.1 of the License, or - (at your option) any later version. - - systemd is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public License - along with systemd; If not, see <http://www.gnu.org/licenses/>. ---> - -<refentry id="systemd-shutdownd.service"> - - <refentryinfo> - <title>systemd-shutdownd.service</title> - <productname>systemd</productname> - - <authorgroup> - <author> - <contrib>Developer</contrib> - <firstname>Lennart</firstname> - <surname>Poettering</surname> - <email>lennart@poettering.net</email> - </author> - </authorgroup> - </refentryinfo> - - <refmeta> - <refentrytitle>systemd-shutdownd.service</refentrytitle> - <manvolnum>8</manvolnum> - </refmeta> - - <refnamediv> - <refname>systemd-shutdownd.service</refname> - <refname>systemd-shutdownd.socket</refname> - <refname>systemd-shutdownd</refname> - <refpurpose>Scheduled shutdown service</refpurpose> - </refnamediv> - - <refsynopsisdiv> - <para><filename>systemd-shutdownd.service</filename></para> - <para><filename>systemd-shutdownd.socket</filename></para> - <para><filename>/usr/lib/systemd/systemd-shutdownd</filename></para> - </refsynopsisdiv> - - <refsect1> - <title>Description</title> - - <para><filename>systemd-shutdownd.service</filename> is a system - service that implements scheduled shutdowns, as exposed by - <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>. - <filename>systemd-shutdownd.service</filename> is automatically - activated on request and terminates itself when it is - unused.</para> - </refsect1> - - <refsect1> - <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> - </refsect1> - -</refentry> diff --git a/man/systemd-sleep.conf.xml b/man/systemd-sleep.conf.xml index 433f2f83a0..c5d26d0649 100644 --- a/man/systemd-sleep.conf.xml +++ b/man/systemd-sleep.conf.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2013 Zbigniew Jędrzejewski-Szmek + Copyright 2013 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="systemd-sleep.conf" @@ -49,10 +52,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/sleep.conf</filename></para> - <para><filename>/etc/systemd/sleep.conf.d/*.conf</filename></para> + <para><filename>&pkgsysconfdir;/sleep.conf</filename></para> + <para><filename>&pkgsysconfdir;/sleep.conf.d/*.conf</filename></para> <para><filename>/run/systemd/sleep.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/sleep.conf.d/*.conf</filename></para> + <para><filename>&rootlibexecdir;/sleep.conf.d/*.conf</filename></para> </refsynopsisdiv> <refsect1> @@ -112,15 +115,14 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. attempts to suspend or hibernate the machine.</para> </refsect1> - <xi:include href="standard-conf.xml" xpointer="confd" /> - <xi:include href="standard-conf.xml" xpointer="conf" /> + <xi:include href="standard-conf.xml" xpointer="main-conf" /> <refsect1> <title>Options</title> <para>The following options can be configured in the <literal>[Sleep]</literal> section of - <filename>/etc/systemd/sleep.conf</filename> or a + <filename>&pkgsysconfdir;/sleep.conf</filename> or a <filename>sleep.conf.d</filename> file:</para> <variablelist class='systemd-directives'> diff --git a/man/systemd-socket-proxyd.xml b/man/systemd-socket-proxyd.xml index 1c78b656e1..dc3baefe38 100644 --- a/man/systemd-socket-proxyd.xml +++ b/man/systemd-socket-proxyd.xml @@ -1,7 +1,10 @@ <?xml version="1.0"?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -72,7 +75,7 @@ to a configured server for each client, and then bidirectionally forwards data between the two.</para> <para>This utility's behavior is similar to - <citerefentry><refentrytitle>socat</refentrytitle><manvolnum>1</manvolnum></citerefentry>. + <citerefentry project='die-net'><refentrytitle>socat</refentrytitle><manvolnum>1</manvolnum></citerefentry>. The main differences for <command>systemd-socket-proxyd</command> are support for socket activation with <literal>Accept=false</literal> and an event-driven @@ -113,7 +116,7 @@ Requires=nginx.service After=nginx.service [Service] -ExecStart=/usr/lib/systemd/systemd-socket-proxyd /tmp/nginx.sock +ExecStart=]]>&rootlibexecdir;<![CDATA[/systemd-socket-proxyd /tmp/nginx.sock PrivateTmp=yes PrivateNetwork=yes]]></programlisting> </example> @@ -156,7 +159,7 @@ After=nginx.service JoinsNamespaceOf=nginx.service [Service] -ExecStart=/usr/lib/systemd/systemd-socket-proxyd 127.0.0.1:8080 +ExecStart=]]>&rootlibexecdir;<![CDATA[/systemd-socket-proxyd 127.0.0.1:8080 PrivateTmp=yes PrivateNetwork=yes]]></programlisting> </example> @@ -165,7 +168,6 @@ PrivateNetwork=yes]]></programlisting> <programlisting><![CDATA[[...] server { listen 8080; - listen unix:/tmp/nginx.sock; [...]]]></programlisting> </example> <example> @@ -183,9 +185,9 @@ $ curl http://localhost:80/]]></programlisting> <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>socat</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nginx</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>curl</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>socat</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>nginx</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>curl</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> </refentry> diff --git a/man/systemd-suspend.service.xml b/man/systemd-suspend.service.xml index a8beb86f4d..2722d1840a 100644 --- a/man/systemd-suspend.service.xml +++ b/man/systemd-suspend.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -56,7 +59,7 @@ <para><filename>systemd-suspend.service</filename></para> <para><filename>systemd-hibernate.service</filename></para> <para><filename>systemd-hybrid-sleep.service</filename></para> - <para><filename>/usr/lib/systemd/system-sleep</filename></para> + <para><filename>&rootlibexecdir;/system-sleep</filename></para> </refsynopsisdiv> <refsect1> @@ -75,7 +78,7 @@ <para>Immediately before entering system suspend and/or hibernation <filename>systemd-suspend.service</filename> (and the other mentioned units, respectively) will run all executables in - <filename>/usr/lib/systemd/system-sleep/</filename> and pass two + <filename>&rootlibexecdir;/system-sleep/</filename> and pass two arguments to them. The first argument will be <literal>pre</literal>, the second either <literal>suspend</literal>, <literal>hibernate</literal>, or @@ -87,7 +90,7 @@ until all executables have finished.</para> <para>Note that scripts or binaries dropped in - <filename>/usr/lib/systemd/system-sleep/</filename> are intended + <filename>&rootlibexecdir;/system-sleep/</filename> are intended for local use only and should be considered hacks. If applications want to be notified of system suspend/hibernation and resume, there are much nicer interfaces available.</para> @@ -104,7 +107,7 @@ <literal>mem</literal> into <filename>/sys/power/state</filename>, to trigger the actual system suspend. What exactly is written where can be configured in the <literal>[Sleep]</literal> section - of <filename>/etc/systemd/sleep.conf</filename> or a + of <filename>&pkgsysconfdir;/sleep.conf</filename> or a <filename>sleep.conf.d</filename> file. See <citerefentry><refentrytitle>systemd-sleep.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. </para> diff --git a/man/systemd-sysctl.service.xml b/man/systemd-sysctl.service.xml index f35a18a4d4..f7da4cd71a 100644 --- a/man/systemd-sysctl.service.xml +++ b/man/systemd-sysctl.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,7 +51,7 @@ <refsynopsisdiv> <para><filename>systemd-sysctl.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-sysctl</filename></para> + <para><filename>&rootlibexecdir;/systemd-sysctl</filename></para> </refsynopsisdiv> <refsect1> @@ -56,11 +59,11 @@ <para><filename>systemd-sysctl.service</filename> is an early-boot service that configures - <citerefentry><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> kernel parameters.</para> <para>See - <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> for information about the configuration of this service.</para> </refsect1> @@ -68,8 +71,8 @@ <title>See Also</title> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, </para> </refsect1> diff --git a/man/systemd-system-update-generator.xml b/man/systemd-system-update-generator.xml index 3eec1d7b93..5c593b3906 100644 --- a/man/systemd-system-update-generator.xml +++ b/man/systemd-system-update-generator.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -46,7 +49,7 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/usr/lib/systemd/system-generators/systemd-system-update-generator</filename></para> + <para><filename>&rootlibexecdir;/system-generators/systemd-system-update-generator</filename></para> </refsynopsisdiv> <refsect1> @@ -61,10 +64,8 @@ Updates Specification</ulink>. </para> - <para><filename>systemd-system-update-generator</filename> - implements the - <ulink url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator - specification</ulink>.</para> + <para><filename>systemd-system-update-generator</filename> implements + <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> </refsect1> <refsect1> diff --git a/man/systemd-system.conf.xml b/man/systemd-system.conf.xml index 7c3f237567..5aa5da4706 100644 --- a/man/systemd-system.conf.xml +++ b/man/systemd-system.conf.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -51,14 +54,14 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/system.conf</filename></para> - <para><filename>/etc/systemd/system.conf.d/*.conf</filename></para> + <para><filename>&pkgsysconfdir;/system.conf</filename></para> + <para><filename>&pkgsysconfdir;/system.conf.d/*.conf</filename></para> <para><filename>/run/systemd/system.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/system.conf.d/*.conf</filename></para> - <para><filename>/etc/systemd/user.conf</filename></para> - <para><filename>/etc/systemd/user.conf.d/*.conf</filename></para> + <para><filename>&rootlibexecdir;/system.conf.d/*.conf</filename></para> + <para><filename>&pkgsysconfdir;/user.conf</filename></para> + <para><filename>&pkgsysconfdir;/user.conf.d/*.conf</filename></para> <para><filename>/run/systemd/user.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/user.conf.d/*.conf</filename></para> + <para><filename>&rootlibexecdir;/user.conf.d/*.conf</filename></para> </refsynopsisdiv> <refsect1> @@ -74,8 +77,7 @@ operations.</para> </refsect1> - <xi:include href="standard-conf.xml" xpointer="confd" /> - <xi:include href="standard-conf.xml" xpointer="conf" /> + <xi:include href="standard-conf.xml" xpointer="main-conf" /> <refsect1> <title>Options</title> @@ -173,7 +175,7 @@ <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details. Takes a whitespace-separated list of capability names as read by - <citerefentry><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>. + <citerefentry project='mankier'><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>. Capabilities listed will be included in the bounding set, all others are removed. If the list of capabilities is prefixed with ~, all but the listed capabilities will be included, the @@ -261,7 +263,11 @@ <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details on the per-unit settings). For non-service units, <varname>DefaultTimeoutStartSec=</varname> sets the default - <varname>TimeoutSec=</varname> value. </para></listitem> + <varname>TimeoutSec=</varname> + value. <varname>DefaultTimeoutStartSec=</varname> and + <varname>DefaultTimeoutStopSec=</varname> default to + 90s. <varname>DefaultRestartSec=</varname> defaults to + 100ms.</para></listitem> </varlistentry> <varlistentry> @@ -273,7 +279,10 @@ <varname>StartLimitInterval=</varname> and <varname>StartLimitBurst=</varname>. See <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> - for details on the per-service settings.</para></listitem> + for details on the per-service settings. + <varname>DefaultStartLimitInterval=</varname> defaults to + 10s. <varname>DefaultStartLimitBurst=</varname> defaults to + 5.</para></listitem> </varlistentry> <varlistentry> diff --git a/man/systemd-sysusers.xml b/man/systemd-sysusers.xml index a0c0f996ac..cbe4f2f9cb 100644 --- a/man/systemd-sysusers.xml +++ b/man/systemd-sysusers.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd-sysv-generator.xml b/man/systemd-sysv-generator.xml index e619b1bc2e..e7592d6692 100644 --- a/man/systemd-sysv-generator.xml +++ b/man/systemd-sysv-generator.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -46,7 +49,7 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/usr/lib/systemd/system-generators/systemd-sysv-generator</filename></para> + <para><filename>&rootlibexecdir;/system-generators/systemd-sysv-generator</filename></para> </refsynopsisdiv> <refsect1> @@ -81,10 +84,8 @@ part of early boot, so all wrapper units are ordered after <filename>basic.target</filename>.</para> - <para><filename>systemd-sysv-generator</filename> - implements the <ulink - url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator - specification</ulink>.</para> + <para><filename>systemd-sysv-generator</filename> implements + <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> </refsect1> <refsect1> diff --git a/man/systemd-timedated.service.xml b/man/systemd-timedated.service.xml index e44163aefb..3598490d14 100644 --- a/man/systemd-timedated.service.xml +++ b/man/systemd-timedated.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -50,7 +53,7 @@ <refsynopsisdiv> <para><filename>systemd-timedated.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-timedated</filename></para> + <para><filename>&rootlibexecdir;/systemd-timedated</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-timesyncd.service.xml b/man/systemd-timesyncd.service.xml index ac1af2d136..a1b364534b 100644 --- a/man/systemd-timesyncd.service.xml +++ b/man/systemd-timesyncd.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -50,7 +53,7 @@ <refsynopsisdiv> <para><filename>systemd-timesyncd.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-timesyncd</filename></para> + <para><filename>&rootlibexecdir;/systemd-timesyncd</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-tmpfiles.xml b/man/systemd-tmpfiles.xml index ceec06f840..f12f997f93 100644 --- a/man/systemd-tmpfiles.xml +++ b/man/systemd-tmpfiles.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd-tty-ask-password-agent.xml b/man/systemd-tty-ask-password-agent.xml index 2876fab644..dac3a3c02c 100644 --- a/man/systemd-tty-ask-password-agent.xml +++ b/man/systemd-tty-ask-password-agent.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd-udevd.service.xml b/man/systemd-udevd.service.xml index b18b22871f..c0d323033c 100644 --- a/man/systemd-udevd.service.xml +++ b/man/systemd-udevd.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <refentry id="systemd-udevd.service" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -37,7 +40,7 @@ <para><filename>systemd-udevd-kernel.socket</filename></para> <cmdsynopsis> - <command>/usr/lib/systemd/systemd-udevd</command> + <command>&rootlibexecdir;/systemd-udevd</command> <arg><option>--daemon</option></arg> <arg><option>--debug</option></arg> <arg><option>--children-max=</option></arg> diff --git a/man/systemd-update-done.service.xml b/man/systemd-update-done.service.xml index d65f175418..3f121582e9 100644 --- a/man/systemd-update-done.service.xml +++ b/man/systemd-update-done.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,7 +51,7 @@ <refsynopsisdiv> <para><filename>systemd-update-done.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-update-done</filename></para> + <para><filename>&rootlibexecdir;/systemd-update-done</filename></para> </refsynopsisdiv> <refsect1> diff --git a/man/systemd-update-utmp.service.xml b/man/systemd-update-utmp.service.xml index b842d29721..285691849f 100644 --- a/man/systemd-update-utmp.service.xml +++ b/man/systemd-update-utmp.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -51,7 +54,7 @@ <refsynopsisdiv> <para><filename>systemd-update-utmp.service</filename></para> <para><filename>systemd-update-utmp-runlevel.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-update-utmp</filename></para> + <para><filename>&rootlibexecdir;/systemd-update-utmp</filename></para> </refsynopsisdiv> <refsect1> @@ -69,7 +72,7 @@ <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>auditd</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>auditd</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd-user-sessions.service.xml b/man/systemd-user-sessions.service.xml index 9d796b1ae1..620648cfe8 100644 --- a/man/systemd-user-sessions.service.xml +++ b/man/systemd-user-sessions.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,20 +51,19 @@ <refsynopsisdiv> <para><filename>systemd-user-sessions.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-user-sessions</filename></para> + <para><filename>&rootlibexecdir;/systemd-user-sessions</filename></para> </refsynopsisdiv> <refsect1> <title>Description</title> <para><filename>systemd-user-sessions.service</filename> is a - service that controls user logins. After basic system - initialization is complete it removes + service that controls user logins through + <citerefentry project='man-pages'><refentrytitle>pam_nologin</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + After basic system initialization is complete it removes <filename>/run/nologin</filename>, thus permitting logins. Before system shutdown it creates <filename>/run/nologin</filename>, thus - prohibiting further logins. At the same time it also kills all - user processes, so that system shutdown may proceed without any - remaining user processes around.</para> + prohibiting further logins.</para> </refsect1> <refsect1> diff --git a/man/systemd-vconsole-setup.service.xml b/man/systemd-vconsole-setup.service.xml index 59bb5e4e8c..6c6d8e2af0 100644 --- a/man/systemd-vconsole-setup.service.xml +++ b/man/systemd-vconsole-setup.service.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -48,7 +51,7 @@ <refsynopsisdiv> <para><filename>systemd-vconsole-setup.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-vconsole-setup</filename></para> + <para><filename>&rootlibexecdir;/systemd-vconsole-setup</filename></para> </refsynopsisdiv> <refsect1> @@ -57,9 +60,9 @@ <para><filename>systemd-vconsole-setup.service</filename> is an early-boot service that configures the virtual console font and console keymap. Internally it calls - <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry> and - <citerefentry><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> + <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> <para>See <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> @@ -105,8 +108,8 @@ <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml index 3db65d988d..18c10d00f5 100644 --- a/man/systemd.automount.xml +++ b/man/systemd.automount.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -96,7 +99,7 @@ <para>Automount units may either be configured via unit files, or via <filename>/etc/fstab</filename> (see - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details).</para> <para>For details how systemd parses @@ -135,6 +138,14 @@ creating these directories. Takes an access mode in octal notation. Defaults to 0755.</para></listitem> </varlistentry> + <varlistentry> + <term><varname>TimeoutIdleSec=</varname></term> + <listitem><para>Configures an idleness timeout. Once the mount has been + idle for the specified time, systemd will attempt to unmount. Takes a + unit-less value in seconds, or a time span value such as "5min 20s". + Pass 0 to disable the timeout logic. The timeout is disabled by + default.</para></listitem> + </varlistentry> </variablelist> </refsect1> @@ -145,8 +156,8 @@ <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>automount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>automount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd.device.xml b/man/systemd.device.xml index ac6deafb18..96a20d14d1 100644 --- a/man/systemd.device.xml +++ b/man/systemd.device.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 11b160e58f..ea53722f0f 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -1,5 +1,8 @@ <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -283,7 +286,9 @@ shortly before the process is executed (more specifically, after all processes from a previous unit state terminated. This means you can generate these files in one unit state, and - read it with this option in the next). Settings from these + read it with this option in the next).</para> + + <para>Settings from these files override settings made with <varname>Environment=</varname>. If the same variable is set twice from these files, the files will be read in the order @@ -334,7 +339,7 @@ service was activated from, which is primarily useful for compatibility with daemons designed for use with the traditional - <citerefentry><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='freebsd'><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry> daemon.</para> <para>This setting defaults to @@ -661,7 +666,7 @@ <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details. Takes a whitespace-separated list of capability names as read by - <citerefentry><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry project='mankier'><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>, e.g. <constant>CAP_SYS_ADMIN</constant>, <constant>CAP_DAC_OVERRIDE</constant>, <constant>CAP_SYS_PTRACE</constant>. Capabilities listed will @@ -709,7 +714,7 @@ set for the executed process. Take a capability string describing the effective, permitted and inherited capability sets as documented in - <citerefentry><refentrytitle>cap_from_text</refentrytitle><manvolnum>3</manvolnum></citerefentry>. + <citerefentry project='mankier'><refentrytitle>cap_from_text</refentrytitle><manvolnum>3</manvolnum></citerefentry>. Note that these capability sets are usually influenced (and filtered) by the capabilities attached to the executed file. Due to that <varname>CapabilityBoundingSet=</varname> is @@ -879,7 +884,7 @@ <option>private</option>, which control whether mounts in the file system namespace set up for this unit's processes will receive or propagate mounts or unmounts. See - <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>2</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>2</manvolnum></citerefentry> for details. Defaults to <option>shared</option>. Use <option>shared</option> to ensure that mounts and unmounts are propagated from the host to the container and vice versa. Use @@ -927,7 +932,7 @@ authorize the transition. This directive is ignored if SELinux is disabled. If prefixed by <literal>-</literal>, all errors will be ignored. See - <citerefentry><refentrytitle>setexeccon</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>setexeccon</refentrytitle><manvolnum>3</manvolnum></citerefentry> for details.</para></listitem> </varlistentry> @@ -1074,7 +1079,7 @@ prefixed with <constant>~</constant> the listed address families will be applied as blacklist, otherwise as whitelist. Note that this restricts access to the - <citerefentry><refentrytitle>socket</refentrytitle><manvolnum>2</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call only. Sockets passed into the process by other means (for example, by using socket activation with socket units, see @@ -1102,7 +1107,7 @@ <term><varname>Personality=</varname></term> <listitem><para>Controls which kernel architecture - <citerefentry><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> shall report, when invoked by unit processes. Takes one of <constant>x86</constant> and <constant>x86-64</constant>. This is useful when running 32-bit services on a 64-bit host @@ -1164,7 +1169,7 @@ <term><varname>$LANG</varname></term> <listitem><para>Locale. Can be set in - <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> or on the kernel command line (see <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> and @@ -1182,7 +1187,7 @@ login shell. The variables are set for the units that have <varname>User=</varname> set, which includes user <command>systemd</command> instances. See - <citerefentry><refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + <citerefentry project='die-net'><refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum></citerefentry>. </para></listitem> </varlistentry> diff --git a/man/systemd.generator.xml b/man/systemd.generator.xml index ccb698752a..5ce0592a6e 100644 --- a/man/systemd.generator.xml +++ b/man/systemd.generator.xml @@ -59,14 +59,14 @@ <para> <literallayout><filename>/run/systemd/system-generators/*</filename> -<filename>/etc/systemd/system-generators/*</filename> +<filename>&pkgsysconfdir;/system-generators/*</filename> <filename>/usr/local/lib/systemd/system-generators/*</filename> <filename>&systemgeneratordir;/*</filename></literallayout> </para> <para> <literallayout><filename>/run/systemd/user-generators/*</filename> -<filename>/etc/systemd/user-generators/*</filename> +<filename>&pkgsysconfdir;/user-generators/*</filename> <filename>/usr/local/lib/systemd/user-generators/*</filename> <filename>&usergeneratordir;/*</filename></literallayout> </para> @@ -140,7 +140,7 @@ <listitem> <para><parameter>late-dir</parameter></para> <para>argv[3] may be used to extend the unit file tree without - overridding any other unit files. Any native configuration + overriding any other unit files. Any native configuration files supplied by the vendor or user/administrator take precedence over the generated ones placed in this directory. </para> @@ -333,7 +333,7 @@ find $dir</programlisting> <citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-efi-boot-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-getty-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml index 1fd46de31f..2cb010c0be 100644 --- a/man/systemd.journal-fields.xml +++ b/man/systemd.journal-fields.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -134,7 +137,7 @@ derived from glibc's <varname>program_invocation_short_name</varname> variable, see - <citerefentry><refentrytitle>program_invocation_short_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>.)</para> + <citerefentry project='die-net'><refentrytitle>program_invocation_short_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>.)</para> </listitem> </varlistentry> @@ -390,7 +393,7 @@ </varlistentry> </variablelist> - <para>Priviledged programs (currently UID 0) may attach + <para>Privileged programs (currently UID 0) may attach <varname>OBJECT_PID=</varname> to a message. This will instruct <command>systemd-journald</command> to attach additional fields on behalf of the caller:</para> diff --git a/man/systemd.kill.xml b/man/systemd.kill.xml index c974e22489..ef828e081c 100644 --- a/man/systemd.kill.xml +++ b/man/systemd.kill.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -135,7 +138,7 @@ of shutting down a unit (see above), and is usually followed by <constant>SIGKILL</constant> (see above and below). For a list of valid signals, see - <citerefentry><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>. + <citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>. Defaults to <constant>SIGTERM</constant>. </para></listitem> </varlistentry> @@ -176,7 +179,7 @@ <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>kill</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd.link.xml b/man/systemd.link.xml index 3fac760b01..5db06842bd 100644 --- a/man/systemd.link.xml +++ b/man/systemd.link.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -56,21 +59,21 @@ <command>net_setup_link</command> udev builtin.</para> <para>The link files are read from the files located in the system - network directory <filename>/usr/lib/systemd/network</filename>, + network directory <filename>&rootlibexecdir;/network</filename>, the volatile runtime network directory <filename>/run/systemd/network</filename>, and the local administration network directory - <filename>/etc/systemd/network</filename>. Link files must have + <filename>&pkgsysconfdir;/network</filename>. Link files must have the extension <filename>.link</filename>; other extensions are ignored. All link files are collectively sorted and processed in lexical order, regardless of the directories in which they live. However, files with identical filenames replace each other. Files in <filename>/etc</filename> have the highest priority, files in <filename>/run</filename> take precedence over files with the same - name in <filename>/usr/lib</filename>. This can be used to + name in <filename>&rootprefix;/lib</filename>. This can be used to override a system-supplied link file with a local file if needed; a symlink in <filename>/etc</filename> with the same name as a - link file in <filename>/usr/lib</filename>, pointing to + link file in <filename>&rootprefix;/lib</filename>, pointing to <filename>/dev/null</filename>, disables the link file entirely.</para> @@ -382,7 +385,7 @@ <refsect1> <title>Example</title> <example> - <title>/etc/systemd/network/wireless.link</title> + <title>&pkgsysconfdir;/network/wireless.link</title> <programlisting>[Match] MACAddress=12:34:56:78:9a:bc diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index 5cbde8b84c..f22c86adc1 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -68,7 +71,7 @@ <para>Additional options are listed in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, which define the execution environment the - <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> binary is executed in, and in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>, which define the way the processes are terminated, and in @@ -78,7 +81,7 @@ particularly useful for mount units specifying a <literal>Type=</literal> option or using configuration not specified in <filename>/etc/fstab</filename>; - <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> will refuse options that are not listed in <filename>/etc/fstab</filename> if it is not run as UID 0.</para> @@ -106,7 +109,7 @@ </para> <para>Some file systems have special semantics as API file systems - for kernel-to-userspace and userspace-to-userpace interfaces. Some + for kernel-to-userspace and userspace-to-userspace interfaces. Some of them may not be changed via mount units, and cannot be disabled. For a longer discussion see <ulink url="http://www.freedesktop.org/wiki/Software/systemd/APIFileSystems">API @@ -118,7 +121,7 @@ <para>Mount units may either be configured via unit files, or via <filename>/etc/fstab</filename> (see - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). Mounts listed in <filename>/etc/fstab</filename> will be converted into native units dynamically at boot and when the configuration of the system manager is reloaded. In general, @@ -139,6 +142,36 @@ <variablelist class='fstab-options'> <varlistentry> + <term><option>x-systemd.requires=</option></term> + + <listitem><para>Configures a <varname>Requires=</varname> and + an <varname>After=</varname> dependency between the created + mount unit and another systemd unit, such as a device or mount + unit. The argument should be a unit name, or an absolute path + to a device node or mount point. This option may be specified + more than once. This option is particularly useful for mount + point declarations that need an additional device to be around + (such as an external journal device for journal file systems) + or an additional mount to be in place (such as an overlay file + system that merges multiple mount points). See + <varname>After=</varname> and <varname>Requires=</varname> in + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for details.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>x-systemd.requires-mounts-for=</option></term> + + <listitem><para>Configures a + <varname>RequiresMountsFor=</varname> dependency between the + created mount unit and other mount units. The argument must be + an absolute path. This option may be specified more than once. + See <varname>RequiresMountsFor=</varname> in + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for details.</para></listitem> + </varlistentry> + + <varlistentry> <term><option>x-systemd.automount</option></term> <listitem><para>An automount unit will be created for the file @@ -148,6 +181,15 @@ </varlistentry> <varlistentry> + <term><option>x-systemd.idle-timeout=</option></term> + + <listitem><para>Configures the idleness timeout of the + automount unit. See <varname>TimeoutIdleSec=</varname> in + <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for details.</para></listitem> + </varlistentry> + + <varlistentry> <term><option>x-systemd.device-timeout=</option></term> <listitem><para>Configure how long systemd should wait for a @@ -231,7 +273,7 @@ <term><varname>What=</varname></term> <listitem><para>Takes an absolute path of a device node, file or other resource to mount. See - <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details. If this refers to a device node, a dependency on the respective device unit is automatically created. (See <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry> @@ -251,7 +293,7 @@ <varlistentry> <term><varname>Type=</varname></term> <listitem><para>Takes a string for the file system type. See - <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details. This setting is optional.</para></listitem> </varlistentry> @@ -270,7 +312,7 @@ the options specified in <varname>Options=</varname> is relaxed, and unknown mount options are tolerated. This corresponds with - <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>'s + <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>'s <parameter>-s</parameter> switch. Defaults to off.</para></listitem> </varlistentry> @@ -321,7 +363,7 @@ <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> </para> diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml index 4480e1999d..786c7d478a 100644 --- a/man/systemd.netdev.xml +++ b/man/systemd.netdev.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -68,20 +71,20 @@ <para>The <filename>.netdev</filename> files are read from the files located in the system network directory - <filename>/usr/lib/systemd/network</filename>, the volatile + <filename>&rootlibexecdir;/network</filename>, the volatile runtime network directory <filename>/run/systemd/network</filename> and the local administration network directory - <filename>/etc/systemd/network</filename>. All configuration files + <filename>&pkgsysconfdir;/network</filename>. All configuration files are collectively sorted and processed in lexical order, regardless of the directories in which they live. However, files with identical filenames replace each other. Files in <filename>/etc</filename> have the highest priority, files in <filename>/run</filename> take precedence over files with the same - name in <filename>/usr/lib</filename>. This can be used to + name in <filename>&rootprefix;/lib</filename>. This can be used to override a system-supplied configuration file with a local file if needed; a symlink in <filename>/etc</filename> with the same name - as a configuration file in <filename>/usr/lib</filename>, pointing + as a configuration file in <filename>&rootprefix;/lib</filename>, pointing to <filename>/dev/null</filename>, disables the configuration file entirely.</para> @@ -108,7 +111,7 @@ <entry>A bond device is an aggregation of all its slave devices. See <ulink url="https://www.kernel.org/doc/Documentation/networking/bonding.txt">Linux Ethernet Bonding Driver HOWTO</ulink> for details.Local configuration</entry></row> <row><entry><varname>bridge</varname></entry> - <entry>A bridge devcie is a software switch, each of its slave devices and the bridge itself are ports of the switch.</entry></row> + <entry>A bridge device is a software switch, each of its slave devices and the bridge itself are ports of the switch.</entry></row> <row><entry><varname>dummy</varname></entry> <entry>A dummy device drops all packets sent to it.</entry></row> @@ -155,6 +158,9 @@ <row><entry><varname>vti</varname></entry> <entry>An IPv4 over IPSec tunnel.</entry></row> + <row><entry><varname>vti6</varname></entry> + <entry>An IPv6 over IPSec tunnel.</entry></row> + <row><entry><varname>vxlan</varname></entry> <entry>A virtual extensible LAN (vxlan), for connecting Cloud computing deployments.</entry></row> </tbody> @@ -253,7 +259,7 @@ <para>The maximum transmission unit in bytes to set for the device. The usual suffixes K, M, G, are supported and are understood to the base of 1024. This key is not - currently suported for <literal>tun</literal> or + currently supported for <literal>tun</literal> or <literal>tap</literal> devices. </para> </listitem> @@ -265,7 +271,7 @@ given, one is generated based on the interface name and the <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>. - This key is not currently suported for + This key is not currently supported for <literal>tun</literal> or <literal>tap</literal> devices. </para> </listitem> @@ -410,6 +416,24 @@ on.</para> </listitem> </varlistentry> + <varlistentry> + <term><varname>UDPCheckSum=</varname></term> + <listitem> + <para>A boolean. When true transmitting UDP checksums when doing VXLAN/IPv4 is turned on.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>UDP6ZeroChecksumTx=</varname></term> + <listitem> + <para>A boolean. When true sending zero checksums in VXLAN/IPv6 is turned on.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>UDP6ZeroCheckSumRx=</varname></term> + <listitem> + <para>A boolean. When true receiving zero checksums in VXLAN/IPv6 is turned on.</para> + </listitem> + </varlistentry> </variablelist> </refsect1> <refsect1> @@ -423,7 +447,8 @@ <literal>gretap</literal>, <literal>ip6gre</literal>, <literal>ip6gretap</literal>, - <literal>vti</literal>, and + <literal>vti</literal>, + <literal>vti6</literal>, and <literal>ip6tnl</literal> and accepts the following keys:</para> @@ -534,7 +559,7 @@ <varlistentry> <term><varname>PacketInfo=</varname></term> <listitem><para>Takes a boolean argument. Configures whether - packets should be prepened with four extra bytes (two flag + packets should be prepended with four extra bytes (two flag bytes and two protocol bytes). If disabled it indicates that the packets will be pure IP packets. Defaults to <literal>no</literal>.</para> @@ -647,13 +672,180 @@ </listitem> </varlistentry> + <varlistentry> + <term><varname>LearnPacketIntervalSec=</varname></term> + <listitem> + <para>Specifies the number of seconds between instances where the bonding + driver sends learning packets to each slaves peer switch. + The valid range is 1 - 0x7fffffff; the default value is 1. This Option + has effect only in balance-tlb and balance-alb modes.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>AdSelect=</varname></term> + <listitem> + <para>Specifies the 802.3ad aggregation selection logic to use. Possible values are + <literal>stable</literal>, + <literal>bandwidth</literal>, + <literal>count</literal> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>FailOverMACPolicy=</varname></term> + <listitem> + <para>Specifies whether active-backup mode should set all slaves to + the same MAC address at enslavement or, when enabled, perform special handling of the + bond's MAC address in accordance with the selected policy. The default policy is none. + Possible values are + <literal>none</literal>, + <literal>active</literal>, + <literal>follow</literal> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ARPValidate=</varname></term> + <listitem> + <para>Specifies whether or not ARP probes and replies should be + validated in any mode that supports ARP monitoring, or whether + non-ARP traffic should be filtered (disregarded) for link + monitoring purposes. Possible values are + <literal>none</literal>, + <literal>active</literal>, + <literal>backup</literal>, + <literal>all</literal> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ARPIntervalSec=</varname></term> + <listitem> + <para>Specifies the ARP link monitoring frequency in milliseconds. + A value of 0 disables ARP monitoring. The default value is 0. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ARPIPTargets=</varname></term> + <listitem> + <para>Specifies the IP addresses to use as ARP monitoring peers when + ARPIntervalSec is greater than 0. These are the targets of the ARP request + sent to determine the health of the link to the targets. + Specify these values in ipv4 dotted decimal format. At least one IP + address must be given for ARP monitoring to function. The + maximum number of targets that can be specified is 16. The + default value is no IP addresses. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ARPAllTargets=</varname></term> + <listitem> + <para>Specifies the quantity of ARPIPTargets that must be reachable + in order for the ARP monitor to consider a slave as being up. + This option affects only active-backup mode for slaves with + ARPValidate enabled. Possible values are + <literal>any</literal>, + <literal>all</literal> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>PrimaryReselectPolicy=</varname></term> + <listitem> + <para>Specifies the reselection policy for the primary slave. This + affects how the primary slave is chosen to become the active slave + when failure of the active slave or recovery of the primary slave + occurs. This option is designed to prevent flip-flopping between + the primary slave and other slaves. Possible values are + <literal>always</literal>, + <literal>better</literal>, + <literal>failure</literal> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ResendIGMP=</varname></term> + <listitem> + <para>Specifies the number of IGMP membership reports to be issued after + a failover event. One membership report is issued immediately after + the failover, subsequent packets are sent in each 200ms interval. + The valid range is (0 - 255). Defaults to 1. A value of 0 + prevents the IGMP membership report from being issued in response + to the failover event. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>PacketsPerSlave=</varname></term> + <listitem> + <para> Specify the number of packets to transmit through a slave before + moving to the next one. When set to 0 then a slave is chosen at + random.The valid range is (0 - 65535). Defaults to 1. This option + has effect only in balance-rr mode. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>GratuitousARP=</varname></term> + <listitem> + <para>Specify the number of peer notifications (gratuitous ARPs and + unsolicited IPv6 Neighbor Advertisements) to be issued after a + failover event. As soon as the link is up on the new slave + a peer notification is sent on the bonding device and each + VLAN sub-device. This is repeated at each link monitor interval + (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is + greater than 1. The valid range is (0 - 255). Default value is 1. + These options affect only the active-backup mode. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>AllSlavesActive=</varname></term> + <listitem> + <para> A boolean. Specifies that duplicate frames (received on inactive ports) + should be dropped false or delivered true. Normally, bonding will drop + duplicate frames (received on inactive ports), which is desirable for + most users. But there are some times it is nice to allow duplicate + frames to be delivered. The default value is false (drop duplicate frames + received on inactive ports). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>MinLinks=</varname></term> + <listitem> + <para>Specifies the minimum number of links that must be active before + asserting carrier. The default value is 0. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para>For more detail information see + <ulink url="https://www.kernel.org/doc/Documentation/networking/bonding.txt"> + Linux Ethernet Bonding Driver HOWTO</ulink></para> + </refsect1> <refsect1> <title>Example</title> <example> - <title>/etc/systemd/network/bridge.netdev</title> + <title>&pkgsysconfdir;/network/bridge.netdev</title> <programlisting>[NetDev] Name=bridge0 @@ -661,7 +853,7 @@ Kind=bridge</programlisting> </example> <example> - <title>/etc/systemd/network/vlan1.netdev</title> + <title>&pkgsysconfdir;/network/vlan1.netdev</title> <programlisting>[Match] Virtualization=no @@ -674,7 +866,7 @@ Kind=vlan Id=1</programlisting> </example> <example> - <title>/etc/systemd/network/ipip.netdev</title> + <title>&pkgsysconfdir;/network/ipip.netdev</title> <programlisting>[NetDev] Name=ipip-tun Kind=ipip @@ -686,7 +878,7 @@ Remote=192.169.224.239 TTL=64</programlisting> </example> <example> - <title>/etc/systemd/network/tap.netdev</title> + <title>&pkgsysconfdir;/network/tap.netdev</title> <programlisting>[NetDev] Name=tap-test Kind=tap @@ -696,7 +888,7 @@ MultiQueue=true PacketInfo=true</programlisting> </example> <example> - <title>/etc/systemd/network/sit.netdev</title> + <title>&pkgsysconfdir;/network/sit.netdev</title> <programlisting>[NetDev] Name=sit-tun Kind=sit @@ -708,7 +900,7 @@ Remote=10.65.223.239</programlisting> </example> <example> - <title>/etc/systemd/network/gre.netdev</title> + <title>&pkgsysconfdir;/network/gre.netdev</title> <programlisting>[NetDev] Name=gre-tun Kind=gre @@ -720,7 +912,7 @@ Remote=10.65.223.239</programlisting> </example> <example> - <title>/etc/systemd/network/vti.netdev</title> + <title>&pkgsysconfdir;/network/vti.netdev</title> <programlisting>[NetDev] Name=vti-tun @@ -733,7 +925,7 @@ Remote=10.65.223.239</programlisting> </example> <example> - <title>/etc/systemd/network/veth.netdev</title> + <title>&pkgsysconfdir;/network/veth.netdev</title> <programlisting>[NetDev] Name=veth-test Kind=veth @@ -743,7 +935,7 @@ Name=veth-peer</programlisting> </example> <example> - <title>/etc/systemd/network/dummy.netdev</title> + <title>&pkgsysconfdir;/network/dummy.netdev</title> <programlisting>[NetDev] Name=dummy-test Kind=dummy diff --git a/man/systemd.network.xml b/man/systemd.network.xml index 485876b6ac..54fef4c9c4 100644 --- a/man/systemd.network.xml +++ b/man/systemd.network.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -64,20 +67,20 @@ <para>The <filename>.network</filename> files are read from the files located in the system network directory - <filename>/usr/lib/systemd/network</filename>, the volatile + <filename>&rootlibexecdir;/network</filename>, the volatile runtime network directory <filename>/run/systemd/network</filename> and the local administration network directory - <filename>/etc/systemd/network</filename>. All configuration files + <filename>&pkgsysconfdir;/network</filename>. All configuration files are collectively sorted and processed in lexical order, regardless of the directories in which they live. However, files with identical filenames replace each other. Files in <filename>/etc</filename> have the highest priority, files in <filename>/run</filename> take precedence over files with the same - name in <filename>/usr/lib</filename>. This can be used to + name in <filename>&rootprefix;/lib</filename>. This can be used to override a system-supplied configuration file with a local file if needed; a symlink in <filename>/etc</filename> with the same name - as a configuration file in <filename>/usr/lib</filename>, pointing + as a configuration file in <filename>&rootprefix;/lib</filename>, pointing to <filename>/dev/null</filename>, disables the configuration file entirely.</para> @@ -91,7 +94,8 @@ to a given device; and a <literal>[Network]</literal> section specifying how the device should be configured. The first (in lexical order) of the network files that matches a given device - is applied.</para> + is applied, all later files are ignored, even if they match as + well.</para> <para>A network file is said to match a device if each of the entries in the <literal>[Match]</literal> section matches, or if @@ -227,6 +231,10 @@ <para>Enables DHCPv4 and/or DHCPv6 support. Accepts <literal>yes</literal>, <literal>no</literal>, <literal>ipv4</literal>, or <literal>ipv6</literal>.</para> + + <para>Please note that by default the domain name + specified through DHCP is not used for name resolution. + See option <option>UseDomains=</option> below.</para> </listitem> </varlistentry> <varlistentry> @@ -280,13 +288,24 @@ </listitem> </varlistentry> <varlistentry> + <term><varname>BindCarrier=</varname></term> + <listitem> + <para>A port or a list of ports. When set, controls the + behaviour of the current interface. When all ports in the list + are in an operational down state, the current interface is brought + down. When at least one port has carrier, the current interface + is brought up. + </para> + </listitem> + </varlistentry> + <varlistentry> <term><varname>Address=</varname></term> <listitem> <para>A static IPv4 or IPv6 address and its prefix length, separated by a <literal>/</literal> character. Specify this key more than once to configure several addresses. The format of the address must be as described in - <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. + <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. This is a short-hand for an [Address] section only containing an Address key (see below). This option may be specified more than once. @@ -312,7 +331,7 @@ <listitem> <para>The gateway address, which must be in the format described in - <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. + <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. This is a short-hand for a [Route] section only containing a Gateway key. This option may be specified more than once.</para> @@ -323,7 +342,7 @@ <listitem> <para>A DNS server address, which must be in the format described in - <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. + <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. This option may be specified more than once.</para> </listitem> </varlistentry> @@ -347,7 +366,23 @@ the routing table. Takes either a boolean argument, or the values <literal>ipv4</literal> or <literal>ipv6</literal>, which only enables IP forwarding for the specified address - family.</para></listitem> + family, or <literal>kernel</literal>, which preserves existing sysctl settings. + This controls the + <filename>net.ipv4.conf.<interface>.forwarding</filename> + and + <filename>net.ipv6.conf.<interface>.forwarding</filename> + sysctl options of the network interface (see <ulink + url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink> + for details about sysctl options). Defaults to + <literal>no</literal>.</para> + + <para>Note: unless this option is turned on, or set to <literal>kernel</literal>, + no IP forwarding is done on this interface, even if this is + globally turned on in the kernel, with the + <filename>net.ipv4.ip_forward</filename> and + <filename>net.ipv4.ip_forward</filename> sysctl + options.</para> + </listitem> </varlistentry> <varlistentry> <term><varname>IPMasquerade=</varname></term> @@ -355,7 +390,8 @@ interface. If enabled packets forwarded from the network interface will be appear as coming from the local host. Takes a boolean argument. Implies - <varname>IPForward=yes</varname>.</para></listitem> + <varname>IPForward=ipv4</varname>. Defaults to + <literal>no</literal>.</para></listitem> </varlistentry> <varlistentry> <term><varname>Bridge=</varname></term> @@ -429,7 +465,7 @@ <listitem> <para>The broadcast address, which must be in the format described in - <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. + <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. This key only applies to IPv4 addresses. If it is not given, it is derived from the <literal>Address</literal> key.</para> @@ -501,6 +537,17 @@ <para>When true (the default), the DNS servers received from the DHCP server will be used and take precedence over any statically configured ones.</para> + + <para>This corresponds to the <option>nameserver</option> + option in <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>UseNTP=</varname></term> + <listitem> + <para>When true (the default), the NTP servers received + from the DHCP server will be used by systemd-timesyncd + and take precedence over any statically configured ones.</para> </listitem> </varlistentry> <varlistentry> @@ -531,7 +578,13 @@ <listitem> <para>When true (not the default), the domain name received from the DHCP server will be used for DNS - resolution over this link.</para> + resolution over this link. When a name cannot be resolved + as specified, the domain name will be used a suffix and + name resolution of that will be attempted.</para> + + <para>This corresponds to the <option>domain</option> + option in <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + and should not be enabled on untrusted networks.</para> </listitem> </varlistentry> <varlistentry> @@ -553,6 +606,14 @@ </listitem> </varlistentry> <varlistentry> + <term><varname>ClientIdentifier=</varname></term> + <listitem> + <para>DHCP client identifier to use. Either <literal>mac</literal> + to use the MAC address of the link or <literal>duid</literal> + (the default) to use a RFC4361-compliant Client ID.</para> + </listitem> + </varlistentry> + <varlistentry> <term><varname>VendorClassIdentifier=</varname></term> <listitem> <para>The vendor class identifier used to identify vendor @@ -626,7 +687,7 @@ <refsect1> <title>Example</title> <example> - <title>/etc/systemd/network/50-static.network</title> + <title>&pkgsysconfdir;/network/50-static.network</title> <programlisting>[Match] Name=enp2s0 @@ -637,17 +698,17 @@ Gateway=192.168.0.1</programlisting> </example> <example> - <title>/etc/systemd/network/80-dhcp.network</title> + <title>&pkgsysconfdir;/network/80-dhcp.network</title> <programlisting>[Match] Name=en* [Network] -DHCP=both</programlisting> +DHCP=yes</programlisting> </example> <example> - <title>/etc/systemd/network/bridge-static.network</title> + <title>&pkgsysconfdir;/network/bridge-static.network</title> <programlisting>[Match] Name=bridge0 @@ -659,7 +720,7 @@ DNS=192.168.0.1</programlisting> </example> <example> - <title>/etc/systemd/network/bridge-slave-interface.network</title> + <title>&pkgsysconfdir;/network/bridge-slave-interface.network</title> <programlisting>[Match] Name=enp2s0 @@ -668,7 +729,7 @@ Name=enp2s0 Bridge=bridge0</programlisting> </example> <example> - <title>/etc/systemd/network/ipip.network</title> + <title>&pkgsysconfdir;/network/ipip.network</title> <programlisting>[Match] Name=em1 @@ -678,7 +739,7 @@ Tunnel=ipip-tun</programlisting> </example> <example> - <title>/etc/systemd/network/sit.network</title> + <title>&pkgsysconfdir;/network/sit.network</title> <programlisting>[Match] Name=em1 @@ -688,7 +749,7 @@ Tunnel=sit-tun</programlisting> </example> <example> - <title>/etc/systemd/network/gre.network</title> + <title>&pkgsysconfdir;/network/gre.network</title> <programlisting>[Match] Name=em1 @@ -698,7 +759,7 @@ Tunnel=gre-tun</programlisting> </example> <example> - <title>/etc/systemd/network/vti.network</title> + <title>&pkgsysconfdir;/network/vti.network</title> <programlisting>[Match] Name=em1 diff --git a/man/systemd.path.xml b/man/systemd.path.xml index 08a7ec8975..03b626b560 100644 --- a/man/systemd.path.xml +++ b/man/systemd.path.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -74,7 +77,7 @@ (see below).</para> <para>Internally, path units use the - <citerefentry><refentrytitle>inotify</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>inotify</refentrytitle><manvolnum>7</manvolnum></citerefentry> API to monitor file systems. Due to that, it suffers by the same limitations as inotify, and for example cannot be used to monitor files or directories changed by other machines on remote NFS file @@ -187,7 +190,7 @@ <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>inotify</refentrytitle><manvolnum>7</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>inotify</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd.preset.xml b/man/systemd.preset.xml index 2f9add8d6c..4667f9d616 100644 --- a/man/systemd.preset.xml +++ b/man/systemd.preset.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -46,12 +49,12 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/system-preset/*.preset</filename></para> + <para><filename>&pkgsysconfdir;/system-preset/*.preset</filename></para> <para><filename>/run/systemd/system-preset/*.preset</filename></para> - <para><filename>/usr/lib/systemd/system-preset/*.preset</filename></para> - <para><filename>/etc/systemd/user-preset/*.preset</filename></para> + <para><filename>&rootlibexecdir;/system-preset/*.preset</filename></para> + <para><filename>&pkgsysconfdir;/user-preset/*.preset</filename></para> <para><filename>/run/systemd/user-preset/*.preset</filename></para> - <para><filename>/usr/lib/systemd/user-preset/*.preset</filename></para> + <para><filename>&rootlibexecdir;/user-preset/*.preset</filename></para> </refsynopsisdiv> <refsect1> @@ -125,7 +128,7 @@ <para>If the administrator wants to disable a preset file supplied by the vendor, the recommended way is to place a symlink to <filename>/dev/null</filename> in - <filename>/etc/systemd/system-preset/</filename> bearing the same + <filename>&pkgsysconfdir;/system-preset/</filename> bearing the same filename.</para> </refsect1> @@ -133,7 +136,7 @@ <title>Example</title> <example> - <title>Default off example <filename>/usr/lib/systemd/system-preset/99-default.preset</filename>:</title> + <title>Default off example <filename>&rootlibexecdir;/system-preset/99-default.preset</filename>:</title> <programlisting>disable *</programlisting> </example> @@ -144,7 +147,7 @@ suchlike.</para> <example> - <title>A GNOME spin example <filename>/usr/lib/systemd/system-preset/50-gnome.preset</filename>:</title> + <title>A GNOME spin example <filename>&rootlibexecdir;/system-preset/50-gnome.preset</filename>:</title> <programlisting>enable gdm.service enable colord.service @@ -162,7 +165,7 @@ enable avahi-daemon.*</programlisting> example like the one from the first example above.</para> <example> - <title>Administrator policy <filename>/etc/systemd/system-preset/00-lennart.preset</filename>:</title> + <title>Administrator policy <filename>&pkgsysconfdir;/system-preset/00-lennart.preset</filename>:</title> <programlisting>enable httpd.service enable sshd.service diff --git a/man/systemd.resource-control.xml b/man/systemd.resource-control.xml index 8f4e7a3f16..82e21c6906 100644 --- a/man/systemd.resource-control.xml +++ b/man/systemd.resource-control.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd.scope.xml b/man/systemd.scope.xml index 59eede9596..f137cb7391 100644 --- a/man/systemd.scope.xml +++ b/man/systemd.scope.xml @@ -1,24 +1,27 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- -This file is part of systemd. + This file is part of systemd. -Copyright 2013 Zbigniew Jędrzejewski-Szmek + Copyright 2013 Zbigniew Jędrzejewski-Szmek -systemd is free software; you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2.1 of the License, or -(at your option) any later version. + systemd is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or + (at your option) any later version. -systemd is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. + systemd is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License -along with systemd; If not, see <http://www.gnu.org/licenses/>. + You should have received a copy of the GNU Lesser General Public License + along with systemd; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="systemd.scope"> diff --git a/man/systemd.service.xml b/man/systemd.service.xml index c03b4e8a54..0fe694ab7e 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -334,6 +337,11 @@ <para>If any of those commands (not prefixed with <literal>-</literal>) fail, the rest are not executed and the unit is considered failed.</para> + + <para>Note that <varname>ExecStartPre=</varname> may not be + used to start long-running processes. All processes forked + off by processes invoked via <varname>ExecStartPre=</varname> will + be killed before the next service process is run.</para> </listitem> </varlistentry> @@ -508,7 +516,7 @@ <option>on-failure</option>, the service will be restarted when the process exits with a non-zero exit code, is terminated by a signal (including on core dump, but excluding - the aforementiond four signals), when an operation (such as + the aforementioned four signals), when an operation (such as service reload) times out, and when the configured watchdog timeout is triggered. If set to <option>on-abnormal</option>, the service will be restarted when the process is terminated @@ -886,7 +894,7 @@ <title>Command lines</title> <para>This section describes command line parsing and - variable and specifier substitions for + variable and specifier substitutions for <varname>ExecStart=</varname>, <varname>ExecStartPre=</varname>, <varname>ExecStartPost=</varname>, @@ -1126,7 +1134,7 @@ WantedBy=multi-user.target</programlisting> <varname>Type=</varname><option>oneshot</option> exists. Units of this type will wait until the process specified terminates and then fall back to being inactive. The following unit will - perform a clenaup action:</para> + perform a cleanup action:</para> <programlisting>[Unit] Description=Cleanup old Foo data diff --git a/man/systemd.slice.xml b/man/systemd.slice.xml index f0bac41763..c443528ab1 100644 --- a/man/systemd.slice.xml +++ b/man/systemd.slice.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -90,7 +93,7 @@ slice specific configuration options are configured in the [Slice] section. Currently, only generic resource control settings as described in - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>7</manvolnum></citerefentry> are allowed. + <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry> are allowed. </para> <para>Unless <varname>DefaultDependencies=false</varname> diff --git a/man/systemd.snapshot.xml b/man/systemd.snapshot.xml index 96069c324a..4c1f40e814 100644 --- a/man/systemd.snapshot.xml +++ b/man/systemd.snapshot.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 3938345fac..1d0fa1bd16 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -127,7 +130,7 @@ (see <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry> for details) or via the traditional - <citerefentry><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry>-style + <citerefentry project='freebsd'><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry>-style socket passing (i.e. sockets passed in via standard input and output, using <varname>StandardInput=socket</varname> in the service file).</para> @@ -265,7 +268,7 @@ <listitem><para>Takes a one of <option>default</option>, <option>both</option> or <option>ipv6-only</option>. Controls the IPV6_V6ONLY socket option (see - <citerefentry><refentrytitle>ipv6</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>ipv6</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details). If <option>both</option>, IPv6 sockets bound will be accessible via both IPv4 and IPv6. If <option>ipv6-only</option>, they will be accessible via IPv6 @@ -294,7 +297,7 @@ this socket to. If set, traffic will only be accepted from the specified network interfaces. This controls the SO_BINDTODEVICE socket option (see - <citerefentry><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details). If this option is used, an automatic dependency from this socket unit on the network interface device unit (<citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry> @@ -355,9 +358,14 @@ <varname>Accept=true</varname> set. Setting <varname>Accept=true</varname> is mostly useful to allow daemons designed for usage with - <citerefentry><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='freebsd'><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry> to work unmodified with systemd socket - activation.</para></listitem> + activation.</para> + + <para>For IPv4 and IPv6 connections the <varname>REMOTE_ADDR</varname> + environment variable will contain the remote IP, and <varname>REMOTE_PORT</varname> + will contain the remote port. This is the same as the format used by CGI. + For SOCK_RAW the port is the IP protocol.</para></listitem> </varlistentry> <varlistentry> @@ -380,7 +388,7 @@ <filename>/proc/sys/net/ipv4/tcp_keepalive_time</filename>) for all TCP streams accepted on this socket. This controls the SO_KEEPALIVE socket option (see - <citerefentry><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> and the <ulink url="http://www.tldp.org/HOWTO/html_single/TCP-Keepalive-HOWTO/">TCP Keepalive HOWTO</ulink> for details.) Defaults to @@ -392,7 +400,7 @@ <listitem><para>Takes time (in seconds) as argument . The connection needs to remain idle before TCP starts sending keepalive probes. This controls the TCP_KEEPIDLE socket option (see - <citerefentry><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> and the <ulink url="http://www.tldp.org/HOWTO/html_single/TCP-Keepalive-HOWTO/">TCP Keepalive HOWTO</ulink> for details.) @@ -405,7 +413,7 @@ individual keepalive probes, if the socket option SO_KEEPALIVE has been set on this socket seconds as argument. This controls the TCP_KEEPINTVL socket option (see - <citerefentry><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> and the <ulink url="http://www.tldp.org/HOWTO/html_single/TCP-Keepalive-HOWTO/">TCP Keepalive HOWTO</ulink> for details.) Defaults value is 75 @@ -418,7 +426,7 @@ unacknowledged probes to send before considering the connection dead and notifying the application layer. This controls the TCP_KEEPCNT socket option (see - <citerefentry><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> and the <ulink url="http://www.tldp.org/HOWTO/html_single/TCP-Keepalive-HOWTO/">TCP Keepalive HOWTO</ulink> for details.) Defaults value is @@ -431,7 +439,7 @@ algorithm works by combining a number of small outgoing messages, and sending them all at once. This controls the TCP_NODELAY socket option (see - <citerefentry><refentrytitle>tcp</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>tcp</refentrytitle><manvolnum>7</manvolnum></citerefentry> Defaults to <option>false</option>.</para></listitem> </varlistentry> @@ -440,7 +448,7 @@ <listitem><para>Takes an integer argument controlling the priority for all traffic sent from this socket. This controls the SO_PRIORITY socket option (see - <citerefentry><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details.).</para></listitem> </varlistentry> @@ -453,7 +461,7 @@ established. When this option is set, the <constant>TCP_DEFER_ACCEPT</constant> socket option will be used (see - <citerefentry><refentrytitle>tcp</refentrytitle><manvolnum>7</manvolnum></citerefentry>), + <citerefentry project='die-net'><refentrytitle>tcp</refentrytitle><manvolnum>7</manvolnum></citerefentry>), and the kernel will ignore initial ACK packets without any data. The argument specifies the approximate amount of time the kernel should wait for incoming data before falling back @@ -480,7 +488,7 @@ <listitem><para>Takes an integer argument controlling the receive or send buffer sizes of this socket, respectively. This controls the SO_RCVBUF and SO_SNDBUF socket options (see - <citerefentry><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details.). The usual suffixes K, M, G are supported and are understood to the base of 1024.</para></listitem> </varlistentry> @@ -490,7 +498,7 @@ <listitem><para>Takes an integer argument controlling the IP Type-Of-Service field for packets generated from this socket. This controls the IP_TOS socket option (see - <citerefentry><refentrytitle>ip</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details.). Either a numeric string or one of <option>low-delay</option>, <option>throughput</option>, <option>reliability</option> or <option>low-cost</option> may @@ -503,9 +511,9 @@ Time-To-Live/IPv6 Hop-Count field for packets generated from this socket. This sets the IP_TTL/IPV6_UNICAST_HOPS socket options (see - <citerefentry><refentrytitle>ip</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>7</manvolnum></citerefentry> and - <citerefentry><refentrytitle>ipv6</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>ipv6</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details.)</para></listitem> </varlistentry> @@ -515,7 +523,7 @@ mark of packets generated by this socket. This can be used in the firewall logic to filter packets from this socket. This sets the SO_MARK socket option. See - <citerefentry><refentrytitle>iptables</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>iptables</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details.</para></listitem> </varlistentry> @@ -526,7 +534,7 @@ <citerefentry><refentrytitle>bind</refentrytitle><manvolnum>2</manvolnum></citerefentry>s to this TCP or UDP port. This controls the SO_REUSEPORT socket option. See - <citerefentry><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details.</para></listitem> </varlistentry> @@ -578,7 +586,7 @@ control the mq_maxmsg field or the mq_msgsize field, respectively, when creating the message queue. Note that either none or both of these variables need to be set. See - <citerefentry><refentrytitle>mq_setattr</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry project='die-net'><refentrytitle>mq_setattr</refentrytitle><manvolnum>3</manvolnum></citerefentry> for details.</para></listitem> </varlistentry> diff --git a/man/systemd.special.xml b/man/systemd.special.xml index cf76aaf607..8db3050b58 100644 --- a/man/systemd.special.xml +++ b/man/systemd.special.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 23b9c712ed..d3ddc1ab4d 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -69,7 +72,7 @@ <para>Additional options are listed in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, which define the execution environment the - <citerefentry><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry> binary is executed in, and in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>, which define the way the processes are terminated, and in @@ -100,7 +103,7 @@ <para>Swap units may either be configured via unit files, or via <filename>/etc/fstab</filename> (see - <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). Swaps listed in <filename>/etc/fstab</filename> will be converted into native units dynamically at boot and when the configuration of the system manager is reloaded. See @@ -161,7 +164,7 @@ <term><varname>What=</varname></term> <listitem><para>Takes an absolute path of a device node or file to use for paging. See - <citerefentry><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details. If this refers to a device node, a dependency on the respective device unit is automatically created. (See <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry> @@ -177,7 +180,8 @@ <listitem><para>Swap priority to use when activating the swap device or file. This takes an integer. This setting is - optional.</para></listitem> + optional and ignored when priotiry is set by <option>pri=</option> in the + <varname>Options=</varname> option.</para></listitem> </varlistentry> <varlistentry> @@ -187,7 +191,7 @@ device. This may be used for controlling discard options among other functionality, if the swap backing device supports the discard or trim operation. (See - <citerefentry><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry> for more information.) </para></listitem> </varlistentry> @@ -229,7 +233,7 @@ <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> </para> diff --git a/man/systemd.target.xml b/man/systemd.target.xml index e790e9b77a..884177e9fa 100644 --- a/man/systemd.target.xml +++ b/man/systemd.target.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd.time.xml b/man/systemd.time.xml index da0729725d..570a20e5cf 100644 --- a/man/systemd.time.xml +++ b/man/systemd.time.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index 20890f2270..5f7e80425e 100644 --- a/man/systemd.timer.xml +++ b/man/systemd.timer.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 09e11b4711..8286cf3f78 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -64,20 +64,20 @@ <filename><replaceable>slice</replaceable>.slice</filename>, <filename><replaceable>scope</replaceable>.scope</filename></para> - <para><literallayout><filename>/etc/systemd/system/*</filename> + <para><literallayout><filename>&pkgsysconfdir;/system/*</filename> <filename>/run/systemd/system/*</filename> -<filename>/usr/lib/systemd/system/*</filename> +<filename>&rootlibexecdir;/system/*</filename> <filename>...</filename> </literallayout></para> <para><literallayout><filename>$XDG_CONFIG_HOME/systemd/user/*</filename> <filename>$HOME/.config/systemd/user/*</filename> -<filename>/etc/systemd/user/*</filename> +<filename>&pkgsysconfdir;/user/*</filename> <filename>$XDG_RUNTIME_DIR/systemd/user/*</filename> <filename>/run/systemd/user/*</filename> <filename>$XDG_DATA_HOME/systemd/user/*</filename> <filename>$HOME/.local/share/systemd/user/*</filename> -<filename>/usr/lib/systemd/user/*</filename> +<filename>&rootlibexecdir;/user/*</filename> <filename>...</filename> </literallayout></para> </refsynopsisdiv> @@ -287,7 +287,7 @@ </thead> <tbody> <row> - <entry><filename>/etc/systemd/system</filename></entry> + <entry><filename>&pkgsysconfdir;/system</filename></entry> <entry>Local configuration</entry> </row> <row> @@ -295,7 +295,7 @@ <entry>Runtime units</entry> </row> <row> - <entry><filename>/usr/lib/systemd/system</filename></entry> + <entry><filename>&rootlibexecdir;/system</filename></entry> <entry>Units of installed packages</entry> </row> </tbody> @@ -326,7 +326,7 @@ <entry>User configuration (only used when $XDG_CONFIG_HOME is not set)</entry> </row> <row> - <entry><filename>/etc/systemd/user</filename></entry> + <entry><filename>&pkgsysconfdir;/user</filename></entry> <entry>Local configuration</entry> </row> <row> @@ -346,7 +346,7 @@ <entry>Units of packages that have been installed in the home directory (only used when $XDG_DATA_HOME is not set)</entry> </row> <row> - <entry><filename>/usr/lib/systemd/user</filename></entry> + <entry><filename>&rootlibexecdir;/user</filename></entry> <entry>Units of packages that have been installed system-wide</entry> </row> </tbody> @@ -357,8 +357,8 @@ from directories not on the unit load path. See the <command>link</command> command for <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. - Also, some units are dynamically created via generators <ulink - url="http://www.freedesktop.org/wiki/Software/systemd/Generators/">Generators</ulink>. + Also, some units are dynamically created via a + <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>. </para> </refsect1> @@ -826,7 +826,7 @@ <varname>cris</varname> to test against a specific architecture. The architecture is determined from the information returned by - <citerefentry><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> and is thus subject to <citerefentry><refentrytitle>personality</refentrytitle><manvolnum>2</manvolnum></citerefentry>. Note that a <varname>Personality=</varname> setting in the @@ -1250,7 +1250,7 @@ <row> <entry><literal>%H</literal></entry> <entry>Host name</entry> - <entry>The hostname of the running system at the point in time the unit configuation is loaded.</entry> + <entry>The hostname of the running system at the point in time the unit configuration is loaded.</entry> </row> <row> <entry><literal>%v</literal></entry> @@ -1296,7 +1296,7 @@ ExecStart=/usr/sbin/foo-daemon <para>After running <command>systemctl enable</command>, a symlink - <filename>/etc/systemd/system/multi-user.target.wants/foo.service</filename> + <filename>&pkgsysconfdir;/system/multi-user.target.wants/foo.service</filename> linking to the actual unit will be created. It tells systemd to pull in the unit when starting <filename>multi-user.target</filename>. The inverse @@ -1309,11 +1309,11 @@ ExecStart=/usr/sbin/foo-daemon <para>There are two methods of overriding vendor settings in unit files: copying the unit file from - <filename>/usr/lib/systemd/system</filename> to - <filename>/etc/systemd/system</filename> and modifying the + <filename>&rootlibexecdir;/system</filename> to + <filename>&pkgsysconfdir;/system</filename> and modifying the chosen settings. Alternatively, one can create a directory named <filename><replaceable>unit</replaceable>.d/</filename> within - <filename>/etc/systemd/system</filename> and place a drop-in + <filename>&pkgsysconfdir;/system</filename> and place a drop-in file <filename><replaceable>name</replaceable>.conf</filename> there that only changes the specific settings one is interested in. Note that multiple such drop-in files are read if @@ -1343,7 +1343,7 @@ ExecStart=/usr/sbin/foo-daemon load paths for further details.</para> <para>Suppose there is a vendor-supplied unit - <filename>/usr/lib/systemd/system/httpd.service</filename> with + <filename>&rootlibexecdir;/system/httpd.service</filename> with the following contents:</para> <programlisting>[Unit] @@ -1375,7 +1375,7 @@ WantedBy=multi-user.target</programlisting> the niceness of the service to its default value of 0.</para> <para>The first possibility is to copy the unit file to - <filename>/etc/systemd/system/httpd.service</filename> and + <filename>&pkgsysconfdir;/system/httpd.service</filename> and change the chosen settings:</para> <programlisting>[Unit] @@ -1395,7 +1395,7 @@ WantedBy=multi-user.target</programlisting> <para>Alternatively, the administrator could create a drop-in file - <filename>/etc/systemd/system/httpd.service.d/local.conf</filename> + <filename>&pkgsysconfdir;/system/httpd.service.d/local.conf</filename> with the following contents:</para> <programlisting>[Unit] @@ -1438,7 +1438,7 @@ PrivateTmp=yes</programlisting> <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>uname</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd.xml b/man/systemd.xml index 80591dc732..5fa65a3631 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -415,9 +418,8 @@ <para>Units may be generated dynamically at boot and system manager reload time, for example based on other configuration - files or parameters passed on the kernel command line. For details - see the - <ulink url="http://www.freedesktop.org/wiki/Software/systemd/Generators">Generators Specification</ulink>.</para> + files or parameters passed on the kernel command line. For details see + <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> <para>Systems which invoke systemd in a container or initrd environment should implement the @@ -439,7 +441,7 @@ by <command>pkg-config systemd --variable=systemdsystemunitdir</command>. Other directories checked are <filename>/usr/local/lib/systemd/system</filename> - and <filename>/usr/lib/systemd/system</filename>. User + and <filename>&rootlibexecdir;/system</filename>. User configuration always takes precedence. <command>pkg-config systemd --variable=systemdsystemconfdir</command> returns the path of the system configuration directory. Packages should @@ -1013,9 +1015,9 @@ <listitem><para>Set the system locale to use. This overrides the settings in <filename>/etc/locale.conf</filename>. For more information see - <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> and - <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>. + <citerefentry project='man-pages'><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>. </para></listitem> </varlistentry> </variablelist> @@ -1040,16 +1042,6 @@ </varlistentry> <varlistentry> - <term><filename>/run/systemd/shutdownd</filename></term> - - <listitem><para>Used internally by the - <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry> - tool to implement delayed shutdowns. This is an - <constant>AF_UNIX</constant> datagram - socket.</para></listitem> - </varlistentry> - - <varlistentry> <term><filename>/run/systemd/private</filename></term> <listitem><para>Used internally as communication channel @@ -1078,7 +1070,7 @@ <para> The <ulink url="http://www.freedesktop.org/wiki/Software/systemd/">systemd Homepage</ulink>, <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-notify</refentrytitle><manvolnum>1</manvolnum></citerefentry>, diff --git a/man/sysusers.d.xml b/man/sysusers.d.xml index 99aa07a1cc..3085f3dd01 100644 --- a/man/sysusers.d.xml +++ b/man/sysusers.d.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/telinit.xml b/man/telinit.xml index 02d31fbd46..ec7e8eace4 100644 --- a/man/telinit.xml +++ b/man/telinit.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/timedatectl.xml b/man/timedatectl.xml index 98ec013ebb..d7bd052eff 100644 --- a/man/timedatectl.xml +++ b/man/timedatectl.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -103,9 +106,14 @@ <varlistentry> <term><command>status</command></term> - <listitem><para>Show current settings - of the system clock and - RTC.</para></listitem> + <listitem><para>Show current settings of the system clock and + RTC, including whether network time synchronization is + on. Note that whether network time synchronization is on + simply reflects whether the + <filename>systemd-timesyncd.service</filename> unit is + enabled. Even if this command shows the status as off a + different service might still synchronize the clock with the + network.</para></listitem> </varlistentry> <varlistentry> @@ -160,9 +168,13 @@ <varlistentry> <term><command>set-ntp [BOOL]</command></term> - <listitem><para>Takes a boolean argument. Controls whether NTP - based network time synchronization is enabled (if - available).</para></listitem> + <listitem><para>Takes a boolean argument. Controls whether + network time synchronization is enabled (if available). This + enables or disables the + <filename>systemd-timesyncd.service</filename> unit. Note that + even if this command turns time synchronization off a + different system service might still synchronize the clock + with the network.</para></listitem> </varlistentry> </variablelist> @@ -182,25 +194,16 @@ <title>Examples</title> <para>Show current settings: <programlisting>$ timedatectl - Local time: Fri, 2012-11-02 09:26:46 CET - Universal time: Fri, 2012-11-02 08:26:46 UTC - RTC time: Fri, 2012-11-02 08:26:45 - Timezone: Europe/Warsaw - UTC offset: +0100 - NTP enabled: no -NTP synchronized: no - RTC in local TZ: no - DST active: no - Last DST change: CEST → CET, DST became inactive - Sun, 2012-10-28 02:59:59 CEST - Sun, 2012-10-28 02:00:00 CET - Next DST change: CET → CEST, DST will become active - the clock will jump one hour forward - Sun, 2013-03-31 01:59:59 CET - Sun, 2013-03-31 03:00:00 CEST</programlisting> + Local time: Di 2015-04-07 16:26:56 CEST + Universal time: Di 2015-04-07 14:26:56 UTC + RTC time: Di 2015-04-07 14:26:56 + Time zone: Europe/Berlin (CEST, +0200) + Network time on: yes +NTP synchronized: yes + RTC in local TZ: no</programlisting> </para> - <para>Enable an NTP daemon (chronyd): + <para>Enable network time synchronization: <programlisting>$ timedatectl set-ntp true ==== AUTHENTICATING FOR org.freedesktop.timedate1.set-ntp === Authentication is required to control whether network time synchronization shall be enabled. @@ -208,10 +211,15 @@ Authenticating as: user Password: ******** ==== AUTHENTICATION COMPLETE ===</programlisting> - <programlisting>$ systemctl status chronyd.service -chronyd.service - NTP client/server - Loaded: loaded (/usr/lib/systemd/system/chronyd.service; enabled) - Active: active (running) since Fri, 2012-11-02 09:36:25 CET; 5s ago + <programlisting>$ systemctl status systemd-timesyncd.service +● systemd-timesyncd.service - Network Time Synchronization + Loaded: loaded (&rootlibexecdir;/system/systemd-timesyncd.service; enabled) + Active: active (running) since Mo 2015-03-30 14:20:38 CEST; 5s ago + Docs: man:systemd-timesyncd.service(8) + Main PID: 595 (systemd-timesyn) + Status: "Using Time Server 216.239.38.15:123 (time4.google.com)." + CGroup: /system.slice/systemd-timesyncd.service + └─595 &rootlibexecdir;/systemd-timesyncd ...</programlisting> </para> </refsect1> @@ -225,6 +233,7 @@ chronyd.service - NTP client/server <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/timesyncd.conf.xml b/man/timesyncd.conf.xml index 1127970a18..c297d3254c 100644 --- a/man/timesyncd.conf.xml +++ b/man/timesyncd.conf.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -49,10 +52,10 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/timesyncd.conf</filename></para> - <para><filename>/etc/systemd/timesyncd.conf.d/*.conf</filename></para> + <para><filename>&pkgsysconfdir;/timesyncd.conf</filename></para> + <para><filename>&pkgsysconfdir;/timesyncd.conf.d/*.conf</filename></para> <para><filename>/run/systemd/timesyncd.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/timesyncd.conf.d/*.conf</filename></para> + <para><filename>&rootlibexecdir;/timesyncd.conf.d/*.conf</filename></para> </refsynopsisdiv> <refsect1> @@ -63,8 +66,7 @@ </refsect1> - <xi:include href="standard-conf.xml" xpointer="confd" /> - <xi:include href="standard-conf.xml" xpointer="conf" /> + <xi:include href="standard-conf.xml" xpointer="main-conf" /> <refsect1> <title>Options</title> diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml index 8815bf9970..c37de65229 100644 --- a/man/tmpfiles.d.xml +++ b/man/tmpfiles.d.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -101,9 +104,12 @@ the lexicographically earliest name will be applied. All other conflicting entries will be logged as errors. When two lines are prefix and suffix of each other, then the prefix is always - processed first, the suffix later. Otherwise, the - files/directories are processed in the order they are - listed.</para> + processed first, the suffix later. Lines that take globs are + applied after those accepting no globs. If multiple operations + shall be applied on the same file (such as ACL, xattr, file + attribute adjustments) these are always done in the same fixed + order. Otherwise, the files/directories are processed in the order + they are listed.</para> <para>If the administrator wants to disable a configuration file supplied by the vendor, the recommended way is to place a symlink @@ -118,6 +124,8 @@ d /run/user 0755 root root 10d - L /tmp/foobar - - - - /dev/null</programlisting> + <para>Fields may be enclosed within quotes and contain C-style escapes.</para> + <refsect2> <title>Type</title> @@ -131,13 +139,13 @@ <term><varname>f</varname></term> <listitem><para>Create a file if it does not exist yet. If the argument parameter is given, it will be written to the - file.</para></listitem> + file. Does not follow symlinks.</para></listitem> </varlistentry> <varlistentry> <term><varname>F</varname></term> <listitem><para>Create or truncate a file. If the argument - parameter is given, it will be written to the file.</para> + parameter is given, it will be written to the file. Does not follow symlinks.</para> </listitem> </varlistentry> @@ -147,7 +155,8 @@ the file exists. Lines of this type accept shell-style globs in place of normal path names. The argument parameter will be written without a trailing newline. C-style - backslash escapes are interpreted.</para></listitem> + backslash escapes are interpreted. Follows + symlinks.</para></listitem> </varlistentry> <varlistentry> @@ -225,7 +234,7 @@ copy operation is skipped. If the argument is omitted, files from the source directory <filename>/usr/share/factory/</filename> with the same name - are copied.</para></listitem> + are copied. Does not follow symlinks.</para></listitem> </varlistentry> <varlistentry> @@ -257,7 +266,7 @@ This may not be used to remove non-empty directories, use <varname>R</varname> for that. Lines of this type accept shell-style globs in place of normal path - names.</para></listitem> + names. Does not follow symlinks.</para></listitem> </varlistentry> <varlistentry> @@ -265,7 +274,7 @@ <listitem><para>Recursively remove a path and all its subdirectories (if it is a directory). Lines of this type accept shell-style globs in place of normal path - names.</para></listitem> + names. Does not follow symlinks.</para></listitem> </varlistentry> <varlistentry> @@ -273,7 +282,7 @@ <listitem><para>Adjust the access mode, group and user, and restore the SELinux security context of a file or directory, if it exists. Lines of this type accept shell-style globs in - place of normal path names.</para></listitem> + place of normal path names. Does not follow symlinks.</para></listitem> </varlistentry> <varlistentry> @@ -282,23 +291,56 @@ user, and restore the SELinux security context of a file or directory if it exists, as well as of its subdirectories and the files contained therein (if applicable). Lines of this - type accept shell-style globs in place of normal path names. - </para></listitem> + type accept shell-style globs in place of normal path + names. Does not follow symlinks. </para></listitem> </varlistentry> <varlistentry> <term><varname>t</varname></term> <listitem><para>Set extended attributes. Lines of this type accept shell-style globs in place of normal path names. - This can be useful for setting SMACK labels. - </para></listitem> + This can be useful for setting SMACK labels. Does not follow + symlinks.</para></listitem> </varlistentry> <varlistentry> <term><varname>T</varname></term> <listitem><para>Recursively set extended attributes. Lines of this type accept shell-style globs in place of normal - path names. This can be useful for setting SMACK labels. + path names. This can be useful for setting SMACK + labels. Does not follow symlinks. </para></listitem> + </varlistentry> + + <varlistentry> + <term><varname>h</varname></term> + <listitem><para>Set file/directory attributes. Lines of this type + accept shell-style globs in place of normal path names.</para> + + <para>The format of the argument field is + <varname>[+-=][aAcCdDeijsStTu] </varname>. The prefix + <varname>+</varname> (the default one) causes the + attribute(s) to be added; <varname>-</varname> causes the + attribute(s) to be removed; <varname>=</varname> causes the + attributes to set exactly as the following letters. The + letters <literal>aAcCdDeijsStTu</literal> select the new + attributes for the files, see + <citerefentry><refentrytitle>chattr</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> for further information. + </para> + <para>Passing only <varname>=</varname> as argument resets + all the file attributes listed above. It has to be pointed + out that the <varname>=</varname> prefix, limits itself to + the attributes corresponding to the letters listed here. All + other attributes will be left untouched. Does not follow + symlinks.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>H</varname></term> + <listitem><para>Recursively set file/directory attributes. Lines + of this type accept shell-style globs in place of normal + path names. Does not follow symlinks. </para></listitem> </varlistentry> @@ -315,14 +357,15 @@ specified explicitly or already present. Lines of this type accept shell-style globs in place of normal path names. This can be useful for allowing additional access to certain - files.</para></listitem> + files. Does not follow symlinks.</para></listitem> </varlistentry> <varlistentry> <term><varname>A</varname></term> <term><varname>A+</varname></term> <listitem><para>Same as <varname>a</varname> and - <varname>a+</varname>, but recursive.</para></listitem> + <varname>a+</varname>, but recursive. Does not follow + symlinks.</para></listitem> </varlistentry> </variablelist> @@ -443,23 +486,22 @@ delete when cleaning. If a file or directory is older than the current time minus the age field, it is deleted. The field format is a series of integers each followed by one of the - following postfixes for the respective time units:</para> - - <variablelist> - <varlistentry> - <term><varname>s</varname></term> - <term><varname>min</varname></term> - <term><varname>h</varname></term> - <term><varname>d</varname></term> - <term><varname>w</varname></term> - <term><varname>ms</varname></term> - <term><varname>m</varname></term> - <term><varname>us</varname></term></varlistentry> - </variablelist> + following postfixes for the respective time units: + <constant>s</constant>, + <constant>m</constant> or <constant>min</constant>, + <constant>h</constant>, + <constant>d</constant>, + <constant>w</constant>, + <constant>ms</constant>, + <constant>us</constant>, + respectively meaning seconds, minutes, hours, days, weeks, + milliseconds, and microseconds. Full names of the time units can + be used too. + </para> <para>If multiple integers and units are specified, the time - values are summed up. If an integer is given without a unit, - <varname>s</varname> is assumed. + values are summed. If an integer is given without a unit, + <constant>s</constant> is assumed. </para> <para>When the age is set to zero, the files are cleaned @@ -490,9 +532,12 @@ <varname>w</varname> may be used to specify a short string that is written to the file, suffixed by a newline. For <varname>C</varname>, specifies the source file or - directory. For <varname>t</varname> determines extended - attributes to be set. For <varname>a</varname> determines - ACL attributes to be set. Ignored for all other lines.</para> + directory. For <varname>t</varname>, <varname>T</varname> + determines extended attributes to be set. For + <varname>a</varname>, <varname>A</varname> determines ACL + attributes to be set. For <varname>h</varname>, + <varname>H</varname> determines the file attributes to + set. Ignored for all other lines.</para> </refsect2> </refsect1> @@ -505,15 +550,15 @@ boot with specific modes and ownership.</para> <programlisting>d /run/screens 1777 root root 10d - d /run/uscreens 0755 root root 10d12h - t /run/screen - - - - user.name="John Smith" security.SMACK64=screen</programlisting> +d /run/uscreens 0755 root root 10d12h +t /run/screen - - - - user.name="John Smith" security.SMACK64=screen</programlisting> </example> <example> <title>/etc/tmpfiles.d/abrt.conf example</title> <para><command>abrt</command> needs a directory created at boot with specific mode and ownership and its content should be preserved.</para> <programlisting>d /var/tmp/abrt 0755 abrt abrt - x /var/tmp/abrt/*</programlisting> +x /var/tmp/abrt/*</programlisting> </example> </refsect1> @@ -528,7 +573,8 @@ <citerefentry project='man-pages'><refentrytitle>getfattr</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>setfattr</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>setfacl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>getfacl</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <citerefentry project='man-pages'><refentrytitle>getfacl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>chattr</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/udev.conf.xml b/man/udev.conf.xml index e104e53f5d..a10cc3cebe 100644 --- a/man/udev.conf.xml +++ b/man/udev.conf.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. diff --git a/man/udev.xml b/man/udev.xml index a948ea79a9..d5d8a17cdb 100644 --- a/man/udev.xml +++ b/man/udev.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <refentry id="udev"> <refentryinfo> @@ -55,17 +58,17 @@ <refsect1><title>Rules Files</title> <para>The udev rules are read from the files located in the - system rules directory <filename>/usr/lib/udev/rules.d</filename>, + system rules directory <filename>&udevlibexecdir;/rules.d</filename>, the volatile runtime directory <filename>/run/udev/rules.d</filename> and the local administration directory <filename>/etc/udev/rules.d</filename>. All rules files are collectively sorted and processed in lexical order, regardless of the directories in which they live. However, files with identical filenames replace each other. Files in <filename>/etc</filename> have the highest priority, files in <filename>/run</filename> take precedence - over files with the same name in <filename>/usr/lib</filename>. This can be + over files with the same name in <filename>&rootprefix;/lib</filename>. This can be used to override a system-supplied rules file with a local file if needed; a symlink in <filename>/etc</filename> with the same name as a rules file in - <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>, + <filename>&rootprefix;/lib</filename>, pointing to <filename>/dev/null</filename>, disables the rules file entirely. Rule files must have the extension <filename>.rules</filename>; other extensions are ignored.</para> @@ -193,6 +196,11 @@ value itself contains trailing whitespace. </para> </listitem> + <term><varname>SYSCTL{<replaceable>kernel parameter</replaceable>}</varname></term> + <listitem> + <para>Match a kernel parameter value. + </para> + </listitem> </varlistentry> <varlistentry> @@ -375,6 +383,13 @@ </varlistentry> <varlistentry> + <term><varname>SYSCTL{<replaceable>kernel parameter</replaceable>}</varname></term> + <listitem> + <para>The value that should be written to kernel parameter.</para> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>ENV{<replaceable>key</replaceable>}</varname></term> <listitem> <para>Set a device property value. Property names with a leading <literal>.</literal> @@ -409,7 +424,7 @@ <listitem> <para>Execute an external program specified as the assigned value. If no absolute path is given, the program is expected - to live in <filename>/usr/lib/udev</filename>; otherwise, the + to live in <filename>&udevlibexecdir;</filename>; otherwise, the absolute path must be specified.</para> <para>This is the default if no <replaceable>type</replaceable> is specified.</para> diff --git a/man/udevadm.xml b/man/udevadm.xml index 8ef9e23aa2..c7ef7279c9 100644 --- a/man/udevadm.xml +++ b/man/udevadm.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <refentry id="udevadm"> <refentryinfo> diff --git a/man/user-system-options.xml b/man/user-system-options.xml index 8616c54249..1e415ddd4c 100644 --- a/man/user-system-options.xml +++ b/man/user-system-options.xml @@ -1,6 +1,9 @@ <?xml version="1.0"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <variablelist> <varlistentry id='user'> diff --git a/man/vconsole.conf.xml b/man/vconsole.conf.xml index 17bea8b682..1c3bdd2e54 100644 --- a/man/vconsole.conf.xml +++ b/man/vconsole.conf.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- This file is part of systemd. @@ -129,9 +132,9 @@ FONT=eurlatgr</programlisting> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> |