summaryrefslogtreecommitdiff
path: root/man/standard-options.xml
blob: 8ba5b09df85f291e4f0803b034085e5e3e1b8494 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->

<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>

  <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>

  <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>

  <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>

  <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>
</variablelist>