Skip to content

Commit

Permalink
update manpages
Browse files Browse the repository at this point in the history
The old manpages were quite out of date; Replace them with some basic
help2man generated pages

Signed-off-by: Sjoerd Simons <[email protected]>
  • Loading branch information
sjoerdsimons committed Nov 4, 2023
1 parent 0b7a3d4 commit 7b408ab
Show file tree
Hide file tree
Showing 6 changed files with 106 additions and 320 deletions.
5 changes: 1 addition & 4 deletions debian/control
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Uploaders: Matt Hart <[email protected]>,
Sjoerd Simons <[email protected]>
Build-Depends: debhelper-compat (= 13),
dh-python,
docbook-xml,
docbook-xsl,
python3,
python3-aiohttp,
python3-all,
Expand All @@ -23,8 +21,7 @@ Build-Depends: debhelper-compat (= 13),
python3-serial-asyncio,
python3-setuptools,
python3-systemd,
python3-usb,
xsltproc
python3-usb
Standards-Version: 4.2.0
Homepage: http://github.com/pdudaemon
Vcs-Git: https://github.com/pdudaemon/pkg-pdudaemon.git
Expand Down
44 changes: 44 additions & 0 deletions debian/pduclient.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH PDUCLIENT "1" "November 2023" "pduclient 0.0.8" "User Commands"
.SH NAME
pduclient \- manual page for pduclient 0.0.8
.SH SYNOPSIS
.B pduclient
\fI\,--daemon deamonhostname --hostname pduhostname --port pduportnum --command pducommand\/\fR
.SH DESCRIPTION
PDUDaemon client
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-H\fR, \fB\-\-http\fR
Use HTTP protocol
.TP
\fB\-\-daemon\fR=\fI\,PDUDAEMONHOSTNAME\/\fR
PDUDaemon listener hostname (ex: localhost)
.TP
\fB\-\-hostname\fR=\fI\,PDUHOSTNAME\/\fR
PDU Hostname (ex: pdu05)
.TP
\fB\-\-port\fR=\fI\,PDUPORTNUM\/\fR
PDU Portnumber (ex: 04)
.TP
\fB\-\-command\fR=\fI\,PDUCOMMAND\/\fR
PDU command (ex: reboot|on|off)
.TP
\fB\-\-delay\fR=\fI\,PDUDELAY\/\fR
Delay before command runs, or between off/on when
rebooting (ex: 5)
.SH "SEE ALSO"
The full documentation for
.B pduclient
is maintained as a Texinfo manual. If the
.B info
and
.B pduclient
programs are properly installed at your site, the command
.IP
.B info pduclient
.PP
should give you access to the complete manual.
179 changes: 0 additions & 179 deletions debian/pduclient.xml

This file was deleted.

59 changes: 59 additions & 0 deletions debian/pdudaemon.8
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH PDUDAEMON "1" "November 2023" "pdudaemon 0.0.8" "User Commands"
.SH NAME
pdudaemon \- manual page for pdudaemon 0.0.8
.SH DESCRIPTION
usage: pdudaemon [\-h] [\-\-journal] [\-\-logfile LOGFILE]
.IP
[\-\-loglevel {DEBUG,ERROR,INFO,WARN}] [\-\-conf CONF]
[\-\-listener LISTENER]
[\-\-alias ALIAS | \fB\-\-hostname\fR DRIVEHOSTNAME] [\-\-drive]
[\-\-request DRIVEREQUEST] [\-\-retries DRIVERETRIES]
[\-\-delay DRIVEDELAY] [\-\-port DRIVEPORT]
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-conf\fR CONF, \fB\-c\fR CONF
configuration file [/etc/pdudaemon/pdudaemon.conf]
.TP
\fB\-\-listener\fR LISTENER
PDUDaemon listener setting
.HP
\fB\-\-alias\fR ALIAS
.HP
\fB\-\-hostname\fR DRIVEHOSTNAME
.SS "logging:"
.TP
\fB\-\-journal\fR, \fB\-j\fR
Log to the journal
.TP
\fB\-\-logfile\fR LOGFILE
log file [/var/log/pdudaemon.log]
.TP
\fB\-\-loglevel\fR {DEBUG,ERROR,INFO,WARN}
logging level [INFO]
.SS "drive:"
.HP
\fB\-\-drive\fR
.HP
\fB\-\-request\fR DRIVEREQUEST
.HP
\fB\-\-retries\fR DRIVERETRIES
.HP
\fB\-\-delay\fR DRIVEDELAY
.HP
\fB\-\-port\fR DRIVEPORT
.SH "SEE ALSO"
The full documentation for
.B pdudaemon
is maintained as a Texinfo manual. If the
.B info
and
.B pdudaemon
programs are properly installed at your site, the command
.IP
.B info pdudaemon
.PP
should give you access to the complete manual.
Loading

0 comments on commit 7b408ab

Please sign in to comment.