shaba/systemd-stable
1
1
Fork 0
mirror of https://github.com/systemd/systemd-stable.git synced 2025-01-21 18:03:41 +03:00
Code
systemd-stable/man/standard-options.xml

90 lines
3.1 KiB
XML
Raw Normal View History

man: drop mode line in file headers This is already included in .dir-locals, so we don't need it in the files themselves.
2018-07-02 23:15:39 +02:00
<?xml version="1.0"?>
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 14:40:58 +01:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 13:23:58 +09:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
Add missing headers and SPDX identifiers to man pages
2017-11-18 17:52:56 +01:00
man: xinclude --help/--version/--no-pager
2014-02-13 14:33:51 -05:00
<variablelist>
<varlistentry id='help'>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem id='help-text'>
<para>Print a short help text and exit.
</para></listitem>
</varlistentry>
<varlistentry id='version'>
<term><option>--version</option></term>
<listitem id='version-text'>
<para>Print a short version string and exit.</para>
</listitem>
</varlistentry>
<varlistentry id='no-pager'>
<term><option>--no-pager</option></term>
<listitem>
<para>Do not pipe output into a pager.</para>
</listitem>
</varlistentry>
man: use one description of --no-legend
2015-01-19 21:43:35 -05:00
add a new tool for creating transient mount and automount units This adds "systemd-mount" which is for transient mount and automount units what "systemd-run" is for transient service, scope and timer units. The tool allows establishing mounts and automounts during runtime. It is very similar to the usual /bin/mount commands, but can pull in additional dependenices on access (for example, it pulls in fsck automatically), an take benefit of the automount logic. This tool is particularly useful for mount removable file systems (such as USB sticks), as the automount logic (together with automatic unmount-on-idle), as well as automatic fsck on first access ensure that the removable file system has a high chance to remain in a fully clean state even when it is unplugged abruptly, and returns to a clean state on the next re-plug. This is a follow-up for #2471, as it adds a simple client-side for the transient automount logic added in that PR. In later work it might make sense to invoke this tool automatically from udev rules in order to implement a simpler and safer version of removable media management á la udisks.
2016-08-06 00:32:46 +02:00
<varlistentry id='no-ask-password'>
<term><option>--no-ask-password</option></term>
<listitem><para>Do not query the user for authentication for privileged operations.</para></listitem>
</varlistentry>
systemctl: hide legends with --quiet, allow overriding --no-legend is replaced by --legend=no. --quiet now implies --legend=no, but --legend=yes may be used to override that. --quiet controls hints and warnings and such, and --legend controls just the legends. I think it makes sense to allow both to controlled independently, in particular --quiet --legend makes sense when using systemctl in a script to provide some user-visible output. Fixes #18560.
2021-02-15 10:56:28 +01:00
<varlistentry id='legend'>
<term><option>--legend=</option><replaceable>BOOL</replaceable></term>
<listitem>
<para>Enable or disable printing of the legend, i.e. column headers and the footer with hints. The
legend is printed by default, unless disabled with <option>--quiet</option> or similar.</para>
</listitem>
</varlistentry>
man: use one description of --no-legend
2015-01-19 21:43:35 -05:00
<varlistentry id='no-legend'>
<term><option>--no-legend</option></term>
<listitem>
<para>Do not print the legend, i.e. column headers and the
footer with hints.</para>
</listitem>
</varlistentry>
tmpfiles: add --cat-config This implements similar logic as conf_files_cat(), but with slightly different file gathering logic. I also want to add support for replacement files later on, so it seems better to keep those two file-gathering functions separate.
2018-04-26 19:07:54 +02:00
<varlistentry id='cat-config'>
<term><option>--cat-config</option></term>
<listitem>
<para>Copy the contents of config files to standard output.
Before each file, the filename is printed as a comment.</para>
</listitem>
</varlistentry>
man: share a common explanation for --json=
2021-01-21 18:21:41 +01:00
<varlistentry id='json'>
<term><option>--json=</option><replaceable>MODE</replaceable></term>
<listitem><para>Shows output formatted as JSON. Expects one of <literal>short</literal> (for the
shortest possible output without any redundant whitespace or line breaks), <literal>pretty</literal>
(for a pretty version of the same, with indentation and line breaks) or <literal>off</literal> (to turn
off JSON output, the default).</para></listitem>
</varlistentry>
systemctl,loginctl,machinectl: use a shared helper for arg_signal I seems frivolous to yet another two -util.[ch] files, but the helper should be in shared/ and it doesn't seem to fit anywhere else.
2021-02-13 15:55:10 +01:00
<varlistentry id='signal'>
<term><option>-s</option></term>
<term><option>--signal=</option></term>
<listitem>
<para>When used with <command>kill</command>, choose which signal to send to selected processes. Must
be one of the well-known signal specifiers such as <constant>SIGTERM</constant>,
<constant>SIGINT</constant> or <constant>SIGSTOP</constant>. If omitted, defaults to
<option>SIGTERM</option>.</para>
<para>The special value <literal>help</literal> will list the known values and the program will exit
systemctl,loginctl,machinectl: add --signal=list This lists numerical signal values: $ systemctl --signal list SIGNAL NAME 1 SIGHUP 2 SIGINT 3 SIGQUIT ... 62 SIGRTMIN+28 63 SIGRTMIN+29 64 SIGRTMIN+30 This is useful when trying to kill e.g. systemd with a specific signal number using kill. kill doesn't accept our fancy signal names like RTMIN+4, so one would have to calculate that value somehow. Doing systemctl --signal list | grep -F RTMIN+4 is a nice way of doing that.
2021-02-13 16:03:03 +01:00
immediately, and the special value <literal>list</literal> will list known values along with the
numerical signal numbers and the program will exit immediately.</para>
systemctl,loginctl,machinectl: use a shared helper for arg_signal I seems frivolous to yet another two -util.[ch] files, but the helper should be in shared/ and it doesn't seem to fit anywhere else.
2021-02-13 15:55:10 +01:00
</listitem>
</varlistentry>
man: xinclude --help/--version/--no-pager
2014-02-13 14:33:51 -05:00
</variablelist>
Copy Permalink