From 7b54c62b5b4c02ded22becf624ef246e13120460 Mon Sep 17 00:00:00 2001 From: Lena <126529524+acuteenvy@users.noreply.github.com> Date: Wed, 2 Aug 2023 07:26:52 +0200 Subject: [PATCH] nmcli*: update pages (#10544) --- pages/linux/nmcli-agent.md | 8 ++++---- pages/linux/nmcli-connection.md | 6 +++--- pages/linux/nmcli-device.md | 8 ++++---- pages/linux/nmcli-radio.md | 14 +++++++------- pages/linux/nmcli.md | 29 ++++++++++++++++------------- 5 files changed, 34 insertions(+), 31 deletions(-) diff --git a/pages/linux/nmcli-agent.md b/pages/linux/nmcli-agent.md index 228ba4860..dcc88740b 100644 --- a/pages/linux/nmcli-agent.md +++ b/pages/linux/nmcli-agent.md @@ -1,17 +1,17 @@ # nmcli agent -> Run nmcli as a NetworkManager secret agent or polkit agent. +> Run `nmcli` as a NetworkManager secret agent or polkit agent. > This subcommand can also be called with `nmcli a`. > More information: . -- Register nmcli as a secret agent and listen for secret requests: +- Register `nmcli` as a secret agent and listen for secret requests: `nmcli agent secret` -- Register nmcli as a polkit agent and listen for authorization requests: +- Register `nmcli` as a polkit agent and listen for authorization requests: `nmcli agent polkit` -- Register nmcli as a secret agent and a polkit agent: +- Register `nmcli` as a secret agent and a polkit agent: `nmcli agent all` diff --git a/pages/linux/nmcli-connection.md b/pages/linux/nmcli-connection.md index 84220c9f4..1466f35d1 100644 --- a/pages/linux/nmcli-connection.md +++ b/pages/linux/nmcli-connection.md @@ -1,6 +1,6 @@ # nmcli connection -> Connection management with NetworkManager. +> Manage connections with NetworkManager. > This subcommand can also be called with `nmcli c`. > More information: . @@ -8,7 +8,7 @@ `nmcli connection` -- Activate a connection by specifying a UUID: +- Activate a connection: `nmcli connection up uuid {{uuid}}` @@ -28,6 +28,6 @@ `nmcli connection add ifname {{interface_name}} type {{ethernet}} ip4 {{10.0.0.7/8}} gw4 {{10.0.0.1}} ipv4.dns {{10.0.0.1}} ipv6.method {{ignore}}` -- Create a VPN connection using OpenVPN from a OVPN file: +- Create a VPN connection using OpenVPN from an OVPN file: `nmcli connection import type {{openvpn}} file {{path/to/vpn_config.ovpn}}` diff --git a/pages/linux/nmcli-device.md b/pages/linux/nmcli-device.md index 16aba36d7..0d1625dfa 100644 --- a/pages/linux/nmcli-device.md +++ b/pages/linux/nmcli-device.md @@ -1,6 +1,6 @@ # nmcli device -> Hardware device management with NetworkManager. +> Manage network interfaces and establish new Wi-Fi connections using NetworkManager. > This subcommand can also be called with `nmcli d`. > More information: . @@ -12,10 +12,10 @@ `nmcli device wifi` -- Connect to the Wi-Fi network with a specified name and password: +- Connect to a Wi-Fi network with the specified SSID (you will be prompted for a password): -`nmcli device wifi connect {{ssid}} password {{password}}` +`nmcli --ask device wifi connect {{ssid}}` -- Print password and QR code for the current Wi-Fi network: +- Print the password and QR code for the current Wi-Fi network: `nmcli device wifi show-password` diff --git a/pages/linux/nmcli-radio.md b/pages/linux/nmcli-radio.md index 8c5c9d96b..682bf6422 100644 --- a/pages/linux/nmcli-radio.md +++ b/pages/linux/nmcli-radio.md @@ -1,29 +1,29 @@ # nmcli radio -> Show radio switches status or enable and disable switches. +> Show the status of radio switches or enable/disable them using NetworkManager. > This subcommand can also be called with `nmcli r`. > More information: . -- Show status of Wi-Fi in NetworkManager: +- Show status of Wi-Fi: `nmcli radio wifi` -- Turn Wi-Fi on or off in NetworkManager: +- Turn Wi-Fi on or off: `nmcli radio wifi {{on|off}}` -- Show status of WWAN in NetworkManager: +- Show status of WWAN: `nmcli radio wwan` -- Turn WWAN on or off in NetworkManager: +- Turn WWAN on or off: `nmcli radio wwan {{on|off}}` -- Show status of both switches in NetworkManager: +- Show status of both switches: `nmcli radio all` -- Turn both switches on or off in NetworkManager: +- Turn both switches on or off: `nmcli radio all {{on|off}}` diff --git a/pages/linux/nmcli.md b/pages/linux/nmcli.md index 64ebb1ffc..4570bdd08 100644 --- a/pages/linux/nmcli.md +++ b/pages/linux/nmcli.md @@ -1,29 +1,32 @@ # nmcli > Manage the network configuration using NetworkManager. -> Some subcommands such as `nmcli monitor` have their own usage documentation. > More information: . -- List all available wifi networks: +- View documentation for running `nmcli` as a NetworkManager secret/polkit agent: -`nmcli device wifi` +`tldr nmcli agent` -- Connect to a wifi network: +- View documentation for managing network connections: -`nmcli dev wifi connect {{SSID}}` +`tldr nmcli connection` -- Run an `nmcli` subcommand: +- View documentation for managing network interfaces and establishing new Wi-Fi connections: -`nmcli {{agent|connection|device|general|help|monitor|networking|radio}} {{command_options}}` +`tldr nmcli device` -- Display the current version of NetworkManager: +- View documentation for managing general settings of NetworkManager: -`nmcli --version` +`tldr nmcli general` -- Display help: +- View documentation for NetworkManager's activity monitor: -`nmcli --help` +`tldr nmcli monitor` -- Display help for a subcommand: +- View documentation for enabling/disabling and checking the status of networking: -`nmcli {{subcommand}} --help` +`tldr nmcli networking` + +- View documentation for managing radio switches: + +`tldr nmcli radio`