fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-02-04 23:30:28 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

man: update nmcli manual page to stress that we can remove values by name

Browse source
This commit is contained in:
Jiří Klimeš 2014-02-25 14:09:26 +01:00
parent a5673d113c
commit 2ef197983f
1 changed files with 22 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
man/nmcli.1.in
View file

@ -21,7 +21,7 @@
.\"
.\" Copyright (C) 2010 - 2014 Red Hat, Inc.
.\"
.TH NMCLI "1" "17 February 2014"
.TH NMCLI "1" "25 February 2014"
.SH NAME
nmcli \- command\(hyline tool for controlling NetworkManager
@ -625,21 +625,24 @@ descriptions; and \fInmcli-examples\fP(5) for sample editor sessions.
Modify one or more properties in the connection profile.
.br
The connection is identified by its name, UUID or D-Bus path. If <ID> is
ambiguous, a keyword \fIid\fP, \fIuuid\fP or \fIpath\fP can be used.
See \fInm-settings\fP(5) for setting and property names, their descriptions
and default values. This command supports abbreviations for \fIsetting name\fP
and \fIproperty name\fP provided they are unique. Empty \fIvalue\fP ("")
removes the property value (sets the property to the default value).
The provided value overwrite the existing property value. If you want to
append to the existing value instead, use \fI+\fP prefix for the property name.
If you want to remove just one item from container-type property, use \fI-\fP
prefix for the property name and specify its index (or option name) as
\fIvalue\fP. Of course, it only has a real effect for multi-value (container)
properties like ipv4.dns, ipv4.addresses, bond.options, etc.
ambiguous, a keyword \fIid\fP, \fIuuid\fP or \fIpath\fP can be used. See
\fInm-settings\fP(5) for setting and property names, their descriptions and
default values. This command supports abbreviations for \fIsetting name\fP and
\fIproperty name\fP provided they are unique. Empty \fIvalue\fP ("") removes
the property value (sets the property to the default value). The provided
value overwrites the existing property value.
.br
The changes will be saved persistently by NetworkManager, unless
\fI--temporary\fP option is provided, in which case the changes won't persist
over NetworkManager restart.
If you want to append an item to the existing value, use \fI+\fP prefix for the
property name. If you want to remove just one item from container-type
property, use \fI-\fP prefix for the property name and specify a value or an
zero-based index of the item to remove (or option name for properties with
named options) as \fIvalue\fP. Of course, \fI+|-\fP only have a real effect for
multi-value (container) properties like ipv4.dns, ipv4.addresses, bond.options,
etc.
.br
The changes to the connection profile will be saved persistently by
NetworkManager, unless \fI--temporary\fP option is provided, in which case the
changes won't persist over NetworkManager restart.
.TP
.B delete [ id | uuid | path ] <ID>
.br
@ -916,6 +919,10 @@ sets manual addressing and the addresses in em1-1 profile.
.IP
appends a Google public DNS server to DNS servers in ABC profile.
.IP "\fB\f(CWnmcli con modify ABC -ipv4.addresses \(dq\&192.168.100.25/24 192.168.1.1\(dq\&\fP\fP"
.IP
removes the specified IP address from (static) profile ABC.
.SH NOTES
\fInmcli\fP accepts abbreviations, as long as they are a unique prefix in the set
of possible options. As new options get added, these abbreviations are not guaranteed