diff options
| author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2013-06-26 19:47:34 -0400 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2013-06-26 19:47:34 -0400 |
| commit | 74d005783e355acc784d123024e33bbb66ef9ef1 (patch) | |
| tree | 6f03a459398fd5079a645ec830e0154651f4d7dd /man | |
| parent | 909f413d3c572baadf9b13e36e1e90beba42af86 (diff) | |
man: use <constant> for various constants which look ugly with quotes
Diffstat (limited to 'man')
37 files changed, 244 insertions, 226 deletions
diff --git a/man/bootchart.conf.xml b/man/bootchart.conf.xml index 1e440eb2c..7fd47ebe9 100644 --- a/man/bootchart.conf.xml +++ b/man/bootchart.conf.xml @@ -87,7 +87,7 @@ <varlistentry> <term><varname>Relative=no</varname></term> <listitem><para>Configures whether the left axis of the - output graph equals time=0.0 (CLOCK_MONOTONIC start). This + output graph equals time=0.0 (<constant>CLOCK_MONOTONIC</constant> start). This is useful for using bootchart at post-boot time to profile an already booted system, otherwise the graph would become extremely large. If set to yes, the horizontal axis starts diff --git a/man/daemon.xml b/man/daemon.xml index de362c1b7..258694080 100644 --- a/man/daemon.xml +++ b/man/daemon.xml @@ -894,7 +894,7 @@ fi</programlisting> <listitem><para>If the daemon offers interfaces to other software running on the - local system via local AF_UNIX sockets, + local system via local <constant>AF_UNIX</constant> sockets, consider implementing socket-based activation (see above). Usually a minimal patch is sufficient to implement this: Extend the @@ -906,7 +906,7 @@ fi</programlisting> positive value), skip the socket creation step and use the passed sockets. Secondly, ensure that the file system socket nodes for local - AF_UNIX sockets used in the socket-based + <constant>AF_UNIX</constant> sockets used in the socket-based activation are not removed when the daemon shuts down, if sockets have been passed. Third, if the daemon normally closes diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index 2dc665188..035481197 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -285,7 +285,7 @@ include the value of <varname>$XDG_SESSION_ID</varname> in the filename. This directory shall be used for runtime file system - objects such as AF_UNIX sockets, + objects such as <constant>AF_UNIX</constant> sockets, FIFOs, PID files and similar. It is guaranteed that this directory is local and offers the greatest possible diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index a3bf662fe..55ee1fd89 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -146,7 +146,7 @@ <filename>sd-daemon.h</filename> files. These interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-daemon</literal> + <constant>libsystemd-daemon</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file. Alternatively, applications consuming these APIs may copy the implementation into their source tree, diff --git a/man/sd-id128.xml b/man/sd-id128.xml index ac2000e27..51a16e35d 100644 --- a/man/sd-id128.xml +++ b/man/sd-id128.xml @@ -149,7 +149,7 @@ <para>Note that new, randomized IDs may be generated with <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s - <literal>--new-id</literal> option.</para> + <option>--new-id</option> option.</para> </refsect1> <refsect1> diff --git a/man/sd-journal.xml b/man/sd-journal.xml index a7220ec6b..490b971f1 100644 --- a/man/sd-journal.xml +++ b/man/sd-journal.xml @@ -100,7 +100,7 @@ <para>These APIs are implemented as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd-login.xml b/man/sd-login.xml index 697259564..c186324f8 100644 --- a/man/sd-login.xml +++ b/man/sd-login.xml @@ -95,7 +95,7 @@ each other.</para> <para>If the functions return string arrays, these are - generally NULL terminated and need to be freed by the + generally <constant>NULL</constant> terminated and need to be freed by the caller with the libc <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> call after use, including the strings referenced @@ -103,7 +103,7 @@ be freed, as well.</para> <para>As a special exception, instead of an empty - string array NULL may be returned, which should be + string array <constant>NULL</constant> may be returned, which should be treated equivalent to an empty string array.</para> <para>See @@ -122,7 +122,7 @@ <para>These APIs are implemented as shared library, which can be compiled and linked to with the - <literal>libsystemd-login</literal> + <constant>libsystemd-login</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_booted.xml b/man/sd_booted.xml index ce5a34dc8..32d0fd095 100644 --- a/man/sd_booted.xml +++ b/man/sd_booted.xml @@ -102,7 +102,7 @@ <filename>sd-daemon.h</filename> files. These interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-daemon</literal> + <constant>libsystemd-daemon</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file. Alternatively, applications consuming these APIs may copy the implementation into their source diff --git a/man/sd_get_seats.xml b/man/sd_get_seats.xml index 9bc866dc6..9fb0732c1 100644 --- a/man/sd_get_seats.xml +++ b/man/sd_get_seats.xml @@ -82,12 +82,12 @@ <para><function>sd_get_seats()</function> may be used to determine all currently available local - seats. Returns a NULL terminated array of seat + seats. Returns a <constant>NULL</constant> terminated array of seat identifiers. The returned array and all strings it references need to be freed with the libc <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> call after use. Note that instead of an empty array - NULL may be returned and should be considered + <constant>NULL</constant> may be returned and should be considered equivalent to an empty array.</para> <para>Similar, <function>sd_get_sessions()</function> may @@ -124,7 +124,7 @@ <function>sd_get_machine_names()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-login</literal> + <constant>libsystemd-login</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_id128_randomize.xml b/man/sd_id128_randomize.xml index be74937dd..37efe164c 100644 --- a/man/sd_id128_randomize.xml +++ b/man/sd_id128_randomize.xml @@ -79,7 +79,7 @@ <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> <para><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s - <literal>--new-id</literal> command may be used as + <option>--new-id</option> option may be used as command line front-end for <function>sd_id128_randomize()</function>.</para> </refsect1> diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index 595c8f112..5eaf1585a 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -109,11 +109,13 @@ called to check whether the specified file descriptor refers to a socket. If the <parameter>family</parameter> parameter is not - AF_UNSPEC it is checked whether the socket is of the - specified family (AF_UNIX, AF_INET, ...). If the + <constant>AF_UNSPEC</constant> it is checked whether + the socket is of the specified family (AF_UNIX, + <constant>AF_INET</constant>, ...). If the <parameter>type</parameter> parameter is not 0 it is checked whether the socket is of the specified type - (SOCK_STREAM, SOCK_DGRAM, ...). If the + (<constant>SOCK_STREAM</constant>, + <constant>SOCK_DGRAM</constant>, ...). If the <parameter>listening</parameter> parameter is positive it is checked whether the socket is in accepting mode, i.e. <function>listen()</function> has been called for @@ -129,14 +131,14 @@ optionally checks the IPv4 or IPv6 port number the socket is bound to, unless <parameter>port</parameter> is zero. For this call <parameter>family</parameter> - must be passed as either AF_UNSPEC, AF_INET, or - AF_INET6.</para> + must be passed as either <constant>AF_UNSPEC</constant>, <constant>AF_INET</constant>, or + <constant>AF_INET6</constant>.</para> <para><function>sd_is_socket_unix()</function> is similar to <function>sd_is_socket()</function>, but - optionally checks the AF_UNIX path the socket is bound + optionally checks the <constant>AF_UNIX</constant> path the socket is bound to, unless the <parameter>path</parameter> parameter - is NULL. For normal file system AF_UNIX sockets set + is <constant>NULL</constant>. For normal file system <constant>AF_UNIX</constant> sockets set the <parameter>length</parameter> parameter to 0. For Linux abstract namespace sockets set the <parameter>length</parameter> to the size of the @@ -190,7 +192,7 @@ <filename>sd-daemon.h</filename> files. These interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-daemon</literal> + <constant>libsystemd-daemon</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file. Alternatively, applications consuming these APIs may copy the implementation into their source diff --git a/man/sd_journal_add_match.xml b/man/sd_journal_add_match.xml index 549785ca8..82edf2183 100644 --- a/man/sd_journal_add_match.xml +++ b/man/sd_journal_add_match.xml @@ -176,7 +176,7 @@ <function>sd_journal_flush_matches()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_journal_get_catalog.xml b/man/sd_journal_get_catalog.xml index 719d77f72..d1962e4ca 100644 --- a/man/sd_journal_get_catalog.xml +++ b/man/sd_journal_get_catalog.xml @@ -120,7 +120,7 @@ <function>sd_journal_get_catalog_for_message_id()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_journal_get_cursor.xml b/man/sd_journal_get_cursor.xml index 1b0e775bb..d83c5191f 100644 --- a/man/sd_journal_get_cursor.xml +++ b/man/sd_journal_get_cursor.xml @@ -132,7 +132,7 @@ and <function>sd_journal_test_cursor()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_journal_get_cutoff_realtime_usec.xml b/man/sd_journal_get_cutoff_realtime_usec.xml index ed014cb50..506c02c38 100644 --- a/man/sd_journal_get_cutoff_realtime_usec.xml +++ b/man/sd_journal_get_cutoff_realtime_usec.xml @@ -79,9 +79,11 @@ three arguments: the journal context object and two pointers to 64 Bit unsigned integers to store the timestamps in. The timestamps are in microseconds - since the epoch, i.e. CLOCK_REALTIME. Either one of - the two timestamp arguments may be passed as NULL in - case the timestamp is not needed, but not both.</para> + since the epoch, + i.e. <constant>CLOCK_REALTIME</constant>. Either one + of the two timestamp arguments may be passed as + <constant>NULL</constant> in case the timestamp is not + needed, but not both.</para> <para><function>sd_journal_get_cutoff_monotonic_usec()</function> gets the monotonic timestamps of the first and last @@ -90,7 +92,8 @@ identifier for the boot, and two pointers to 64 Bit unsigned integers to store the timestamps. The timestamps are in microseconds since boot-up of the - specific boot, i.e. CLOCK_MONOTONIC. Since the + specific boot, + i.e. <constant>CLOCK_MONOTONIC</constant>. Since the monotonic clock begins new with every reboot it only defines a well-defined point in time when used together with an identifier identifying the boot, see @@ -98,8 +101,8 @@ for more information. The function will return the timestamps for the boot identified by the passed boot ID. Either one of the two timestamp arguments may be - passed as NULL in case the timestamp is not needed, - but not both.</para> + passed as <constant>NULL</constant> in case the + timestamp is not needed, but not both.</para> </refsect1> <refsect1> @@ -121,7 +124,7 @@ <function>sd_journal_get_cutoff_monotonic_usec()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_journal_get_data.xml b/man/sd_journal_get_data.xml index 1259b0cdb..ba50b8d09 100644 --- a/man/sd_journal_get_data.xml +++ b/man/sd_journal_get_data.xml @@ -205,7 +205,7 @@ <function>sd_journal_get_data_threshold()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_journal_get_fd.xml b/man/sd_journal_get_fd.xml index 33d2980b3..f3fbe69c3 100644 --- a/man/sd_journal_get_fd.xml +++ b/man/sd_journal_get_fd.xml @@ -123,22 +123,28 @@ <para><function>sd_journal_get_events()</function> will return the <function>poll()</function> mask to wait for. This function will return a combination of - <literal>POLLIN</literal> and - <literal>POLLOUT</literal> and similar to fill into + <constant>POLLIN</constant> and + <constant>POLLOUT</constant> and similar to fill into the <literal>.events</literal> field of - <literal>struct pollfd</literal>.</para> + <varname>struct pollfd</varname>.</para> <para><function>sd_journal_get_timeout()</function> - will return a timeout value for usage in <function>poll()</function>. This returns a value in microseconds since the epoch of CLOCK_MONOTONIC for timing out <function>poll()</function> in <literal>timeout_usec</literal>. See + will return a timeout value for usage in + <function>poll()</function>. This returns a value in + microseconds since the epoch of + <constant>CLOCK_MONOTONIC</constant> for timing out + <function>poll()</function> in + <varname>timeout_usec</varname>. See <citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry> for details about - <literal>CLOCK_MONOTONIC</literal>. If there's no + <constant>CLOCK_MONOTONIC</constant>. If there's no timeout to wait for this will fill in - <literal>(uint64_t) -1</literal> instead. Note that + <constant>(uint64_t) -1</constant> instead. Note that <function>poll()</function> takes a relative timeout in milliseconds rather than an absolute timeout in - microseconds. To convert the absolute 'us' timeout into - relative 'ms', use code like the following:</para> + microseconds. To convert the absolute 'us' timeout + into relative 'ms', use code like the + following:</para> <programlisting>uint64_t t; int msec; @@ -154,7 +160,7 @@ else { }</programlisting> <para>The code above does not do any error checking - for brevity's sake. The calculated <literal>msec</literal> + for brevity's sake. The calculated <varname>msec</varname> integer can be passed directly as <function>poll()</function>'s timeout parameter.</para> @@ -174,7 +180,7 @@ else { synchronously wait until the journal gets changed. The maximum time this call sleeps may be controlled with the <parameter>timeout_usec</parameter> - parameter. Pass <literal>(uint64_t) -1</literal> to + parameter. Pass <constant>(uint64_t) -1</constant> to wait indefinitely. Internally this call simply combines <function>sd_journal_get_fd()</function>, <function>sd_journal_get_events()</function>, @@ -209,8 +215,8 @@ else { errno-style error code.</para> <para><function>sd_journal_get_events()</function> - returns a combination of <literal>POLLIN</literal>, - <literal>POLLOUT</literal> and suchlike on success or + returns a combination of <constant>POLLIN</constant>, + <constant>POLLOUT</constant> and suchlike on success or a negative errno-style error code.</para> <para><function>sd_journal_reliable_fd()</function> @@ -222,19 +228,19 @@ else { <para><function>sd_journal_process()</function> and <function>sd_journal_wait()</function> return one of - <literal>SD_JOURNAL_NOP</literal>, - <literal>SD_JOURNAL_APPEND</literal> or - <literal>SD_JOURNAL_INVALIDATE</literal> on success or + <constant>SD_JOURNAL_NOP</constant>, + <constant>SD_JOURNAL_APPEND</constant> or + <constant>SD_JOURNAL_INVALIDATE</constant> on success or a negative errno-style error code. If - <literal>SD_JOURNAL_NOP</literal> is returned the + <constant>SD_JOURNAL_NOP</constant> is returned the journal didn't change since the last invocation. If - <literal>SD_JOURNAL_APPEND</literal> is returned new + <constant>SD_JOURNAL_APPEND</constant> is returned new entries have been appended to the end of the - journal. If <literal>SD_JOURNAL_INVALIDATE</literal> + journal. If <constant>SD_JOURNAL_INVALIDATE</constant> journal files were added or removed (possibly due to rotation). In the latter event live-view UIs should probably refresh their entire display while in the - case of <literal>SD_JOURNAL_APPEND</literal> it is + case of <constant>SD_JOURNAL_APPEND</constant> it is sufficient to simply continue reading at the previous end of the journal.</para> </refsect1> @@ -249,7 +255,7 @@ else { <function>sd_journal_wait()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_journal_get_realtime_usec.xml b/man/sd_journal_get_realtime_usec.xml index 515932c6d..b57a7c15b 100644 --- a/man/sd_journal_get_realtime_usec.xml +++ b/man/sd_journal_get_realtime_usec.xml @@ -77,24 +77,25 @@ journal context object and a pointer to a 64 Bit unsigned integer to store the timestamp in. The timestamp is in microseconds since the epoch, - i.e. CLOCK_REALTIME.</para> + i.e. <constant>CLOCK_REALTIME</constant>.</para> <para><function>sd_journal_get_monotonic_usec()</function> - gets the monotonic timestamp of the current - journal entry. It takes three arguments: the journal - context object, a pointer to a 64 Bit unsigned integer - to store the timestamp in as well as a 128 Bit ID - buffer to store the boot ID of the monotonic timestamp + gets the monotonic timestamp of the current journal + entry. It takes three arguments: the journal context + object, a pointer to a 64 Bit unsigned integer to + store the timestamp in as well as a 128 Bit ID buffer + to store the boot ID of the monotonic timestamp in. The timestamp is in microseconds since boot-up of - the specific boot, i.e. CLOCK_MONOTONIC. Since the + the specific boot, + i.e. <constant>CLOCK_MONOTONIC</constant>. Since the monotonic clock begins new with every reboot it only defines a well-defined point in time when used together with an identifier identifying the boot, see <citerefentry><refentrytitle>sd_id128_get_boot</refentrytitle><manvolnum>3</manvolnum></citerefentry> for more information. If the boot ID parameter is - passed NULL the function will fail if the monotonic - timestamp of the current entry is not of the current - system boot.</para> + passed <constant>NULL</constant> the function will + fail if the monotonic timestamp of the current entry + is not of the current system boot.</para> <para>Note that these functions will not work before <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry> @@ -109,7 +110,7 @@ and <function>sd_journal_get_monotonic_usec()</function> returns 0 on success or a negative errno-style error - code. If the boot ID parameter was passed NULL and the + code. If the boot ID parameter was passed <constant>NULL</constant> and the monotonic timestamp of the current journal entry is not of the current system boot, -ESTALE is returned by <function>sd_journal_get_monotonic_usec()</function>.</para> </refsect1> @@ -123,7 +124,7 @@ <function>sd_journal_get_monotonic_usec()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_journal_get_usage.xml b/man/sd_journal_get_usage.xml index a2b868f21..490317ac9 100644 --- a/man/sd_journal_get_usage.xml +++ b/man/sd_journal_get_usage.xml @@ -66,7 +66,7 @@ <para><function>sd_journal_get_usage()</function> determines the total disk space currently used by journal files (in bytes). If - <literal>SD_JOURNAL_LOCAL_ONLY</literal> was passed + <constant>SD_JOURNAL_LOCAL_ONLY</constant> was passed when opening the journal this value will only reflect the size of journal files of the local host, otherwise of all hosts.</para> @@ -86,7 +86,7 @@ <para>The <function>sd_journal_get_usage()</function> interface is available as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_journal_next.xml b/man/sd_journal_next.xml index 9b1cb1fc4..11066611f 100644 --- a/man/sd_journal_next.xml +++ b/man/sd_journal_next.xml @@ -158,7 +158,7 @@ <function>sd_journal_previous_skip()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_journal_open.xml b/man/sd_journal_open.xml index 36c9d1601..d7ea8ff95 100644 --- a/man/sd_journal_open.xml +++ b/man/sd_journal_open.xml @@ -93,22 +93,22 @@ the log journal for reading. It will find all journal files automatically and interleave them automatically when reading. As first argument it takes a pointer to - a <literal>sd_journal</literal> pointer, which on + a <varname>sd_journal</varname> pointer, which on success will contain a journal context object. The second argument is a flags field, which may consist of the following flags ORed together: - <literal>SD_JOURNAL_LOCAL_ONLY</literal> makes sure + <constant>SD_JOURNAL_LOCAL_ONLY</constant> makes sure only journal files generated on the local machine will - be opened. <literal>SD_JOURNAL_RUNTIME_ONLY</literal> + be opened. <constant>SD_JOURNAL_RUNTIME_ONLY</constant> makes sure only volatile journal files will be opened, excluding those which are stored on persistent - storage. <literal>SD_JOURNAL_SYSTEM</literal> + storage. <constant>SD_JOURNAL_SYSTEM</constant> will cause journal files of system services and the kernel (in opposition to user session processes) to - be opened. <literal>SD_JOURNAL_CURRENT_USER</literal> + be opened. <constant>SD_JOURNAL_CURRENT_USER</constant> will cause journal files of the current user to be - opened. If neither <literal>SD_JOURNAL_SYSTEM</literal> - nor <literal>SD_JOURNAL_CURRENT_USER</literal> are + opened. If neither <constant>SD_JOURNAL_SYSTEM</constant> + nor <constant>SD_JOURNAL_CURRENT_USER</constant> are specified, all journal file types will be opened.</para> <para><function>sd_journal_open_directory()</function> @@ -121,7 +121,7 @@ <para><function>sd_journal_open_files()</function> is similar to <function>sd_journal_open()</function> - but takes a <literal>NULL</literal>-terminated list + but takes a <constant>NULL</constant>-terminated list of file paths to open. All files will be opened and interleaved automatically. This call also takes a flags argument, but it must be passed as 0 as no flags @@ -191,7 +191,7 @@ <function>sd_journal_close()</function> interfaces are available as a shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> @@ -201,19 +201,19 @@ <para><function>sd_journal_open()</function>, <function>sd_journal_close()</function>, - <literal>SD_JOURNAL_LOCAL_ONLY</literal>, - <literal>SD_JOURNAL_RUNTIME_ONLY</literal>, - <literal>SD_JOURNAL_SYSTEM_ONLY</literal> were added + <constant>SD_JOURNAL_LOCAL_ONLY</constant>, + <constant>SD_JOURNAL_RUNTIME_ONLY</constant>, + <constant>SD_JOURNAL_SYSTEM_ONLY</constant> were added in systemd-38.</para> <para><function>sd_journal_open_directory()</function> was added in systemd-187.</para> - <para><literal>SD_JOURNAL_SYSTEM</literal>, - <literal>SD_JOURNAL_CURRENT_USER</literal>, + <para><constant>SD_JOURNAL_SYSTEM</constant>, + <constant>SD_JOURNAL_CURRENT_USER</constant>, and <function>sd_journal_open_files()</function> were added in systemd-205. - <literal>SD_JOURNAL_SYSTEM_ONLY</literal> + <constant>SD_JOURNAL_SYSTEM_ONLY</constant> was deprecated.</para> </refsect1> diff --git a/man/sd_journal_print.xml b/man/sd_journal_print.xml index cdaea8c2e..7292d3345 100644 --- a/man/sd_journal_print.xml +++ b/man/sd_journal_print.xml @@ -102,14 +102,14 @@ or <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>. The priority value is one of - <literal>LOG_EMERG</literal>, - <literal>LOG_ALERT</literal>, - <literal>LOG_CRIT</literal>, - <literal>LOG_ERR</literal>, - <literal>LOG_WARNING</literal>, - <literal>LOG_NOTICE</literal>, - <literal>LOG_INFO</literal>, - <literal>LOG_DEBUG</literal>, as defined in + <constant>LOG_EMERG</constant>, + <constant>LOG_ALERT</constant>, + <constant>LOG_CRIT</constant>, + <constant>LOG_ERR</constant>, + <constant>LOG_WARNING</constant>, + <constant>LOG_NOTICE</constant>, + <constant>LOG_INFO</constant>, + <constant>LOG_DEBUG</constant>, as defined in <filename>syslog.h</filename>, see <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> for details. It is recommended to use this call to @@ -120,7 +120,7 @@ <para><function>sd_journal_printv()</function> is similar to <function>sd_journal_print()</function> but takes a variable argument list encapsulated in an - object of type <literal>va_list</literal> (see + object of type <varname>va_list</varname> (see <citerefentry><refentrytitle>stdarg</refentrytitle><manvolnum>3</manvolnum></citerefentry> for more information) instead of the format string. It is otherwise equivalent in behavior.</para> @@ -129,7 +129,7 @@ used to submit structured log entries to the system journal. It takes a series of format strings, each immediately followed by their associated parameters, - terminated by NULL. The strings passed should be of + terminated by <constant>NULL</constant>. The strings passed should be of the format <literal>VARIABLE=value</literal>. The variable name must be in uppercase and consist only of characters, numbers and underscores, and may not begin @@ -147,7 +147,7 @@ <para><function>sd_journal_sendv()</function> is similar to <function>sd_journal_send()</function> but - takes an array of <literal>struct iovec</literal> (as + takes an array of <varname>struct iovec</varname> (as defined in <filename>uio.h</filename>, see <citerefentry><refentrytitle>readv</refentrytitle><manvolnum>3</manvolnum></citerefentry> for details) instead of the format string. Each @@ -166,12 +166,12 @@ readable representation of the current error code stored in <citerefentry><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>. If - the message string is passed as NULL or empty string + the message string is passed as <constant>NULL</constant> or empty string only the error string representation will be written, prefixed with nothing. An additional journal field ERRNO= is included in the entry containing the numeric error code formatted as decimal string. The log - priority used is <literal>LOG_ERR</literal> (3).</para> + priority used is <constant>LOG_ERR</constant> (3).</para> <para>Note that <function>sd_journal_send()</function> is a wrapper around @@ -229,7 +229,7 @@ sd_journal_send("MESSAGE=Hello World, this is PID %lu!", (unsigned long) getpid( <function>sd_journal_sendv()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_journal_query_unique.xml b/man/sd_journal_query_unique.xml index 502a7e08c..dde52cf5f 100644 --- a/man/sd_journal_query_unique.xml +++ b/man/sd_journal_query_unique.xml @@ -158,7 +158,7 @@ <function>sd_journal_restart_unique()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_journal_seek_head.xml b/man/sd_journal_seek_head.xml index d24b2f30e..9cf9dd07a 100644 --- a/man/sd_journal_seek_head.xml +++ b/man/sd_journal_seek_head.xml @@ -101,13 +101,15 @@ <para><function>sd_journal_seek_monotonic_usec()</function> seeks to the entry with the specified monotonic - timestamp, i.e. CLOCK_MONOTONIC. Since monotonic time - restarts on every reboot a boot ID needs to be - specified as well.</para> + timestamp, + i.e. <constant>CLOCK_MONOTONIC</constant>. Since + monotonic time restarts on every reboot a boot ID + needs to be specified as well.</para> <para><function>sd_journal_seek_realtime_usec()</function> seeks to the entry with the specified realtime - (wallclock) timestamp, i.e. CLOCK_REALTIME. Note that + (wallclock) timestamp, + i.e. <constant>CLOCK_REALTIME</constant>. Note that the realtime clock is not necessarily monotonic. If a realtime timestamp is ambiguous it is not defined which position is sought to.</para> @@ -156,7 +158,7 @@ and <function>sd_journal_seek_cursor()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_journal_stream_fd.xml b/man/sd_journal_stream_fd.xml index 4407296b4..ec42e8cb1 100644 --- a/man/sd_journal_stream_fd.xml +++ b/man/sd_journal_stream_fd.xml @@ -79,19 +79,19 @@ <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry> for more information). The second argument shall be the default priority level for all messages. The - priority level is one of <literal>LOG_EMERG</literal>, - <literal>LOG_ALERT</literal>, - <literal>LOG_CRIT</literal>, - <literal>LOG_ERR</literal>, - <literal>LOG_WARNING</literal>, - <literal>LOG_NOTICE</literal>, - <literal>LOG_INFO</literal>, - <literal>LOG_DEBUG</literal>, as defined in + priority level is one of <constant>LOG_EMERG</constant>, + <constant>LOG_ALERT</constant>, + <constant>LOG_CRIT</constant>, + <constant>LOG_ERR</constant>, + <constant>LOG_WARNING</constant>, + <constant>LOG_NOTICE</constant>, + <constant>LOG_INFO</constant>, + <constant>LOG_DEBUG</constant>, as defined in <filename>syslog.h</filename>, see <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> for details. The third argument is a boolean: if true kernel-style log priority level prefixes (such as - <literal>SD_WARNING</literal>) are interpreted, see + <constant>SD_WARNING</constant>) are interpreted, see <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry> for more information.</para> @@ -114,7 +114,7 @@ <para>The <function>sd_journal_stream_fd()</function> interface is available as shared library, which can be compiled and linked to with the - <literal>libsystemd-journal</literal> + <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index 9c8fdbcca..9d9f4d0d7 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -151,7 +151,7 @@ <filename>sd-daemon.h</filename> files. These interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-daemon</literal> + <constant>libsystemd-daemon</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file. Alternatively, applications consuming these APIs may copy the implementation into their source diff --git a/man/sd_login_monitor_new.xml b/man/sd_login_monitor_new.xml index 261ef1d9d..c7650e6ba 100644 --- a/man/sd_login_monitor_new.xml +++ b/man/sd_login_monitor_new.xml @@ -112,7 +112,7 @@ logins) or <literal>machine</literal> (to get only notifications when a virtual machine or container is started or stopped). If notifications shall be - generated in all these conditions, NULL may be + generated in all these conditions, <constant>NULL</constant> may be passed. Note that in the future additional categories may be defined. The second parameter returns a monitor object and needs to be freed with the @@ -154,22 +154,22 @@ <para><function>sd_login_monitor_get_events()</function> will return the <function>poll()</function> mask to wait for. This function will return a combination of - <literal>POLLIN</literal>, <literal>POLLOUT</literal> + <constant>POLLIN</constant>, <constant>POLLOUT</constant> and similar to fill into the - <literal>.events</literal> field of <literal>struct - pollfd</literal>.</para> + <literal>.events</literal> field of <varname>struct + pollfd</varname>.</para> <para><function>sd_login_monitor_get_timeout()</function> will return a timeout value for usage in <function>poll()</function>. This returns a value in - microseconds since the epoch of CLOCK_MONOTONIC for - timing out <function>poll()</function> in - <literal>timeout_usec</literal>. See + microseconds since the epoch of <constant>CLOCK_MONOTONIC</constant> + for timing out <function>poll()</function> in + <varname>timeout_usec</varname>. See <citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry> for details about - <literal>CLOCK_MONOTONIC</literal>. If there's no + <constant>CLOCK_MONOTONIC</constant>. If there's no timeout to wait for this will fill in - <literal>(uint64_t) -1</literal> instead. Note that + <constant>(uint64_t) -1</constant> instead. Note that <function>poll()</function> takes a relative timeout in milliseconds rather than an absolute timeout in microseconds. To convert the absolute 'us' timeout into @@ -189,7 +189,7 @@ else { }</programlisting> <para>The code above does not do any error checking - for brevity's sake. The calculated <literal>msec</literal> + for brevity's sake. The calculated <varname>msec</varname> integer can be passed directly as <function>poll()</function>'s timeout parameter.</para> @@ -206,13 +206,13 @@ else { <function>sd_login_monitor_get_fd()</function> returns a Unix file descriptor. On success <function>sd_login_monitor_get_events()</function> - returns a combination of <literal>POLLIN</literal>, - <literal>POLLOUT</literal> and suchlike. On failure, + returns a combination of <constant>POLLIN</constant>, + <constant>POLLOUT</constant> and suchlike. On failure, these calls return a negative errno-style error code.</para> <para><function>sd_login_monitor_unref()</function> - always returns NULL.</para> + always returns <constant>NULL</constant>.</para> </refsect1> <refsect1> @@ -226,7 +226,7 @@ else { <function>sd_login_monitor_get_timeout()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-login</literal> + <constant>libsystemd-login</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 81f74aa84..52614a207 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -217,7 +217,7 @@ <para>Internally, these functions send a single datagram with the state string as payload to the - AF_UNIX socket referenced in the + <constant>AF_UNIX</constant> socket referenced in the <varname>$NOTIFY_SOCKET</varname> environment variable. If the first character of <varname>$NOTIFY_SOCKET</varname> is @ the string is @@ -238,7 +238,7 @@ <filename>sd-daemon.h</filename> files. These interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-daemon</literal> + <constant>libsystemd-daemon</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file. Alternatively, applications consuming these APIs may copy the implementation into their source tree. For diff --git a/man/sd_pid_get_session.xml b/man/sd_pid_get_session.xml index 543a5c0c7..b45c9a552 100644 --- a/man/sd_pid_get_session.xml +++ b/man/sd_pid_get_session.xml @@ -146,7 +146,7 @@ <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> call after use.</para> - <para>If the <literal>pid</literal> parameter of any + <para>If the <varname>pid</varname> parameter of any of these functions is passed as 0 the operation is executed for the calling process.</para> </refsect1> @@ -169,7 +169,7 @@ <function>sd_pid_get_machine_name()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-login</literal> + <constant>libsystemd-login</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml index 07e018de1..3060ec7d5 100644 --- a/man/sd_seat_get_active.xml +++ b/man/sd_seat_get_active.xml @@ -101,18 +101,18 @@ <para><function>sd_seat_get_sessions()</function> may be used to determine all sessions on the specified - seat. Returns two arrays, one (NULL terminated) with + seat. Returns two arrays, one (<constant>NULL</constant> terminated) with the session identifiers of the sessions and one with the user identifiers of the Unix users the sessions belong to. An additional parameter may be used to return the number of entries in the latter array. The two arrays and the latter parameter may be passed as - NULL in case these values need not to be + <constant>NULL</constant> in case these values need not to be determined. The arrays and the strings referenced by them need to be freed with the libc <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> call after use. Note that instead of an empty array - NULL may be returned and should be considered + <constant>NULL</constant> may be returned and should be considered equivalent to an empty array.</para> <para><function>sd_seat_can_multi_session()</function> @@ -130,10 +130,11 @@ graphics functionality, i.e. is useful as a graphics display.</para> - <para>If the <literal>seat</literal> parameter of any - of these functions is passed as NULL the operation is - executed for the seat of the session of the calling - process, if there is any.</para> + <para>If the <varname>seat</varname> parameter of any + of these functions is passed as + <constant>NULL</constant> the operation is executed + for the seat of the session of the calling process, if + there is any.</para> </refsect1> <refsect1> @@ -162,7 +163,7 @@ <function>sd_seat_can_grapical()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-login</literal> + <constant>libsystemd-login</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml index 6fa803bfa..0146fb427 100644 --- a/man/sd_session_is_active.xml +++ b/man/sd_session_is_active.xml @@ -202,10 +202,11 @@ <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> call after use.</para> - <para>If the <literal>session</literal> parameter of - any of these functions is passed as NULL the operation - is executed for the session the calling process is a - member of, if there is any.</para> + <para>If the <varname>session</varname> parameter of + any of these functions is passed as + <constant>NULL</constant> the operation is executed + for the session the calling process is a member of, if + there is any.</para> </refsect1> <refsect1> @@ -240,7 +241,7 @@ <function>sd_session_get_tty()</function> interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-login</literal> + <constant>libsystemd-login</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml index cc8fc0f5b..9a20b5453 100644 --- a/man/sd_uid_get_state.xml +++ b/man/sd_uid_get_state.xml @@ -127,15 +127,15 @@ currently active (> 0), where the user is currently online but possibly inactive (= 0), or logged in at all but possibly closing the session (< 0). The call returns a - NULL terminated string array of session identifiers in + <constant>NULL</constant> terminated string array of session identifiers in <parameter>sessions</parameter> which needs to be freed by the caller with the libc <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> call after use, including all the strings referenced. If the string array parameter is passed as - NULL the array will not be filled in, but the return + <constant>NULL</constant> the array will not be filled in, but the return code still indicates the number of current - sessions. Note that instead of an empty array NULL may + sessions. Note that instead of an empty array <constant>NULL</constant> may be returned and should be considered equivalent to an empty array.</para> @@ -172,7 +172,7 @@ <function>sd_uid_get_sessions()</function>, and <function>sd_uid_get_seats()</function> interfaces are available as shared library, which can be compiled and - linked to with the <literal>libsystemd-login</literal> + linked to with the <constant>libsystemd-login</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file.</para> </refsect1> diff --git a/man/systemd-journald.service.xml b/man/systemd-journald.service.xml index 822f3c28f..2860ae976 100644 --- a/man/systemd-journald.service.xml +++ b/man/systemd-journald.service.xml @@ -87,8 +87,8 @@ the data.</para> <para><filename>systemd-journald</filename> will - forward all received log messages to the AF_UNIX - SOCK_DGRAM socket + forward all received log messages to the <constant>AF_UNIX</constant> + <constant>SOCK_DGRAM</constant> socket <filename>/run/systemd/journal/syslog</filename> (if it exists) which may be used by UNIX syslog daemons to process the data further.</para> diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 8d5948ab0..2ccc470e2 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -721,9 +721,9 @@ separated list of capability names as read by <citerefentry><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - e.g. <literal>CAP_SYS_ADMIN - CAP_DAC_OVERRIDE - CAP_SYS_PTRACE</literal>. + e.g. <constant>CAP_SYS_ADMIN</constant>, + <constant>CAP_DAC_OVERRIDE</constant>, + <constant>CAP_SYS_PTRACE</constant>. Capabilities listed will be included in the bounding set, all others are removed. If the list of capabilities @@ -1217,7 +1217,8 @@ system calls executed by the unit process except for the listed ones will result in immediate process - termination with the SIGSYS signal + termination with the + <constant>SIGSYS</constant> signal (whitelisting). If the first character of the list is <literal>~</literal> the effect is inverted: only the diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml index de01dc236..fe65078f7 100644 --- a/man/systemd.journal-fields.xml +++ b/man/systemd.journal-fields.xml @@ -100,9 +100,9 @@ enforced, and formatted differently. Developers can generate a new ID for this - purpose with - <command>journalctl - --new-id</command>.</para> + purpose with <command>journalctl + <option>--new-id</option></command>. + </para> </listitem> </varlistentry> @@ -474,8 +474,8 @@ describes the position of an entry in the journal and is portable across machines, - platforms and journal - files.</para> + platforms and journal files. + </para> </listitem> </varlistentry> @@ -483,16 +483,17 @@ <term><varname>__REALTIME_TIMESTAMP=</varname></term> <listitem> <para>The wallclock time - (CLOCK_REALTIME) at the point - in time the entry was received - by the journal, in usec since - the epoch UTC formatted as - decimal string. This has - different properties from + (<constant>CLOCK_REALTIME</constant>) + at the point in time the entry + was received by the journal, + in usec since the epoch UTC + formatted as decimal + string. This has different + properties from <literal>_SOURCE_REALTIME_TIMESTAMP=</literal> as it is usually a bit later - but more likely to be - monotonic.</para> + but more likely to be monotonic. + </para> </listitem> </varlistentry> @@ -500,15 +501,15 @@ <term><varname>__MONOTONIC_TIMESTAMP=</varname></term> <listitem> <para>The monotonic time - (CLOCK_MONOTONIC) at the point - in time the entry was received - by the journal in usec - formatted as decimal + (<constant>CLOCK_MONOTONIC</constant>) + at the point in time the entry + was received by the journal in + usec formatted as decimal string. To be useful as an address for the entry this should be combined with with - boot ID in - <literal>_BOOT_ID=</literal>.</para> + boot ID in <literal>_BOOT_ID=</literal>. + </para> </listitem> </varlistentry> </variablelist> diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 040305c63..0d5652b83 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -150,19 +150,19 @@ <term><varname>ListenSequentialPacket=</varname></term> <listitem><para>Specifies an address to listen on for a stream - (SOCK_STREAM), datagram (SOCK_DGRAM), + (<constant>SOCK_STREAM</constant>), datagram (<constant>SOCK_DGRAM</constant>), or sequential packet - (SOCK_SEQPACKET) socket, respectively. The address + (<constant>SOCK_SEQPACKET</constant>) socket, respectively. The address can be written in various formats:</para> <para>If the address starts with a slash (/), it is read as file system - socket in the AF_UNIX socket + socket in the <constant>AF_UNIX</constant> socket family.</para> <para>If the address starts with an at symbol (@) it is read as abstract - namespace socket in the AF_UNIX + namespace socket in the <constant>AF_UNIX</constant> family. The @ is replaced with a NUL character before binding. For details see @@ -193,13 +193,13 @@ setting (see below). </para> - <para>Note that SOCK_SEQPACKET + <para>Note that <constant>SOCK_SEQPACKET</constant> (i.e. <varname>ListenSequentialPacket=</varname>) - is only available for AF_UNIX - sockets. SOCK_STREAM + is only available for <constant>AF_UNIX</constant> + sockets. <constant>SOCK_STREAM</constant> (i.e. <varname>ListenStream=</varname>) when used for IP sockets refers to TCP - sockets, SOCK_DGRAM + sockets, <constant>SOCK_DGRAM</constant> (i.e. <varname>ListenDatagram=</varname>) to UDP.</para> @@ -258,7 +258,7 @@ <listitem><para>Specifies a Netlink family to create a socket for to listen on. This expects a short string - referring to the AF_NETLINK family + referring to the <constant>AF_NETLINK</constant> family name (such as <varname>audit</varname> or <varname>kobject-uevent</varname>) as argument, optionally suffixed by a @@ -382,7 +382,7 @@ to write new daemons only in a way that is suitable for <option>Accept=false</option>. A - daemon listening on an AF_UNIX socket + daemon listening on an <constant>AF_UNIX</constant> socket may, but does not need to, call <citerefentry><refentrytitle>close</refentrytitle><manvolnum>2</manvolnum></citerefentry> on the received socket before @@ -584,7 +584,7 @@ <term><varname>PassCredentials=</varname></term> <listitem><para>Takes a boolean value. This controls the SO_PASSCRED - socket option, which allows AF_UNIX sockets to + socket option, which allows <constant>AF_UNIX</constant> sockets to receive the credentials of the sending process in an ancillary message. Defaults to @@ -595,7 +595,7 @@ <term><varname>PassSecurity=</varname></term> <listitem><para>Takes a boolean value. This controls the SO_PASSSEC - socket option, which allows AF_UNIX + socket option, which allows <constant>AF_UNIX</constant> sockets to receive the security context of the sending process in an ancillary message. Defaults to diff --git a/man/systemd.xml b/man/systemd.xml index 497dd2bfe..ef9564138 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -611,7 +611,7 @@ <variablelist> <varlistentry> - <term>SIGTERM</term> + <term><constant>SIGTERM</constant></term> <listitem><para>Upon receiving this signal the systemd system manager @@ -631,7 +631,7 @@ </varlistentry> <varlistentry> - <term>SIGINT</term> + <term><constant>SIGINT</constant></term> <listitem><para>Upon receiving this signal the systemd system manager will @@ -647,7 +647,7 @@ </varlistentry> <varlistentry> - <term>SIGWINCH</term> + <term><constant>SIGWINCH</constant></term> <listitem><para>When this signal is received the systemd system manager @@ -663,7 +663,7 @@ </varlistentry> <varlistentry> - <term>SIGPWR</term> + <term><constant>SIGPWR</constant></term> <listitem><para>When this signal is received the systemd manager @@ -675,7 +675,7 @@ </varlistentry> <varlistentry> - <term>SIGUSR1</term> + <term><constant>SIGUSR1</constant></term> <listitem><para>When this signal is received the systemd manager will try @@ -684,7 +684,7 @@ </varlistentry> <varlistentry> - <term>SIGUSR2</term> + <term><constant>SIGUSR2</constant></term> <listitem><para>When this signal is received the systemd manager will log @@ -695,7 +695,7 @@ </varlistentry> <varlistentry> - <term>SIGHUP</term> + <term><constant>SIGHUP</constant></term> <listitem><para>Reloads the complete daemon configuration. This is mostly @@ -704,7 +704,7 @@ </varlistentry> <varlistentry> - <term>SIGRTMIN+0</term> + <term><constant>SIGRTMIN+0</constant></term> <listitem><para>Enters default mode, starts the <filename>default.target</filename> @@ -714,7 +714,7 @@ </varlistentry> <varlistentry> - <term>SIGRTMIN+1</term> + <term><constant>SIGRTMIN+1</constant></term> <listitem><para>Enters rescue mode, starts the @@ -725,7 +725,7 @@ </varlistentry> <varlistentry> - <term>SIGRTMIN+2</term> + <term><constant>SIGRTMIN+2</constant></term> <listitem><para>Enters emergency mode, starts the @@ -736,7 +736,7 @@ </varlistentry> <varlistentry> - <term>SIGRTMIN+3</term> + <term><constant>SIGRTMIN+3</constant></term> <listitem><para>Halts the machine, starts the @@ -747,7 +747,7 @@ </varlistentry> <varlistentry> - <term>SIGRTMIN+4</term> + <term><constant>SIGRTMIN+4</constant></term> <listitem><para>Powers off the machine, starts the @@ -758,7 +758,7 @@ </varlistentry> <varlistentry> - <term>SIGRTMIN+5</term> + <term><constant>SIGRTMIN+5</constant></term> <listitem><para>Reboots the machine, starts the @@ -769,7 +769,7 @@ </varlistentry> <varlistentry> - <term>SIGRTMIN+6</term> + <term><constant>SIGRTMIN+6</constant></term> <listitem><para>Reboots the machine via kexec, starts the @@ -780,31 +780,31 @@ </varlistentry> <varlistentry> - <term>SIGRTMIN+13</term> + <term><constant>SIGRTMIN+13</constant></term> <listitem><para>Immediately halts the machine.</para></listitem> </varlistentry> <varlistentry> - <term>SIGRTMIN+14</term> + <term><constant>SIGRTMIN+14</constant></term> <listitem><para>Immediately powers off the machine.</para></listitem> </varlistentry> <varlistentry> - <term>SIGRTMIN+15</term> + <term><constant>SIGRTMIN+15</constant></term> <listitem><para>Immediately reboots the machine.</para></listitem> </varlistentry> <varlistentry> - <term>SIGRTMIN+16</term> + <term><constant>SIGRTMIN+16</constant></term> <listitem><para>Immediately reboots the machine with kexec.</para></listitem> </varlistentry> <varlistentry> - <term>SIGRTMIN+20</term> + <term><constant>SIGRTMIN+20</constant></term> <listitem><para>Enables display of status messages on the console, as @@ -815,7 +815,7 @@ </varlistentry> <varlistentry> - <term>SIGRTMIN+21</term> + <term><constant>SIGRTMIN+21</constant></term> <listitem><para>Disables display of status messages on the console, as @@ -826,23 +826,23 @@ </varlistentry> <varlistentry> - <term>SIGRTMIN+22</term> - <term>SIGRTMIN+23</term> + <term><constant>SIGRTMIN+22</constant></term> + <term><constant>SIGRTMIN+23</constant></term> <listitem><para>Sets the log level to <literal>debug</literal> (or <literal>info</literal> on - <literal>SIGRTMIN+23</literal>), as + <constant>SIGRTMIN+23</constant>), as controlled via <varname>systemd.log_level=debug</varname> (or <varname>systemd.log_level=info</varname> - on <literal>SIGRTMIN+23</literal>) on + on <constant>SIGRTMIN+23</constant>) on the kernel command line.</para></listitem> </varlistentry> <varlistentry> - <term>SIGRTMIN+24</term> + <term><constant>SIGRTMIN+24</constant></term> <listitem><para>Immediately exits the manager (only available for --user @@ -850,28 +850,28 @@ </varlistentry> <varlistentry> - <term>SIGRTMIN+26</term> - <term>SIGRTMIN+27</term> - <term>SIGRTMIN+28</term> - <term>SIGRTMIN+29</term> + <term><constant>SIGRTMIN+26</constant></term> + <term><constant>SIGRTMIN+27</constant></term> + <term><constant>SIGRTMIN+28</constant></term> + <term><constant>SIGRTMIN+29</constant></term> <listitem><para>Sets the log level to <literal>journal-or-kmsg</literal> (or <literal>console</literal> on - <literal>SIGRTMIN+27</literal>, + <constant>SIGRTMIN+27</constant>, <literal>kmsg</literal> on - <literal>SIGRTMIN+28</literal>, + <constant>SIGRTMIN+28</constant>, or <literal>syslog-or-kmsg</literal> - on <literal>SIGRTMIN+29</literal>), as + on <constant>SIGRTMIN+29</constant>), as controlled via <varname>systemd.log_target=journal-or-kmsg</varname> (or <varname>systemd.log_target=console</varname> - on <literal>SIGRTMIN+27</literal>, + on <constant>SIGRTMIN+27</constant>, <varname>systemd.log_target=kmsg</varname> - on <literal>SIGRTMIN+28</literal>, + on <constant>SIGRTMIN+28</constant>, or <varname>systemd.log_target=syslog-or-kmsg</varname> - on <literal>SIGRTMIN+29</literal>) on + on <constant>SIGRTMIN+29</constant>) on the kernel command line.</para></listitem> </varlistentry> @@ -1044,7 +1044,7 @@ argument. If positive systemd activates the specified virtual terminal when it crashes. Defaults to - <literal>-1</literal>.</para></listitem> + <constant>-1</constant>.</para></listitem> </varlistentry> <varlistentry> @@ -1223,7 +1223,7 @@ <listitem><para>Daemon status notification socket. This is an - AF_UNIX datagram socket and is used to + <constant>AF_UNIX</constant> datagram socket and is used to implement the daemon notification logic as implemented by <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem> @@ -1236,7 +1236,7 @@ <listitem><para>Used internally by the <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry> tool to implement delayed - shutdowns. This is an AF_UNIX datagram + shutdowns. This is an <constant>AF_UNIX</constant> datagram socket.</para></listitem> </varlistentry> @@ -1247,7 +1247,7 @@ communication channel between <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> and the systemd process. This is an - AF_UNIX stream socket. This interface + <constant>AF_UNIX</constant> stream socket. This interface is private to systemd and should not be used in external projects.</para></listitem> |