diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2017-02-19 20:02:12 -0500 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2017-02-22 11:52:31 -0500 |
commit | 770c4777c92c2c2b5763348135719478f36c3616 (patch) | |
tree | 757d5f677d0be0709b938dc21d678b3bb3785064 | |
parent | ee0755131de1986e816f8e003d848532f6e36f3e (diff) |
man: update descriptions of argument-less kernel cmdline args
This updates the man page for the changes introduced in 1d84ad944520fc3e062ef518c4db4e1d3a1866af.
"=" is kep if the option is predominantly used with an argument, and dropped
otherwise.
v2:
- update also description of log_color
- drop '=' in all cases where it is optional
(previous rule of dropping it only in some cases was just too arbitrary.)
-rw-r--r-- | man/kernel-command-line.xml | 14 | ||||
-rw-r--r-- | man/systemd.xml | 113 |
2 files changed, 67 insertions, 60 deletions
diff --git a/man/kernel-command-line.xml b/man/kernel-command-line.xml index f9ce4e0c69..f02ca3e7bc 100644 --- a/man/kernel-command-line.xml +++ b/man/kernel-command-line.xml @@ -78,16 +78,16 @@ <varlistentry> <term><varname>systemd.unit=</varname></term> <term><varname>rd.systemd.unit=</varname></term> - <term><varname>systemd.dump_core=</varname></term> - <term><varname>systemd.crash_chvt=</varname></term> - <term><varname>systemd.crash_shell=</varname></term> - <term><varname>systemd.crash_reboot=</varname></term> - <term><varname>systemd.confirm_spawn=</varname></term> - <term><varname>systemd.show_status=</varname></term> + <term><varname>systemd.dump_core</varname></term> + <term><varname>systemd.crash_chvt</varname></term> + <term><varname>systemd.crash_shell</varname></term> + <term><varname>systemd.crash_reboot</varname></term> + <term><varname>systemd.confirm_spawn</varname></term> + <term><varname>systemd.show_status</varname></term> <term><varname>systemd.log_target=</varname></term> <term><varname>systemd.log_level=</varname></term> - <term><varname>systemd.log_color=</varname></term> <term><varname>systemd.log_location=</varname></term> + <term><varname>systemd.log_color</varname></term> <term><varname>systemd.default_standard_output=</varname></term> <term><varname>systemd.default_standard_error=</varname></term> <term><varname>systemd.setenv=</varname></term> diff --git a/man/systemd.xml b/man/systemd.xml index c6f2613139..bc1563d5e1 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -51,10 +51,13 @@ <refsynopsisdiv> <cmdsynopsis> - <command>systemd <arg choice="opt" rep="repeat">OPTIONS</arg></command> + <command>systemd</command> + <arg choice="opt" rep="repeat">OPTIONS</arg> </cmdsynopsis> <cmdsynopsis> - <command>init <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg></command> + <command>init</command> + <arg choice="opt" rep="repeat">OPTIONS</arg> + <arg choice="req">COMMAND</arg> </cmdsynopsis> </refsynopsisdiv> @@ -150,6 +153,7 @@ user instance. This setting may also be enabled during boot, on the kernel command line via the <varname>systemd.crash_vt=</varname> option, see + <!-- FIXME: there is no crash_vt command line option? --> below.</para></listitem> </varlistentry> @@ -898,88 +902,91 @@ </varlistentry> <varlistentry> - <term><varname>systemd.dump_core=</varname></term> + <term><varname>systemd.dump_core</varname></term> - <listitem><para>Takes a boolean argument. If - <option>yes</option>, the systemd manager (PID 1) dumps core - when it crashes. Otherwise, no core dump is created. Defaults - to <option>yes</option>.</para></listitem> + <listitem><para>Takes a boolean argument or enables the option if specified + without an argument. If enabled, the systemd manager (PID 1) dumps core when + it crashes. Otherwise, no core dump is created. Defaults to enabled.</para> + </listitem> </varlistentry> <varlistentry> - <term><varname>systemd.crash_chvt=</varname></term> + <term><varname>systemd.crash_chvt</varname></term> - <listitem><para>Takes a positive integer, or a boolean - argument. If a positive integer (in the range 1–63) is - specified, the system manager (PID 1) will activate the specified - virtual terminal (VT) when it crashes. Defaults to - <constant>no</constant>, meaning that no such switch is - attempted. If set to <constant>yes</constant>, the VT the - kernel messages are written to is selected.</para></listitem> + <listitem><para>Takes a positive integer, or a boolean argument. Can be also + specified without an argument, with the same effect as a positive boolean. If + a positive integer (in the range 1–63) is specified, the system manager (PID + 1) will activate the specified virtual terminal (VT) when it + crashes. Defaults to disabled, meaning that no such switch is attempted. If + set to enabled, the VT the kernel messages are written to is selected. + </para></listitem> </varlistentry> <varlistentry> - <term><varname>systemd.crash_shell=</varname></term> + <term><varname>systemd.crash_shell</varname></term> - <listitem><para>Takes a boolean argument. If - <option>yes</option>, the system manager (PID 1) spawns a - shell when it crashes, after a 10s delay. Otherwise, no shell - is spawned. Defaults to <option>no</option>, for security - reasons, as the shell is not protected by password + <listitem><para>Takes a boolean argument or enables the option if specified + without an argument. If enabled, the system manager (PID 1) spawns a shell + when it crashes, after a 10s delay. Otherwise, no shell is spawned. Defaults + to disabled, for security reasons, as the shell is not protected by password authentication.</para></listitem> </varlistentry> <varlistentry> - <term><varname>systemd.crash_reboot=</varname></term> + <term><varname>systemd.crash_reboot</varname></term> - <listitem><para>Takes a boolean argument. If - <option>yes</option>, the system manager (PID 1) will reboot - the machine automatically when it crashes, after a 10s delay. - Otherwise, the system will hang indefinitely. Defaults to - <option>no</option>, in order to avoid a reboot loop. If - combined with <varname>systemd.crash_shell=</varname>, the + <listitem><para>Takes a boolean argument or enables the option if specified + without an argument. If enabled, the system manager (PID 1) will reboot the + machine automatically when it crashes, after a 10s delay. Otherwise, the + system will hang indefinitely. Defaults to disabled, in order to avoid a + reboot loop. If combined with <varname>systemd.crash_shell</varname>, the system is rebooted after the shell exits.</para></listitem> </varlistentry> <varlistentry> - <term><varname>systemd.confirm_spawn=</varname></term> + <term><varname>systemd.confirm_spawn</varname></term> - <listitem><para>Takes a boolean argument or a path to the - virtual console where the confirmation messages should be - emitted. If <option>yes</option>, the system manager (PID 1) - asks for confirmation when spawning processes using - <option>/dev/console</option>. If a path or a console name - (such as <literal>ttyS0</literal>) is provided, the virtual - console pointed to by this path or described by the give name - will be used instead. Defaults to <option>no</option>.</para></listitem> + <listitem><para>Takes a boolean argument or a path to the virtual console + where the confirmation messages should be emitted. Can be also specified + without an argument, with the same effect as a positive boolean. If enabled, + the system manager (PID 1) asks for confirmation when spawning processes + using <option>/dev/console</option>. If a path or a console name (such as + <literal>ttyS0</literal>) is provided, the virtual console pointed to by this + path or described by the give name will be used instead. Defaults to disabled. + </para></listitem> </varlistentry> <varlistentry> - <term><varname>systemd.show_status=</varname></term> + <term><varname>systemd.show_status</varname></term> - <listitem><para>Takes a boolean argument or the constant <constant>auto</constant>. If <option>yes</option>, - the systemd manager (PID 1) shows terse service status updates on the console during bootup. - <constant>auto</constant> behaves like <option>false</option> until a unit fails or there is a significant - delay in boot. Defaults to <option>yes</option>, unless <option>quiet</option> is passed as kernel command - line option, in which case it defaults to <constant>auto</constant>. If specified overrides the system manager - configuration file option <option>ShowStatus=</option>, see - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. However, - the process command line option <option>--show-status=</option> takes precedence over both this kernel command - line option and the configuration file option.</para></listitem> + <listitem><para>Takes a boolean argument or the constant + <constant>auto</constant>. Can be also specified without an argument, with + the same effect as a positive boolean. If enabled, the systemd manager (PID + 1) shows terse service status updates on the console during bootup. + <constant>auto</constant> behaves like <option>false</option> until a unit + fails or there is a significant delay in boot. Defaults to enabled, unless + <option>quiet</option> is passed as kernel command line option, in which case + it defaults to <constant>auto</constant>. If specified overrides the system + manager configuration file option <option>ShowStatus=</option>, see + <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + However, the process command line option <option>--show-status=</option> + takes precedence over both this kernel command line option and the + configuration file option.</para></listitem> </varlistentry> <varlistentry> <term><varname>systemd.log_target=</varname></term> <term><varname>systemd.log_level=</varname></term> - <term><varname>systemd.log_color=</varname></term> <term><varname>systemd.log_location=</varname></term> + <term><varname>systemd.log_color</varname></term> - <listitem><para>Controls log output, with the same effect as - the <varname>$SYSTEMD_LOG_TARGET</varname>, + <listitem><para>Controls log output, with the same effect as the + <varname>$SYSTEMD_LOG_TARGET</varname>, <varname>$SYSTEMD_LOG_LEVEL</varname>, - <varname>$SYSTEMD_LOG_COLOR</varname>, - <varname>$SYSTEMD_LOG_LOCATION</varname> environment variables - described above.</para></listitem> + <varname>$SYSTEMD_LOG_LOCATION</varname>, + <varname>$SYSTEMD_LOG_COLOR</varname> environment variables described above. + <varname>systemd.log_color</varname> can be specified without an argument, + with the same effect as a positive boolean.</para></listitem> </varlistentry> <varlistentry> |