diff --git a/man/nmcli.1.in b/man/nmcli.1.in index cc3bd492e1..6135178451 100644 --- a/man/nmcli.1.in +++ b/man/nmcli.1.in @@ -73,7 +73,7 @@ Typical uses include: .IP \(em 4 Scripts: utilize NetworkManager via \fInmcli\fP instead of managing network connections manually. \fInmcli\fP supports a terse output format which is better -suited for script processing. Note that Networkmanager can also execute scripts, +suited for script processing. Note that NetworkManager can also execute scripts, called "dispatcher scripts", in response to network events. See \fBNetworkManager\fP for details about these dispatcher scripts. .IP \(em 4 @@ -94,7 +94,7 @@ for humans, i.e. values are aligned, headers are printed, etc. Switch between \fItabular\fP and \fImultiline\fP output. If omitted, default is \fItabular\fP for most commands. For the commands producing more structured information, that cannot be displayed on a single -line, default is \fImultiline\fP. Currenly, they are: +line, default is \fImultiline\fP. Currently, they are: .br .nf 'nmcli connection show configured ' @@ -134,10 +134,11 @@ When using this option \fInmcli\fP will stop and ask for any missing required arguments, so do not use this option for non-interactive purposes like scripts. .TP .B \-w, \-\-wait -This option sets a timeout \fInmcli\fP waits for finishing operations that -\fINetworkManager\fP take longer time to complete, like e.g. connection activation. -Specifying value of \fB0\fP instructs \fInmcli\fP not to wait and exit immediatelly -with a success. Default value depends on the executed command. +This option sets a timeout period for which \fInmcli\fP will wait for \fINetworkManager\fP +to finsh operations. It is especially useful for commands that may take a longer time to +complete, e.g. connection activation. +Specifying a value of \fB0\fP instructs \fInmcli\fP not to wait but to exit immediately +with a status of success. The default value depends on the executed command. .TP .B \-v, \-\-version Show \fInmcli\fP version. @@ -163,23 +164,23 @@ command is provided for \fIgeneral\fP object. .B permissions .br Show the permissions a caller has for various authenticated operations that -NetworkManager provides, like enable/disable networking, changing Wi\(hyFi, +NetworkManager provides, like enable and disable networking, changing Wi\(hyFi, WWAN, and WiMAX state, modifying connections, etc. .TP .B logging [level ] [domains ] .br Get and change \fINetworkManager\fP logging level and domains. Without any argument current logging level and domains are shown. In order to change logging state, provide -\fIlevel\fP and/or \fIdomains\fP parameters. See \fBNetworkManager.conf\fP for available +\fIlevel\fP and, or, \fIdomain\fP parameters. See \fBNetworkManager.conf\fP for available level and domain values. .RE .TP .B networking \- get or set general networking state of NetworkManager .br -Use this object to show NetworkManager networking status, or enable/disable -networking. Disabling networking deconfigures all devices and changes them to -the 'unmanaged' state. +Use this object to show NetworkManager networking status, or to enable and disable +networking. Disabling networking removes the configuration from all devices and +changes them to the 'unmanaged' state. .TP .SS \fICOMMAND\fP := { [ on | off | connectivity ] } .sp @@ -187,7 +188,7 @@ the 'unmanaged' state. .TP .B [ on | off ] .br -Get networking\(hyenabled status or enable/disable networking by NetworkManager. +Get networking\(hyenabled status or enable and disable networking by NetworkManager. All interfaces managed by NetworkManager are deactivated when networking has been disabled. .TP @@ -207,7 +208,7 @@ Possible states are: .IP \fIlimited\fP 9 \(en the host is connected to a network, but it has no access to the Internet .IP \fIfull\fP 9 -\(en the host is connected to a network and has the full access to the Internet +\(en the host is connected to a network and has full access to the Internet .IP \fIunknown\fP 9 \(en the connectivity status cannot be found out .RE @@ -216,7 +217,7 @@ Possible states are: .TP .B radio \- get or set radio switch states .br -Use this object to show radio switches status, or enable/disable +Use this object to show radio switches status, or enable and disable the switches. .TP .SS \fICOMMAND\fP := { all | wifi | wwan | wimax } @@ -250,7 +251,7 @@ Show or set all previously mentioned radio switches at the same time. .B connection \- start, stop, and manage network connections .sp NetworkManager stores all network configuration as \fIconnections\fP, which are -collections of data (Layer2 details, IP addressing, etc) that describe +collections of data (Layer2 details, IP addressing, etc.) that describe how to create or connect to a network. A connection is \fIactive\fP when a device uses that connection's configuration to create or connect to a network. There may be multiple connections that apply to a device, but only one of them @@ -333,9 +334,9 @@ further auto-activation. .sp Be aware that this command deactivates the specified active connection. 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 +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 autoconnect, it will be automatically started on the disconnected device again. +to auto-connect, it will be automatically started on the disconnected device again. .br In most cases you may want to use \fIdevice disconnect\fP command instead. .sp @@ -347,12 +348,12 @@ See \fBshow active\fP above for the description of the -specifying keywords. .TP .B add COMMON_OPTIONS TYPE_SPECIFIC_OPTIONS IP_OPTIONS .br -Add a connection for NetworkManager. Arguments differ according to connection types, see bellow. +Add a connection for NetworkManager. Arguments differ according to connection types, see below. .RS .TP .B COMMON_OPTIONS: .IP "\fItype \fP" 42 -\(en connection type; see bellow \fBTYPE_SPECIFIC_OPTIONS\fP for allowed values; (mandatory) +\(en connection type; see below \fBTYPE_SPECIFIC_OPTIONS\fP for allowed values; (mandatory) .IP "\fIifname | \(dq\&*\(dq\&\fP" 42 \(en interface to bind the connection to. The connection will only be applicable to this interface name. A special value of "\fB*\fP" can be used for interface-independent connections. @@ -502,7 +503,7 @@ Note: use quotes around \fB*\fP to suppress shell expansion. .IP "\fI[max-age <6-42>]\fP" 42 \(en STP maximum message age, in seconds .IP "\fI[ageing-time <0-1000000>]\fP" 42 -\(en the ethernet MAC address aging time, in seconds +\(en the Ethernet MAC address aging time, in seconds .RE .RS .TP @@ -559,7 +560,7 @@ Not providing an means that a new connection will be added. The interactive editor will guide you through the connection editing and allow you to change connection parameters according to your needs by means of a simple menu-driven interface. The editor indicates what settings and -properties can be modified and provides an inline help. +properties can be modified and provides in-line help. .sp .PP Available options: @@ -570,7 +571,7 @@ Available options: .RE .RS .sp -See also \fInm-settings\fP(5) for all NM setting and property names, and their +See also \fInm-settings\fP(5) for all NetworkManager settings and property names, and their descriptions; and \fInmcli-examples\fP(5) for sample editor sessions. .RE .TP @@ -587,7 +588,7 @@ specified, the property will be set to the default value (deleted). .TP .B delete [ id | uuid | path ] .br -Delete a configured connection. The connection to delete is identified by +Delete a configured connection. The connection to be deleted is identified by its name, UUID or D-Bus path. If is ambiguous, a keyword \fIid\fP, \fIuuid\fP or \fIpath\fP can be used. .br @@ -640,9 +641,9 @@ Connect to a Wi\(hyFi network specified by SSID or BSSID. The command creates a connection and then activates it on a device. This is a command\(hyline 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\(hyFi networks. If a connection -for the network already exists, it's better to connect through it using -\fInmcli con up id \fP. Note that only open, WEP and WPA\(hyPSK networks are -supported at the moment. It is also supposed that IP configuration is obtained via +for the network already exists, it is better to bring up (activate) the existing connection +as follows: \fInmcli con up id \fP. Note that only open, WEP and WPA\(hyPSK networks +are supported at the moment. It is also supposed that IP configuration is obtained via DHCP. .br If '--wait' option is not specified, the default timeout will be 90 seconds. @@ -661,7 +662,7 @@ Available options are: \(en if specified, the connection will use the name (else NM creates a name itself) .IP \fIprivate\fP 13 \(en if set to \fByes\fP, the connection will only be visible to the user who created it. -Otherwise the connection is system\(hywide, which is default. +Otherwise the connection is system\(hywide, which is the default. .RE .TP .B wifi rescan [[ifname] ] @@ -669,7 +670,7 @@ Otherwise the connection is system\(hywide, which is default. Request that \fINetworkManager\fP immediately re-scan for available access points. NetworkManager scans Wi\(hyFi networks periodically, but in some cases it can be useful to start scanning manually (e.g. after resuming the computer). -This command doesn't show the APs, use 'nmcli device wifi list' for that. +This command does not show the APs, use 'nmcli device wifi list' for that. .TP .B wimax [list [ifname ] [nsp ]] .br @@ -691,7 +692,7 @@ or null. .RE Internationalization notes: .br -Be aware that \fInmcli\fP is localized and that's why the output depends on +Be aware that \fInmcli\fP is localized and that is why the output depends on your environment. This is important to realize especially when you parse the output. .br @@ -750,7 +751,7 @@ lists all connections NetworkManager has. .IP "\fB\f(CWnmcli \-p \-m multiline \-f all con show c\fP\fP" .IP -shows all configured connections in multiline mode. +shows all configured connections in multi-line mode. .IP "\fB\f(CWnmcli \-p connection show active\fP\fP" .IP @@ -763,7 +764,7 @@ information. .IP "\fB\f(CWnmcli \-f name,autoconnect c s c\fP\fP" .IP -shows all connections' names and their autoconnect settings. +shows all connections' names and their auto-connect settings. .IP "\fB\f(CWnmcli con s c \(dq\&My wired connection\(dq\&\fP\fP" .IP @@ -786,8 +787,8 @@ shows the status for all devices. .IP "\fB\f(CWnmcli dev disconnect em2\fP\fP" .IP disconnects a connection on interface em2 and marks the device as unavailable for -auto\(hyconnecting. That's why no connection will automatically be activated on the -device until the device's "autoconnect" is set to TRUE or user manually activates +auto\(hyconnecting. As a result, no connection will automatically be activated on the +device until the device's 'autoconnect' is set to TRUE or the user manually activates a connection. .IP "\fB\f(CWnmcli \-f GENERAL,WIFI\-PROPERTIES dev show wlan0\fP\fP" @@ -801,27 +802,27 @@ lists available Wi\(hyFi access points known to NetworkManager. .IP "\fB\f(CWnmcli dev wifi con \(dq\&Cafe Hotspot 1\(dq\& password caffeine name \(dq\&My cafe\(dq\&\fP\fP" .IP creates a new connection named "My cafe" and then connects it to "Cafe Hotspot 1" SSID -using "caffeine" password. This is mainly useful when connecting to "Cafe Hotspot 1" for +using password "caffeine". This is mainly useful when connecting to "Cafe Hotspot 1" for the first time. Next time, it is better to use 'nmcli con up id "My cafe"' so that the existing connection profile can be used and no additional is created. .IP "\fB\f(CWnmcli connection add type ethernet autoconnect no ifname eth0\fP\fP" .IP -non-interactively adds an ethernet connection tied to eth0 interface with auto IP configuration (DHCP), -and disables the connection's auto-connect flag. +non-interactively adds an Ethernet connection tied to eth0 interface with automatic IP configuration (DHCP), +and disables the connection's "autoconnect" flag. -.IP "\fB\f(CWnmcli c a ifname maxipes\-fik type vlan dev eth0 id 55\fP\fP" +.IP "\fB\f(CWnmcli c a ifname Maxipes\(hyfik type vlan dev eth0 id 55\fP\fP" .IP non-interactively adds a VLAN connection with ID 55. The connection will use eth0 and the VLAN interface -will be named maxipes\(hyfik. +will be named Maxipes\(hyfik. .IP "\fB\f(CWnmcli connection edit ethernet\-em1\-2\fP\fP" .IP edits existing "ethernet\(hyem1\(hy2" connection in the interactive editor. -.IP "\fB\f(CWnmcli connection edit type ethernet con-name \(dq\&yet another ethernet connection\(dq\&\fP\fP" +.IP "\fB\f(CWnmcli connection edit type ethernet con-name \(dq\&yet another Ethernet connection\(dq\&\fP\fP" .IP -adds a new ethernet connection in the interactive editor. +adds a new Ethernet connection in the interactive editor. .IP "\fB\f(CWnmcli con mod ethernet\-2 connection.autoconnect no\fP\fP" .IP