diff options
Diffstat (limited to 'man')
48 files changed, 338 insertions, 341 deletions
diff --git a/man/binfmt.d.xml b/man/binfmt.d.xml index 762d1fc66e..7f31b76de9 100644 --- a/man/binfmt.d.xml +++ b/man/binfmt.d.xml @@ -94,11 +94,11 @@ with an alphabetically later name.</para> <para>If the administrator wants to disable a - configuration file supplied by the vendor the + configuration file supplied by the vendor, the recommended way is to place a symlink to <filename>/dev/null</filename> in <filename>/etc/binfmt.d/</filename> bearing the - same file name.</para> + same filename.</para> </refsect1> <refsect1> diff --git a/man/hostname.xml b/man/hostname.xml index f89332e983..5971ad4345 100644 --- a/man/hostname.xml +++ b/man/hostname.xml @@ -44,7 +44,7 @@ <refnamediv> <refname>hostname</refname> - <refpurpose>Local host name configuration file</refpurpose> + <refpurpose>Local hostname configuration file</refpurpose> </refnamediv> <refsynopsisdiv> @@ -59,17 +59,17 @@ during boot, with the <citerefentry><refentrytitle>sethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call. It should contain a single - newline-terminated host name string. The - host name may be a free-form string up to 64 characters - in length, however it is recommended that it consists - only of 7bit ASCII lower-case characters and no spaces or dots, + newline-terminated hostname string. The + hostname may be a free-form string up to 64 characters + in length; however, it is recommended that it consists + only of 7-bit ASCII lower-case characters and no spaces or dots, and limits itself to the format allowed for DNS domain name labels, even though this is not a strict requirement.</para> - <para>Depending on the operating system other + <para>Depending on the operating system, other configuration files might be checked for configuration - of the host name as well, however only as fallback.</para> + of the hostname as well, however only as fallback.</para> <para>You may use <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml index 801ab3a7bf..d7a9e92879 100644 --- a/man/hostnamectl.xml +++ b/man/hostnamectl.xml @@ -60,9 +60,9 @@ query and change the system hostname and related settings.</para> - <para>This tool distinguishes three different host - names: the high-level "pretty" hostname which might - include all kinds of special characters + <para>This tool distinguishes three different + hostnames: the high-level "pretty" hostname which + might include all kinds of special characters (e.g. "Lennart's Laptop"), the static hostname which is used to initialize the kernel hostname at boot (e.g. "lennarts-laptop"), and the transient hostname @@ -77,10 +77,10 @@ and transient hostnames are limited to the usually accepted characters of internet domain names.</para> - <para>The static host name is stored in + <para>The static hostname is stored in <filename>/etc/hostname</filename>, see <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry> - for more information. The pretty host name, chassis + for more information. The pretty hostname, chassis type and icon name are stored in <filename>/etc/machine-info</filename>, see <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> @@ -143,8 +143,8 @@ <listitem><para>If <command>set-hostname</command> is invoked and one or more of these - options are passed only the selected - hostnames is + options are passed, only the selected + hostname(s) is/are updated.</para></listitem> </varlistentry> </variablelist> @@ -164,34 +164,34 @@ <term><command>set-hostname [NAME]</command></term> <listitem><para>Set the system - hostname. By default this will alter + hostname. By default, this will alter the pretty, the static, and the - transient hostname alike, however if + transient hostname alike; however, if one or more of <option>--static</option>, <option>--transient</option>, - <option>--pretty</option> are used + <option>--pretty</option> are used, only the selected hostnames are changed. If the pretty hostname is being set, and static or transient are - being set as well the specified host - name will be simplified in regards to - the character set used before the + being set as well, the specified + hostname will be simplified in regards + to the character set used before the latter are updated. This is done by - replacing spaces by "-" and removing + replacing spaces with "-" and removing special characters. This ensures that - the pretty and the static hostname - are always closely related while still + the pretty and the static hostname are + always closely related while still following the validity rules of the specific name. This simplification of the hostname string is not done if - only the transient and/or static host - names are set, and the pretty host - name is left untouched. Pass the empty - string "" as hostname to reset the - selected hostnames to their default - (usually - "localhost").</para></listitem> + only the transient and/or static + hostnames are set, and the pretty + hostname is left untouched. Pass the + empty string "" as the hostname to + reset the selected hostnames to their + default (usually "localhost"). + </para></listitem> </varlistentry> <varlistentry> @@ -206,7 +206,7 @@ Naming Specification</ulink>. Pass an empty string to this operation to reset the icon name to the default - value which is determined from chassis + value, which is determined from chassis type (see below) and possibly other parameters.</para></listitem> </varlistentry> diff --git a/man/kernel-install.xml b/man/kernel-install.xml index 8c2abc747c..d21d7579bf 100644 --- a/man/kernel-install.xml +++ b/man/kernel-install.xml @@ -67,7 +67,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. located in the directory <filename>/usr/lib/kernel/install.d/</filename> and the local administration directory <filename>/etc/kernel/install.d/</filename>. All files are collectively sorted and executed in lexical order, regardless of the directory in - which they live. However, files with identical file names replace each other. + which they live. However, files with identical filenames replace each other. Files in <filename>/etc/kernel/install.d/</filename> take precedence over files with the same name in <filename>/usr/lib/kernel/install.d/</filename>. This can be used to override a system-supplied executables with a local file if needed; a symbolic link in <filename>/etc/kernel/install.d/</filename> diff --git a/man/localtime.xml b/man/localtime.xml index d3da4ed277..b95c2ee6be 100644 --- a/man/localtime.xml +++ b/man/localtime.xml @@ -51,7 +51,7 @@ <refnamediv> <refname>localtime</refname> - <refpurpose>Local time zone configuration file</refpurpose> + <refpurpose>Local timezone configuration file</refpurpose> </refnamediv> <refsynopsisdiv> @@ -62,24 +62,24 @@ <title>Description</title> <para>The <filename>/etc/localtime</filename> file - configures the system-wide time zone of the local + configures the system-wide timezone of the local system that is used by applications for presentation to the user. It should be an absolute or relative symbolic link pointing to <filename>/usr/share/zoneinfo/</filename>, followed by - a time zone identifier such as + a timezone identifier such as <literal>Europe/Berlin</literal> or <literal>Etc/UTC</literal>. The resulting link should lead to the corresponding binary <citerefentry><refentrytitle>tzfile</refentrytitle><manvolnum>5</manvolnum></citerefentry> - time zone data for the configured time zone.</para> + timezone data for the configured timezone.</para> - <para>As the time zone identifier is extracted from + <para>As the timezone identifier is extracted from the symlink target name of <filename>/etc/localtime</filename> this file may not be a normal file or hardlink.</para> - <para>The time zone may be overridden for individual + <para>The timezone may be overridden for individual programs by using the TZ environment variable. See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> diff --git a/man/loginctl.xml b/man/loginctl.xml index e76ee95902..f10ca030c9 100644 --- a/man/loginctl.xml +++ b/man/loginctl.xml @@ -144,7 +144,7 @@ <option>all</option> to select whether to kill only the leader process of the session or all processes of the - session. If omitted defaults to + session. If omitted, defaults to <option>all</option>.</para></listitem> </varlistentry> @@ -157,8 +157,8 @@ <command>kill-user</command>, choose which signal to send to selected processes. Must be one of the well - known signal specifiers such as - SIGTERM, SIGINT or SIGSTOP. If omitted + known signal specifiers, such as + SIGTERM, SIGINT or SIGSTOP. If omitted, defaults to <option>SIGTERM</option>.</para></listitem> </varlistentry> @@ -308,10 +308,10 @@ <listitem><para>Show properties of one or more users or the manager - itself. If no argument is specified + itself. If no argument is specified, properties of the manager will be - shown. If a user is specified - properties of the user is shown. By + shown. If a user is specified, + properties of the user are shown. By default, empty properties are suppressed. Use <option>--all</option> to show those too. To select specific @@ -332,9 +332,9 @@ <listitem><para>Enable/disable user lingering for one or more users. If - enabled for a specific user a user + enabled for a specific user, a user manager is spawned for him/her at - boot, and kept around after + boot and kept around after logouts. This allows users who aren't logged in to run long-running services.</para></listitem> @@ -386,14 +386,14 @@ <listitem><para>Show properties of one or more seats or the manager - itself. If no argument is specified + itself. If no argument is specified, properties of the manager will be - shown. If a seat is specified + shown. If a seat is specified, properties of the seat are shown. By default, empty properties are suppressed. Use <option>--all</option> to show those too. To select specific - properties to show use + properties to show, use <option>--property=</option>. This command is intended to be used whenever computer-parsable output is @@ -411,13 +411,13 @@ one or more devices to a seat. The devices should be specified via device paths in the <filename>/sys</filename> - file system. To create a new seat + file system. To create a new seat, attach at least one graphics card to a previously unused seat name. Seat names may consist only of a-z, A-Z, 0-9, "-" and "_" and must be prefixed with "seat". To drop assignment of a - device to a specific seat just + device to a specific seat, just reassign it to a different seat, or use <command>flush-devices</command>.</para></listitem> @@ -429,8 +429,8 @@ <listitem><para>Removes all device assignments previously created with <command>attach</command>. After this - call only automatically generated - seats will remain and all seat + call, only automatically generated + seats will remain, and all seat hardware is assigned to them.</para></listitem> </varlistentry> diff --git a/man/logind.conf.xml b/man/logind.conf.xml index 47ee0e73ff..b7109353ca 100644 --- a/man/logind.conf.xml +++ b/man/logind.conf.xml @@ -184,10 +184,10 @@ <term><varname>KillExcludeUsers=</varname></term> <listitem><para>These settings take - space separated lists of user names + space-separated lists of usernames that influence the effect of <varname>KillUserProcesses=</varname>. If - not empty only processes of users + not empty, only processes of users listed in <varname>KillOnlyUsers</varname> will be killed when they log out @@ -210,12 +210,12 @@ users logging in are added to, in addition to the <literal>name=systemd</literal> named - hierarchy. These settings take space - separated lists of controller + hierarchy. These settings take + space-separated lists of controller names. Pass the empty string to ensure that logind does not touch any hierarchies but systemd's own. When - logging in user sessions will get + logging in, user sessions will get private control groups in all hierarchies listed in <varname>Controllers=</varname> and be @@ -228,8 +228,8 @@ <literal>cpu</literal>. Note that for all controllers that are not listed in either <varname>Controllers=</varname> - nor - <varname>ResetControllers=</varname> + or + <varname>ResetControllers=</varname>, newly created sessions will be part of the control groups of the system service that created the @@ -269,11 +269,11 @@ <literal>hibernate</literal>, <literal>hybrid-sleep</literal> and <literal>lock</literal>. If - <literal>ignore</literal> logind will + <literal>ignore</literal>, logind will never handle these keys. If - <literal>lock</literal> all running - sessions will be screen - locked. Otherwise the specified action + <literal>lock</literal>, all running + sessions will be screen-locked; otherwise, + the specified action will be taken in the respective event. Only input devices with the <literal>power-switch</literal> udev @@ -301,10 +301,10 @@ sleep keys and the lid switch are subject to inhibitor locks. These settings take boolean arguments. If - <literal>off</literal> the inhibitor + <literal>off</literal>, the inhibitor locks taken by applications in order to block the requested operation are - respected, if <literal>on</literal> + respected, if <literal>on</literal>, the requested operation is executed in any case. <varname>PowerKeyIgnoreInhibited=</varname>, diff --git a/man/machine-id.xml b/man/machine-id.xml index 1e558a6178..d7a56cb548 100644 --- a/man/machine-id.xml +++ b/man/machine-id.xml @@ -55,12 +55,12 @@ <title>Description</title> <para>The <filename>/etc/machine-id</filename> file - contains the unique machine id of the local system + contains the unique machine ID of the local system that is set during installation. The machine ID is a - single newline-terminated, hexadecimal, lowercase 32 - character machine ID string. (When decoded from - hexadecimal this corresponds with a 16 byte/128 bit - string.)</para> + single newline-terminated, hexadecimal, 32-character, + lowercase machine ID string. When decoded from + hexadecimal, this corresponds with a 16-byte/128-bit + string.</para> <para>The machine ID is usually generated from a random source during system installation and stays @@ -69,7 +69,7 @@ boot if it is found to be empty.</para> <para>The machine ID does not change based on user - configuration, or when hardware is replaced.</para> + configuration or when hardware is replaced.</para> <para>This machine ID adheres to the same format and logic as the D-Bus machine ID.</para> @@ -77,10 +77,10 @@ <para>Programs may use this ID to identify the host with a globally unique ID in the network, which does not change even if the local network configuration - changes. Due to this and its greater length it is + changes. Due to this and its greater length, it is a more useful replacement for the <citerefentry><refentrytitle>gethostid</refentrytitle><manvolnum>3</manvolnum></citerefentry> - call POSIX specifies.</para> + call that POSIX specifies.</para> <para>The <citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry> @@ -94,8 +94,8 @@ <para>Note that the machine ID historically is not an OSF UUID as defined by <ulink url="http://tools.ietf.org/html/rfc4122">RFC - 4122</ulink>, nor a Microsoft GUID. Starting with - systemd v30 newly generated machine IDs however do + 4122</ulink>, nor a Microsoft GUID; however, starting with + systemd v30, newly generated machine IDs do qualify as v4 UUIDs.</para> <para>In order to maintain compatibility with existing diff --git a/man/machine-info.xml b/man/machine-info.xml index 1c3a21c643..7f396aafde 100644 --- a/man/machine-info.xml +++ b/man/machine-info.xml @@ -101,12 +101,12 @@ present to the user and does not suffer by the syntax limitations of internet domain names. If possible the - internet host name as configured in + internet hostname as configured in <filename>/etc/hostname</filename> should be kept similar to this one. Example: if this value is <literal>Lennart's Computer</literal> - an Internet host name of + an Internet hostname of <literal>lennarts-computer</literal> might be a good choice. If this parameter is not set an application diff --git a/man/modules-load.d.xml b/man/modules-load.d.xml index ce94bef7a7..0d104c563d 100644 --- a/man/modules-load.d.xml +++ b/man/modules-load.d.xml @@ -94,7 +94,7 @@ recommended way is to place a symlink to <filename>/dev/null</filename> in <filename>/etc/modules-load.d/</filename> bearing the - same file name.</para> + same filename.</para> </refsect1> <refsect1> diff --git a/man/nss-myhostname.xml b/man/nss-myhostname.xml index c0e2b828be..efbadac33f 100644 --- a/man/nss-myhostname.xml +++ b/man/nss-myhostname.xml @@ -45,7 +45,7 @@ <refnamediv> <refname>nss-myhostname</refname> - <refpurpose>Provide host name resolution for the locally + <refpurpose>Provide hostname resolution for the locally configured system hostname.</refpurpose> </refnamediv> @@ -58,17 +58,17 @@ <para><command>nss-myhostname</command> is a plugin for the GNU Name Service Switch (NSS) functionality of the GNU C Library (<command>glibc</command>) - providing host name resolution for the locally configured system + providing hostname resolution for the locally configured system hostname as returned by <citerefentry><refentrytitle>gethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry>. - Various software relies on an always resolvable local host name. When - using dynamic hostnames this is usually achieved by patching + Various software relies on an always-resolvable local hostname. When + using dynamic hostnames, this is usually achieved by patching <filename>/etc/hosts</filename> at the same time as changing the host name. This however is not ideal since it requires a writable <filename>/etc</filename> file system and is fragile because the file might be edited by the administrator at the same time. <command>nss-myhostname</command> - simply returns all locally configure public IP addresses, or -- if none - are configured -- the IPv4 address 127.0.0.2 (which is on the local + simply returns all locally configured public IP addresses, or, if none + are configured, the IPv4 address 127.0.0.2 (which is on the local loopback) and the IPv6 address ::1 (which is the local host) for whatever system hostname is configured locally. Patching <filename>/etc/hosts</filename> is thus no longer necessary.</para> @@ -116,7 +116,7 @@ $ getent ahosts `hostname` 127.0.0.2 RAW </programlisting> - <para>In this case the local host name is <varname>omega</varname>.</para> + <para>In this case the local hostname is <varname>omega</varname>.</para> </refsect1> diff --git a/man/os-release.xml b/man/os-release.xml index 45babd61b9..d714b51fba 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -142,7 +142,7 @@ identifying the operating system, excluding any version information and suitable for processing by scripts or - usage in generated file names. If not + usage in generated filenames. If not set defaults to <literal>ID=linux</literal>. Example: <literal>ID=fedora</literal> or @@ -199,7 +199,7 @@ system version, excluding any OS name information or release code name, and suitable for processing by scripts or - usage in generated file names. This + usage in generated filenames. This field is optional. Example: <literal>VERSION_ID=17</literal> or <literal>VERSION_ID=11.04</literal>.</para></listitem> diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index 0354811976..4e5cdf248b 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -131,13 +131,13 @@ <varlistentry> <term><option>kill-only-users=</option></term> - <listitem><para>Takes a comma - separated list of user names or - numeric user ids as argument. If this - option is used the effect of the + <listitem><para>Takes a comma-separated + list of usernames or + numeric user IDs as argument. If this + option is used, the effect of the <option>kill-session-processes=</option> options will apply only to the listed - users. If this option is not used the + users. If this option is not used, the option applies to all local users. Note that <option>kill-exclude-users=</option> @@ -149,13 +149,13 @@ <varlistentry> <term><option>kill-exclude-users=</option></term> - <listitem><para>Takes a comma - separated list of user names or - numeric user ids as argument. Users + <listitem><para>Takes a comma-separated + list of usernames or + numeric user IDs as argument. Users listed in this argument will not be subject to the effect of - <option>kill-session-processes=</option>. Note - that this option takes precedence + <option>kill-session-processes=</option>. + Note that this option takes precedence over <option>kill-only-users=</option>, and hence whatever is listed for @@ -169,8 +169,8 @@ <varlistentry> <term><option>controllers=</option></term> - <listitem><para>Takes a comma - separated list of control group + <listitem><para>Takes a comma-separated + list of control group controllers in which hierarchies a user/session control group will be created by default for each user @@ -183,8 +183,8 @@ <varlistentry> <term><option>reset-controllers=</option></term> - <listitem><para>Takes a comma - separated list of control group + <listitem><para>Takes a comma-separated + list of control group controllers in which hierarchies the logged in processes will be reset to the root control @@ -222,7 +222,7 @@ configured system-wide in <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The former kills processes of a session as soon as it - ends, the latter kills processes as soon as the last + ends; the latter kills processes as soon as the last session of the user ends.</para> <para>If the options are omitted they default to @@ -250,7 +250,7 @@ <term><varname>$XDG_SESSION_ID</varname></term> <listitem><para>A session identifier, - suitable to be used in file names. The + suitable to be used in filenames. The string itself should be considered opaque, although often it is just the audit session ID as reported by @@ -281,7 +281,7 @@ applications should not rely on this behavior and must be able to deal with stale files. To store session-private - data in this directory the user should + data in this directory, the user should include the value of <varname>$XDG_SESSION_ID</varname> in the filename. This directory shall be used for runtime file system diff --git a/man/sd-id128.xml b/man/sd-id128.xml index c194f57458..02fb76b56d 100644 --- a/man/sd-id128.xml +++ b/man/sd-id128.xml @@ -50,7 +50,7 @@ <refname>SD_ID128_FORMAT_STR</refname> <refname>SD_ID128_FORMAT_VAL</refname> <refname>sd_id128_equal</refname> - <refpurpose>APIs for processing 128 bit IDs</refpurpose> + <refpurpose>APIs for processing 128-bit IDs</refpurpose> </refnamediv> <refsynopsisdiv> @@ -68,12 +68,12 @@ <title>Description</title> <para><filename>sd-id128.h</filename> provides APIs to - process and generate 128 bit ID values. The 128 bit ID + process and generate 128-bit ID values. The 128-bit ID values processed and generated by these APIs are a generalization of OSF UUIDs as defined by <ulink url="http://tools.ietf.org/html/rfc4122">RFC - 4122</ulink>, though use a simpler string - formatting. These functions impose no structure on the + 4122</ulink> but use a simpler string + format. These functions impose no structure on the used IDs, much unlike OSF UUIDs or Microsoft GUIDs, but are fully compatible with those types of IDs. </para> @@ -85,7 +85,7 @@ for more information about the implemented functions.</para> - <para>A 128 bit ID is implemented as the following + <para>A 128-bit ID is implemented as the following union type:</para> <programlisting>typedef union sd_id128 { @@ -93,26 +93,26 @@ uint64_t qwords[2]; } sd_id128_t;</programlisting> - <para>This union type allows accessing the 128 bit ID - as 16 separate bytes or two 64 bit words. It is generally - safer to access the ID components by their 8 bit array + <para>This union type allows accessing the 128-bit ID + as 16 separate bytes or two 64-bit words. It is generally + safer to access the ID components by their 8-bit array to avoid endianness issues. This union is intended to be passed call-by-value (as opposed to call-by-reference) and may be directly manipulated by clients.</para> <para>A couple of macros are defined to denote and - decode 128 bit IDs:</para> + decode 128-bit IDs:</para> <para><function>SD_ID128_MAKE()</function> may be used - to denote a constant 128 bit ID in source code. A - commonly used idiom is to assign a name to a 128 bit + to denote a constant 128-bit ID in source code. A + commonly used idiom is to assign a name to a 128-bit ID using this macro:</para> <programlisting>#define SD_MESSAGE_COREDUMP SD_ID128_MAKE(fc,2e,22,bc,6e,e6,47,b6,b9,07,29,ab,34,a2,50,b1)</programlisting> <para><function>SD_ID128_CONST_STR()</function> may be - used to convert constant 128bit IDs into constant + used to convert constant 128-bit IDs into constant strings for output. The following example code will output the string "fc2e22bc6ee647b6b90729ab34a250b1":</para> @@ -122,7 +122,7 @@ <para><function>SD_ID128_FORMAT_STR</function> and <function>SD_ID128_FORMAT_VAL()</function> may be used - to format a 128 bit ID in a + to format a 128-bit ID in a <citerefentry><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry> format string, as shown in the following example:</para> @@ -134,7 +134,7 @@ return 0; }</programlisting> - <para>Use <function>sd_id128_equal()</function> to compare two 128 bit IDs:</para> + <para>Use <function>sd_id128_equal()</function> to compare two 128-bit IDs:</para> <programlisting>int main(int argc, char *argv[]) { sd_id128_t a, b, c; diff --git a/man/sd_id128_get_machine.xml b/man/sd_id128_get_machine.xml index 12887a240a..6bee7ad9c1 100644 --- a/man/sd_id128_get_machine.xml +++ b/man/sd_id128_get_machine.xml @@ -45,7 +45,7 @@ <refnamediv> <refname>sd_id128_get_machine</refname> <refname>sd_id128_get_boot</refname> - <refpurpose>Retrieve 128 bit IDs</refpurpose> + <refpurpose>Retrieve 128-bit IDs</refpurpose> </refnamediv> <refsynopsisdiv> @@ -92,10 +92,10 @@ <function>sd_id128_get_boot()</function> always returns a UUID v4 compatible ID. <function>sd_id128_get_machine()</function> will - also return a UUID v4 compatible ID on new - installations, but might not on older. It is possible - to convert the machine ID into an UUID v4 compatible - one. For more information see + also return a UUID v4-compatible ID on new + installations but might not on older. It is possible + to convert the machine ID into a UUID v4-compatible + one. For more information, see <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> <para>For more information about the diff --git a/man/sd_id128_randomize.xml b/man/sd_id128_randomize.xml index 15e17619d0..0b9580308a 100644 --- a/man/sd_id128_randomize.xml +++ b/man/sd_id128_randomize.xml @@ -44,7 +44,7 @@ <refnamediv> <refname>sd_id128_randomize</refname> - <refpurpose>Generate 128 bit IDs</refpurpose> + <refpurpose>Generate 128-bit IDs</refpurpose> </refnamediv> <refsynopsisdiv> @@ -63,7 +63,7 @@ <title>Description</title> <para><function>sd_id128_randomize()</function> - generates a new randomized 128 bit ID and returns it + generates a new randomized 128-bit ID and returns it in <parameter>ret</parameter>. Every invocation returns a new randomly generated ID. This uses the <filename>/dev/urandom</filename> kernel random number @@ -71,16 +71,15 @@ <para>Note that <function>sd_id128_randomize()</function> always returns - a UUID v4 compatible - ID.</para> + a UUID v4-compatible ID.</para> <para>For more information about the - <literal>sd_id128_t</literal> type see + <literal>sd_id128_t</literal> type, see <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> <para><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s - <option>--new-id</option> option may be used as - command line front-end for + <option>--new-id</option> option may be used as a + command-line front-end for <function>sd_id128_randomize()</function>.</para> </refsect1> diff --git a/man/sd_id128_to_string.xml b/man/sd_id128_to_string.xml index 6d5cf45f90..3da5b70f80 100644 --- a/man/sd_id128_to_string.xml +++ b/man/sd_id128_to_string.xml @@ -45,7 +45,7 @@ <refnamediv> <refname>sd_id128_to_string</refname> <refname>sd_id128_from_string</refname> - <refpurpose>Format or parse 128 bit IDs as strings</refpurpose> + <refpurpose>Format or parse 128-bit IDs as strings</refpurpose> </refnamediv> <refsynopsisdiv> @@ -69,7 +69,7 @@ <title>Description</title> <para><function>sd_id128_to_string()</function> - formats a 128 bit ID as character string. It expects + formats a 128-bit ID as a character string. It expects the ID and a string array capable of storing 33 characters. The ID will be formatted as 32 lowercase hexadecimal digits and be terminated by a NUL @@ -78,10 +78,10 @@ <para><function>sd_id128_from_string()</function> implements the reverse operation: it takes a 33 character string with 32 hexadecimal digits - (either lowercase or uppercase, terminated by NUL) and parses them back into an 128 - bit ID returned in + (either lowercase or uppercase, terminated by NUL) and + parses them back into a 128-bit ID returned in <parameter>ret</parameter>. Alternatively, this call - can also parse a 37 character string with a 128bit ID + can also parse a 37-character string with a 128-bit ID formatted as RFC UUID.</para> <para>For more information about the @@ -89,9 +89,9 @@ <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>. Note that these calls operate the same way on all architectures, i.e. the results do not depend on - endianess.</para> + endianness.</para> - <para>When formatting a 128 bit ID into a string it is + <para>When formatting a 128-bit ID into a string, it is often easier to use a format string for <citerefentry><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry>. This is easily done using the @@ -106,9 +106,9 @@ <para><function>sd_id128_to_string()</function> always succeeds and returns a pointer to the string array - passed in. <function>sd_id128_from_string</function> - returns 0 on success (in which case - <parameter>ret</parameter> is filled in), or a negative + passed in. <function>sd_id128_from_string</function> + returns 0 on success, in which case + <parameter>ret</parameter> is filled in, or a negative errno-style error code.</para> </refsect1> diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index 44b41abf86..c136b37d8f 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -109,14 +109,14 @@ called to check whether the specified file descriptor refers to a socket. If the <parameter>family</parameter> parameter is not - <constant>AF_UNSPEC</constant> it is checked whether + <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 + <parameter>type</parameter> parameter is not 0, it is checked whether the socket is of the specified type (<constant>SOCK_STREAM</constant>, <constant>SOCK_DGRAM</constant>, ...). If the - <parameter>listening</parameter> parameter is positive + <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 it. If <parameter>listening</parameter> is 0, it is @@ -135,14 +135,14 @@ <constant>AF_INET6</constant>.</para> <para><function>sd_is_socket_unix()</function> is - similar to <function>sd_is_socket()</function>, but + similar to <function>sd_is_socket()</function> but optionally checks the <constant>AF_UNIX</constant> path the socket is bound to, unless the <parameter>path</parameter> parameter - 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 + 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 - address, including the initial 0 byte and set + address, including the initial 0 byte, and set the <parameter>path</parameter> to the initial 0 byte of the socket address.</para> @@ -170,7 +170,7 @@ <para>These functions are provided by the reference implementation of APIs for new-style daemons and distributed with the systemd package. The algorithms - they implement are simple, and can easily be + they implement are simple, and they can easily be reimplemented in daemons if it is important to support this interface without using the reference implementation.</para> @@ -180,7 +180,7 @@ <filename>getsockname()</filename> to check the file descriptor type and where it is bound to.</para> - <para>For details about the algorithms check the + <para>For details about the algorithms, check the liberally licensed reference implementation sources: <ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/libsystemd-daemon/sd-daemon.c"/> and <ulink diff --git a/man/sd_journal_get_cutoff_realtime_usec.xml b/man/sd_journal_get_cutoff_realtime_usec.xml index d987011a8b..9bf8220d11 100644 --- a/man/sd_journal_get_cutoff_realtime_usec.xml +++ b/man/sd_journal_get_cutoff_realtime_usec.xml @@ -77,7 +77,7 @@ gets the realtime (wallclock) timestamps of the first and last entries accessible in the journal. It takes three arguments: the journal context object and two - pointers to 64 Bit unsigned integers to store the + pointers to 64-bit unsigned integers to store the timestamps in. The timestamps are in microseconds since the epoch, i.e. <constant>CLOCK_REALTIME</constant>. Either one @@ -88,8 +88,8 @@ <para><function>sd_journal_get_cutoff_monotonic_usec()</function> gets the monotonic timestamps of the first and last entries accessible in the journal. It takes three - arguments: the journal context object, a 128 Bit - identifier for the boot, and two pointers to 64 Bit + arguments: the journal context object, a 128-bit + 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, diff --git a/man/sd_journal_get_realtime_usec.xml b/man/sd_journal_get_realtime_usec.xml index e7e4e4e4d1..8870c29e30 100644 --- a/man/sd_journal_get_realtime_usec.xml +++ b/man/sd_journal_get_realtime_usec.xml @@ -73,27 +73,27 @@ <para><function>sd_journal_get_realtime_usec()</function> gets the realtime (wallclock) timestamp of the - current journal entry. It takes two arguments: the - journal context object and a pointer to a 64 Bit + current journal entry. It takes two arguments: the + 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. <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 - in. The timestamp is in microseconds since boot-up of + 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. + The timestamp is in microseconds since boot-up of the specific boot, i.e. <constant>CLOCK_MONOTONIC</constant>. Since the - monotonic clock begins new with every reboot it only + 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 + 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 <constant>NULL</constant> the function will + passed <constant>NULL</constant>, the function will fail if the monotonic timestamp of the current entry is not of the current system boot.</para> diff --git a/man/sd_journal_print.xml b/man/sd_journal_print.xml index 81900dbdfb..1437342a55 100644 --- a/man/sd_journal_print.xml +++ b/man/sd_journal_print.xml @@ -202,7 +202,7 @@ sd_journal_send("MESSAGE=Hello World, this is PID %lu!", (unsigned long) getpid( chronological ordering between the two streams cannot be guaranteed. Using <function>sd_journal_print()</function> has the - benefit of logging source code line, file names, and + benefit of logging source code line, filenames, and functions as meta data along all entries, and guaranteeing chronological ordering with structured log entries that are generated via diff --git a/man/sd_journal_stream_fd.xml b/man/sd_journal_stream_fd.xml index 3577526f20..4bd0abc3b4 100644 --- a/man/sd_journal_stream_fd.xml +++ b/man/sd_journal_stream_fd.xml @@ -67,7 +67,7 @@ <para><function>sd_journal_stream_fd()</function> may be used to create a log stream file descriptor. Log messages written to this file descriptor as simple - newline separated text strings are written to the + newline-separated text strings are written to the journal. This file descriptor can be used internally by applications or be made STDOUT/STDERR of other processes executed.</para> diff --git a/man/sysctl.d.xml b/man/sysctl.d.xml index 759b8740f5..69e96ee9e5 100644 --- a/man/sysctl.d.xml +++ b/man/sysctl.d.xml @@ -96,11 +96,11 @@ contain the same variable setting.</para> <para>If the administrator wants to disable a - configuration file supplied by the vendor the + configuration file supplied by the vendor, the recommended way is to place a symlink to <filename>/dev/null</filename> in <filename>/etc/sysctl.d/</filename> bearing the - same file name.</para> + same filename.</para> </refsect1> <refsect1> diff --git a/man/systemctl.xml b/man/systemctl.xml index 9ab5c8ba5f..84a149c3d0 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -92,7 +92,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <term><option>--type=</option></term> <listitem> - <para>The argument should be a comma separated list of unit + <para>The argument should be a comma-separated list of unit types such as <option>service</option> and <option>socket</option>, or unit load states such as <option>loaded</option> and <option>masked</option> @@ -732,7 +732,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service names such as <literal>cpu.shares</literal>. This will output the current values of the specified attributes, separated by new-lines. For attributes that take list of - items the output will be new-line separated, too. This + items the output will be new-line-separated, too. This operation will always try to retrieve the data in question from the kernel first, and if that is not available use the configured values instead. Instead of low-level control diff --git a/man/systemd-analyze.xml b/man/systemd-analyze.xml index cecf1bf4d3..f5a9424248 100644 --- a/man/systemd-analyze.xml +++ b/man/systemd-analyze.xml @@ -95,7 +95,7 @@ prints the time spent in the kernel before userspace has been reached, the time spent in the initial RAM disk (initrd) before normal system - userspace has been reached and the time normal system + userspace has been reached, and the time normal system userspace took to initialize. Note that these measurements simply measure the time passed up to the point where all system services have been spawned, but @@ -111,7 +111,7 @@ of another service to complete.</para> <para><command>systemd-analyze critical-chain [<replaceable>UNIT...</replaceable>]</command> - prints a tree of the time critical chain of units + prints a tree of the time-critical chain of units (for each of the specified <replaceable>UNIT</replaceable>s or for the default target otherwise). The time after the unit is active or started is printed @@ -135,7 +135,7 @@ dot | dot -Tsvg > systemd.svg</command> to generate a graphical dependency tree. Unless <option>--order</option> or <option>--require</option> - is passed the generated graph will show both ordering + is passed, the generated graph will show both ordering and requirement dependencies. Optional pattern globbing style specifications (e.g. <filename>*.target</filename>) may be given at @@ -143,7 +143,7 @@ any of these patterns match either the origin or destination node.</para> - <para>If no command is passed <command>systemd-analyze + <para>If no command is passed, <command>systemd-analyze time</command> is implied.</para> </refsect1> @@ -191,7 +191,7 @@ <varname>RequisiteOverridable=</varname>, <varname>Wants=</varname> and <varname>Conflicts=</varname> are - shown. If neither is passed, shows + shown. If neither is passed, this shows dependencies of all these types.</para></listitem> </varlistentry> @@ -203,16 +203,16 @@ <listitem><para>When used in conjunction with the <command>dot</command> command (see - above), selects which relationships + above), this selects which relationships are shown in the dependency graph. They both require <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry> patterns as arguments, which are - matched against lefthand and - righthand, respectively, nodes of a + matched against left-hand and + right-hand, respectively, nodes of a relationship. Each of these can be - used more than once which means a - unit name must match one of given + used more than once, which means a + unit name must match one of the given values.</para></listitem> </varlistentry> @@ -226,7 +226,7 @@ latest unit in the same level. The unit of <replaceable>timespan</replaceable> is seconds unless specified with a different unit, - i.e. "50ms".</para></listitem> + e.g. "50ms".</para></listitem> </varlistentry> </variablelist> diff --git a/man/systemd-hostnamed.service.xml b/man/systemd-hostnamed.service.xml index fe64a62fbe..bdd3a51cc9 100644 --- a/man/systemd-hostnamed.service.xml +++ b/man/systemd-hostnamed.service.xml @@ -45,7 +45,7 @@ <refnamediv> <refname>systemd-hostnamed.service</refname> <refname>systemd-hostnamed</refname> - <refpurpose>Hostname bus mechanism</refpurpose> + <refpurpose>Host name bus mechanism</refpurpose> </refnamediv> <refsynopsisdiv> @@ -57,14 +57,14 @@ <title>Description</title> <para><filename>systemd-hostnamed</filename> is a system - service that may be used as mechanism to change the - system hostname. <filename>systemd-hostnamed</filename> is + service that may be used as a mechanism to change the + system's hostname. <filename>systemd-hostnamed</filename> is automatically activated on request and terminates itself when it is unused.</para> <para>The tool <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - is a command line client to this service.</para> + is a command-line client to this service.</para> <para>See the <ulink url="http://www.freedesktop.org/wiki/Software/systemd/hostnamed"> diff --git a/man/systemd-inhibit.xml b/man/systemd-inhibit.xml index 6f63c8c73e..de2f264147 100644 --- a/man/systemd-inhibit.xml +++ b/man/systemd-inhibit.xml @@ -101,8 +101,8 @@ <varlistentry> <term><option>--what=</option></term> - <listitem><para>Takes a colon - separated list of one or more + <listitem><para>Takes a colon-separated + list of one or more operations to inhibit: <literal>shutdown</literal>, <literal>sleep</literal>, @@ -124,9 +124,9 @@ <varlistentry> <term><option>--who=</option></term> - <listitem><para>Takes a short human - readable descriptive string for the - program taking the lock. If not passed + <listitem><para>Takes a short, + human-readable descriptive string for the + program taking the lock. If not passed, defaults to the command line string.</para></listitem> </varlistentry> @@ -134,8 +134,8 @@ <varlistentry> <term><option>--why=</option></term> - <listitem><para>Takes a short human - readable descriptive string for the + <listitem><para>Takes a short, + human-readable descriptive string for the reason for taking the lock. Defaults to "Unknown reason".</para></listitem> </varlistentry> @@ -155,7 +155,7 @@ <literal>delay</literal> is used, the lock can only delay the requested operations for a limited time. If the - time elapses the lock is ignored and + time elapses, the lock is ignored and the operation executed. The time limit may be specified in <citerefentry><refentrytitle>systemd-logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note diff --git a/man/systemd-journald.service.xml b/man/systemd-journald.service.xml index 2860ae9769..d751f9b855 100644 --- a/man/systemd-journald.service.xml +++ b/man/systemd-journald.service.xml @@ -73,14 +73,14 @@ </para> <para>Log data collected by the journal is primarily - text based but can also include binary data where + text-based but can also include binary data where necessary. All objects stored in the journal can be up to 2^64-1 bytes in size.</para> <para>By default the journal stores log data in <filename>/run/log/journal/</filename>. Since - <filename>/run/</filename> is volatile log data is - lost at reboot. To make the data persistent it + <filename>/run/</filename> is volatile, log data is + lost at reboot. To make the data persistent, it is sufficient to create <filename>/var/log/journal/</filename> where <filename>systemd-journald</filename> will then store @@ -89,8 +89,8 @@ <para><filename>systemd-journald</filename> will 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 + <filename>/run/systemd/journal/syslog</filename>, if it exists, which + may be used by Unix syslog daemons to process the data further.</para> <para>See @@ -161,15 +161,15 @@ <refsect1> <title>Access Control</title> - <para>Journal files are by default owned and readable + <para>Journal files are, by default, owned and readable by the <literal>systemd-journal</literal> system group - (but not writable). Adding a user to this group thus + but are not writable. Adding a user to this group thus enables her/him to read the journal files.</para> <para>By default, each logged in user will get her/his own set of journal files in <filename>/var/log/journal/</filename>. These files - will not be owned by the user however, in order to + will not be owned by the user, however, in order to avoid that the user can write to them directly. Instead, file system ACLs are used to ensure the user gets read access only.</para> diff --git a/man/systemd-modules-load.service.xml b/man/systemd-modules-load.service.xml index 1d33b8eec6..f8dfab351a 100644 --- a/man/systemd-modules-load.service.xml +++ b/man/systemd-modules-load.service.xml @@ -77,8 +77,8 @@ <term><varname>modules-load=</varname></term> <term><varname>rd.modules-load=</varname></term> - <listitem><para>Takes a comma - separated list of kernel modules to + <listitem><para>Takes a comma-separated + list of kernel modules to statically load during early boot. The option prefixed with <literal>rd.</literal> is read by the diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index ca21f2e6db..feafb31bc0 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -242,7 +242,7 @@ <varlistentry> <term><option>--uuid=</option></term> - <listitem><para>Set the specified uuid + <listitem><para>Set the specified UUID for the container. The init system will initialize <filename>/etc/machine-id</filename> @@ -274,7 +274,7 @@ <term><option>--read-only</option></term> <listitem><para>Mount the root file - system read only for the + system read-only for the container.</para></listitem> </varlistentry> @@ -283,7 +283,7 @@ <listitem><para>List one or more additional capabilities to grant the - container. Takes a comma separated + container. Takes a comma-separated list of capability names, see <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> for more information. Note that the diff --git a/man/systemd-readahead-replay.service.xml b/man/systemd-readahead-replay.service.xml index a00f7e589b..806d46093b 100644 --- a/man/systemd-readahead-replay.service.xml +++ b/man/systemd-readahead-replay.service.xml @@ -72,7 +72,7 @@ time. <filename>systemd-readahead-replay.service</filename> is a service that replays this access data collected at the subsequent boot. Since disks tend to be - magnitudes slower than RAM this is intended to improve + magnitudes slower than RAM, this is intended to improve boot speeds by pre-loading early at boot all data on disk that is known to be read for the complete boot process.</para> @@ -80,9 +80,9 @@ <para><filename>systemd-readahead-done.service</filename> is executed a short while after boot completed and signals <filename>systemd-readahead-collect.service</filename> - to end data collection. On this signal this service + to end data collection. On this signal, this service will then sort the collected disk accesses and store - information about them disk in + information about them in <filename>/.readahead</filename>.</para> <para>Normally, both @@ -92,17 +92,17 @@ are activated at boot so that access patterns from the preceding boot are replayed and new data collected for the subsequent boot. However, on read-only media - where the collected data cannot be stored it might + where the collected data cannot be stored, it might be a good idea to disable <filename>systemd-readahead-collect.service</filename>.</para> <para>On rotating media, when replaying disk accesses - at early boot + at early boot, <filename>systemd-readahead-replay.service</filename> will order read requests by their location on disk. On non-rotating media, they will be ordered by their original access timestamp. If the file system supports - it + it, <filename>systemd-readahead-collect.service</filename> will also defragment and rearrange files on disk to optimize subsequent boot times.</para> @@ -136,7 +136,7 @@ <term><option>--file-size-max=</option></term> <listitem><para>Maximum size of files - (in bytes) to read ahead. Only valid + in bytes to read ahead. Only valid for the <command>collect</command> and <command>replay</command> commands.</para></listitem> @@ -145,8 +145,8 @@ <varlistentry> <term><option>--timeout=</option></term> - <listitem><para>Maximum time (in usec) - to to spend collecting data. Only valid + <listitem><para>Maximum time in microseconds + to spend collecting data. Only valid for the <command>collect</command> command.</para></listitem> </varlistentry> @@ -164,7 +164,7 @@ [<replaceable>DIRECTORY</replaceable>]</command></term> <listitem> <para>Collect read-ahead data on - early boot. When terminating it will + early boot. When terminating, it will write out a pack file to the indicated directory containing the read-ahead data. </para> @@ -186,9 +186,9 @@ <listitem> <para>Dumps the content of the read-ahead pack file to the - terminal. The output lists - approximately for each file - how much will be read-ahead by + terminal. For each file, the + output lists approximately how + much will be read ahead by the <command>replay</command> command.</para> </listitem> diff --git a/man/systemd-system.conf.xml b/man/systemd-system.conf.xml index 48d02269cc..a67b158996 100644 --- a/man/systemd-system.conf.xml +++ b/man/systemd-system.conf.xml @@ -112,8 +112,8 @@ addition to the <literal>name=systemd</literal> named hierarchy. Defaults to - <literal>cpu</literal>. Takes a space - separated list of controller + <literal>cpu</literal>. Takes a + space-separated list of controller names. Pass the empty string to ensure that systemd does not touch any hierarchies but its own.</para> @@ -138,8 +138,8 @@ enabled in the kernel in individual hierarchies, with the exception of those listed in this setting. Takes a - space separated list of comma - separated controller names, in order + space-separated list of comma-separated + controller names, in order to allow multiple joined hierarchies. Defaults to 'cpu,cpuacct'. Pass an empty string to @@ -150,7 +150,7 @@ <para>Note that this option is only applied once, at very early boot. If you use an initial RAM disk (initrd) - that uses systemd it might hence be + that uses systemd, it might hence be necessary to rebuild the initrd if this option is changed, and make sure the new configuration file is included @@ -214,9 +214,8 @@ capability bounding set for PID 1 and its children. See <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> - for details. Takes a whitespace - separated list of capability names as - read by + for details. Takes a whitespace-separated + list of capability names as read by <citerefentry><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>. Capabilities listed will be included in the bounding set, all others are diff --git a/man/systemd-timedated.service.xml b/man/systemd-timedated.service.xml index c82c0ff439..4f17bccc69 100644 --- a/man/systemd-timedated.service.xml +++ b/man/systemd-timedated.service.xml @@ -57,7 +57,7 @@ <title>Description</title> <para><filename>systemd-timedated</filename> is a - system service that may be used as mechanism to change + system service that may be used as a mechanism to change the system clock and timezone, as well as to enable/disable NTP time synchronization. <filename>systemd-timedated</filename> @@ -66,7 +66,7 @@ <para>The tool <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - is a command line client to this service.</para> + is a command-line client to this service.</para> <para>See the <ulink url="http://www.freedesktop.org/wiki/Software/systemd/timedated"> diff --git a/man/systemd-tmpfiles.xml b/man/systemd-tmpfiles.xml index 0d2d65d593..405a9f1781 100644 --- a/man/systemd-tmpfiles.xml +++ b/man/systemd-tmpfiles.xml @@ -76,7 +76,7 @@ <para>If invoked with no arguments, it applies all directives from all configuration files. If one or - more file names are passed on the command line, only + more filenames are passed on the command line, only the directives in these files are applied. If only the basename of a configuration file is specified, all configuration directories as specified in <citerefentry> diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml index e01cac7bc2..2a310d3ecf 100644 --- a/man/systemd.automount.xml +++ b/man/systemd.automount.xml @@ -133,7 +133,7 @@ existing at time that the automount point is installed it is created. This string must be reflected in the unit - file name. (See above.) This option is + filename. (See above.) This option is mandatory.</para></listitem> </varlistentry> diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 2ccc470e26..d6fc324b5d 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -129,7 +129,7 @@ <listitem><para>Sets the supplementary Unix groups the processes are executed - as. This takes a space separated list + as. This takes a space-separated list of group names or IDs. This option may be specified more than once in which case all listed groups are set as @@ -312,7 +312,7 @@ <varname>Environment=</varname> but reads the environment variables from a text file. The text file should - contain new-line separated variable + contain new-line-separated variable assignments. Empty lines and lines starting with ; or # will be ignored, which may be used for commenting. A line @@ -324,7 +324,7 @@ double quotes (").</para> <para>The argument passed should be an - absolute file name or wildcard + absolute filename or wildcard expression, optionally prefixed with "-", which indicates that if the file does not exist it won't be read and no @@ -717,9 +717,8 @@ capability bounding set for the executed process. See <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> - for details. Takes a whitespace - separated list of capability names as - read by + for details. Takes a whitespace-separated + list of capability names as read by <citerefentry><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>, e.g. <constant>CAP_SYS_ADMIN</constant>, <constant>CAP_DAC_OVERRIDE</constant>, @@ -986,7 +985,7 @@ <listitem><para>Control access to specific device nodes by the executed processes. Takes two - space separated strings: a device node + space-separated strings: a device node path (such as <filename>/dev/null</filename>) followed by a combination of r, w, m @@ -1011,7 +1010,7 @@ processes. Takes either a single weight value (between 10 and 1000) to set the default block IO weight, or a - space separated pair of a file path + space-separated pair of a file path and a weight value to specify the device specific weight value (Example: "/dev/sda 500"). The file path may be @@ -1037,8 +1036,8 @@ <listitem><para>Set the per-device overall block IO bandwidth limit for - the executed processes. Takes a space - separated pair of a file path and a + the executed processes. Takes a + space-separated pair of a file path and a bandwidth value (in bytes per second) to specify the device specific bandwidth. The file path may be @@ -1185,9 +1184,9 @@ <term><varname>IgnoreSIGPIPE=</varname></term> <listitem><para>Takes a boolean - argument. If true causes SIGPIPE to be + argument. If true, causes SIGPIPE to be ignored in the executed - process. Defaults to true, since + process. Defaults to true because SIGPIPE generally is useful only in shell pipelines.</para></listitem> </varlistentry> @@ -1196,7 +1195,7 @@ <term><varname>NoNewPrivileges=</varname></term> <listitem><para>Takes a boolean - argument. If true ensures that the + argument. If true, ensures that the service process and all its children can never gain new privileges. This option is more powerful than the respective @@ -1211,9 +1210,9 @@ <varlistentry> <term><varname>SystemCallFilter=</varname></term> - <listitem><para>Takes a space - separated list of system call - names. If this setting is used all + <listitem><para>Takes a space-separated + list of system call + names. If this setting is used, all system calls executed by the unit process except for the listed ones will result in immediate process diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml index fe65078f76..bced51d635 100644 --- a/man/systemd.journal-fields.xml +++ b/man/systemd.journal-fields.xml @@ -72,7 +72,7 @@ <varlistentry> <term><varname>MESSAGE=</varname></term> <listitem> - <para>The human readable + <para>The human-readable message string for this entry. This is supposed to be the primary text shown to the @@ -87,16 +87,16 @@ <varlistentry> <term><varname>MESSAGE_ID=</varname></term> <listitem> - <para>A 128bit message + <para>A 128-bit message identifier ID for recognizing certain message types, if this is desirable. This should - contain a 128bit id formatted - as lower-case hexadecimal + contain a 128-bit ID formatted + as a lower-case hexadecimal string, without any separating dashes or suchlike. This is - recommended to be a UUID - compatible ID, but this is not + recommended to be a + UUID-compatible ID, but this is not enforced, and formatted differently. Developers can generate a new ID for this @@ -113,7 +113,7 @@ 0 (<literal>emerg</literal>) and 7 (<literal>debug</literal>) - formatted as decimal + formatted as a decimal string. This field is compatible with syslog's priority concept.</para> @@ -128,7 +128,7 @@ <para>The code location generating this message, if known. Contains the source - file name, the line number and + filename, the line number and the function name.</para> </listitem> </varlistentry> @@ -141,7 +141,7 @@ any. Contains the numeric value of <citerefentry><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry> - formatted as decimal + formatted as a decimal string.</para> </listitem> </varlistentry> @@ -179,7 +179,7 @@ <para>The process, user and group ID of the process the journal entry originates from - formatted as decimal + formatted as a decimal string.</para> </listitem> </varlistentry> @@ -246,8 +246,8 @@ any is known that is different from the reception time of the journal. This is the time in - usec since the epoch UTC - formatted as decimal + microseconds since the epoch UTC, + formatted as a decimal string.</para> </listitem> </varlistentry> @@ -258,7 +258,7 @@ <para>The kernel boot ID for the boot the message was generated in, formatted as - 128bit hexadecimal + a 128-bit hexadecimal string.</para> </listitem> </varlistentry> @@ -457,7 +457,7 @@ JSON Format</ulink>, the addresses of journal entries are serialized into fields prefixed with double underscores. Note that these aren't proper fields when - stored in the journal, but addressing meta data of + stored in the journal but for addressing meta data of entries. They cannot be written as part of structured log entries via calls such as <citerefentry><refentrytitle>sd_journal_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>. They @@ -486,11 +486,11 @@ (<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 + in microseconds since the epoch + UTC, formatted as a decimal string. This has different properties from - <literal>_SOURCE_REALTIME_TIMESTAMP=</literal> + <literal>_SOURCE_REALTIME_TIMESTAMP=</literal>, as it is usually a bit later but more likely to be monotonic. </para> @@ -504,10 +504,10 @@ (<constant>CLOCK_MONOTONIC</constant>) at the point in time the entry was received by the journal in - usec formatted as decimal + microseconds, formatted as a decimal string. To be useful as an - address for the entry this - should be combined with with + address for the entry, this + should be combined with with the boot ID in <literal>_BOOT_ID=</literal>. </para> </listitem> diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index 21177a2623..d47fb93669 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -206,14 +206,14 @@ the mount point does not exist at the time of mounting, it is created. This string must be reflected in the unit - file name. (See above.) This option is + filename. (See above.) This option is mandatory.</para></listitem> </varlistentry> <varlistentry> <term><varname>Type=</varname></term> <listitem><para>Takes a string for the - filesystem type. See + file system type. See <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details. This setting is optional.</para></listitem> @@ -223,8 +223,8 @@ <term><varname>Options=</varname></term> <listitem><para>Mount options to use - when mounting. This takes a comma - separated list of options. This + when mounting. This takes a + comma-separated list of options. This setting is optional.</para></listitem> </varlistentry> @@ -245,7 +245,7 @@ <listitem><para>Configures the time to wait for the mount command to finish. If a command does not exit - within the configured time the mount + within the configured time, the mount will be considered failed and be shut down again. All commands still running will be terminated forcibly via diff --git a/man/systemd.preset.xml b/man/systemd.preset.xml index a692053876..1ba9272398 100644 --- a/man/systemd.preset.xml +++ b/man/systemd.preset.xml @@ -109,7 +109,7 @@ by default, <literal>disable</literal> to disable units by default.</para> - <para>If multiple lines apply to a unit name the + <para>If multiple lines apply to a unit name, the first matching one takes precedence over all others.</para> @@ -131,14 +131,14 @@ precedence over another file with an alphabetically earlier name, if both files contain lines that apply to the same unit names. It is recommended to prefix - all file names with two-digit number, to simplify + all filenames with two-digit number, to simplify ordering.</para> <para>If the administrator wants to disable a preset - file supplied by the vendor the recommended way is to + file supplied by the vendor, the recommended way is to place a symlink to <filename>/dev/null</filename> in <filename>/etc/systemd/system-preset/</filename> - bearing the same file name.</para> + bearing the same filename.</para> </refsect1> <refsect1> @@ -150,8 +150,8 @@ <programlisting>disable *</programlisting> </example> - <para>This disables all units. Due to the file name - prefix <literal>99-</literal> it will be read last and + <para>This disables all units. Due to the filename + prefix <literal>99-</literal>, it will be read last and hence can easily be overridden by spin or administrator preset policy or suchlike.</para> @@ -187,7 +187,7 @@ disable *</programlisting> <para>This enables three specific services and disables all others. This is useful for administrators to specifically select the units to enable, and - disable all others. Due to the file name prefix + disable all others. Due to the filename prefix <literal>00-</literal> it will be read early and hence overrides all other preset policy files.</para> </refsect1> diff --git a/man/systemd.service.xml b/man/systemd.service.xml index dcf57c30bb..fab0c4de27 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -375,7 +375,7 @@ <literal>argv[0]</literal> to the executed process, followed by the further arguments specified. If the - absolute file name is prefixed with + absolute filename is prefixed with <literal>-</literal> an exit code of the command normally considered a failure (i.e. non-zero exit status or diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 0d5652b834..0ff3ca22ac 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -387,8 +387,8 @@ <citerefentry><refentrytitle>close</refentrytitle><manvolnum>2</manvolnum></citerefentry> on the received socket before exiting. However, it must not unlink - the socket from a filesystem. It - should note invoke + the socket from a file system. It + should not invoke <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>2</manvolnum></citerefentry> on sockets it got with <varname>Accept=false</varname>, but @@ -412,7 +412,7 @@ are coming in, they will be refused until at least one existing connection is terminated. This setting has no - effect for sockets configured with + effect on sockets configured with <option>Accept=false</option> or datagram sockets. Defaults to 64.</para></listitem> @@ -516,7 +516,7 @@ respectively, i.e. the security label of the FIFO, or the security label for the incoming or outgoing connections - of the socket, respectively. See + of the socket, respectively. See <ulink url="https://www.kernel.org/doc/Documentation/security/Smack.txt">Smack.txt</ulink> for details.</para></listitem> @@ -527,7 +527,7 @@ <listitem><para>Takes an integer value. Controls the pipe buffer size of FIFOs configured in this socket - unit. See + unit. See <citerefentry><refentrytitle>fcntl</refentrytitle><manvolnum>2</manvolnum></citerefentry> for details.</para></listitem> </varlistentry> @@ -598,7 +598,7 @@ socket option, which allows <constant>AF_UNIX</constant> sockets to receive the security context of the sending process in an - ancillary message. Defaults to + ancillary message. Defaults to <option>false</option>.</para></listitem> </varlistentry> @@ -622,7 +622,7 @@ before or after the listening sockets/FIFOs are created and bound, respectively. The first token of the command - line must be an absolute file name, + line must be an absolute filename, then followed by arguments for the process. Multiple command lines may be specified following the same scheme as @@ -701,7 +701,7 @@ </para> <para> - For more extensive descriptions see the "Systemd for Developers" series: + For more extensive descriptions see the "systemd for Developers" series: <ulink url="http://0pointer.de/blog/projects/socket-activation.html">Socket Activation</ulink>, <ulink url="http://0pointer.de/blog/projects/socket-activation2.html">Socket Activation, part II</ulink>, <ulink url="http://0pointer.de/blog/projects/inetd.html">Converting inetd Services</ulink>, diff --git a/man/systemd.time.xml b/man/systemd.time.xml index a9318bb787..79ebdc5dfc 100644 --- a/man/systemd.time.xml +++ b/man/systemd.time.xml @@ -50,16 +50,16 @@ <refsect1> <title>Description</title> - <para>In systemd timestamps, timespans, and calendar + <para>In systemd, timestamps, time spans, and calendar events are displayed and may be specified in closely related syntaxes.</para> </refsect1> <refsect1> - <title>Displaying Timespans</title> + <title>Displaying Time Spans</title> - <para>Timespans refer to time durations. On display - systemd will present timespans as a space separated + <para>Time spans refer to time durations. On display, + systemd will present time spans as a space-separated series of time values each suffixed by a time unit.</para> @@ -70,10 +70,10 @@ </refsect1> <refsect1> - <title>Parsing Timespans</title> + <title>Parsing Time Spans</title> - <para>When parsing systemd will accept the same - timespan syntax. Separating spaces may be omitted. The + <para>When parsing, systemd will accept the same + time span syntax. Separating spaces may be omitted. The following time units are understood:</para> <itemizedlist> @@ -92,9 +92,9 @@ are assumed, but some exceptions exist and are marked as such. In a few cases <literal>ns</literal>, <literal>nsec</literal> is accepted too, where the - granularity of the timespan allows for this.</para> + granularity of the time span allows for this.</para> - <para>Examples for valid timespan specifications:</para> + <para>Examples for valid time span specifications:</para> <programlisting>2 h 2hours @@ -108,12 +108,12 @@ <title>Displaying Timestamps</title> <para>Timestamps refer to specific, unique points in - time. On display systemd will format these in the + time. On display, systemd will format these in the local timezone as follows:</para> <programlisting>Fri 2012-11-23 23:02:15 CET</programlisting> - <para>The week day is printed according to the locale + <para>The weekday is printed according to the locale choice of the user.</para> </refsect1> @@ -123,10 +123,10 @@ <para>When parsing systemd will accept a similar timestamp syntax, but excluding any timezone specification (this limitation might be removed - eventually). The week day specification is optional, - but when the week day is specified it must either be + eventually). The weekday specification is optional, + but when the weekday is specified it must either be in the abbreviated (<literal>Wed</literal>) or - non-abbreviated (<literal>Wednesday</literal>) english + non-abbreviated (<literal>Wednesday</literal>) English language form (case doesn't matter), and is not subject to the locale choice of the user. Either the date, or the time part may be omitted, in which case @@ -136,11 +136,11 @@ specified in full or may be abbreviated (omitting the century).</para> - <para>A timestamp is considered invalid if a week day + <para>A timestamp is considered invalid if a weekday is specified and the date does not actually match the specified day of the week.</para> - <para>When parsing systemd will also accept a few + <para>When parsing, systemd will also accept a few special placeholders instead of timestamps: <literal>now</literal> may be used to refer to the current time (or of the invocation of the command @@ -150,14 +150,14 @@ current day, the day before or the next day, respectively.</para> - <para>When parsing systemd will also accept relative - time specifications. A timespan (see above) that is + <para>When parsing, systemd will also accept relative + time specifications. A time span (see above) that is prefixed with <literal>+</literal> is evaluated to the current time plus the specified - timespan. Correspondingly a timespan that is prefix + time span. Correspondingly, a time span that is prefixed with <literal>-</literal> is evaluated to the current - time minus the specified timespan. Instead of - prefixing the timespan with <literal>-</literal> it + time minus the specified time span. Instead of + prefixing the time span with <literal>-</literal> it may also be suffixed with a space and the word <literal>ago</literal>.</para> @@ -182,10 +182,10 @@ <para>Note that timestamps printed by systemd will not be parsed correctly by systemd, as the timezone specification is not accepted, and printing timestamps - is subject to locale settings for the week day while - parsing only accepts english week day names.</para> + is subject to locale settings for the weekday while + parsing only accepts English weekday names.</para> - <para>In some cases systemd will display a relative + <para>In some cases, systemd will display a relative timestamp (relative to the current time, or the time of invocation of the command) instead or in addition to an absolute timestamp as described above. A @@ -208,17 +208,17 @@ <para>The above refers to 11:12:13 of the first or fifth day of any month of the year 2012, given that it - is a thursday or friday.</para> + is a Thursday or Friday.</para> <para>The weekday specification is optional. If - specified it should consist of one or more english - language week day names, either in the abbreviated + specified, it should consist of one or more English + language weekday names, either in the abbreviated (Wed) or non-abbreviated (Wednesday) form (case does - not matter), separated by commas. Specifying two week - days separated by "-" refers to a range of continuous - week days. "," and "-" may be combined freely.</para> + not matter), separated by commas. Specifying two weekdays + separated by "-" refers to a range of continuous + weekdays. "," and "-" may be combined freely.</para> - <para>In the date and time specifications any + <para>In the date and time specifications, any component may be specified as "*" in which case any value will match. Alternatively, each component can be specified as list of values separated by diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index 2b9d91a60f..1f0aac2eed 100644 --- a/man/systemd.timer.xml +++ b/man/systemd.timer.xml @@ -160,7 +160,7 @@ monotonic clock stops too.</para> <para>If the empty string is assigned - to any of these options the list of + to any of these options, the list of timers is reset, and all prior assignments will have no effect.</para></listitem> diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 1cfdac9267..552c747695 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -182,7 +182,7 @@ directive.</para> <para>If a line starts with <option>.include</option> - followed by a file name, the specified file will be + followed by a filename, the specified file will be parsed at this point. Make sure that the file that is included has the appropriate section headers before any directives.</para> @@ -200,7 +200,7 @@ with the device node <filename noindex='true'>/dev/sda</filename> in the file system namespace. If this applies a special way to escape the path name is used, so that the - result is usable as part of a file name. Basically, + result is usable as part of a filename. Basically, given a path, "/" is replaced by "-", and all unprintable characters and the "-" are replaced by C-style "\x20" escapes. The root directory "/" is @@ -382,7 +382,7 @@ <varlistentry> <term><varname>Documentation=</varname></term> - <listitem><para>A space separated list + <listitem><para>A space-separated list of URIs referencing documentation for this unit or its configuration. Accepted are only URIs @@ -393,7 +393,7 @@ <literal>info:</literal>, <literal>man:</literal>. For more information about the syntax of these - URIs see + URIs, see <citerefentry><refentrytitle>uri</refentrytitle><manvolnum>7</manvolnum></citerefentry>. The URIs should be listed in order of relevance, starting with the most @@ -405,7 +405,7 @@ option may be specified more than once in which case the specified list of URIs is merged. If the empty string is - assigned to this option the list is + assigned to this option, the list is reset and all prior assignments will have no effect.</para></listitem> </varlistentry> @@ -669,8 +669,8 @@ <varlistentry> <term><varname>RequiresMountsFor=</varname></term> - <listitem><para>Takes a space - separated list of absolute paths. Automatically + <listitem><para>Takes a space-separated + list of absolute paths. Automatically adds dependencies of type <varname>Requires=</varname> and <varname>After=</varname> for all @@ -1007,11 +1007,11 @@ <para><varname>ConditionHost=</varname> may be used to match against the - host name or machine ID of the - host. This either takes a host name + hostname or machine ID of the + host. This either takes a hostname string (optionally with shell style globs) which is tested against the - locally set host name as returned by + locally set hostname as returned by <citerefentry><refentrytitle>gethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry>, or a machine ID formatted as string (see @@ -1108,7 +1108,7 @@ time, <command>systemctl enable</command> will create symlinks from these names - to the unit file name.</para></listitem> + to the unit filename.</para></listitem> </varlistentry> <varlistentry> @@ -1207,7 +1207,7 @@ </row> <row> <entry><literal>%f</literal></entry> - <entry>Unescaped file name</entry> + <entry>Unescaped filename</entry> <entry>This is either the unescaped instance name (if applicable) with <filename>/</filename> prepended (if applicable), or the prefix name similarly prepended with <filename>/</filename>.</entry> </row> <row> @@ -1263,7 +1263,7 @@ <row> <entry><literal>%H</literal></entry> <entry>Host name</entry> - <entry>The host name of the running system.</entry> + <entry>The hostname of the running system.</entry> </row> <row> <entry><literal>%%</literal></entry> diff --git a/man/systemd.xml b/man/systemd.xml index ef95641387..5f941e5f94 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -473,7 +473,7 @@ <para>Systemd contains native implementations of various tasks that need to be executed as part of the - boot process. For example, it sets the host name or + boot process. For example, it sets the hostname or configures the loopback network device. It also sets up and mounts various API file systems, such as <filename>/sys</filename> or diff --git a/man/timedatectl.xml b/man/timedatectl.xml index e291f04e1e..77af2ad460 100644 --- a/man/timedatectl.xml +++ b/man/timedatectl.xml @@ -158,7 +158,7 @@ <listitem><para>Set the system time zone to the specified value. Available - time zones can be listed with + timezones can be listed with <command>list-timezones</command>. If the RTC is configured to be in the local time this will also update the @@ -176,7 +176,7 @@ <listitem><para>List available time zones, one per line. Entries from the list can be set as the system - time zone with + timezone with <command>set-timezone</command>.</para></listitem> </varlistentry> @@ -190,7 +190,7 @@ <literal>1</literal> it will maintain the RTC in local time instead. Note that maintaining the RTC in the local - time zone is not fully supported and + timezone is not fully supported and will create various problems with time zone changes and daylight saving adjustments. If at all possible use diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml index 519f9bc618..6a2193d67d 100644 --- a/man/tmpfiles.d.xml +++ b/man/tmpfiles.d.xml @@ -89,7 +89,7 @@ recommended way is to place a symlink to <filename>/dev/null</filename> in <filename>/etc/tmpfiles.d/</filename> bearing the - same file name.</para> + same filename.</para> <para>The configuration format is one line per path containing action, path, mode, ownership, age and argument diff --git a/man/udev.xml b/man/udev.xml index 2353b10023..553bbfd056 100644 --- a/man/udev.xml +++ b/man/udev.xml @@ -61,7 +61,7 @@ and the local administration directory <filename>/etc/udev/rules.d</filename>. All rules files are collectively sorted and processed in lexical order, regardless of the directories in which they live. However, files with - identical file names replace each other. Files in <filename>/etc</filename> + identical filenames replace each other. Files in <filename>/etc</filename> have the highest priority, files in <filename>/run</filename> take precedence over files with the same name in <filename>/lib</filename>. This can be used to override a system-supplied rules file with a local file if needed; |