desktop/wmsupermon: Add man page.

Signed-off-by: B. Watson <urchlay@slackware.uk>

Signed-off-by: Willy Sudiarto Raharjo <willysr@slackbuilds.org>

3 files changed, 175 insertions, 0 deletions

diff --git a/desktop/wmsupermon/wmsupermon.1 b/desktop/wmsupermon/wmsupermon.1
new file mode 100644
index 000000000000..8592020cef60
--- /dev/null
+++ b/desktop/wmsupermon/wmsupermon.1
@@ -0,0 +1,91 @@
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH "WMSUPERMON" 1 "2023-01-29" "1.2.2" "SlackBuilds.org"
+.SH NAME
+wmsupermon \- universal monitoring dockapp for WindowMaker
+.\" RST source for wmsupermon(1) man page. Convert with:
+.
+.\" rst2man.py wmsupermon.rst > wmsupermon.1
+.
+.SH SYNOPSIS
+.sp
+wmsupermon [\fB\-d|display\fP \fIdisplay\fP] [\fB\-c|\-\-config\fP \fIfile\fP]
+.sp
+wmsupermon [\fB\-h|\-\-help\fP]
+.sp
+wmsupermon [\fB\-v|\-\-version\fP]
+.SH DESCRIPTION
+.sp
+\fBwmsupermon\fP is a WindowMaker dockapp that can be used to monitor
+CPU usage, frequency, and temperature; disk I/O; memory, swap, and
+filesystem usage; network traffic (local or to/from your router);
+wireless link quality; battery status; and anything else you can think
+of that has a numeric value.
+.sp
+The dockapp is configured via the config file (\fI~/.wmsupermonrc\fP
+by default), which specifies what to monitor and how to present the
+results.
+.sp
+See /usr/doc/wmsupermon\-1.2.2/README for the syntax of the config
+file. In the same directory are some example configs.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \-d, \-\-display \fIdisplay\fP
+Display to use (default: \fIDISPLAY\fP in environment).
+.TP
+.B \-c, \-\-config \fIfile\fP
+Path to config file (default: \fI~/.wmsupermonrc\fP). Useful if you want
+to run multiple instances that show different data.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B  \-h\fP,\fB  \-\-help
+Shows help text and exits.
+.TP
+.B  \-v\fP,\fB  \-\-version
+Shows program version and exits.
+.UNINDENT
+.SH COPYRIGHT
+.sp
+See the file /usr/doc/wmsupermon\-1.2.2/COPYING for license information.
+.SH AUTHORS
+.sp
+wmsupermon was written by Sergei Golubchik.
+.sp
+This man page written for the SlackBuilds.org project
+by B. Watson, and is licensed under the WTFPL.
+.SH SEE ALSO
+.sp
+\fBWindowMaker\fP(1), \fBwmmon\fP(1), \fBwmnet\fP(1)
+.sp
+\fI\%http://dockapps.net\fP, for a large collection of other dockapps.
+.\" Generated by docutils manpage writer.
+.
diff --git a/desktop/wmsupermon/wmsupermon.SlackBuild b/desktop/wmsupermon/wmsupermon.SlackBuild
index 870a6c367ea3..318f3926f77d 100644
--- a/desktop/wmsupermon/wmsupermon.SlackBuild
+++ b/desktop/wmsupermon/wmsupermon.SlackBuild
@@ -70,6 +70,10 @@ make FLAGS="$SLKCFLAGS"
 mkdir -p $PKG/usr/bin
 install -s -m0755 -oroot -groot $PRGNAM $PKG/usr/bin
 
+# 20230129 bkw: wrote a man page. seemed like there should be one.
+mkdir -p $PKG/usr/man/man1
+gzip -9c < $CWD/$PRGNAM.1 > $PKG/usr/man/man1/$PRGNAM.1.gz
+
 PKGDOC=$PKG/usr/doc/$PRGNAM-$VERSION
 mkdir -p $PKGDOC
 cp -a example-wmsupermonrc COPYING ChangeLog README TODO $PKGDOC
diff --git a/desktop/wmsupermon/wmsupermon.rst b/desktop/wmsupermon/wmsupermon.rst
new file mode 100644
index 000000000000..daaba76bb59b
--- /dev/null
+++ b/desktop/wmsupermon/wmsupermon.rst
@@ -0,0 +1,80 @@
+.. RST source for wmsupermon(1) man page. Convert with:
+..   rst2man.py wmsupermon.rst > wmsupermon.1
+
+.. |version| replace:: 1.2.2
+.. |date| date::
+
+==========
+wmsupermon
+==========
+
+--------------------------------------------
+universal monitoring dockapp for WindowMaker
+--------------------------------------------
+
+:Manual section: 1
+:Manual group: SlackBuilds.org
+:Date: |date|
+:Version: |version|
+
+SYNOPSIS
+========
+
+wmsupermon [**-d|display** *display*] [**-c|--config** *file*]
+
+wmsupermon [**-h|--help**]
+
+wmsupermon [**-v|--version**]
+
+DESCRIPTION
+===========
+
+**wmsupermon** is a WindowMaker dockapp that can be used to monitor
+CPU usage, frequency, and temperature; disk I/O; memory, swap, and
+filesystem usage; network traffic (local or to/from your router);
+wireless link quality; battery status; and anything else you can think
+of that has a numeric value.
+
+The dockapp is configured via the config file (*~/.wmsupermonrc*
+by default), which specifies what to monitor and how to present the
+results.
+
+See /usr/doc/wmsupermon-|version|/README for the syntax of the config
+file. In the same directory are some example configs.
+
+OPTIONS
+=======
+
+-d, --display *display*
+  Display to use (default: *DISPLAY* in environment).
+
+-c, --config *file*
+  Path to config file (default: *~/.wmsupermonrc*). Useful if you want
+  to run multiple instances that show different data.
+
+-h, --help
+  Shows help text and exits.
+
+-v, --version
+  Shows program version and exits.
+
+
+COPYRIGHT
+=========
+
+See the file /usr/doc/wmsupermon-|version|/COPYING for license information.
+
+AUTHORS
+=======
+
+wmsupermon was written by Sergei Golubchik.
+
+This man page written for the SlackBuilds.org project
+by B. Watson, and is licensed under the WTFPL.
+
+SEE ALSO
+========
+
+**WindowMaker**\(1), **wmmon**\(1), **wmnet**\(1)
+
+http://dockapps.net, for a large collection of other dockapps.