From eedaf7f322a850c5d9f49346d43420423fc6f593 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Mon, 24 Jun 2019 15:21:22 +0200 Subject: [PATCH] man: drop references to "syslog" and "syslog+console" from man page These options are pretty much equivalent to "journal" and "journal+console" anyway, let's simplify things, and drop them from the documentation hence. For compat reasons let's keep them in the code. (Note that they are not 100% identical to 'journal', but I doubt the distinction in behaviour is really relevant to keep this in the docs. And we should probably should drop 'syslog' entirely from our codebase eventually, but it's problematic as long as we semi-support udev on non-systemd systems still.) --- man/systemd.exec.xml | 86 ++++++++++++++++++++++---------------------- man/systemd.xml | 2 -- 2 files changed, 43 insertions(+), 45 deletions(-) diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index f333c2c812..8f7d64d017 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -1936,12 +1936,12 @@ SystemCallErrorNumber=EPERM StandardOutput= - Controls where file descriptor 1 (STDOUT) of the executed processes is connected to. Takes one - of , , , , - , , , - , , - , , - or . + Controls where file descriptor 1 (STDOUT) of the executed processes is connected + to. Takes one of , , , + , , , + , , + , or + . duplicates the file descriptor of standard input for standard output. @@ -1952,23 +1952,20 @@ SystemCallErrorNumber=EPERM see below). If the TTY is used for output only, the executed process will not become the controlling process of the terminal, and will not fail or wait for other processes to release the terminal. - connects standard output with the journal which is accessible via - journalctl1. Note that - everything that is written to syslog or kmsg (see below) is implicitly stored in the journal as well, the - specific two options listed below are hence supersets of this one. - - connects standard output to the syslog3 system syslog - service, in addition to the journal. Note that the journal daemon is usually configured to forward everything - it receives to syslog anyway, in which case this option is no different from . + connects standard output with the journal, which is accessible via + journalctl1. Note + that everything that is written to kmsg (see below) is implicitly stored in the journal as well, the + specific option listed below is hence a superset of this one. (Also note that any external, + additional syslog daemons receive their log data from the journal, too, hence this is the option to + use when logging shall be processed with such a daemon.) connects standard output with the kernel log buffer which is accessible via dmesg1, in addition to the journal. The journal daemon might be configured to send all logs to kmsg anyway, in which case this option is no different from . - , and work - in a similar way as the three options above but copy the output to the system console as well. + and work in a similar way as the + two options above but copy the output to the system console as well. The option may be used to connect a specific file system object to standard output. The semantics are similar to the same option of @@ -1997,13 +1994,14 @@ SystemCallErrorNumber=EPERM systemd.socket5 for more details about named descriptors and their ordering. - If the standard output (or error output, see below) of a unit is connected to the journal, syslog or the - kernel log buffer, the unit will implicitly gain a dependency of type After= on - systemd-journald.socket (also see the "Implicit Dependencies" section above). Also note - that in this case stdout (or stderr, see below) will be an AF_UNIX stream socket, and not - a pipe or FIFO that can be re-opened. This means when executing shell scripts the construct echo - "hello" > /dev/stderr for writing text to stderr will not work. To mitigate this use the construct - echo "hello" >&2 instead, which is mostly equivalent and avoids this pitfall. + If the standard output (or error output, see below) of a unit is connected to the journal or + the kernel log buffer, the unit will implicitly gain a dependency of type After= + on systemd-journald.socket (also see the "Implicit Dependencies" section + above). Also note that in this case stdout (or stderr, see below) will be an + AF_UNIX stream socket, and not a pipe or FIFO that can be re-opened. This means + when executing shell scripts the construct echo "hello" > /dev/stderr for + writing text to stderr will not work. To mitigate this use the construct echo "hello" + >&2 instead, which is mostly equivalent and avoids this pitfall. This setting defaults to the value set with DefaultStandardOutput= in systemd-system.conf5, which @@ -2121,12 +2119,12 @@ StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy SyslogIdentifier= - Sets the process name ("syslog 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 StandardOutput= or StandardError= are set to - , or (or to the same settings in - combination with ) and only applies to log messages written to stdout or - stderr. + Sets the process name ("syslog 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 StandardOutput= or + StandardError= are set to or (or to + the same settings in combination with ) and only applies to log messages + written to stdout or stderr. @@ -2137,12 +2135,13 @@ StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy , , , , , , , , , , , , - , , or . See - syslog3 - for details. This option is only useful when StandardOutput= or - StandardError= are set to , or - (or to the same settings in combination with ), and only applies - to log messages written to stdout or stderr. Defaults to . + , , or + . See syslog3 for + details. This option is only useful when StandardOutput= or + StandardError= are set to or (or to + the same settings in combination with ), and only applies to log messages + written to stdout or stderr. Defaults to . @@ -2154,7 +2153,7 @@ StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy . See syslog3 for details. This option is only useful when StandardOutput= or - StandardError= are set to , or + StandardError= are set to or (or to the same settings in combination with ), 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 @@ -2167,12 +2166,13 @@ StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy SyslogLevelPrefix= Takes a boolean argument. If true and StandardOutput= or - StandardError= are set to , or - (or to the same settings in combination with ), 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 sd-daemon3. + StandardError= are set to or (or to + the same settings in combination with ), 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 + sd-daemon3. Defaults to true. diff --git a/man/systemd.xml b/man/systemd.xml index 7ede4e3f40..dfd77a474d 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -234,8 +234,6 @@ , , , - , - , , . If the argument is omitted