From 9a6dcbf895f9da01768e64b73cec88c16157d91e Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 26 Mar 2019 23:25:23 +0100 Subject: New upstream version 1.16.0 --- man/nmcli.xml | 236 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 119 insertions(+), 117 deletions(-) (limited to 'man/nmcli.xml') diff --git a/man/nmcli.xml b/man/nmcli.xml index 2a0765d0..3f123a57 100644 --- a/man/nmcli.xml +++ b/man/nmcli.xml @@ -68,7 +68,9 @@ replacement for nm-applet or other graphical clients. nmcli is used to create, display, edit, delete, activate, and deactivate network connections, as well as control and display network - device status. + device status. See + nmcli-examples7 + for ready to run nmcli examples. Typical uses include: @@ -95,98 +97,73 @@ - - + + - Output is terse. This mode is designed and suitable for computer (script) - processing. + When using this option nmcli 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. - - + + + + yes + no + auto + - Output is pretty. This causes nmcli to produce easily - readable outputs for humans, i.e. values are aligned, headers are printed, - etc. + 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. + The actual colors used are configured as described in + terminal-colors.d5. + Please refer to the section for a + list of color names supported by nmcli. - - - - tabular - multiline - + - Switch between tabular and multiline output: - - - - tabular - - Output is a table where each line describes a single entry. - Columns define particular properties of the entry. - - - - - multiline - - Each entry comprises multiple lines, each property on its - own line. The values are prefixed with the property name. - - - - - If omitted, default is tabular for most commands. - For the commands producing more structured information, that cannot be - displayed on a single line, default is multiline. - Currently, they are: - - - - nmcli connection show ID - + Instead of conducting the desired action, nmcli + will list possible completions for the last argument. This is useful to implement + argument completion in shell. - - nmcli device show - - + The exit status will indicate success + or return a code 65 to indicate the last argument is a file name. + NetworkManager ships with command completion support for GNU Bash. - - + + yes no - auto - 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. - The actual colors used are configured as described in - terminal-colors.d5. - Please refer to the section for a - list of color names supported by nmcli. + Whether to escape : and \ characters in terse tabular mode. The + escape character is \. + + If omitted, default is yes. @@ -238,33 +215,74 @@ - - + + + + + + Print help information. + + + + + + + - yes - no + tabular + multiline - Whether to escape : and \ characters in terse tabular mode. The - escape character is \. + Switch between tabular and multiline output: + + + + tabular + + Output is a table where each line describes a single entry. + Columns define particular properties of the entry. + + + + + multiline + + Each entry comprises multiple lines, each property on its + own line. The values are prefixed with the property name. + + + + + If omitted, default is tabular for most commands. + For the commands producing more structured information, that cannot be + displayed on a single line, default is multiline. + Currently, they are: + + + + nmcli connection show ID + + + + nmcli device show + + - If omitted, default is yes. - - + + - When using this option nmcli 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 pretty. This causes nmcli to produce easily + readable outputs for humans, i.e. values are aligned, headers are printed, + etc. @@ -283,37 +301,13 @@ - - - seconds - - - - This option sets a timeout period for which nmcli will - wait for NetworkManager to finish operations. It is - especially useful for commands that may take a longer time to complete, e.g. - connection activation. - - Specifying a value of 0 instructs - nmcli not to wait but to exit immediately with a status of - success. The default value depends on the executed command. - - - - - - + + - Instead of conducting the desired action, nmcli - will list possible completions for the last argument. This is useful to implement - argument completion in shell. - - The exit status will indicate success - or return a code 65 to indicate the last argument is a file name. - - NetworkManager ships with command completion support for GNU Bash. + Output is terse. This mode is designed and suitable for computer (script) + processing. @@ -330,12 +324,20 @@ - - - + + + seconds + - Print help information. + This option sets a timeout period for which nmcli will + wait for NetworkManager to finish operations. It is + especially useful for commands that may take a longer time to complete, e.g. + connection activation. + + Specifying a value of 0 instructs + nmcli not to wait but to exit immediately with a status of + success. The default value depends on the executed command. @@ -831,9 +833,10 @@ 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 'autoconnect' 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. + the 'autoconnect' 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. In most cases you may want to use device disconnect command instead. @@ -1442,14 +1445,13 @@ 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: + 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: nmcli con up id name. 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. + 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. If option is not specified, the default timeout will be 90 seconds. @@ -2537,9 +2539,9 @@ It's equivalent to the +bond.options 'option=value' syntax. - nmcli --show-secrets connection show "My Home WiFi" + nmcli --show-secrets connection show "My Home Wi-Fi" - shows details for "My Home WiFi" connection profile with all passwords. + shows details for "My Home Wi-Fi" connection profile with all passwords. Without option, secrets would not be displayed. -- cgit 1.3.0-6-gf8a5