]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/standard-options.xml
Merge pull request #18007 from fw-strlen/ipv6_masq_and_dnat
[thirdparty/systemd.git] / man / standard-options.xml
CommitLineData
514094f9 1<?xml version="1.0"?>
3a54a157
ZJS
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
db9ecf05 4<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
f48f7543 5
dfdebb1b
ZJS
6<variablelist>
7 <varlistentry id='help'>
8 <term><option>-h</option></term>
9 <term><option>--help</option></term>
10
11 <listitem id='help-text'>
12 <para>Print a short help text and exit.
13 </para></listitem>
14 </varlistentry>
15
16 <varlistentry id='version'>
17 <term><option>--version</option></term>
18
19 <listitem id='version-text'>
20 <para>Print a short version string and exit.</para>
21 </listitem>
22 </varlistentry>
23
24 <varlistentry id='no-pager'>
25 <term><option>--no-pager</option></term>
26
27 <listitem>
28 <para>Do not pipe output into a pager.</para>
29 </listitem>
30 </varlistentry>
12f15e59 31
450442cf
LP
32 <varlistentry id='no-ask-password'>
33 <term><option>--no-ask-password</option></term>
34
35 <listitem><para>Do not query the user for authentication for privileged operations.</para></listitem>
36 </varlistentry>
37
12f15e59
ZJS
38 <varlistentry id='no-legend'>
39 <term><option>--no-legend</option></term>
40
41 <listitem>
42 <para>Do not print the legend, i.e. column headers and the
43 footer with hints.</para>
44 </listitem>
45 </varlistentry>
ceaaeb9b
ZJS
46
47 <varlistentry id='cat-config'>
48 <term><option>--cat-config</option></term>
49
50 <listitem>
51 <para>Copy the contents of config files to standard output.
52 Before each file, the filename is printed as a comment.</para>
53 </listitem>
54 </varlistentry>
8d0d1a30
LP
55
56 <varlistentry id='json'>
57 <term><option>--json=</option><replaceable>MODE</replaceable></term>
58
59 <listitem><para>Shows output formatted as JSON. Expects one of <literal>short</literal> (for the
60 shortest possible output without any redundant whitespace or line breaks), <literal>pretty</literal>
61 (for a pretty version of the same, with indentation and line breaks) or <literal>off</literal> (to turn
62 off JSON output, the default).</para></listitem>
63 </varlistentry>
86beb213
ZJS
64
65 <varlistentry id='signal'>
66 <term><option>-s</option></term>
67 <term><option>--signal=</option></term>
68
69 <listitem>
70 <para>When used with <command>kill</command>, choose which signal to send to selected processes. Must
71 be one of the well-known signal specifiers such as <constant>SIGTERM</constant>,
72 <constant>SIGINT</constant> or <constant>SIGSTOP</constant>. If omitted, defaults to
73 <option>SIGTERM</option>.</para>
74
75 <para>The special value <literal>help</literal> will list the known values and the program will exit
97ab9dfc
ZJS
76 immediately, and the special value <literal>list</literal> will list known values along with the
77 numerical signal numbers and the program will exit immediately.</para>
86beb213
ZJS
78 </listitem>
79 </varlistentry>
dfdebb1b 80</variablelist>