diff options
Diffstat (limited to 'man/nmcli.1')
| -rw-r--r-- | man/nmcli.1 | 190 |
1 files changed, 96 insertions, 94 deletions
diff --git a/man/nmcli.1 b/man/nmcli.1 index 00ab979b..e16e5c16 100644 --- a/man/nmcli.1 +++ b/man/nmcli.1 @@ -2,12 +2,12 @@ .\" Title: nmcli .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 02/23/2019 +.\" Date: 03/15/2019 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.14.6 +.\" Source: NetworkManager 1.16.0 .\" Language: English .\" -.TH "NMCLI" "1" "" "NetworkManager 1\&.14\&.6" "General Commands Manual" +.TH "NMCLI" "1" "" "NetworkManager 1\&.16\&.0" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -39,7 +39,9 @@ is a command\-line tool for controlling NetworkManager and reporting network sta \fBnm\-applet\fR or other graphical clients\&. \fBnmcli\fR -is used to create, display, edit, delete, activate, and deactivate network connections, as well as control and display network device status\&. +is used to create, display, edit, delete, activate, and deactivate network connections, as well as control and display network device status\&. See +\fBnmcli-examples\fR(7) +for ready to run nmcli examples\&. .PP Typical uses include: .sp @@ -74,16 +76,83 @@ can be used to control NetworkManager without a GUI, including creating, editing .RE .SH "OPTIONS" .PP -\fB\-t\fR | \fB\-\-terse\fR +\fB\-a\fR | \fB\-\-ask\fR .RS 4 -Output is terse\&. This mode is designed and suitable for computer (script) processing\&. +When using this option +\fBnmcli\fR +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\&. .RE .PP -\fB\-p\fR | \fB\-\-pretty\fR +\fB\-c\fR | \fB\-\-colors\fR {yes | no | auto} .RS 4 -Output is pretty\&. This causes +This option controls color output (using terminal escape sequences)\&. +yes +enables colors, +no +disables them, +auto +only produces colors when standard output is directed to a terminal\&. The default value is +auto\&. +.sp +The actual colors used are configured as described in +\fBterminal-colors.d\fR(5)\&. Please refer to the +COLORS +section for a list of color names supported by +\fBnmcli\fR\&. +.RE +.PP +\fB\-\-complete\-args\fR +.RS 4 +Instead of conducting the desired action, \fBnmcli\fR -to produce easily readable outputs for humans, i\&.e\&. values are aligned, headers are printed, etc\&. +will list possible completions for the last argument\&. This is useful to implement argument completion in shell\&. +.sp +The +exit status +will indicate success or return a code 65 to indicate the last argument is a file name\&. +.sp +NetworkManager ships with command completion support for GNU Bash\&. +.RE +.PP +\fB\-e\fR | \fB\-\-escape\fR {yes | no} +.RS 4 +Whether to escape +: +and +\e +characters in terse tabular mode\&. The escape character is +\e\&. +.sp +If omitted, default is +yes\&. +.RE +.PP +\fB\-f\fR | \fB\-\-fields\fR {\fIfield1\fR,\fIfield2\fR... | all | common} +.RS 4 +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 +\fB\-\-fields\fR +option\&. +all +is used to print all valid field values of the command\&. +common +is used to print common field values of the command\&. +.sp +If omitted, default is +common\&. +.RE +.PP +\fB\-g\fR | \fB\-\-get\-values\fR {\fIfield1\fR,\fIfield2\fR... | all | common} +.RS 4 +This option is used to print values from specific fields\&. It is basically a shortcut for +\-\-mode tabular \-\-terse \-\-fields +and is a convenient way to retrieve values for particular fields\&. The values are printed one per line without headers\&. +.sp +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\&. +.RE +.PP +\fB\-h\fR | \fB\-\-help\fR +.RS 4 +Print help information\&. .RE .PP \fB\-m\fR | \fB\-\-mode\fR {tabular | multiline} @@ -128,72 +197,30 @@ nmcli device show .RE .RE .PP -\fB\-c\fR | \fB\-\-colors\fR {yes | no | auto} -.RS 4 -This option controls color output (using terminal escape sequences)\&. -yes -enables colors, -no -disables them, -auto -only produces colors when standard output is directed to a terminal\&. The default value is -auto\&. -.sp -The actual colors used are configured as described in -\fBterminal-colors.d\fR(5)\&. Please refer to the -COLORS -section for a list of color names supported by -\fBnmcli\fR\&. -.RE -.PP -\fB\-f\fR | \fB\-\-fields\fR {\fIfield1\fR,\fIfield2\fR... | all | common} -.RS 4 -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 -\fB\-\-fields\fR -option\&. -all -is used to print all valid field values of the command\&. -common -is used to print common field values of the command\&. -.sp -If omitted, default is -common\&. -.RE -.PP -\fB\-g\fR | \fB\-\-get\-values\fR {\fIfield1\fR,\fIfield2\fR... | all | common} +\fB\-p\fR | \fB\-\-pretty\fR .RS 4 -This option is used to print values from specific fields\&. It is basically a shortcut for -\-\-mode tabular \-\-terse \-\-fields -and is a convenient way to retrieve values for particular fields\&. The values are printed one per line without headers\&. -.sp -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\&. +Output is pretty\&. This causes +\fBnmcli\fR +to produce easily readable outputs for humans, i\&.e\&. values are aligned, headers are printed, etc\&. .RE .PP -\fB\-e\fR | \fB\-\-escape\fR {yes | no} +\fB\-s\fR | \fB\-\-show\-secrets\fR .RS 4 -Whether to escape -: -and -\e -characters in terse tabular mode\&. The escape character is -\e\&. -.sp -If omitted, default is -yes\&. +When using this option +\fBnmcli\fR +will display passwords and secrets that might be present in an output of an operation\&. This option also influences echoing passwords typed by user as an input\&. .RE .PP -\fB\-a\fR | \fB\-\-ask\fR +\fB\-t\fR | \fB\-\-terse\fR .RS 4 -When using this option -\fBnmcli\fR -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\&. +Output is terse\&. This mode is designed and suitable for computer (script) processing\&. .RE .PP -\fB\-s\fR | \fB\-\-show\-secrets\fR +\fB\-v\fR | \fB\-\-version\fR .RS 4 -When using this option +Show \fBnmcli\fR -will display passwords and secrets that might be present in an output of an operation\&. This option also influences echoing passwords typed by user as an input\&. +version\&. .RE .PP \fB\-w\fR | \fB\-\-wait\fR \fIseconds\fR @@ -208,31 +235,6 @@ instructs \fBnmcli\fR not to wait but to exit immediately with a status of success\&. The default value depends on the executed command\&. .RE -.PP -\fB\-\-complete\-args\fR -.RS 4 -Instead of conducting the desired action, -\fBnmcli\fR -will list possible completions for the last argument\&. This is useful to implement argument completion in shell\&. -.sp -The -exit status -will indicate success or return a code 65 to indicate the last argument is a file name\&. -.sp -NetworkManager ships with command completion support for GNU Bash\&. -.RE -.PP -\fB\-v\fR | \fB\-\-version\fR -.RS 4 -Show -\fBnmcli\fR -version\&. -.RE -.PP -\fB\-h\fR | \fB\-\-help\fR -.RS 4 -Print help information\&. -.RE .SH "GENERAL COMMANDS" .HP \w'\fBnmcli\ general\fR\ 'u \fBnmcli general\fR {\fBstatus\fR | \fBhostname\fR | \fBpermissions\fR | \fBlogging\fR} [\fIARGUMENTS\fR...] @@ -558,7 +560,7 @@ was not passed, NetworkManager can ask another secret agent that may be running .RS 4 Deactivate a connection from a device without preventing the device from further auto\-activation\&. Multiple connections can be passed to the command\&. .sp -Be aware that this command deactivates the specified active connection, but the device on which the connection was active, is still ready to connect and will perform auto\-activation by looking for a suitable connection that has the \*(Aqautoconnect\*(Aq flag set\&. This includes the just deactivated connection\&. So if the connection is set to auto\-connect, it will be automatically started on the disconnected device again\&. +Be aware that this command deactivates the specified active connection, but the device on which the connection was active, is still ready to connect and will perform auto\-activation by looking for a suitable connection that has the \*(Aqautoconnect\*(Aq flag set\&. Note that the deactivating connection profile is internally blocked from autoconnecting again\&. Hence it will not autoconnect until reboot or until the user performs an action that unblocks autoconnect, like modifying the profile or explicitly activating it\&. .sp In most cases you may want to use \fBdevice disconnect\fR @@ -1162,8 +1164,8 @@ can be used to either force or disable the scan regardless of how fresh the acce .PP \fBwifi\fR \fBconnect\fR \fI(B)SSID\fR [\fBpassword\fR\ \fIpassword\fR] [\fBwep\-key\-type\fR\ {key\ |\ phrase}] [\fBifname\fR\ \fIifname\fR] [\fBbssid\fR\ \fIBSSID\fR] [\fBname\fR\ \fIname\fR] [\fBprivate\fR\ {yes\ |\ no}] [\fBhidden\fR\ {yes\ |\ no}] .RS 4 -Connect to a Wi\-Fi network specified by SSID or BSSID\&. The command creates a new connection and then activates it on a device\&. This is a command\-line counterpart of clicking an SSID in a GUI client\&. The command always creates a new connection and thus it is mainly useful for connecting to new Wi\-Fi networks\&. If a connection for the network already exists, it is better to bring up (activate) the existing connection as follows: -\fBnmcli con up id \fR\fB\fIname\fR\fR\&. Note that only open, WEP and WPA\-PSK networks are supported at the moment\&. It is also supposed that IP configuration is obtained via DHCP\&. +Connect to a Wi\-Fi network specified by SSID or BSSID\&. The command finds a matching connection or creates one and then activates it on a device\&. This is a command\-line counterpart of clicking an SSID in a GUI client\&. If a connection for the network already exists, it is possible to bring up (activate) the existing profile as follows: +\fBnmcli con up id \fR\fB\fIname\fR\fR\&. Note that only open, WEP and WPA\-PSK networks are supported if no previous connection exists\&. It is also assumed that IP configuration is obtained via DHCP\&. .sp If \fB\-\-wait\fR @@ -2818,9 +2820,9 @@ shows all connection profile names and their auto\-connect property\&. shows details for "My default em1" connection profile\&. .RE .PP -\fBnmcli \-\-show\-secrets connection show "My Home WiFi"\fR +\fBnmcli \-\-show\-secrets connection show "My Home Wi\-Fi"\fR .RS 4 -shows details for "My Home WiFi" connection profile with all passwords\&. Without +shows details for "My Home Wi\-Fi" connection profile with all passwords\&. Without \fB\-\-show\-secrets\fR option, secrets would not be displayed\&. .RE |