From: Lennart Poettering <lennart@poettering.net>
Date: Thu, 2 Nov 2017 18:40:35 +0000 (+0300)
Subject: man: update SyslogXYZ= documentation a bit
X-Git-Tag: v236~198^2~3
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4d14b2bd35916dc35dc8669e89e6a01fcbd6c861;p=thirdparty%2Fsystemd.git

man: update SyslogXYZ= documentation a bit

Let's clarify that these settings only apply to stdout/stderr logging.
Always mention the journal before syslog (as the latter is in most ways
just a legacy alias these days). Always mention the +console cases too.
---

diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
index 8b538edf779..4a97b1d2037 100644
--- a/man/systemd.exec.xml
+++ b/man/systemd.exec.xml
@@ -686,81 +686,61 @@
         that the screen and scrollback buffer is cleared. Defaults to
         <literal>no</literal>.</para></listitem>
       </varlistentry>
+
       <varlistentry>
         <term><varname>SyslogIdentifier=</varname></term>
-        <listitem><para>Sets the process name to prefix log lines sent
-        to the logging system or the kernel log buffer with. If not
-        set, defaults to the process name of the executed process.
-        This option is only useful when
-        <varname>StandardOutput=</varname> or
-        <varname>StandardError=</varname> are set to
-        <option>syslog</option>, <option>journal</option> or
-        <option>kmsg</option> (or to the same settings in combination
-        with <option>+console</option>).</para></listitem>
+        <listitem><para>Sets the process name ("<command>syslog</command> tag") to prefix log lines sent to the logging
+        system or the kernel log buffer with. If not set, defaults to the process name of the executed process.  This
+        option is only useful when <varname>StandardOutput=</varname> or <varname>StandardError=</varname> are set to
+        <option>journal</option>, <option>syslog</option> or <option>kmsg</option> (or to the same settings in
+        combination with <option>+console</option>) and only applies to log messages written to stdout or
+        stderr.</para></listitem>
       </varlistentry>
+
       <varlistentry>
         <term><varname>SyslogFacility=</varname></term>
-        <listitem><para>Sets the syslog facility to use when logging
-        to syslog. One of <option>kern</option>,
-        <option>user</option>, <option>mail</option>,
-        <option>daemon</option>, <option>auth</option>,
-        <option>syslog</option>, <option>lpr</option>,
-        <option>news</option>, <option>uucp</option>,
-        <option>cron</option>, <option>authpriv</option>,
-        <option>ftp</option>, <option>local0</option>,
-        <option>local1</option>, <option>local2</option>,
-        <option>local3</option>, <option>local4</option>,
-        <option>local5</option>, <option>local6</option> or
-        <option>local7</option>. See
+        <listitem><para>Sets the <command>syslog</command> facility identifier to use when logging. One of
+        <option>kern</option>, <option>user</option>, <option>mail</option>, <option>daemon</option>,
+        <option>auth</option>, <option>syslog</option>, <option>lpr</option>, <option>news</option>,
+        <option>uucp</option>, <option>cron</option>, <option>authpriv</option>, <option>ftp</option>,
+        <option>local0</option>, <option>local1</option>, <option>local2</option>, <option>local3</option>,
+        <option>local4</option>, <option>local5</option>, <option>local6</option> or <option>local7</option>. See
         <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
-        for details. This option is only useful when
-        <varname>StandardOutput=</varname> or
-        <varname>StandardError=</varname> are set to
-        <option>syslog</option>. Defaults to
-        <option>daemon</option>.</para></listitem>
+        for details. This option is only useful when <varname>StandardOutput=</varname> or
+        <varname>StandardError=</varname> are set to <option>journal</option>, <option>syslog</option> or
+        <option>kmsg</option> (or to the same settings in combination with <option>+console</option>), and only applies
+        to log messages written to stdout or stderr. Defaults to <option>daemon</option>.</para></listitem>
       </varlistentry>
+
       <varlistentry>
         <term><varname>SyslogLevel=</varname></term>
-        <listitem><para>The default syslog level to use when logging to
-        syslog or the kernel log buffer. One of
-        <option>emerg</option>,
-        <option>alert</option>,
-        <option>crit</option>,
-        <option>err</option>,
-        <option>warning</option>,
-        <option>notice</option>,
-        <option>info</option>,
-        <option>debug</option>. See
-        <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
-        for details. This option is only useful when
-        <varname>StandardOutput=</varname> or
-        <varname>StandardError=</varname> are set to
-        <option>syslog</option> or <option>kmsg</option>. Note that
-        individual lines output by the daemon might be prefixed with a
-        different log level which can be used to override the default
-        log level specified here. The interpretation of these prefixes
-        may be disabled with <varname>SyslogLevelPrefix=</varname>,
-        see below. For details, see
-        <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
+        <listitem><para>The default <command>syslog</command> log level to use when logging to the logging system or
+        the kernel log buffer. One of <option>emerg</option>, <option>alert</option>, <option>crit</option>,
+        <option>err</option>, <option>warning</option>, <option>notice</option>, <option>info</option>,
+        <option>debug</option>. See <citerefentry
+        project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
+        details. This option is only useful when <varname>StandardOutput=</varname> or
+        <varname>StandardError=</varname> are set to <option>journal</option>, <option>syslog</option> or
+        <option>kmsg</option> (or to the same settings in combination with <option>+console</option>), and only applies
+        to log messages written to stdout or stderr. Note that individual lines output by executed processes may be
+        prefixed with a different log level which can be used to override the default log level specified here. The
+        interpretation of these prefixes may be disabled with <varname>SyslogLevelPrefix=</varname>, see below. For
+        details, see <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
 
-        Defaults to
-        <option>info</option>.</para></listitem>
+        Defaults to <option>info</option>.</para></listitem>
       </varlistentry>
 
       <varlistentry>
         <term><varname>SyslogLevelPrefix=</varname></term>
-        <listitem><para>Takes a boolean argument. If true and
-        <varname>StandardOutput=</varname> or
-        <varname>StandardError=</varname> are set to
-        <option>syslog</option>, <option>kmsg</option> or
-        <option>journal</option>, log lines written by the executed
-        process that are prefixed with a log level will be passed on
-        to syslog with this log level set but the prefix removed. If
-        set to false, the interpretation of these prefixes is disabled
-        and the logged lines are passed on as-is. For details about
-        this prefixing see
-        <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
-        Defaults to true.</para></listitem>
+        <listitem><para>Takes a boolean argument. If true and <varname>StandardOutput=</varname> or
+        <varname>StandardError=</varname> are set to <option>journal</option>, <option>syslog</option> or
+        <option>kmsg</option> (or to the same settings in combination with <option>+console</option>), log lines
+        written by the executed process that are prefixed with a log level will be processed with this log level set
+        but the prefix removed. If set to false, the interpretation of these prefixes is disabled and the logged lines
+        are passed on as-is. This only applies to log messages written to stdout or stderr.  For details
+        about this prefixing see
+        <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.  Defaults to
+        true.</para></listitem>
       </varlistentry>
 
       <varlistentry>