diff --git a/man/bootchart.conf.xml b/man/bootchart.conf.xml index 1e440eb2cc..7fd47ebe96 100644 --- a/man/bootchart.conf.xml +++ b/man/bootchart.conf.xml @@ -87,7 +87,7 @@ Relative=no Configures whether the left axis of the - output graph equals time=0.0 (CLOCK_MONOTONIC start). This + output graph equals time=0.0 (CLOCK_MONOTONIC 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 de362c1b71..258694080e 100644 --- a/man/daemon.xml +++ b/man/daemon.xml @@ -894,7 +894,7 @@ fi If the daemon offers interfaces to other software running on the - local system via local AF_UNIX sockets, + local system via local AF_UNIX sockets, consider implementing socket-based activation (see above). Usually a minimal patch is sufficient to implement this: Extend the @@ -906,7 +906,7 @@ fi 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 + AF_UNIX 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 2dc6651885..0354811976 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -285,7 +285,7 @@ include the value of $XDG_SESSION_ID in the filename. This directory shall be used for runtime file system - objects such as AF_UNIX sockets, + objects such as AF_UNIX 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 a3bf662fe9..55ee1fd893 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -146,7 +146,7 @@ sd-daemon.h files. These interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-daemon + libsystemd-daemon pkg-config1 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 ac2000e275..51a16e35d4 100644 --- a/man/sd-id128.xml +++ b/man/sd-id128.xml @@ -149,7 +149,7 @@ Note that new, randomized IDs may be generated with journalctl1's - --new-id option. + option. diff --git a/man/sd-journal.xml b/man/sd-journal.xml index a7220ec6bc..490b971f19 100644 --- a/man/sd-journal.xml +++ b/man/sd-journal.xml @@ -100,7 +100,7 @@ These APIs are implemented as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd-login.xml b/man/sd-login.xml index 697259564d..c186324f83 100644 --- a/man/sd-login.xml +++ b/man/sd-login.xml @@ -95,7 +95,7 @@ each other. If the functions return string arrays, these are - generally NULL terminated and need to be freed by the + generally NULL terminated and need to be freed by the caller with the libc free3 call after use, including the strings referenced @@ -103,7 +103,7 @@ be freed, as well. As a special exception, instead of an empty - string array NULL may be returned, which should be + string array NULL may be returned, which should be treated equivalent to an empty string array. See @@ -122,7 +122,7 @@ These APIs are implemented as shared library, which can be compiled and linked to with the - libsystemd-login + libsystemd-login pkg-config1 file. diff --git a/man/sd_booted.xml b/man/sd_booted.xml index ce5a34dc86..32d0fd095d 100644 --- a/man/sd_booted.xml +++ b/man/sd_booted.xml @@ -102,7 +102,7 @@ sd-daemon.h files. These interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-daemon + libsystemd-daemon pkg-config1 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 9bc866dc68..9fb0732c10 100644 --- a/man/sd_get_seats.xml +++ b/man/sd_get_seats.xml @@ -82,12 +82,12 @@ sd_get_seats() may be used to determine all currently available local - seats. Returns a NULL terminated array of seat + seats. Returns a NULL terminated array of seat identifiers. The returned array and all strings it references need to be freed with the libc free3 call after use. Note that instead of an empty array - NULL may be returned and should be considered + NULL may be returned and should be considered equivalent to an empty array. Similar, sd_get_sessions() may @@ -124,7 +124,7 @@ sd_get_machine_names() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-login + libsystemd-login pkg-config1 file. diff --git a/man/sd_id128_randomize.xml b/man/sd_id128_randomize.xml index be74937dd0..37efe164cd 100644 --- a/man/sd_id128_randomize.xml +++ b/man/sd_id128_randomize.xml @@ -79,7 +79,7 @@ sd-id1283. journalctl1's - --new-id command may be used as + option may be used as command line front-end for sd_id128_randomize(). diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index 595c8f112d..5eaf1585a2 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 family parameter is not - AF_UNSPEC it is checked whether the socket is of the - specified family (AF_UNIX, AF_INET, ...). If the + AF_UNSPEC it is checked whether + the socket is of the specified family (AF_UNIX, + AF_INET, ...). If the type parameter is not 0 it is checked whether the socket is of the specified type - (SOCK_STREAM, SOCK_DGRAM, ...). If the + (SOCK_STREAM, + SOCK_DGRAM, ...). If the listening parameter is positive it is checked whether the socket is in accepting mode, i.e. listen() has been called for @@ -129,14 +131,14 @@ optionally checks the IPv4 or IPv6 port number the socket is bound to, unless port is zero. For this call family - must be passed as either AF_UNSPEC, AF_INET, or - AF_INET6. + must be passed as either AF_UNSPEC, AF_INET, or + AF_INET6. sd_is_socket_unix() is similar to sd_is_socket(), but - optionally checks the AF_UNIX path the socket is bound + optionally checks the AF_UNIX path the socket is bound to, unless the path parameter - is NULL. For normal file system AF_UNIX sockets set + is NULL. For normal file system AF_UNIX sockets set the length parameter to 0. For Linux abstract namespace sockets set the length to the size of the @@ -190,7 +192,7 @@ sd-daemon.h files. These interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-daemon + libsystemd-daemon pkg-config1 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 549785ca83..82edf21834 100644 --- a/man/sd_journal_add_match.xml +++ b/man/sd_journal_add_match.xml @@ -176,7 +176,7 @@ sd_journal_flush_matches() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd_journal_get_catalog.xml b/man/sd_journal_get_catalog.xml index 719d77f723..d1962e4ca1 100644 --- a/man/sd_journal_get_catalog.xml +++ b/man/sd_journal_get_catalog.xml @@ -120,7 +120,7 @@ sd_journal_get_catalog_for_message_id() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd_journal_get_cursor.xml b/man/sd_journal_get_cursor.xml index 1b0e775bb4..d83c5191f5 100644 --- a/man/sd_journal_get_cursor.xml +++ b/man/sd_journal_get_cursor.xml @@ -132,7 +132,7 @@ and sd_journal_test_cursor() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd_journal_get_cutoff_realtime_usec.xml b/man/sd_journal_get_cutoff_realtime_usec.xml index ed014cb509..506c02c38c 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. + 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. sd_journal_get_cutoff_monotonic_usec() 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. CLOCK_MONOTONIC. 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. + passed as NULL in case the + timestamp is not needed, but not both. @@ -121,7 +124,7 @@ sd_journal_get_cutoff_monotonic_usec() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd_journal_get_data.xml b/man/sd_journal_get_data.xml index 1259b0cdbe..ba50b8d092 100644 --- a/man/sd_journal_get_data.xml +++ b/man/sd_journal_get_data.xml @@ -205,7 +205,7 @@ sd_journal_get_data_threshold() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd_journal_get_fd.xml b/man/sd_journal_get_fd.xml index 33d2980b3b..f3fbe69c32 100644 --- a/man/sd_journal_get_fd.xml +++ b/man/sd_journal_get_fd.xml @@ -123,22 +123,28 @@ sd_journal_get_events() will return the poll() mask to wait for. This function will return a combination of - POLLIN and - POLLOUT and similar to fill into + POLLIN and + POLLOUT and similar to fill into the .events field of - struct pollfd. + struct pollfd. sd_journal_get_timeout() - will return a timeout value for usage in poll(). This returns a value in microseconds since the epoch of CLOCK_MONOTONIC for timing out poll() in timeout_usec. See + will return a timeout value for usage in + poll(). This returns a value in + microseconds since the epoch of + CLOCK_MONOTONIC for timing out + poll() in + timeout_usec. See clock_gettime2 for details about - CLOCK_MONOTONIC. If there's no + CLOCK_MONOTONIC. If there's no timeout to wait for this will fill in - (uint64_t) -1 instead. Note that + (uint64_t) -1 instead. Note that poll() 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: + microseconds. To convert the absolute 'us' timeout + into relative 'ms', use code like the + following: uint64_t t; int msec; @@ -154,7 +160,7 @@ else { } The code above does not do any error checking - for brevity's sake. The calculated msec + for brevity's sake. The calculated msec integer can be passed directly as poll()'s timeout parameter. @@ -174,7 +180,7 @@ else { synchronously wait until the journal gets changed. The maximum time this call sleeps may be controlled with the timeout_usec - parameter. Pass (uint64_t) -1 to + parameter. Pass (uint64_t) -1 to wait indefinitely. Internally this call simply combines sd_journal_get_fd(), sd_journal_get_events(), @@ -209,8 +215,8 @@ else { errno-style error code. sd_journal_get_events() - returns a combination of POLLIN, - POLLOUT and suchlike on success or + returns a combination of POLLIN, + POLLOUT and suchlike on success or a negative errno-style error code. sd_journal_reliable_fd() @@ -222,19 +228,19 @@ else { sd_journal_process() and sd_journal_wait() return one of - SD_JOURNAL_NOP, - SD_JOURNAL_APPEND or - SD_JOURNAL_INVALIDATE on success or + SD_JOURNAL_NOP, + SD_JOURNAL_APPEND or + SD_JOURNAL_INVALIDATE on success or a negative errno-style error code. If - SD_JOURNAL_NOP is returned the + SD_JOURNAL_NOP is returned the journal didn't change since the last invocation. If - SD_JOURNAL_APPEND is returned new + SD_JOURNAL_APPEND is returned new entries have been appended to the end of the - journal. If SD_JOURNAL_INVALIDATE + journal. If SD_JOURNAL_INVALIDATE 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 SD_JOURNAL_APPEND it is + case of SD_JOURNAL_APPEND it is sufficient to simply continue reading at the previous end of the journal. @@ -249,7 +255,7 @@ else { sd_journal_wait() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd_journal_get_realtime_usec.xml b/man/sd_journal_get_realtime_usec.xml index 515932c6d8..b57a7c15b2 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. + i.e. CLOCK_REALTIME. sd_journal_get_monotonic_usec() - 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. CLOCK_MONOTONIC. 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 sd_id128_get_boot3 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. + passed NULL the function will + fail if the monotonic timestamp of the current entry + is not of the current system boot. Note that these functions will not work before sd_journal_next3 @@ -109,7 +110,7 @@ and sd_journal_get_monotonic_usec() 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 NULL and the monotonic timestamp of the current journal entry is not of the current system boot, -ESTALE is returned by sd_journal_get_monotonic_usec(). @@ -123,7 +124,7 @@ sd_journal_get_monotonic_usec() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd_journal_get_usage.xml b/man/sd_journal_get_usage.xml index a2b868f218..490317ac91 100644 --- a/man/sd_journal_get_usage.xml +++ b/man/sd_journal_get_usage.xml @@ -66,7 +66,7 @@ sd_journal_get_usage() determines the total disk space currently used by journal files (in bytes). If - SD_JOURNAL_LOCAL_ONLY was passed + SD_JOURNAL_LOCAL_ONLY was passed when opening the journal this value will only reflect the size of journal files of the local host, otherwise of all hosts. @@ -86,7 +86,7 @@ The sd_journal_get_usage() interface is available as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd_journal_next.xml b/man/sd_journal_next.xml index 9b1cb1fc46..11066611f1 100644 --- a/man/sd_journal_next.xml +++ b/man/sd_journal_next.xml @@ -158,7 +158,7 @@ sd_journal_previous_skip() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd_journal_open.xml b/man/sd_journal_open.xml index 36c9d16019..d7ea8ff95b 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 sd_journal pointer, which on + a sd_journal 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: - SD_JOURNAL_LOCAL_ONLY makes sure + SD_JOURNAL_LOCAL_ONLY makes sure only journal files generated on the local machine will - be opened. SD_JOURNAL_RUNTIME_ONLY + be opened. SD_JOURNAL_RUNTIME_ONLY makes sure only volatile journal files will be opened, excluding those which are stored on persistent - storage. SD_JOURNAL_SYSTEM + storage. SD_JOURNAL_SYSTEM will cause journal files of system services and the kernel (in opposition to user session processes) to - be opened. SD_JOURNAL_CURRENT_USER + be opened. SD_JOURNAL_CURRENT_USER will cause journal files of the current user to be - opened. If neither SD_JOURNAL_SYSTEM - nor SD_JOURNAL_CURRENT_USER are + opened. If neither SD_JOURNAL_SYSTEM + nor SD_JOURNAL_CURRENT_USER are specified, all journal file types will be opened. sd_journal_open_directory() @@ -121,7 +121,7 @@ sd_journal_open_files() is similar to sd_journal_open() - but takes a NULL-terminated list + but takes a NULL-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 @@ sd_journal_close() interfaces are available as a shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. @@ -201,19 +201,19 @@ sd_journal_open(), sd_journal_close(), - SD_JOURNAL_LOCAL_ONLY, - SD_JOURNAL_RUNTIME_ONLY, - SD_JOURNAL_SYSTEM_ONLY were added + SD_JOURNAL_LOCAL_ONLY, + SD_JOURNAL_RUNTIME_ONLY, + SD_JOURNAL_SYSTEM_ONLY were added in systemd-38. sd_journal_open_directory() was added in systemd-187. - SD_JOURNAL_SYSTEM, - SD_JOURNAL_CURRENT_USER, + SD_JOURNAL_SYSTEM, + SD_JOURNAL_CURRENT_USER, and sd_journal_open_files() were added in systemd-205. - SD_JOURNAL_SYSTEM_ONLY + SD_JOURNAL_SYSTEM_ONLY was deprecated. diff --git a/man/sd_journal_print.xml b/man/sd_journal_print.xml index cdaea8c2ef..7292d33456 100644 --- a/man/sd_journal_print.xml +++ b/man/sd_journal_print.xml @@ -102,14 +102,14 @@ or syslog3. The priority value is one of - LOG_EMERG, - LOG_ALERT, - LOG_CRIT, - LOG_ERR, - LOG_WARNING, - LOG_NOTICE, - LOG_INFO, - LOG_DEBUG, as defined in + LOG_EMERG, + LOG_ALERT, + LOG_CRIT, + LOG_ERR, + LOG_WARNING, + LOG_NOTICE, + LOG_INFO, + LOG_DEBUG, as defined in syslog.h, see syslog3 for details. It is recommended to use this call to @@ -120,7 +120,7 @@ sd_journal_printv() is similar to sd_journal_print() but takes a variable argument list encapsulated in an - object of type va_list (see + object of type va_list (see stdarg3 for more information) instead of the format string. It is otherwise equivalent in behavior. @@ -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 NULL. The strings passed should be of the format VARIABLE=value. The variable name must be in uppercase and consist only of characters, numbers and underscores, and may not begin @@ -147,7 +147,7 @@ sd_journal_sendv() is similar to sd_journal_send() but - takes an array of struct iovec (as + takes an array of struct iovec (as defined in uio.h, see readv3 for details) instead of the format string. Each @@ -166,12 +166,12 @@ readable representation of the current error code stored in errno3. If - the message string is passed as NULL or empty string + the message string is passed as NULL 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 LOG_ERR (3). + priority used is LOG_ERR (3). Note that sd_journal_send() is a wrapper around @@ -229,7 +229,7 @@ sd_journal_send("MESSAGE=Hello World, this is PID %lu!", (unsigned long) getpid( sd_journal_sendv() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd_journal_query_unique.xml b/man/sd_journal_query_unique.xml index 502a7e08c2..dde52cf5fb 100644 --- a/man/sd_journal_query_unique.xml +++ b/man/sd_journal_query_unique.xml @@ -158,7 +158,7 @@ sd_journal_restart_unique() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd_journal_seek_head.xml b/man/sd_journal_seek_head.xml index d24b2f30ee..9cf9dd07a8 100644 --- a/man/sd_journal_seek_head.xml +++ b/man/sd_journal_seek_head.xml @@ -101,13 +101,15 @@ sd_journal_seek_monotonic_usec() 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. + timestamp, + i.e. CLOCK_MONOTONIC. Since + monotonic time restarts on every reboot a boot ID + needs to be specified as well. sd_journal_seek_realtime_usec() seeks to the entry with the specified realtime - (wallclock) timestamp, i.e. CLOCK_REALTIME. Note that + (wallclock) timestamp, + i.e. CLOCK_REALTIME. Note that the realtime clock is not necessarily monotonic. If a realtime timestamp is ambiguous it is not defined which position is sought to. @@ -156,7 +158,7 @@ and sd_journal_seek_cursor() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd_journal_stream_fd.xml b/man/sd_journal_stream_fd.xml index 4407296b40..ec42e8cb1b 100644 --- a/man/sd_journal_stream_fd.xml +++ b/man/sd_journal_stream_fd.xml @@ -79,19 +79,19 @@ systemd.journal-fields7 for more information). The second argument shall be the default priority level for all messages. The - priority level is one of LOG_EMERG, - LOG_ALERT, - LOG_CRIT, - LOG_ERR, - LOG_WARNING, - LOG_NOTICE, - LOG_INFO, - LOG_DEBUG, as defined in + priority level is one of LOG_EMERG, + LOG_ALERT, + LOG_CRIT, + LOG_ERR, + LOG_WARNING, + LOG_NOTICE, + LOG_INFO, + LOG_DEBUG, as defined in syslog.h, see syslog3 for details. The third argument is a boolean: if true kernel-style log priority level prefixes (such as - SD_WARNING) are interpreted, see + SD_WARNING) are interpreted, see sd-daemon3 for more information. @@ -114,7 +114,7 @@ The sd_journal_stream_fd() interface is available as shared library, which can be compiled and linked to with the - libsystemd-journal + libsystemd-journal pkg-config1 file. diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index 9c8fdbccaf..9d9f4d0d76 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -151,7 +151,7 @@ sd-daemon.h files. These interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-daemon + libsystemd-daemon pkg-config1 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 261ef1d9d3..c7650e6ba3 100644 --- a/man/sd_login_monitor_new.xml +++ b/man/sd_login_monitor_new.xml @@ -112,7 +112,7 @@ logins) or machine (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, NULL 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 @@ sd_login_monitor_get_events() will return the poll() mask to wait for. This function will return a combination of - POLLIN, POLLOUT + POLLIN, POLLOUT and similar to fill into the - .events field of struct - pollfd. + .events field of struct + pollfd. sd_login_monitor_get_timeout() will return a timeout value for usage in poll(). This returns a value in - microseconds since the epoch of CLOCK_MONOTONIC for - timing out poll() in - timeout_usec. See + microseconds since the epoch of CLOCK_MONOTONIC + for timing out poll() in + timeout_usec. See clock_gettime2 for details about - CLOCK_MONOTONIC. If there's no + CLOCK_MONOTONIC. If there's no timeout to wait for this will fill in - (uint64_t) -1 instead. Note that + (uint64_t) -1 instead. Note that poll() 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 { } The code above does not do any error checking - for brevity's sake. The calculated msec + for brevity's sake. The calculated msec integer can be passed directly as poll()'s timeout parameter. @@ -206,13 +206,13 @@ else { sd_login_monitor_get_fd() returns a Unix file descriptor. On success sd_login_monitor_get_events() - returns a combination of POLLIN, - POLLOUT and suchlike. On failure, + returns a combination of POLLIN, + POLLOUT and suchlike. On failure, these calls return a negative errno-style error code. sd_login_monitor_unref() - always returns NULL. + always returns NULL. @@ -226,7 +226,7 @@ else { sd_login_monitor_get_timeout() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-login + libsystemd-login pkg-config1 file. diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 81f74aa843..52614a2071 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -217,7 +217,7 @@ Internally, these functions send a single datagram with the state string as payload to the - AF_UNIX socket referenced in the + AF_UNIX socket referenced in the $NOTIFY_SOCKET environment variable. If the first character of $NOTIFY_SOCKET is @ the string is @@ -238,7 +238,7 @@ sd-daemon.h files. These interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-daemon + libsystemd-daemon pkg-config1 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 543a5c0c72..b45c9a5526 100644 --- a/man/sd_pid_get_session.xml +++ b/man/sd_pid_get_session.xml @@ -146,7 +146,7 @@ free3 call after use. - If the pid parameter of any + If the pid parameter of any of these functions is passed as 0 the operation is executed for the calling process. @@ -169,7 +169,7 @@ sd_pid_get_machine_name() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-login + libsystemd-login pkg-config1 file. diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml index 07e018de13..3060ec7d52 100644 --- a/man/sd_seat_get_active.xml +++ b/man/sd_seat_get_active.xml @@ -101,18 +101,18 @@ sd_seat_get_sessions() may be used to determine all sessions on the specified - seat. Returns two arrays, one (NULL terminated) with + seat. Returns two arrays, one (NULL 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 + NULL in case these values need not to be determined. The arrays and the strings referenced by them need to be freed with the libc free3 call after use. Note that instead of an empty array - NULL may be returned and should be considered + NULL may be returned and should be considered equivalent to an empty array. sd_seat_can_multi_session() @@ -130,10 +130,11 @@ graphics functionality, i.e. is useful as a graphics display. - If the seat 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. + If the seat 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. @@ -162,7 +163,7 @@ sd_seat_can_grapical() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-login + libsystemd-login pkg-config1 file. diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml index 6fa803bfa2..0146fb427b 100644 --- a/man/sd_session_is_active.xml +++ b/man/sd_session_is_active.xml @@ -202,10 +202,11 @@ free3 call after use. - If the session 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. + If the session 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. @@ -240,7 +241,7 @@ sd_session_get_tty() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-login + libsystemd-login pkg-config1 file. diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml index cc8fc0f5b6..9a20b5453c 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 + NULL terminated string array of session identifiers in sessions which needs to be freed by the caller with the libc free3 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 + NULL 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 NULL may be returned and should be considered equivalent to an empty array. @@ -172,7 +172,7 @@ sd_uid_get_sessions(), and sd_uid_get_seats() interfaces are available as shared library, which can be compiled and - linked to with the libsystemd-login + linked to with the libsystemd-login pkg-config1 file. diff --git a/man/systemd-journald.service.xml b/man/systemd-journald.service.xml index 822f3c28f0..2860ae9769 100644 --- a/man/systemd-journald.service.xml +++ b/man/systemd-journald.service.xml @@ -87,8 +87,8 @@ the data. systemd-journald will - forward all received log messages to the AF_UNIX - SOCK_DGRAM socket + forward all received log messages to the AF_UNIX + SOCK_DGRAM socket /run/systemd/journal/syslog (if it exists) which may be used by UNIX syslog daemons to process the data further. diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 8d5948ab07..2ccc470e26 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -721,9 +721,9 @@ separated list of capability names as read by cap_from_name3, - e.g. CAP_SYS_ADMIN - CAP_DAC_OVERRIDE - CAP_SYS_PTRACE. + e.g. CAP_SYS_ADMIN, + CAP_DAC_OVERRIDE, + CAP_SYS_PTRACE. 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 + SIGSYS signal (whitelisting). If the first character of the list is ~ the effect is inverted: only the diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml index de01dc236b..fe65078f76 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 - journalctl - --new-id. + purpose with journalctl + . + @@ -474,8 +474,8 @@ describes the position of an entry in the journal and is portable across machines, - platforms and journal - files. + platforms and journal files. + @@ -483,16 +483,17 @@ __REALTIME_TIMESTAMP= 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 + (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 _SOURCE_REALTIME_TIMESTAMP= as it is usually a bit later - but more likely to be - monotonic. + but more likely to be monotonic. + @@ -500,15 +501,15 @@ __MONOTONIC_TIMESTAMP= The monotonic time - (CLOCK_MONOTONIC) at the point - in time the entry was received - by the journal in usec - formatted as decimal + (CLOCK_MONOTONIC) + 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 - _BOOT_ID=. + boot ID in _BOOT_ID=. + diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 040305c632..0d5652b834 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -150,19 +150,19 @@ ListenSequentialPacket= Specifies an address to listen on for a stream - (SOCK_STREAM), datagram (SOCK_DGRAM), + (SOCK_STREAM), datagram (SOCK_DGRAM), or sequential packet - (SOCK_SEQPACKET) socket, respectively. The address + (SOCK_SEQPACKET) socket, respectively. The address can be written in various formats: If the address starts with a slash (/), it is read as file system - socket in the AF_UNIX socket + socket in the AF_UNIX socket family. If the address starts with an at symbol (@) it is read as abstract - namespace socket in the AF_UNIX + namespace socket in the AF_UNIX family. The @ is replaced with a NUL character before binding. For details see @@ -193,13 +193,13 @@ setting (see below). - Note that SOCK_SEQPACKET + Note that SOCK_SEQPACKET (i.e. ListenSequentialPacket=) - is only available for AF_UNIX - sockets. SOCK_STREAM + is only available for AF_UNIX + sockets. SOCK_STREAM (i.e. ListenStream=) when used for IP sockets refers to TCP - sockets, SOCK_DGRAM + sockets, SOCK_DGRAM (i.e. ListenDatagram=) to UDP. @@ -258,7 +258,7 @@ 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 AF_NETLINK family name (such as audit or kobject-uevent) as argument, optionally suffixed by a @@ -382,7 +382,7 @@ to write new daemons only in a way that is suitable for . A - daemon listening on an AF_UNIX socket + daemon listening on an AF_UNIX socket may, but does not need to, call close2 on the received socket before @@ -584,7 +584,7 @@ PassCredentials= Takes a boolean value. This controls the SO_PASSCRED - socket option, which allows AF_UNIX sockets to + socket option, which allows AF_UNIX sockets to receive the credentials of the sending process in an ancillary message. Defaults to @@ -595,7 +595,7 @@ PassSecurity= Takes a boolean value. This controls the SO_PASSSEC - socket option, which allows AF_UNIX + socket option, which allows AF_UNIX 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 497dd2bfee..ef95641387 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -611,7 +611,7 @@ - SIGTERM + SIGTERM Upon receiving this signal the systemd system manager @@ -631,7 +631,7 @@ - SIGINT + SIGINT Upon receiving this signal the systemd system manager will @@ -647,7 +647,7 @@ - SIGWINCH + SIGWINCH When this signal is received the systemd system manager @@ -663,7 +663,7 @@ - SIGPWR + SIGPWR When this signal is received the systemd manager @@ -675,7 +675,7 @@ - SIGUSR1 + SIGUSR1 When this signal is received the systemd manager will try @@ -684,7 +684,7 @@ - SIGUSR2 + SIGUSR2 When this signal is received the systemd manager will log @@ -695,7 +695,7 @@ - SIGHUP + SIGHUP Reloads the complete daemon configuration. This is mostly @@ -704,7 +704,7 @@ - SIGRTMIN+0 + SIGRTMIN+0 Enters default mode, starts the default.target @@ -714,7 +714,7 @@ - SIGRTMIN+1 + SIGRTMIN+1 Enters rescue mode, starts the @@ -725,7 +725,7 @@ - SIGRTMIN+2 + SIGRTMIN+2 Enters emergency mode, starts the @@ -736,7 +736,7 @@ - SIGRTMIN+3 + SIGRTMIN+3 Halts the machine, starts the @@ -747,7 +747,7 @@ - SIGRTMIN+4 + SIGRTMIN+4 Powers off the machine, starts the @@ -758,7 +758,7 @@ - SIGRTMIN+5 + SIGRTMIN+5 Reboots the machine, starts the @@ -769,7 +769,7 @@ - SIGRTMIN+6 + SIGRTMIN+6 Reboots the machine via kexec, starts the @@ -780,31 +780,31 @@ - SIGRTMIN+13 + SIGRTMIN+13 Immediately halts the machine. - SIGRTMIN+14 + SIGRTMIN+14 Immediately powers off the machine. - SIGRTMIN+15 + SIGRTMIN+15 Immediately reboots the machine. - SIGRTMIN+16 + SIGRTMIN+16 Immediately reboots the machine with kexec. - SIGRTMIN+20 + SIGRTMIN+20 Enables display of status messages on the console, as @@ -815,7 +815,7 @@ - SIGRTMIN+21 + SIGRTMIN+21 Disables display of status messages on the console, as @@ -826,23 +826,23 @@ - SIGRTMIN+22 - SIGRTMIN+23 + SIGRTMIN+22 + SIGRTMIN+23 Sets the log level to debug (or info on - SIGRTMIN+23), as + SIGRTMIN+23), as controlled via systemd.log_level=debug (or systemd.log_level=info - on SIGRTMIN+23) on + on SIGRTMIN+23) on the kernel command line. - SIGRTMIN+24 + SIGRTMIN+24 Immediately exits the manager (only available for --user @@ -850,28 +850,28 @@ - SIGRTMIN+26 - SIGRTMIN+27 - SIGRTMIN+28 - SIGRTMIN+29 + SIGRTMIN+26 + SIGRTMIN+27 + SIGRTMIN+28 + SIGRTMIN+29 Sets the log level to journal-or-kmsg (or console on - SIGRTMIN+27, + SIGRTMIN+27, kmsg on - SIGRTMIN+28, + SIGRTMIN+28, or syslog-or-kmsg - on SIGRTMIN+29), as + on SIGRTMIN+29), as controlled via systemd.log_target=journal-or-kmsg (or systemd.log_target=console - on SIGRTMIN+27, + on SIGRTMIN+27, systemd.log_target=kmsg - on SIGRTMIN+28, + on SIGRTMIN+28, or systemd.log_target=syslog-or-kmsg - on SIGRTMIN+29) on + on SIGRTMIN+29) on the kernel command line. @@ -1044,7 +1044,7 @@ argument. If positive systemd activates the specified virtual terminal when it crashes. Defaults to - -1. + -1. @@ -1223,7 +1223,7 @@ Daemon status notification socket. This is an - AF_UNIX datagram socket and is used to + AF_UNIX datagram socket and is used to implement the daemon notification logic as implemented by sd_notify3. @@ -1236,7 +1236,7 @@ Used internally by the shutdown8 tool to implement delayed - shutdowns. This is an AF_UNIX datagram + shutdowns. This is an AF_UNIX datagram socket. @@ -1247,7 +1247,7 @@ communication channel between systemctl1 and the systemd process. This is an - AF_UNIX stream socket. This interface + AF_UNIX stream socket. This interface is private to systemd and should not be used in external projects.