Skip to content

Commit d8d7cf5

Browse files
committed
docs/man/*: fix man page section assignments for end-user interactive clients (man1) [networkupstools#2977]
* Section 1 (programs): upsc, upscmd, upsrw, NUT-Monitor * Section 8 (daemons): upsmon, upssched Signed-off-by: Jim Klimov <[email protected]>
1 parent 45505a6 commit d8d7cf5

32 files changed

+99
-97
lines changed

docs/config-notes.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,7 @@ probably misconfigured during the <<Driver_configuration, Driver configuration>>
421421
step. If you reconfigure the driver, use `upsdrvctl stop` to stop it, then
422422
start it again as shown in the <<Starting_drivers, Starting driver(s)>> step.
423423

424-
Reference: man page: linkman:upsc[8]
424+
Reference: man page: linkman:upsc[1]
425425

426426

427427
All data
@@ -481,7 +481,7 @@ above. A sample run on an UPS (Eaton Ellipse MAX 1100) looks like this:
481481
ups.timer.start: -1
482482
ups.vendorid: 0463
483483

484-
Reference: man page: linkman:upsc[8],
484+
Reference: man page: linkman:upsc[1],
485485
<<nut-names,NUT command and variable naming scheme>>
486486

487487
Startup scripts

docs/man/Makefile.am

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -334,13 +334,13 @@ SRC_CLIENT_PAGES = \
334334

335335
INST_MAN_CLIENT_PAGES = \
336336
nutupsdrv.$(MAN_SECTION_CMD_SYS) \
337-
upsc.$(MAN_SECTION_CMD_SYS) \
338-
upscmd.$(MAN_SECTION_CMD_SYS) \
337+
upsc.$(MAN_SECTION_CMD_USR) \
338+
upscmd.$(MAN_SECTION_CMD_USR) \
339339
upsd.$(MAN_SECTION_CMD_SYS) \
340340
upsdrvctl.$(MAN_SECTION_CMD_SYS) \
341341
upslog.$(MAN_SECTION_CMD_SYS) \
342342
upsmon.$(MAN_SECTION_CMD_SYS) \
343-
upsrw.$(MAN_SECTION_CMD_SYS) \
343+
upsrw.$(MAN_SECTION_CMD_USR) \
344344
upssched.$(MAN_SECTION_CMD_SYS)
345345

346346
INST_HTML_CLIENT_MANS = \
@@ -399,19 +399,19 @@ DIST_ALL_MAN_PAGES += $(MAN_CLIENT_PAGES_ADDON_NUT_EXE)
399399
endif !HAVE_WINDOWS
400400

401401
MAN_CLIENT_PAGES_ADDON_NUT_MONITOR = \
402-
NUT-Monitor-py2gtk2.$(MAN_SECTION_CMD_SYS) \
403-
NUT-Monitor-py3qt5.$(MAN_SECTION_CMD_SYS) \
404-
NUT-Monitor-py3qt6.$(MAN_SECTION_CMD_SYS) \
405-
NUT-Monitor.$(MAN_SECTION_CMD_SYS)
402+
NUT-Monitor-py2gtk2.$(MAN_SECTION_CMD_USR) \
403+
NUT-Monitor-py3qt5.$(MAN_SECTION_CMD_USR) \
404+
NUT-Monitor-py3qt6.$(MAN_SECTION_CMD_USR) \
405+
NUT-Monitor.$(MAN_SECTION_CMD_USR)
406406

407407
# Alias page for one text describing two commands:
408-
NUT-Monitor-py2gtk2.$(MAN_SECTION_CMD_SYS): NUT-Monitor.$(MAN_SECTION_CMD_SYS)
408+
NUT-Monitor-py2gtk2.$(MAN_SECTION_CMD_USR): NUT-Monitor.$(MAN_SECTION_CMD_USR)
409409
touch $@
410410

411-
NUT-Monitor-py3qt5.$(MAN_SECTION_CMD_SYS): NUT-Monitor.$(MAN_SECTION_CMD_SYS)
411+
NUT-Monitor-py3qt5.$(MAN_SECTION_CMD_USR): NUT-Monitor.$(MAN_SECTION_CMD_USR)
412412
touch $@
413413

414-
NUT-Monitor-py3qt6.$(MAN_SECTION_CMD_SYS): NUT-Monitor.$(MAN_SECTION_CMD_SYS)
414+
NUT-Monitor-py3qt6.$(MAN_SECTION_CMD_USR): NUT-Monitor.$(MAN_SECTION_CMD_USR)
415415
touch $@
416416

417417
if WITH_NUT_MONITOR

docs/man/NUT-Monitor.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
NUT-Monitor(8)
1+
NUT-Monitor(1)
22
==============
33

44
NAME
@@ -47,9 +47,9 @@ actual Python UI client.
4747

4848
For each individual run, the UI client can connect to a single NUT data server
4949
and a device on it. This can use either anonymous read-only connections (like
50-
linkman:upsc[8]), or authenticated connections (see linkman:upsd.users[5])
51-
which can also issue commands to the driver (like linkman:upscmd[8]) and
52-
set supported variables (like linkman:upsrw[8]) -- propagated to the device,
50+
linkman:upsc[1]), or authenticated connections (see linkman:upsd.users[5])
51+
which can also issue commands to the driver (like linkman:upscmd[1]) and
52+
set supported variables (like linkman:upsrw[1]) -- propagated to the device,
5353
where applicable.
5454

5555
The Python UI client can be used on a system different from the NUT data
@@ -96,9 +96,9 @@ AUTHORS
9696
SEE ALSO
9797
--------
9898

99-
linkman:upsc[8],
100-
linkman:upscmd[8],
101-
linkman:upsrw[8],
99+
linkman:upsc[1],
100+
linkman:upscmd[1],
101+
linkman:upsrw[1],
102102
linkman:upsd.users[5]
103103

104104
Internet resources:

docs/man/al175.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ linkman:ups.conf[5].
4040
INSTANT COMMANDS
4141
----------------
4242

43-
This driver supports some extra commands (see linkman:upscmd[8]):
43+
This driver supports some extra commands (see linkman:upscmd[1]):
4444

4545
*test.battery.start*::
4646
Start a battery test.

docs/man/bicker_ser.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ VARIABLES
3838
---------
3939

4040
Depending on the type of your UPS unit, some of the following variables may
41-
be changed with linkman:upsrw[8]. If the driver can't read a variable from the
41+
be changed with linkman:upsrw[1]. If the driver can't read a variable from the
4242
UPS, it will not be made available. Whenever not explicitly stated, any variable
4343
can be disabled, in which case the action it performs will not be executed. To
4444
disable a variable, set it to an empty value.

docs/man/blazer-common.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ endif::blazer_usb[]
156156
UPS COMMANDS
157157
------------
158158

159-
This driver supports some instant commands (see linkman:upscmd[8]):
159+
This driver supports some instant commands (see linkman:upscmd[1]):
160160

161161
*beeper.toggle*::
162162

@@ -305,7 +305,8 @@ endif::blazer_usb[]
305305
ifndef::blazer_usb[]
306306
linkman:blazer_usb[8],
307307
endif::blazer_usb[]
308-
linkman:nutupsdrv[8], linkman:upsc[8], linkman:upscmd[8], linkman:upsrw[8]
308+
linkman:nutupsdrv[8],
309+
linkman:upsc[1], linkman:upscmd[1], linkman:upsrw[1]
309310

310311

311312
Internet Resources:

docs/man/clone-outlet.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,8 @@ Arjen de Korte <[email protected]>
179179
SEE ALSO
180180
--------
181181

182-
linkman:upscmd[8],
183-
linkman:upsrw[8],
182+
linkman:upscmd[1],
183+
linkman:upsrw[1],
184184
linkman:ups.conf[5],
185185
linkman:clone[8],
186186
linkman:nutupsdrv[8]

docs/man/clone.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,8 +216,8 @@ Arjen de Korte <[email protected]>
216216
SEE ALSO
217217
--------
218218

219-
linkman:upscmd[8],
220-
linkman:upsrw[8],
219+
linkman:upscmd[1],
220+
linkman:upsrw[1],
221221
linkman:ups.conf[5],
222222
linkman:clone-outlet[8],
223223
linkman:nutupsdrv[8]

docs/man/dummy-ups.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ Dummy Mode
3333
In this mode, *dummy-ups* looks like a standard NUT device driver to
3434
linkman:upsd[8] and allows one to change any value for testing purposes.
3535

36-
It is both interactive, controllable through the linkman:upsrw[8] and
37-
linkman:upscmd[8] commands (or equivalent graphical tool), and batchable
36+
It is both interactive, controllable through the linkman:upsrw[1] and
37+
linkman:upscmd[1] commands (or equivalent graphical tool), and batchable
3838
through script files.
3939

4040
It can be configured, launched and used as any other "real" NUT driver.
@@ -141,7 +141,7 @@ This definition file, specified by the `port` argument in the example above,
141141
is generally named `something.dev` or `something.seq`. It contains a list of
142142
all valid variables and associated values (you can later use `upsrw`
143143
only to modify values of these variables), and has the same format as an
144-
linkman:upsc[8] data dump (`<varname>: <value>`). This means you can easily
144+
linkman:upsc[1] data dump (`<varname>: <value>`). This means you can easily
145145
create definition files from an existing UPS using `upsc > file.dev`.
146146

147147
Note that the Network UPS project provides an extensive
@@ -250,7 +250,7 @@ INTERACTION
250250
Once the driver is loaded in dummy mode, you can change any variables, except
251251
those of the `driver.*` and `server.*` collections.
252252
You can do this by either editing the definition file, or use the
253-
linkman:upsrw[8] and linkman:upscmd[8] commands.
253+
linkman:upsrw[1] and linkman:upscmd[1] commands.
254254

255255
Note that in simulation mode, new variables can be added on the fly, but only
256256
by adding these to the definition file (and waiting for it to be re-read).
@@ -315,8 +315,8 @@ Arnaud Quette
315315
SEE ALSO
316316
--------
317317

318-
linkman:upscmd[8],
319-
linkman:upsrw[8],
318+
linkman:upscmd[1],
319+
linkman:upsrw[1],
320320
linkman:ups.conf[5],
321321
linkman:nutupsdrv[8]
322322

docs/man/failover.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ for "primary" duty according to a set of user configurable rules and priorities.
2727
At any given time, `failover` designates one UPS driver as the *primary*, and
2828
presents its commands, variables and status to the outside world as if it were
2929
directly talking to that UPS. From the perspective of the clients (such as
30-
linkman:upsmon[8] or linkman:upsc[8]), the `failover` driver behaves like any
30+
linkman:upsmon[8] or linkman:upsc[1]), the `failover` driver behaves like any
3131
single UPS, abstracting away the underlying redundancy, and allowing for
3232
seamless transitioning between all monitored UPS drivers and their datasets.
3333

@@ -183,7 +183,7 @@ Any linkman:upsmon[8] clients would be set to monitor the `failover` UPS.
183183

184184
The driver fully supports setting variables and performing instant commands on
185185
the currently elected primary UPS driver, which are proxied and with end-to-end
186-
tracking also being possible (linkman:upscmd[8] and linkman:upsrw[8] `-w`). You
186+
tracking also being possible (linkman:upscmd[1] and linkman:upsrw[1] `-w`). You
187187
may notice some variables and commands will be prefixed with `upstream.`, this
188188
is to clearly separate the upstream commands from those of `failover` itself.
189189

@@ -281,10 +281,10 @@ Sebastian Kuttnig <[email protected]>
281281
SEE ALSO
282282
--------
283283

284-
linkman:upscmd[8],
285-
linkman:upsrw[8],
284+
linkman:upscmd[1],
285+
linkman:upsrw[1],
286286
linkman:ups.conf[5],
287-
linkman:upsc[8],
287+
linkman:upsc[1],
288288
linkman:upsmon[8],
289289
linkman:nutupsdrv[8],
290290
linkman:clone[8],

docs/man/genericups.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ Start the driver with the type you want to try, e.g.:
284284

285285
genericups -x upstype=n /dev/port
286286

287-
Let linkman:upsd[8] sync up (watch the syslog), and then run linkman:upsc[8]
287+
Let linkman:upsd[8] sync up (watch the syslog), and then run linkman:upsc[1]
288288
to see what it found. If the `STATUS` is correct (should be "OL" for online),
289289
continue to <<_step_3,Step 3>>, otherwise go back to step 1.
290290

docs/man/huawei-ups2000.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ as line power is restored.
197197
INSTANT COMMANDS
198198
----------------
199199

200-
This driver supports some instant commands (see linkman:upscmd[8]):
200+
This driver supports some instant commands (see linkman:upscmd[1]):
201201

202202
*shutdown.stayoff*::
203203
After an *offdelay*, turn off the load. When line power is back,
@@ -277,7 +277,7 @@ Stop a running battery test.
277277
VARIABLES
278278
---------
279279

280-
This driver supports some writable runtime variables (see linkman:upsrw[8]):
280+
This driver supports some writable runtime variables (see linkman:upsrw[1]):
281281

282282
**ups.beeper.status**::
283283
Enable or disable the UPS beeper, *disabled* or *enabled*.

docs/man/index.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,21 @@ Configuration files
3030
- linkman:upsset.conf[5]
3131
- linkman:upsstats.html[5]
3232

33-
Daemons
34-
~~~~~~~
33+
Server and Client Daemons
34+
~~~~~~~~~~~~~~~~~~~~~~~~~
3535

3636
- linkman:upsd[8]
3737
- linkman:upsmon[8]
3838
- linkman:upssched[8]
3939
- linkman:upslog[8]
4040

41-
Clients commands
42-
~~~~~~~~~~~~~~~~
41+
End-User Clients and Commands
42+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4343

44-
- linkman:upsc[8]
45-
- linkman:upscmd[8]
46-
- linkman:upsrw[8]
47-
- linkman:NUT-Monitor[8]
44+
- linkman:upsc[1]
45+
- linkman:upscmd[1]
46+
- linkman:upsrw[1]
47+
- linkman:NUT-Monitor[1]
4848

4949
Configuration commands
5050
~~~~~~~~~~~~~~~~~~~~~~

docs/man/nut.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,10 +148,10 @@ The "primary" system is usually also responsible for commanding the managed
148148
and reboots them) just because external power returned when the shut down
149149
spree had already started.
150150

151-
* linkman:upsc[8] is a command-line client for anonymous read-only access,
151+
* linkman:upsc[1] is a command-line client for anonymous read-only access,
152152
used to list devices served by a NUT data server, or to query data points
153153
reported by a particular device.
154-
* linkman:NUT-Monitor[8] is a GUI client for read-only or read-write access.
154+
* linkman:NUT-Monitor[1] is a GUI client for read-only or read-write access.
155155
* A suite of CGI clients can run on a web server like Apache or nginx to
156156
provide a simple HTML interface to your devices.
157157

@@ -309,7 +309,7 @@ into certain directories according to their documentation:
309309
linkman:hosts.conf[5] and linkman:upsset.conf[5] for configuration,
310310
and `upsstats-single.html` and `upsstats.html` for HTML UI templates.
311311

312-
Other clients, whether delivered by NUT project (linkman:NUT-Monitor[8]
312+
Other clients, whether delivered by NUT project (linkman:NUT-Monitor[1]
313313
GUI) or co-located (link:https://github.com/networkupstools/wmnut[WMNut])
314314
or third-party (see https://networkupstools.org/projects.html) would
315315
probably support saving their settings or "favorites". Do not forget

docs/man/nutdrv_qx.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,14 @@ This value is truncated to units of 60 seconds.
7474
+
7575
Note that a value below 3 minutes, may cause earlier firmware versions to not switch on automatically, so it defaults to 3 minutes (i.e. 180 seconds).
7676
+
77-
This option provides a default value for *ups.delay.start* that will then be used by the driver in the automatic shutdown sequence (i.e. calling the driver with the *-k* option, calling linkman:upsdrvctl[8] with the *shutdown* option or when the +FSD+ flag is set and linkman:upsmon[8] enters its shutdown sequence): however you can change this value `on the fly' for the actual session, only for the use with instant commands, setting *ups.delay.start* with linkman:upsrw[8].
77+
This option provides a default value for *ups.delay.start* that will then be used by the driver in the automatic shutdown sequence (i.e. calling the driver with the *-k* option, calling linkman:upsdrvctl[8] with the *shutdown* option or when the +FSD+ flag is set and linkman:upsmon[8] enters its shutdown sequence): however you can change this value `on the fly' for the actual session, only for the use with instant commands, setting *ups.delay.start* with linkman:upsrw[1].
7878

7979
*offdelay =* 'value'::
8080
Time to wait before shutting down the UPS (seconds).
8181
This value is truncated to units of 6 seconds (less than 60 seconds) or 60 seconds (more than 60 seconds).
8282
Defaults to 30 seconds.
8383
+
84-
This option provides a default value for *ups.delay.shutdown* that will then be used by the driver in the automatic shutdown sequence (i.e. calling the driver with the *-k* option, calling linkman:upsdrvctl[8] with the *shutdown* option or when the +FSD+ flag is set and linkman:upsmon[8] enters its shutdown sequence): however you can change this value "on the fly" for the actual session, only for the use with instant commands, setting *ups.delay.shutdown* with linkman:upsrw[8].
84+
This option provides a default value for *ups.delay.shutdown* that will then be used by the driver in the automatic shutdown sequence (i.e. calling the driver with the *-k* option, calling linkman:upsdrvctl[8] with the *shutdown* option or when the +FSD+ flag is set and linkman:upsmon[8] enters its shutdown sequence): however you can change this value "on the fly" for the actual session, only for the use with instant commands, setting *ups.delay.shutdown* with linkman:upsrw[1].
8585

8686
*stayoff*::
8787
If you set stayoff in linkman:ups.conf[5] when FSD arises the UPS will call a *shutdown.stayoff* shutting down after *ups.delay.shutdown* seconds and won't return (see <<_known_problems,KNOWN PROBLEMS>>), otherwise (standard behaviour) the UPS will call *shutdown.return* shutting down after *ups.delay.shutdown* seconds and then turn on after *ups.delay.start* seconds (if mains meanwhile returned).
@@ -214,7 +214,7 @@ MASTERGUARD PROTOCOL
214214
*slave_addr =* 'value'::
215215
Make the claim function verify it's talking to the specified 'slave address' (*ups.id*).
216216
Safeguard against talking to the wrong one of several identical UPSes on the same USB bus.
217-
Note that when changing *ups.id* (through linkman:upsrw[8]) the driver will continue to talk to the UPS with the new 'slave address', but won't claim it again on restart until the *slave_addr* parameter is adjusted.
217+
Note that when changing *ups.id* (through linkman:upsrw[1]) the driver will continue to talk to the UPS with the new 'slave address', but won't claim it again on restart until the *slave_addr* parameter is adjusted.
218218

219219

220220
INNOVART31, INNOVART33, Q1, Q2, Q6 PROTOCOLS
@@ -463,7 +463,7 @@ This subdriver, meant to be used with the 'megatec' protocol, does *not* support
463463
UPS COMMANDS
464464
------------
465465

466-
This driver supports some instant commands (see linkman:upscmd[8]):
466+
This driver supports some instant commands (see linkman:upscmd[1]):
467467

468468
*beeper.toggle*::
469469
Toggle the UPS beeper.
@@ -670,7 +670,7 @@ It no longer defaults to 0 minutes but to 3 minutes (i.e. 180 seconds) for compa
670670
*battnumb*::
671671
This option has been renamed to *battery_number*.
672672

673-
The following options are no longer supported by this driver, you can now change them more conveniently "on the fly" calling linkman:upsrw[8] with the appropriate NUT variable -- provided that your UPS supports them.
673+
The following options are no longer supported by this driver, you can now change them more conveniently "on the fly" calling linkman:upsrw[1] with the appropriate NUT variable -- provided that your UPS supports them.
674674

675675
[horizontal]
676676
*battpacks*:: -> *battery.packs*
@@ -883,11 +883,11 @@ linkman:blazer_ser[8],
883883
linkman:blazer_usb[8],
884884
linkman:nutupsdrv[8],
885885
linkman:ups.conf[5],
886-
linkman:upsc[8],
887-
linkman:upscmd[8],
886+
linkman:upsc[1],
887+
linkman:upscmd[1],
888888
linkman:upsdrvctl[8],
889889
linkman:upsmon[8],
890-
linkman:upsrw[8]
890+
linkman:upsrw[1]
891891

892892

893893
Internet Resources:

0 commit comments

Comments
 (0)