Skip to content

Commit

Permalink
docs/man/nut-scanner.txt: change markup for code and output examples [n…
Browse files Browse the repository at this point in the history
…etworkupstools#2247]

Signed-off-by: Jim Klimov <[email protected]>
  • Loading branch information
jimklimov committed Jan 12, 2024
1 parent aeb0c3c commit b4c001a
Showing 1 changed file with 28 additions and 18 deletions.
46 changes: 28 additions & 18 deletions docs/man/nut-scanner.txt
Original file line number Diff line number Diff line change
Expand Up @@ -222,55 +222,65 @@ EXAMPLES

To scan USB devices only:

*nut-scanner -U*
+
----
:; nut-scanner -U

[nutdev-usb1]
driver = "snmp-ups"
port = "192.168.0.42"
+
----

To scan SNMP v1 device with public community on address range 192.168.0.0
to 192.168.0.255:

*nut-scanner -S -s 192.168.0.0 -e 192.168.0.255*
+
----
:; nut-scanner -S -s 192.168.0.0 -e 192.168.0.255

[nutdev-snmp1]
driver = "snmp-ups"
port = "192.168.0.42"
+
----

The same using CIDR notation:

*nut-scanner -S -m 192.168.0.0/24*
+
----
:; nut-scanner -S -m 192.168.0.0/24

[nutdev-snmp1]
driver = "snmp-ups"
port = "192.168.0.42"
+
----

To scan NUT servers with a timeout of 10 seconds on IP range 192.168.0.0
to 192.168.0.127 using CIDR notation:

*nut-scanner -O -t 10 -m 192.168.0.0/25*
+
----
:; nut-scanner -O -t 10 -m 192.168.0.0/25

[nutdev-nut1]
driver = "dummy-ups"
port = "[email protected]"
+
----

To scan for power supplies, through IPMI (1.5 mode) over the network,
on address range 192.168.0.0 to 192.168.0.255 using CIDR notation:

*nut-scanner -I -m 192.168.0.0/24 -b username -B password*
----
:; nut-scanner -I -m 192.168.0.0/24 -b username -B password
----

To scan for Eaton serial devices on ports 0 and 1 (/dev/ttyS0,
/dev/ttyUSB0, /dev/ttyS1 and /dev/ttyUSB1 on Linux):
To scan for Eaton serial devices on ports 0 and 1 (`/dev/ttyS0`,
`/dev/ttyUSB0`, `/dev/ttyS1` and `/dev/ttyUSB1` on Linux):

*nut-scanner --eaton_serial 0-1*
----
:; nut-scanner --eaton_serial 0-1
----

To scan for Eaton serial devices on ports 1 and 2 (COM1 and COM2 on Windows):
To scan for Eaton serial devices on ports 1 and 2 (`COM1` and `COM2` on Windows):

*nut-scanner --eaton_serial 1-2*
----
:; nut-scanner --eaton_serial 1-2
----

SEE ALSO
--------
Expand Down

0 comments on commit b4c001a

Please sign in to comment.