fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-01-20 14:51:35 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

man: merge branch 'bg/man'

Browse source 
Some small improvements to man pages and program help

https://gitlab.freedesktop.org/NetworkManager/NetworkManager/merge_requests/41
This commit is contained in:
Beniamino Galvani 2018-11-05 09:40:26 +01:00
commit c7371ff441
5 changed files with 190 additions and 178 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
clients/cli/devices.c
View file

@ -703,7 +703,7 @@ usage (void)
" disconnect <ifname> ...\n\n"
" delete <ifname> ...\n\n"
" monitor <ifname> ...\n\n"
" wifi [list [ifname <ifname>] [bssid <BSSID>]]\n\n"
" wifi [list [ifname <ifname>] [bssid <BSSID>] [--rescan yes|no|auto]]\n\n"
" wifi connect <(B)SSID> [password <password>] [wep-key-type key|phrase] [ifname <ifname>]\n"
" [bssid <BSSID>] [name <name>] [private yes|no] [hidden yes|no]\n\n"
" wifi hotspot [ifname <ifname>] [con-name <name>] [ssid <SSID>] [band a|bg] [channel <channel>] [password <password>]\n\n"
@ -838,10 +838,11 @@ usage_device_wifi (void)
"\n"
"Perform operation on Wi-Fi devices.\n"
"\n"
"ARGUMENTS := [list [ifname <ifname>] [bssid <BSSID>]]\n"
"ARGUMENTS := [list [ifname <ifname>] [bssid <BSSID>] [--rescan yes|no|auto]]\n"
"\n"
"List available Wi-Fi access points. The 'ifname' and 'bssid' options can be\n"
"used to list APs for a particular interface, or with a specific BSSID.\n"
"used to list APs for a particular interface, or with a specific BSSID. The"
"--rescan flags tells whether a new wifi scan should be triggered.\n"
"\n"
"ARGUMENTS := connect <(B)SSID> [password <password>] [wep-key-type key|phrase] [ifname <ifname>]\n"
" [bssid <BSSID>] [name <name>] [private yes|no] [hidden yes|no]\n"

26
clients/cli/nmcli.c
View file

@ -245,19 +245,19 @@ usage (void)
g_printerr (_("Usage: nmcli [OPTIONS] OBJECT { COMMAND | help }\n"
"\n"
"OPTIONS\n"
" -o[verview] overview mode (hide default values)\n"
" -t[erse] terse output\n"
" -p[retty] pretty output\n"
" -m[ode] tabular|multiline output mode\n"
" -c[olors] auto|yes|no whether to use colors in output\n"
" -f[ields] <field1,field2,...>|all|common specify fields to output\n"
" -g[et-values] <field1,field2,...>|all|common shortcut for -m tabular -t -f\n"
" -e[scape] yes|no escape columns separators in values\n"
" -a[sk] ask for missing parameters\n"
" -s[how-secrets] allow displaying passwords\n"
" -w[ait] <seconds> set timeout waiting for finishing operations\n"
" -v[ersion] show program version\n"
" -h[elp] print this help\n"
" -a, --ask ask for missing parameters\n"
" -c, --colors auto|yes|no whether to use colors in output\n"
" -e, --escape yes|no escape columns separators in values\n"
" -f, --fields <field,...>|all|common specify fields to output\n"
" -g, --get-values <field,...>|all|common shortcut for -m tabular -t -f\n"
" -h, --help print this help\n"
" -m, --mode tabular|multiline output mode\n"
" -o, --overview overview mode\n"
" -p, --pretty pretty output\n"
" -s, --show-secrets allow displaying passwords\n"
" -t, --terse terse output\n"
" -v, --version how program version\n"
" -w, --wait <seconds> set timeout waiting for finishing operations\n"
"\n"
"OBJECT\n"
" g[eneral] NetworkManager's general status and operations\n"

4
clients/nm-online.c
View file

@ -249,10 +249,10 @@ main (int argc, char *argv[])
GOptionContext *opt_ctx = NULL;
gboolean success;
GOptionEntry options[] = {
{"timeout", 't', 0, G_OPTION_ARG_INT, &t_secs, N_("Time to wait for a connection, in seconds (without the option, default value is 30)"), "<timeout>"},
{"exit", 'x', 0, G_OPTION_ARG_NONE, &data.exit_no_nm, N_("Exit immediately if NetworkManager is not running or connecting"), NULL},
{"quiet", 'q', 0, G_OPTION_ARG_NONE, &data.quiet, N_("Don't print anything"), NULL},
{"wait-for-startup", 's', 0, G_OPTION_ARG_NONE, &data.wait_startup, N_("Wait for NetworkManager startup instead of a connection"), NULL},
{"timeout", 't', 0, G_OPTION_ARG_INT, &t_secs, N_("Time to wait for a connection, in seconds (without the option, default value is 30)"), "<timeout>"},
{"exit", 'x', 0, G_OPTION_ARG_NONE, &data.exit_no_nm, N_("Exit immediately if NetworkManager is not running or connecting"), NULL},
{ NULL },
};

49
man/nm-online.xml
View file

@ -67,30 +67,14 @@
<refsect1 id='options'><title>Options</title>
<variablelist>
<varlistentry>
<term>
<group choice='plain'>
<arg choice='plain'><option>-t</option></arg>
<arg choice='plain'><option>--timeout</option></arg>
</group>
<arg choice='plain'><replaceable>seconds</replaceable></arg>
</term>
<listitem>
<para>Time to wait for a connection, in seconds. If the option is not provided,
the default timeout is 30 seconds.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-x</option></arg>
<arg choice='plain'><option>--exit</option></arg>
<arg choice='plain'><option>-h</option></arg>
<arg choice='plain'><option>--help</option></arg>
</group></term>
<listitem>
<para>Exit immediately if NetworkManager is not running or connecting.</para>
<para>Print help information.</para>
</listitem>
</varlistentry>
@ -122,6 +106,33 @@
</listitem>
</varlistentry>
<varlistentry>
<term>
<group choice='plain'>
<arg choice='plain'><option>-t</option></arg>
<arg choice='plain'><option>--timeout</option></arg>
</group>
<arg choice='plain'><replaceable>seconds</replaceable></arg>
</term>
<listitem>
<para>Time to wait for a connection, in seconds. If the option is not provided,
the default timeout is 30 seconds.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-x</option></arg>
<arg choice='plain'><option>--exit</option></arg>
</group></term>
<listitem>
<para>Exit immediately if NetworkManager is not running or connecting.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

282
man/nmcli.xml
View file

@ -95,26 +95,130 @@
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-t</option></arg>
<arg choice='plain'><option>--terse</option></arg>
<arg choice='plain'><option>-a</option></arg>
<arg choice='plain'><option>--ask</option></arg>
</group></term>
<listitem>
<para>Output is terse. This mode is designed and suitable for computer (script)
processing.</para>
<para>When using this option <command>nmcli</command> will stop and ask for any
missing required arguments, so do not use this option for non-interactive
purposes like scripts. This option controls, for example, whether you will be
prompted for a password if it is required for connecting to a network.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-p</option></arg>
<arg choice='plain'><option>--pretty</option></arg>
<arg choice='plain'><option>-c</option></arg>
<arg choice='plain'><option>--colors</option></arg>
<group choice='req'>
<arg choice='plain'>yes</arg>
<arg choice='plain'>no</arg>
<arg choice='plain'>auto</arg>
</group>
</group></term>
<listitem>
<para>Output is pretty. This causes <command>nmcli</command> to produce easily
readable outputs for humans, i.e. values are aligned, headers are printed,
etc.</para>
<para>This option controls color output (using terminal escape sequences).
<literal>yes</literal> enables colors, <literal>no</literal> disables them,
<literal>auto</literal> only produces colors when standard output is directed
to a terminal. The default value is <literal>auto</literal>.</para>
<para>The actual colors used are configured as described in
<citerefentry><refentrytitle>terminal-colors.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Please refer to the <link linkend='colors' endterm='colors.title' /> section for a
list of color names supported by <command>nmcli</command>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>--complete-args</option></arg>
</group></term>
<listitem>
<para>Instead of conducting the desired action, <command>nmcli</command>
will list possible completions for the last argument. This is useful to implement
argument completion in shell.</para>
<para>The <link linkend='exit_status'>exit status</link> will indicate success
or return a code 65 to indicate the last argument is a file name.</para>
<para>NetworkManager ships with command completion support for GNU Bash.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-e</option></arg>
<arg choice='plain'><option>--escape</option></arg>
<group choice='req'>
<arg choice='plain'>yes</arg>
<arg choice='plain'>no</arg>
</group>
</group></term>
<listitem>
<para>Whether to escape <literal>:</literal> and <literal>\</literal> characters in terse tabular mode. The
escape character is <literal>\</literal>.</para>
<para>If omitted, default is <literal>yes</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-f</option></arg>
<arg choice='plain'><option>--fields</option></arg>
<group choice='req'>
<arg choice='plain' rep='repeat'><replaceable>field1</replaceable>,<replaceable>field2</replaceable></arg>
<arg choice='plain'>all</arg>
<arg choice='plain'>common</arg>
</group>
</group></term>
<listitem>
<para>This option is used to specify what fields (column names) should be
printed. Valid field names differ for specific commands. List available fields
by providing an invalid value to the <option>--fields</option> option.
<literal>all</literal> is used to print all valid field values of the
command. <literal>common</literal> is used to print common field values of
the command.</para>
<para>If omitted, default is <literal>common</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-g</option></arg>
<arg choice='plain'><option>--get-values</option></arg>
<group choice='req'>
<arg choice='plain' rep='repeat'><replaceable>field1</replaceable>,<replaceable>field2</replaceable></arg>
<arg choice='plain'>all</arg>
<arg choice='plain'>common</arg>
</group>
</group></term>
<listitem>
<para>This option is used to print values from specific fields. It is basically
a shortcut for <literal>--mode tabular --terse --fields</literal> and is a convenient
way to retrieve values for particular fields. The values are printed one per line
without headers.</para>
<para>If a section is specified instead of a field, the section name will be printed
followed by colon separated values of the fields belonging to that section, all on
the same line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-h</option></arg>
<arg choice='plain'><option>--help</option></arg>
</group></term>
<listitem>
<para>Print help information.</para>
</listitem>
</varlistentry>
@ -169,102 +273,14 @@
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-c</option></arg>
<arg choice='plain'><option>--colors</option></arg>
<group choice='req'>
<arg choice='plain'>yes</arg>
<arg choice='plain'>no</arg>
<arg choice='plain'>auto</arg>
</group>
<arg choice='plain'><option>-p</option></arg>
<arg choice='plain'><option>--pretty</option></arg>
</group></term>
<listitem>
<para>This option controls color output (using terminal escape sequences).
<literal>yes</literal> enables colors, <literal>no</literal> disables them,
<literal>auto</literal> only produces colors when standard output is directed
to a terminal. The default value is <literal>auto</literal>.</para>
<para>The actual colors used are configured as described in
<citerefentry><refentrytitle>terminal-colors.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Please refer to the <link linkend='colors' endterm='colors.title' /> section for a
list of color names supported by <command>nmcli</command>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-f</option></arg>
<arg choice='plain'><option>--fields</option></arg>
<group choice='req'>
<arg choice='plain' rep='repeat'><replaceable>field1</replaceable>,<replaceable>field2</replaceable></arg>
<arg choice='plain'>all</arg>
<arg choice='plain'>common</arg>
</group>
</group></term>
<listitem>
<para>This option is used to specify what fields (column names) should be
printed. Valid field names differ for specific commands. List available fields
by providing an invalid value to the <option>--fields</option> option.
<literal>all</literal> is used to print all valid field values of the
command. <literal>common</literal> is used to print common field values of
the command.</para>
<para>If omitted, default is <literal>common</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-g</option></arg>
<arg choice='plain'><option>--get-values</option></arg>
<group choice='req'>
<arg choice='plain' rep='repeat'><replaceable>field1</replaceable>,<replaceable>field2</replaceable></arg>
<arg choice='plain'>all</arg>
<arg choice='plain'>common</arg>
</group>
</group></term>
<listitem>
<para>This option is used to print values from specific fields. It is basically
a shortcut for <literal>--mode tabular --terse --fields</literal> and is a convenient
way to retrieve values for particular fields. The values are printed one per line
without headers.</para>
<para>If a section is specified instead of a field, the section name will be printed
followed by colon separated values of the fields belonging to that section, all on
the same line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-e</option></arg>
<arg choice='plain'><option>--escape</option></arg>
<group choice='req'>
<arg choice='plain'>yes</arg>
<arg choice='plain'>no</arg>
</group>
</group></term>
<listitem>
<para>Whether to escape <literal>:</literal> and <literal>\</literal> characters in terse tabular mode. The
escape character is <literal>\</literal>.</para>
<para>If omitted, default is <literal>yes</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-a</option></arg>
<arg choice='plain'><option>--ask</option></arg>
</group></term>
<listitem>
<para>When using this option <command>nmcli</command> will stop and ask for any
missing required arguments, so do not use this option for non-interactive
purposes like scripts. This option controls, for example, whether you will be
prompted for a password if it is required for connecting to a network.</para>
<para>Output is pretty. This causes <command>nmcli</command> to produce easily
readable outputs for humans, i.e. values are aligned, headers are printed,
etc.</para>
</listitem>
</varlistentry>
@ -281,6 +297,29 @@
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-t</option></arg>
<arg choice='plain'><option>--terse</option></arg>
</group></term>
<listitem>
<para>Output is terse. This mode is designed and suitable for computer (script)
processing.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-v</option></arg>
<arg choice='plain'><option>--version</option></arg>
</group></term>
<listitem>
<para>Show <command>nmcli</command> version.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-w</option></arg>
@ -300,45 +339,6 @@
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>--complete-args</option></arg>
</group></term>
<listitem>
<para>Instead of conducting the desired action, <command>nmcli</command>
will list possible completions for the last argument. This is useful to implement
argument completion in shell.</para>
<para>The <link linkend='exit_status'>exit status</link> will indicate success
or return a code 65 to indicate the last argument is a file name.</para>
<para>NetworkManager ships with command completion support for GNU Bash.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-v</option></arg>
<arg choice='plain'><option>--version</option></arg>
</group></term>
<listitem>
<para>Show <command>nmcli</command> version.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><group choice='plain'>
<arg choice='plain'><option>-h</option></arg>
<arg choice='plain'><option>--help</option></arg>
</group></term>
<listitem>
<para>Print help information.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>