Skip to content

Commit e8f800b

Browse files
committed
Docs: Reformat actions - part 2
1 parent 65b0f82 commit e8f800b

12 files changed

Lines changed: 153 additions & 113 deletions

Website/docs/application/bit-calculator.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,27 @@ keywords: [NETworkManager, bit calculator, data unit converter, bits to bytes, b
66

77
# Bit Calculator
88

9-
With the **Bit Calculator** different data units can be converted. Based on the input number and the selected unit the different units like bits, bytes, kilobits, kilobytes, megabits, megabytes, etc. are calculated.
9+
With the **Bit Calculator** you can convert between different data units — enter a number and select the input unit to see the equivalent values in bits, bytes, kilobits, kilobytes, megabits, megabytes, and more.
1010

1111
![Bit Calculator](../img/bit-calculator.png)
1212

13-
In addition, further actions can be performed using the buttons at the bottom right:
13+
### Toolbar
1414

15-
- **Export...** - Export the information to a CSV, XML or JSON file.
15+
| Button | Description |
16+
|--------|-------------|
17+
| **Export...** | Exports the information to a CSV, XML, or JSON file |
1618

17-
:::note
19+
### Context menu
1820

19-
Right-click on the result to copy the information.
20-
21-
:::
21+
| Action | Description |
22+
|--------|-------------|
23+
| **Copy** | Copies the selected information to the clipboard |
2224

2325
## Settings
2426

2527
### Notation
2628

27-
Notation which should be used for the calculation.
29+
Notation used for the calculation.
2830

2931
**Type:** `NETworkManager.Models.Network.BitCaluclatorNotation`
3032

Website/docs/application/connections.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ keywords: [NETworkManager, connections, active connections, netstat, TCP connect
66

77
# Connections
88

9-
In **Connections** you can see all connections with source and destination IP endpoint (IP address and port) and with the associated process that are currently running on your computer.
9+
The **Connections** view shows all active connections with their source and destination IP endpoints (IP address and port) and the associated process running on your computer.
1010

1111
:::info
1212

@@ -16,10 +16,15 @@ The data shown is similar to the output of the `netstat` command.
1616

1717
![Connections](../img/connections.png)
1818

19-
:::note
19+
### Context menu
2020

21-
With `F5` you can refresh the connections.
21+
| Action | Description |
22+
|--------|-------------|
23+
| **Copy** | Copies the selected information to the clipboard |
24+
| **Export...** | Exports the selected or all results to a file |
2225

23-
Right-click on the result to copy or export the information.
26+
### Keyboard shortcuts
2427

25-
:::
28+
| Key | Action |
29+
|-----|--------|
30+
| `F5` | Refresh |

Website/docs/application/discovery-protocol.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,44 @@ keywords: [NETworkManager, LLDP, CDP, discovery protocol, network discovery, swi
66

77
# Discovery Protocol
88

9-
In **Discovery Protocol** you can capture for LLDP (Link Layer Discovery Protocol) and/or CDP (Cisco Discovery Protocol) frames to see to which switch or router your device is connected. The information such as device name, port, VLAN, etc. are displayed in a table.
9+
With **Discovery Protocol** you can capture LLDP (Link Layer Discovery Protocol) and CDP (Cisco Discovery Protocol) frames to see which switch or router your device is connected to. Device name, port, VLAN, and other information are displayed in a table.
1010

1111
:::info
1212

1313
The Link Layer Discovery Protocol (LLDP) is a vendor-neutral Layer 2 network protocol used by network devices, especially switches, to advertise their identity, capabilities, and neighbors on an IEEE 802 Local Area Network (LAN). If configured, LLDP messages are sent out periodically as frames with the destination MAC address of `01:80:c2:00:00:0e`. The default time interval is 30 seconds.
1414

15-
The Cisco Discovery Protocol (CDP) is a proprietary Layer 2 protocol used by Cisco Systems to exchange information about network devices. If configured, CDP messages are sent out periodically as frames with the destination MAC address `01:00:0c:cc:cc`. The default time interval is 60 seconds.
15+
The Cisco Discovery Protocol (CDP) is a proprietary Layer 2 protocol used by Cisco Systems to exchange information about network devices. If configured, CDP messages are sent out periodically as frames with the destination MAC address `01:00:0c:cc:cc:cc`. The default time interval is 60 seconds.
1616

1717
:::
1818

1919
:::warning
2020

21-
If you are using a hypervisor like Hyper-V with a virtual switch configured as "External network" which is shared with host where NETworkManager is running, you may not receive any packets. This is because the virtual switch does not forward the LLDP or CDP frames to the host. You may temporarily change the virtual switch to "Internal network" or "Private network", if you want to use the Discovery Protocol to see which switch or router your device is connected to. You can also verify this behavior by using Wireshark.
21+
If you are using a hypervisor like Hyper-V with a virtual switch configured as "External network" which is shared with the host where NETworkManager is running, you may not receive any packets. This is because the virtual switch does not forward the LLDP or CDP frames to the host. You may temporarily change the virtual switch to "Internal network" or "Private network" if you want to use Discovery Protocol to see which switch or router your device is connected to. You can also verify this behavior by using Wireshark.
2222

2323
:::
2424

25-
:::note
25+
:::warning[Administrator privileges required]
2626

27-
Capturing network packets requires administrator privileges. If the application is not running as administrator, capturing is not available. Use the **Restart as administrator** button to relaunch the application with elevated rights.
27+
Without administrator privileges, capturing is not available. Use the **Restart as administrator** button to relaunch the application with elevated rights.
2828

2929
:::
3030

3131
![Discovery Protocol](../img/discovery-protocol.png)
3232

33-
In addition, further actions can be performed using the buttons at the bottom right:
33+
### Toolbar
3434

35-
- **Export...** - Export the information to a CSV, XML or JSON file.
35+
| Button | Description |
36+
|--------|-------------|
37+
| **Export...** | Exports the information to a CSV, XML, or JSON file |
3638

37-
:::note
39+
### Context menu
3840

39-
With `F5` or `Enter` you can start capturing network packets.
41+
| Action | Description |
42+
|--------|-------------|
43+
| **Copy** | Copies the selected information to the clipboard |
4044

41-
Right-click on the result to copy the information.
45+
### Keyboard shortcuts
4246

43-
:::
47+
| Key | Action |
48+
|-----|--------|
49+
| `F5` / `Enter` | Start capturing |

Website/docs/application/firewall.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,34 +14,39 @@ Windows Firewall (Windows Defender Firewall) is a built-in host-based firewall i
1414

1515
:::
1616

17-
:::note
18-
19-
Adding, editing, enabling, disabling, or deleting firewall rules requires administrator privileges. If the application is not running as administrator, the view is in read-only mode. Use the **Restart as administrator** button to relaunch the application with elevated rights.
17+
:::warning[Administrator privileges required]
2018

21-
Rules created by NETworkManager use the prefix `NETworkManager_` in their display name to distinguish them from system-managed or third-party rules. Only rules with this prefix are shown in the Firewall view.
19+
Without administrator privileges, the view is read-only. Use the **Restart as administrator** button to relaunch the application with elevated rights.
2220

2321
:::
2422

2523
![Firewall](../img/firewall.png)
2624

27-
:::note
28-
29-
In addition, further actions can be performed using the buttons below:
30-
31-
- **Add rule...** - Opens a dialog to create a new firewall rule.
32-
- **Windows Firewall Settings** - Opens the Windows Firewall management console (`WF.msc`).
25+
### Toolbar
3326

34-
:::
27+
| Button | Description |
28+
|--------|-------------|
29+
| **Add rule...** | Opens a dialog to create a new firewall rule |
30+
| **Windows Firewall Settings** | Opens the Windows Firewall management console (`WF.msc`) |
3531

36-
:::note
32+
### Context menu
3733

38-
With `F5` you can refresh the firewall rules.
34+
| Action | Description |
35+
|--------|-------------|
36+
| **Enable** | Enables the selected rule |
37+
| **Disable** | Disables the selected rule |
38+
| **Edit** | Opens the edit dialog for the selected rule |
39+
| **Delete** | Removes the selected rule |
40+
| **Copy** | Copies the rule information to the clipboard |
41+
| **Export** | Exports the rule to a file |
3942

40-
Right-click on a rule to `enable`, `disable`, `edit`, or `delete` it, or to `copy` or `export` the information.
43+
### Keyboard shortcuts
4144

42-
You can also use the Hotkeys `F2` (`edit`) or `Del` (`delete`) on a selected rule.
43-
44-
:::
45+
| Key | Action |
46+
|-----|--------|
47+
| `F5` | Refresh |
48+
| `F2` | Edit selected rule |
49+
| `Del` | Delete selected rule |
4550

4651
## Add rule
4752

@@ -288,4 +293,4 @@ Network profiles the rule applies to. At least one profile must be selected.
288293

289294
The last enabled profile cannot be unchecked — at least one profile must remain selected.
290295

291-
:::
296+
:::

Website/docs/application/hosts-file-editor.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ The application automatically creates a daily backup of the `hosts` file, retain
3636

3737
:::
3838

39-
## Actions
40-
4139
### Toolbar
4240

4341
| Button | Description |

Website/docs/application/ip-geolocation.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,30 @@ IP geolocation data is provided by [ip-api.com](https://ip-api.com/) and the API
1616

1717
:::note
1818

19-
The free API endpoint is limited to 45 requests per minute, supports only the `http` protocol and is available for non-commercial use only.
19+
The free API endpoint is limited to 45 requests per minute, supports only the `HTTP` protocol and is available for non-commercial use only.
2020

2121
:::
2222

23-
Example inputs:
24-
25-
- `borntoberoot.net`
26-
- `1.1.1.1`
27-
2823
![IPGeolocation](../img/ip-geolocation.png)
2924

30-
In addition, further actions can be performed using the buttons at the bottom right:
25+
### Example inputs
3126

32-
- **Export...** - Export the information to a CSV, XML or JSON file.
27+
| Input | Description |
28+
|-------|-------------|
29+
| `borntoberoot.net` | Fully qualified domain name (FQDN) |
30+
| `1.1.1.1` | Public IP address |
3331

34-
:::note
32+
### Toolbar
3533

36-
Right-click on the result to copy the information.
34+
| Button | Description |
35+
|--------|-------------|
36+
| **Export...** | Exports the information to a CSV, XML, or JSON file |
3737

38-
:::
38+
### Context menu
39+
40+
| Action | Description |
41+
|--------|-------------|
42+
| **Copy** | Copies the selected information to the clipboard |
3943

4044
## Profile
4145

Website/docs/application/listeners.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,25 @@ keywords: [NETworkManager, listeners, listening ports, open ports, network liste
66

77
# Listeners
88

9-
In **Listeners** you can see all the listeners with IP addresses and port that are currently running on your computer.
9+
The **Listeners** view shows all active network listeners with their bound IP addresses and ports that are currently running on your computer.
10+
11+
:::info
12+
13+
A network listener is a socket bound to a specific local IP address and port that waits to receive incoming data or connections. TCP listeners accept incoming connections; UDP listeners receive datagrams. Applications use listeners to offer services over a network.
14+
15+
:::
1016

1117
![Listeners](../img/listeners.png)
1218

13-
:::note
19+
### Context menu
1420

15-
With `F5` you can refresh the listeners.
21+
| Action | Description |
22+
|--------|-------------|
23+
| **Copy** | Copies the selected information to the clipboard |
24+
| **Export...** | Exports the selected or all results to a file |
1625

17-
Right-click on the result to copy or export the information.
26+
### Keyboard shortcuts
1827

19-
:::
28+
| Key | Action |
29+
|-----|--------|
30+
| `F5` | Refresh |

Website/docs/application/lookup.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,40 +6,42 @@ keywords: [NETworkManager, OUI lookup, MAC address lookup, port lookup, manufact
66

77
# Lookup
88

9-
In **Lookup** you can search for information about [OUIs](#oui) (Organizationally Unique Identifiers) and [ports](#port).
9+
With **Lookup** you can search for information about [OUIs](#oui) (Organizationally Unique Identifiers) and [ports](#port).
1010

1111
## OUI
1212

13-
On the **OUI** tab, you can search the manufacturer of a network interface card (NIC) by entering the first 24 bits of the MAC address. You can also search by vendor name to get all registered MAC addresses of the vendor.
13+
On the **OUI** tab, you can search for the manufacturer of a network interface card (NIC) by entering the first 24 bits of the MAC address. You can also search by vendor name to get all registered MAC addresses of the vendor.
1414

1515
:::info
1616

17-
The OUI (Organizationally Unique Identifier) is a 24-bit number that is assigned to a network interface card (NIC) by the IEEE Registration Authority. The OUI is used to identify the manufacturer of a network interface card. The OUI is the first 24 bits of the MAC address.
17+
The OUI (Organizationally Unique Identifier) is a 24-bit number assigned by the IEEE Registration Authority to identify network interface card manufacturers. It forms the first 24 bits of a MAC address.
1818

1919
:::
2020

2121
![Lookup - OUI](../img/lookup--oui.png)
2222

23-
:::note
23+
### Context menu
2424

25-
Right-click on the result to copy or export the information.
26-
27-
:::
25+
| Action | Description |
26+
|--------|-------------|
27+
| **Copy** | Copies the selected information to the clipboard |
28+
| **Export...** | Exports the selected or all results to a file |
2829

2930
## Port
3031

3132
On the **Port** tab, you can search for a port number to get information about the service and the protocol used by the port. You can also search by service name to get all registered port numbers of the service.
3233

3334
:::info
3435

35-
A port is a logical construct that identifies a specific process to which network traffic is to be forwarded. Ports are identified by a 16-bit number, known as a port number. Port numbers range from 0 to 65535, but only ports numbers 0 to 1023 are designated as well-known ports. Well-known ports are those registered with IANA for common services such as HTTP (port 80), HTTPS (port 443), FTP (port 21), and SSH (port 22).
36+
A port is a logical construct that identifies a specific process to which network traffic is to be forwarded. Ports are identified by a 16-bit number, known as a port number. Port numbers range from 0 to 65535, but only port numbers 0 to 1023 are designated as well-known ports. Well-known ports are those registered with IANA for common services such as HTTP (port 80), HTTPS (port 443), FTP (port 21), and SSH (port 22).
3637

3738
:::
3839

3940
![Lookup - Port](../img/lookup--port.png)
4041

41-
:::note
42+
### Context menu
4243

43-
Right-click on the result to copy or export the information.
44-
45-
:::
44+
| Action | Description |
45+
|--------|-------------|
46+
| **Copy** | Copies the selected information to the clipboard |
47+
| **Export...** | Exports the selected or all results to a file |

Website/docs/application/neighbor-table.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,30 +18,34 @@ Both protocols are susceptible to spoofing/poisoning attacks that can manipulate
1818

1919
:::
2020

21-
:::note
21+
:::warning[Administrator privileges required]
2222

23-
Adding and deleting neighbor entries requires administrator privileges. If the application is not running as administrator, the view is in read-only mode. Use the **Restart as administrator** button to relaunch the application with elevated rights.
23+
Without administrator privileges, the view is read-only. Use the **Restart as administrator** button to relaunch the application with elevated rights.
2424

2525
:::
2626

2727
![Neighbor Table](../img/neighbor-table.png)
2828

29-
:::note
30-
31-
Additional actions are available via the buttons below the table:
32-
33-
- **Add entry...** – Opens a dialog to add a permanent static neighbor entry.
34-
- **Delete table** – Removes all dynamic entries (permanent entries are preserved).
29+
### Toolbar
3530

36-
:::
31+
| Button | Description |
32+
|--------|-------------|
33+
| **Add entry...** | Opens a dialog to add a permanent static neighbor entry |
34+
| **Delete table** | Removes all dynamic entries (permanent entries are preserved) |
3735

38-
:::note
36+
### Context menu
3937

40-
Press `F5` to refresh the neighbor table.
38+
| Action | Description |
39+
|--------|-------------|
40+
| **Copy** | Copies the selected information to the clipboard |
41+
| **Export...** | Exports the selected or all results to a file |
42+
| **Delete** | Removes the selected entry |
4143

42-
Right-click on a row to copy or export individual values, or to delete the selected entry.
44+
### Keyboard shortcuts
4345

44-
:::
46+
| Key | Action |
47+
|-----|--------|
48+
| `F5` | Refresh |
4549

4650
## Columns
4751

@@ -118,4 +122,4 @@ The network interface on which the entry is created.
118122

119123
Adding a static entry requires administrator privileges. Internally, NETworkManager uses `New-NetNeighbor` (PowerShell `NetTCPIP` module) to create the entry with state `Permanent`.
120124

121-
:::
125+
:::

0 commit comments

Comments
 (0)