chiark / gitweb /
man: replace STDOUT with standard output, etc.
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Sat, 15 Feb 2014 03:00:06 +0000 (22:00 -0500)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Sat, 15 Feb 2014 03:03:40 +0000 (22:03 -0500)
Actually 'STDOUT' is something that doesn't appear anywhere: in the
stdlib we have 'stdin', and there's only the constant STDOUT_FILENO,
so there's no reason to use capitals. When refering to code,
STDOUT/STDOUT/STDERR are replaced with stdin/stdout/stderr, and in
other places they are replaced with normal phrases like standard
output, etc.

15 files changed:
man/daemon.xml
man/sd-daemon.xml
man/sd_journal_stream_fd.xml
man/systemctl.xml
man/systemd-ask-password.xml
man/systemd-bus-proxyd.xml
man/systemd-cat.xml
man/systemd-coredumpctl.xml
man/systemd-journald.service.xml
man/systemd-udevd.service.xml
man/systemd.exec.xml
man/systemd.service.xml
man/systemd.socket.xml
man/udev.xml
man/udevadm.xml

index 17d9dd6a223becf1375a2ef2a4fc2bc4996564bc..26ba60052158030aded0f05eaffa7220b712d80e 100644 (file)
@@ -74,8 +74,8 @@
 
                         <orderedlist>
                                 <listitem><para>Close all open file
 
                         <orderedlist>
                                 <listitem><para>Close all open file
-                                descriptors except STDIN, STDOUT,
-                                STDERR (i.e. the first three file
+                                descriptors except stdin, stdout,
+                                stderr (i.e. the first three file
                                 descriptors 0, 1, 2). This ensures
                                 that no accidentally passed file
                                 descriptor stays around in the daemon
                                 descriptors 0, 1, 2). This ensures
                                 that no accidentally passed file
                                 descriptor stays around in the daemon
 
                                 <listitem><para>In the daemon process,
                                 connect <filename>/dev/null</filename>
 
                                 <listitem><para>In the daemon process,
                                 connect <filename>/dev/null</filename>
-                                to STDIN, STDOUT,
-                                STDERR.</para></listitem>
+                                to standard input, output, and error.
+                                </para></listitem>
 
                                 <listitem><para>In the daemon process,
                                 reset the umask to 0, so that the file
 
                                 <listitem><para>In the daemon process,
                                 reset the umask to 0, so that the file
                         service.</para>
 
                         <para>Note that new-style init systems
                         service.</para>
 
                         <para>Note that new-style init systems
-                        guarantee execution of daemon processes in
-                        clean process context: it is guaranteed that
+                        guarantee execution of daemon processes in a
+                        clean process context: it is guaranteed that
                         the environment block is sanitized, that the
                         signal handlers and mask is reset and that no
                         left-over file descriptors are passed. Daemons
                         the environment block is sanitized, that the
                         signal handlers and mask is reset and that no
                         left-over file descriptors are passed. Daemons
-                        will be executed in their own session, and
-                        STDIN/STDOUT/STDERR connected to
+                        will be executed in their own session, with
+                        standard input/output/error connected to
                         <filename>/dev/null</filename> unless
                         <filename>/dev/null</filename> unless
-                        otherwise configured. The umask is reset.</para>
+                        otherwise configured. The umask is reset.
+                        </para>
 
                         <para>It is recommended for new-style daemons
                         to implement the following:</para>
 
                         <para>It is recommended for new-style daemons
                         to implement the following:</para>
                                 <listitem><para>Instead of using the
                                 <function>syslog()</function> call to log directly to the
                                 system syslog service, a new-style daemon may
                                 <listitem><para>Instead of using the
                                 <function>syslog()</function> call to log directly to the
                                 system syslog service, a new-style daemon may
-                                choose to simply log to STDERR via
+                                choose to simply log to standard error via
                                 <function>fprintf()</function>, which is then forwarded to
                                 syslog by the init system. If log
                                 priorities are necessary, these can be
                                 <function>fprintf()</function>, which is then forwarded to
                                 syslog by the init system. If log
                                 priorities are necessary, these can be
index ed85debd77224f3d4a4f397011c82459f791fb7a..ce4887e406d99d6a1289ba308b7706662452eba0 100644 (file)
@@ -96,7 +96,7 @@
 #define SD_DEBUG   "&lt;7&gt;"  /* debug-level messages */</programlisting>
 
                 <para>These prefixes are intended to be used in
 #define SD_DEBUG   "&lt;7&gt;"  /* debug-level messages */</programlisting>
 
                 <para>These prefixes are intended to be used in
-                conjunction with STDERR-based logging as implemented
+                conjunction with stderr-based logging as implemented
                 by systemd. If a systemd service definition file is
                 configured with <varname>StandardError=syslog</varname>
                 or <varname>StandardError=kmsg</varname>, these
                 by systemd. If a systemd service definition file is
                 configured with <varname>StandardError=syslog</varname>
                 or <varname>StandardError=kmsg</varname>, these
index a8dc8fd08aa92356e67512acde9241ed727fd02c..646fe1580ba142f0fd4f9132401e35d5b240dd8b 100644 (file)
@@ -69,8 +69,8 @@
                 messages written to this file descriptor as simple
                 newline-separated text strings are written to the
                 journal. This file descriptor can be used internally
                 messages written to this file descriptor as simple
                 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>
+                by applications or be made standard output or standard
+                error of other processes executed.</para>
 
                 <para><function>sd_journal_stream_fd()</function>
                 takes a short program identifier string as first
 
                 <para><function>sd_journal_stream_fd()</function>
                 takes a short program identifier string as first
index d78916ba735d10f78f9207c80fb6a4f48c5aa878..a80d3720e4a41fdd7fcf38e5fe0aed2115455d8c 100644 (file)
@@ -700,21 +700,23 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 
           <listitem>
             <para>Check whether any of the specified units are active
 
           <listitem>
             <para>Check whether any of the specified units are active
-            (i.e. running). Returns an exit code 0 if at least one is
-            active, or non-zero otherwise. Unless <option>--quiet</option>
-            is specified, this will also print the current unit state to
-            STDOUT.</para>
+            (i.e. running). Returns an exit code
+            <constant>0</constant> if at least one is active, or
+            non-zero otherwise. Unless <option>--quiet</option> is
+            specified, this will also print the current unit state to
+            standard output.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
           <term><command>is-failed <replaceable>PATTERN</replaceable>...</command></term>
 
           <listitem>
           </listitem>
         </varlistentry>
         <varlistentry>
           <term><command>is-failed <replaceable>PATTERN</replaceable>...</command></term>
 
           <listitem>
-            <para>Check whether any of the specified units are in a "failed" state.
-            Returns an exit code 0 if at least one has failed, non-zero
-            otherwise. Unless <option>--quiet</option> is specified, this
-            will also print the current unit state to
-            STDOUT.</para>
+            <para>Check whether any of the specified units are in a
+            "failed" state. Returns an exit code
+            <constant>0</constant> if at least one has failed,
+            non-zero otherwise. Unless <option>--quiet</option> is
+            specified, this will also print the current unit state to
+            standard output.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
           </listitem>
         </varlistentry>
         <varlistentry>
@@ -1127,9 +1129,10 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           <listitem>
             <para>Create a snapshot. If a snapshot name is specified,
             the new snapshot will be named after it. If none is
           <listitem>
             <para>Create a snapshot. If a snapshot name is specified,
             the new snapshot will be named after it. If none is
-            specified, an automatic snapshot name is generated. In either
-            case, the snapshot name used is printed to STDOUT, unless
-            <option>--quiet</option> is specified.</para>
+            specified, an automatic snapshot name is generated. In
+            either case, the snapshot name used is printed to standard
+            output, unless <option>--quiet</option> is specified.
+            </para>
 
             <para>A snapshot refers to a saved state of the systemd
             manager. It is implemented itself as a unit that is
 
             <para>A snapshot refers to a saved state of the systemd
             manager. It is implemented itself as a unit that is
index 79902cbd9ab02fa91e702688bfbb40a3a3bdc0d0..db5cb20db5f51a44f9036495abf235ae6498431e 100644 (file)
@@ -60,7 +60,7 @@
                 used to query a system password or passphrase from the
                 user, using a question message specified on the
                 command line. When run from a TTY it will query a
                 used to query a system password or passphrase from the
                 user, using a question message specified on the
                 command line. When run from a TTY it will query a
-                password on the TTY and print it to STDOUT. When run
+                password on the TTY and print it to standard output. When run
                 with no TTY or with <option>--no-tty</option> it will
                 query the password system-wide and allow active users
                 to respond via several agents. The latter is
                 with no TTY or with <option>--no-tty</option> it will
                 query the password system-wide and allow active users
                 to respond via several agents. The latter is
index e75815fb4aef82a9290c689f6ba5c8ab2a13b2b5..212780699fc1c393f36f848521ed3c57622b2e24 100644 (file)
@@ -61,8 +61,8 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para><command>systemd-bus-proxyd</command> will proxy D-Bus
     messages to and from a bus. The will be either the system bus or
     the bus specified with <option>--address</option> when that option
     <para><command>systemd-bus-proxyd</command> will proxy D-Bus
     messages to and from a bus. The will be either the system bus or
     the bus specified with <option>--address</option> when that option
-    is given. Messages will be proxied to/from STDIN and STDOUT, or
-    the socket received through socket activation.</para>
+    is given. Messages will be proxied to/from standard input and
+    output, or the socket received through socket activation.</para>
 
     <para>This program can be used to connect a program using classic
     D-Bus to kdbus.</para>
 
     <para>This program can be used to connect a program using classic
     D-Bus to kdbus.</para>
index ba7a2cf0c75879c8db7255875f2ea15049564bfd..16a8eb456c4134fa6558261499300ad647562b40 100644 (file)
                 <title>Description</title>
 
                 <para><command>systemd-cat</command> may be used to
                 <title>Description</title>
 
                 <para><command>systemd-cat</command> may be used to
-                connect STDOUT and STDERR of a process with the
+                connect the standard input and output of a process to the
                 journal, or as a filter tool in a shell pipeline to
                 pass the output the previous pipeline element
                 generates to the journal.</para>
 
                 <para>If no parameter is passed,
                 <command>systemd-cat</command> will write
                 journal, or as a filter tool in a shell pipeline to
                 pass the output the previous pipeline element
                 generates to the journal.</para>
 
                 <para>If no parameter is passed,
                 <command>systemd-cat</command> will write
-                everything it reads from standard input (STDIN) to the journal.</para>
+                everything it reads from standard input (stdin) to the journal.</para>
 
                 <para>If parameters are passed, they are executed as
 
                 <para>If parameters are passed, they are executed as
-                command line with standard output (STDOUT) and standard
-                error output (STDERR) connected to the journal, so
+                command line with standard output (stdout) and standard
+                error output (stderr) connected to the journal, so
                 that all it writes is stored in the journal.</para>
         </refsect1>
 
                 that all it writes is stored in the journal.</para>
         </refsect1>
 
                         <title>Invoke a program</title>
 
                         <para>This calls <filename noindex='true'>/bin/ls</filename>
                         <title>Invoke a program</title>
 
                         <para>This calls <filename noindex='true'>/bin/ls</filename>
-                        with STDOUT/STDERR connected to the
+                        with standard output and error connected to the
                         journal:</para>
 
                         <programlisting># systemd-cat ls</programlisting>
                         journal:</para>
 
                         <programlisting># systemd-cat ls</programlisting>
 
                 <para>Even though the two examples have very similar
                 effects the first is preferable since only one process
 
                 <para>Even though the two examples have very similar
                 effects the first is preferable since only one process
-                is running at a time, and both STDOUT and STDERR are
-                captured while in the second example only STDOUT is
+                is running at a time, and both stdout and stderr are
+                captured while in the second example only stdout is
                 captured.</para>
         </refsect1>
 
                 captured.</para>
         </refsect1>
 
index c096f6d7b1244cfc75b9066c566a1006aab0f155..286ff146396c930b834cd36fdabc62e5f3ae50ae 100644 (file)
 
                                 <listitem><para>Extract the last coredump
                                 matching specified characteristics.
 
                                 <listitem><para>Extract the last coredump
                                 matching specified characteristics.
-                                Coredump will be written on STDOUT, unless
-                                an output file is specified with
+                                Coredump will be written on standard output,
+                                unless an output file is specified with
                                 <option>-o/--output</option>.
                                 </para></listitem>
                         </varlistentry>
                                 <option>-o/--output</option>.
                                 </para></listitem>
                         </varlistentry>
index 2f877f565c5580999de9641789d4deaad53d6e24..0a20e211597ba24db58ca2055a0ff7c723aa0cd1 100644 (file)
                 <title>Description</title>
 
                 <para><filename>systemd-journald</filename> is a
                 <title>Description</title>
 
                 <para><filename>systemd-journald</filename> is a
-                system service that collects and stores logging
-                data. It creates and maintains structured, indexed
-                journals based on logging information that is received
-                from the kernel, from user processes via the libc
+                system service that collects and stores logging data.
+                It creates and maintains structured, indexed journals
+                based on logging information that is received from the
+                kernel, from user processes via the libc
                 <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
-                call, from STDOUT/STDERR of system services or via its
-                native API. It will implicitly collect numerous meta
-                data fields for each log messages in a secure and
-                unfakeable way. See
+                call, from standard input and standard error of system
+                services or via its native API. It will implicitly
+                collect numerous meta data fields for each log
+                messages in a secure and unfakeable way. See
                 <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                 for more information about the collected meta data.
                 </para>
                 <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                 for more information about the collected meta data.
                 </para>
index 50a10764bf8e2e1d05b15b84eb35436d9341127d..b3bca2fec289adb718aff7fc006027451f5956f3 100644 (file)
@@ -70,7 +70,7 @@
       <varlistentry>
         <term><option>--debug</option></term>
         <listitem>
       <varlistentry>
         <term><option>--debug</option></term>
         <listitem>
-          <para>Print debug messages to STDERR.</para>
+          <para>Print debug messages to standard error.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         </listitem>
       </varlistentry>
       <varlistentry>
       <varlistentry>
         <term><option>--exec-delay=</option></term>
         <listitem>
       <varlistentry>
         <term><option>--exec-delay=</option></term>
         <listitem>
-          <para>Delay the execution of RUN instruction by the given
-          number of seconds. This option might be useful when
-          debugging system crashes during coldplug caused by loading
-          non-working kernel modules.</para>
+          <para>Delay the execution of <varname>RUN</varname>
+          instruction by the given number of seconds. This option
+          might be useful when debugging system crashes during
+          coldplug caused by loading non-working kernel
+          modules.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         </listitem>
       </varlistentry>
       <varlistentry>
index 8b7645c4d6993b66fc3dafc7ae8adfeefae1a11d..a9e54cb03b1d573368dc3feb371212238a5c00d7 100644 (file)
                         <varlistentry>
                                 <term><varname>StandardError=</varname></term>
                                 <listitem><para>Controls where file
                         <varlistentry>
                                 <term><varname>StandardError=</varname></term>
                                 <listitem><para>Controls where file
-                                descriptor 2 (STDERR) of the executed
-                                processes is connected to. The
-                                available options are identical to
+                                descriptor 2 (standard error) of the
+                                executed processes is connected to.
+                                The available options are identical to
                                 those of
                                 <varname>StandardOutput=</varname>,
                                 with one exception: if set to
                                 those of
                                 <varname>StandardOutput=</varname>,
                                 with one exception: if set to
                         <varlistentry>
                                 <term><varname>TTYPath=</varname></term>
                                 <listitem><para>Sets the terminal
                         <varlistentry>
                                 <term><varname>TTYPath=</varname></term>
                                 <listitem><para>Sets the terminal
-                                device node to use if STDIN, STDOUT,
-                                or STDERR are connected to a
+                                device node to use if standard input, output,
+                                or error are connected to a
                                 TTY (see above). Defaults to
                                 <filename>/dev/console</filename>.</para></listitem>
                         </varlistentry>
                                 TTY (see above). Defaults to
                                 <filename>/dev/console</filename>.</para></listitem>
                         </varlistentry>
index be9bdcaf99689d5e03d34ac3090f6ce0fdcebfca..454cde4b4992eb25feda0b949dac12fb17ec8896 100644 (file)
@@ -861,7 +861,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
                                 for all file descriptors passed via
                                 socket-based activation. If true, all
                                 file descriptors >= 3 (i.e. all except
                                 for all file descriptors passed via
                                 socket-based activation. If true, all
                                 file descriptors >= 3 (i.e. all except
-                                STDIN/STDOUT/STDERR) will have
+                                stdin, stdout, and stderr) will have
                                 the <constant>O_NONBLOCK</constant> flag
                                 set and hence are in
                                 non-blocking mode. This option is only
                                 the <constant>O_NONBLOCK</constant> flag
                                 set and hence are in
                                 non-blocking mode. This option is only
index 946c30a757a69390d07abdaf17acc953c7b83a86..6472750d0e1c293a3f6d01aa7551b0045bd935a7 100644 (file)
                 <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 for details) or via the traditional
                 <citerefentry><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry>-style
                 <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 for details) or via the traditional
                 <citerefentry><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry>-style
-                socket passing (i.e. sockets passed in via STDIN and
-                STDOUT, using <varname>StandardInput=socket</varname>
+                socket passing (i.e. sockets passed in via standard input and
+                output, using <varname>StandardInput=socket</varname>
                 in the service file).</para>
         </refsect1>
 
                 in the service file).</para>
         </refsect1>
 
index 9ea1cae4a3f81ba665a5dacaa76978251cbd980a..1bf0b089e24359d85d189c7958aca08603f76070 100644 (file)
             <para>Execute a program to determine whether there
             is a match; the key is true if the program returns
             successfully. The device properties are made available to the
             <para>Execute a program to determine whether there
             is a match; the key is true if the program returns
             successfully. The device properties are made available to the
-            executed program in the environment. The program's STDOUT
+            executed program in the environment. The program's standard ouput
             is available in the <varname>RESULT</varname> key.</para>
             <para>This can only be used for very short-running foreground tasks. For details,
             see <varname>RUN</varname>.</para>
             is available in the <varname>RESULT</varname> key.</para>
             <para>This can only be used for very short-running foreground tasks. For details,
             see <varname>RUN</varname>.</para>
index e437c243c578254a96bc154a02bf0966386985fe..a3f8d548df6b4dae87ef4986f295f2669dc91f4e 100644 (file)
@@ -72,7 +72,7 @@
       <varlistentry>
         <term><option>--debug</option></term>
         <listitem>
       <varlistentry>
         <term><option>--debug</option></term>
         <listitem>
-          <para>Print debug messages to STDERR.</para>
+          <para>Print debug messages to standard error.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         </listitem>
       </varlistentry>
       <varlistentry>