summaryrefslogtreecommitdiff
path: root/man/nmcli.xml
diff options
context:
space:
mode:
authorFrancesco Giudici <fgiudici@redhat.com>2017-01-17 14:20:56 +0100
committerFrancesco Giudici <fgiudici@redhat.com>2017-03-28 10:55:00 +0200
commitf4d0417c8d2311205a575afcda59d813614d43fd (patch)
tree98c8f51b1b2a39b3274a876f2b1971cda4330219 /man/nmcli.xml
parenta62b72272fe3013b1a47fbd3b1ec1c31fd9969c9 (diff)
downloadNetworkManager-f4d0417c8d2311205a575afcda59d813614d43fd.tar.gz
nmcli: add -g[et-values] option as a '-m tab -t -f <arg>' shortcut
Quick and easy way to get clean and parsable field values.
Diffstat (limited to 'man/nmcli.xml')
-rw-r--r--man/nmcli.xml28
1 files changed, 24 insertions, 4 deletions
diff --git a/man/nmcli.xml b/man/nmcli.xml
index a2d9223c3f..8ee7914b15 100644
--- a/man/nmcli.xml
+++ b/man/nmcli.xml
@@ -205,10 +205,30 @@
command. <literal>common</literal> is used to print common field values of
the command.</para>
- <para>If omitted, default is <literal>common</literal>. The option is
- mandatory when <option>--terse</option> is used. In this case, generic values
- <literal>all</literal> and <literal>common</literal> cannot be used. This
- is to maintain compatibility when new fields are added in the future.</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>