desktop/wmtimer: Add man page.

Signed-off-by: B. Watson <yalhcru@gmail.com>

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

4 files changed, 249 insertions, 12 deletions

diff --git a/desktop/wmtimer/README b/desktop/wmtimer/README
index 634138c5ef99..ca9b255e0a74 100644
--- a/desktop/wmtimer/README
+++ b/desktop/wmtimer/README
@@ -1,3 +1,5 @@
+wmtimer (Timer DockApp)
+
 WMTimer is a dockable alarm clock for WindowMaker which can be run in
 alarm, countdown timer, or chronograph mode. In alarm or timer mode,
 you can either execute a command or sound the system bell when the time
diff --git a/desktop/wmtimer/wmtimer.1 b/desktop/wmtimer/wmtimer.1
new file mode 100644
index 000000000000..ffb8eb7db401
--- /dev/null
+++ b/desktop/wmtimer/wmtimer.1
@@ -0,0 +1,130 @@
+.\" 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 "WMTIMER" 1 "2021-09-09" "2.92" "SlackBuilds.org"
+.SH NAME
+wmtimer \- alarm clock dockapp for windowmaker
+.\" RST source for wmtimer(1) man page. Convert with:
+.
+.\" rst2man.py wmtimer.rst > wmtimer.1
+.
+.\" rst2man.py comes from the SBo development/docutils package.
+.
+.SH SYNOPSIS
+.sp
+wmtimer \-[a|c|r] [\-b] [\-color \fI<color>\fP] [\-display \fI<display>\fP] [\-geometry \fI<geom>\fP] \-t \fI<hh:mm:ss>\fP \-e \fI<command>\fP
+.SH DESCRIPTION
+.sp
+\fBwmtimer\fP is a dockable alarm clock for WindowMaker which can be run in
+alarm, countdown timer, or chronograph mode. In alarm or timer mode,
+you can either execute a command or sound the system bell when the time
+is reached.
+.sp
+\fBwmtimer\fP can be configured either at startup time via the command
+line, or by using the GTK interface by clicking on the main part of the
+window (anywhere except the buttons).
+.sp
+To switch to the Chrono function simply click on the right arrow button to
+start the chronograph.
+.sp
+You can pause the chronogaph by clicking on the center, rectangle button
+and resume again by clicking the right arrow button.
+.sp
+You can reset the timer by clicking on the left arrow button.
+.sp
+Without any of the \fB\-a\fP, \fB\-c\fP, or \fB\-r\fP options, \fBwmtimer\fP
+just shows the current time until it\(aqs clicked on.
+.sp
+Time entered via the command line must be in the form of hh:mm:ss. You
+don\(aqt need to have 2 digits for each number but you must have at least
+zeroes as placeholders for hours, minutes and seconds.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B  \-a
+Alarm mode. \fBwmtimer\fP will beep or exec a command at the specified time.
+.TP
+.B  \-b
+Beep. This uses the X11 "system bell", which may be disabled
+via \fBxset(1)\fP (in which case you won\(aqt hear anything).
+.TP
+.B  \-c
+Countdown timer mode. \fBwmtimer\fP will beep or exec a command when specified time counts down to 0.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-color \fIcolor\fP
+Set text color; as a color name (e.g. \fBgreen\fP), or hex digits: \fIrgb:RR/GG/BB\fP or \fI#RRGGBB\fP\&.
+.TP
+.B \-display \fIdisplay\fP
+X display to connect to (default: \fB:0\fP).
+.TP
+.B \-e \fIcommand\fP
+Exec command. If the command has arguments, it must be quoted. If
+any of the arguments have spaces, quote them again (e.g. use
+double\-quotes around the whole command, and single\-quotes around
+filenames with spaces).
+.TP
+.B \-geometry \fIgeom\fP
+Window size and placement. Not usually needed.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B  \-r
+Start in chronograph (stopwatch) mode.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-t \fI<hh:mm:ss>\fP
+With \fB\-a\fP, sets the alarm time. With \fB\-c\fP, sets the initial time
+to count down from. With \fB\-r\fP, sets the initial time to count \fIup\fP
+from. Without this option, the default time is \fB00:00:00\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B  \-h
+Show built\-in help.
+.TP
+.B  \-v
+Print the version number and exit.
+.UNINDENT
+.SH COPYRIGHT
+.sp
+See the file /usr/doc/wmtimer\-2.92/COPYING for license information.
+.SH AUTHORS
+.sp
+wmtimer was written by Josh King <\fI\%wmtimer@darkops.net\fP>.
+.sp
+This man page written for the SlackBuilds.org project
+by B. Watson, and is licensed under the WTFPL.
+.SH SEE ALSO
+.sp
+/usr/doc/wmtimer\-2.92/README
+.\" Generated by docutils manpage writer.
+.
diff --git a/desktop/wmtimer/wmtimer.SlackBuild b/desktop/wmtimer/wmtimer.SlackBuild
index aff16ab04432..9167bc1c1f5c 100644
--- a/desktop/wmtimer/wmtimer.SlackBuild
+++ b/desktop/wmtimer/wmtimer.SlackBuild
@@ -27,6 +27,8 @@
 
 # Now maintained by B. Watson <yalhcru@gmail.com>
 
+# 20210909 bkw: BUILD=3, got bored and wrote a man page.
+
 # 20160816 bkw:
 # - took over maintenance
 # - fix literal string == compares (need to be strcmp())
@@ -36,7 +38,7 @@ cd $(dirname $0) ; CWD=$(pwd)
 
 PRGNAM=wmtimer
 VERSION=${VERSION:-2.92}
-BUILD=${BUILD:-2}
+BUILD=${BUILD:-3}
 TAG=${TAG:-_SBo}
 PKGTYPE=${PKGTYPE:-tgz}
 
@@ -48,9 +50,6 @@ if [ -z "$ARCH" ]; then
   esac
 fi
 
-# If the variable PRINT_PACKAGE_NAME is set, then this script will report what
-# the name of the created package would be, and then exit. This information
-# could be useful to other scripts.
 if [ ! -z "${PRINT_PACKAGE_NAME}" ]; then
   echo "$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.$PKGTYPE"
   exit 0
@@ -83,21 +82,19 @@ rm -rf $PRGNAM-$VERSION
 tar xvf $CWD/$PRGNAM-$VERSION.tar.gz
 cd $PRGNAM-$VERSION
 chown -R root:root .
-find -L . \
- \( -perm 777 -o -perm 775 -o -perm 750 -o -perm 711 -o -perm 555 \
-  -o -perm 511 \) -exec chmod 755 {} \; -o \
- \( -perm 666 -o -perm 664 -o -perm 640 -o -perm 600 -o -perm 444 \
-  -o -perm 440 -o -perm 400 \) -exec chmod 644 {} \;
+find -L .  -perm /111 -a \! -perm 755 -a -exec chmod 755 {} \+ -o \
+        \! -perm /111 -a \! -perm 644 -a -exec chmod 644 {} \+
 
 patch -p1 < $CWD/compilefix.diff
 
-sed -i -e "s,-O2,$SLKCFLAGS -fgnu89-inline," -e "s,-g ,," $PRGNAM/Makefile
+sed -i -e "s,-O2,$SLKCFLAGS -fcommon -fgnu89-inline," -e "s,-g ,," $PRGNAM/Makefile
 make -C $PRGNAM
-mkdir -p $PKG/usr/bin
+mkdir -p $PKG/usr/bin $PKG/usr/man/man1
 install -s -m0755 $PRGNAM/$PRGNAM $PKG/usr/bin
+gzip -9c < $CWD/$PRGNAM.1 > $PKG/usr/man/man1/$PRGNAM.1.gz
 
 mkdir -p $PKG/usr/doc/$PRGNAM-$VERSION
-cp -a Changelog COPYING CREDITS INSTALL README $PKG/usr/doc/$PRGNAM-$VERSION
+cp -a Changelog COPYING CREDITS README $PKG/usr/doc/$PRGNAM-$VERSION
 cat $CWD/$PRGNAM.SlackBuild > $PKG/usr/doc/$PRGNAM-$VERSION/$PRGNAM.SlackBuild
 
 mkdir -p $PKG/install
diff --git a/desktop/wmtimer/wmtimer.rst b/desktop/wmtimer/wmtimer.rst
new file mode 100644
index 000000000000..71bbca1cd314
--- /dev/null
+++ b/desktop/wmtimer/wmtimer.rst
@@ -0,0 +1,108 @@
+.. RST source for wmtimer(1) man page. Convert with:
+..   rst2man.py wmtimer.rst > wmtimer.1
+.. rst2man.py comes from the SBo development/docutils package.
+
+.. |version| replace:: 2.92
+.. |date| date::
+
+=======
+wmtimer
+=======
+
+-----------------------------------
+alarm clock dockapp for windowmaker
+-----------------------------------
+
+:Manual section: 1
+:Manual group: SlackBuilds.org
+:Date: |date|
+:Version: |version|
+
+SYNOPSIS
+========
+
+wmtimer -[a|c|r] [-b] [-color *<color>*] [-display *<display>*] [-geometry *<geom>*] -t *<hh:mm:ss>* -e *<command>*
+
+DESCRIPTION
+===========
+
+**wmtimer** is a dockable alarm clock for WindowMaker which can be run in
+alarm, countdown timer, or chronograph mode. In alarm or timer mode,
+you can either execute a command or sound the system bell when the time
+is reached.
+
+**wmtimer** can be configured either at startup time via the command
+line, or by using the GTK interface by clicking on the main part of the
+window (anywhere except the buttons).
+
+To switch to the Chrono function simply click on the right arrow button to
+start the chronograph.
+
+You can pause the chronogaph by clicking on the center, rectangle button
+and resume again by clicking the right arrow button.
+
+You can reset the timer by clicking on the left arrow button.
+
+Without any of the **-a**, **-c**, or **-r** options, **wmtimer**
+just shows the current time until it's clicked on.
+
+Time entered via the command line must be in the form of hh:mm:ss. You
+don't need to have 2 digits for each number but you must have at least
+zeroes as placeholders for hours, minutes and seconds.
+
+OPTIONS
+=======
+
+-a
+       Alarm mode. **wmtimer** will beep or exec a command at the specified time.
+
+-b     Beep. This uses the X11 "system bell", which may be disabled
+       via **xset(1)** (in which case you won't hear anything).
+
+-c
+       Countdown timer mode. **wmtimer** will beep or exec a command when specified time counts down to 0.
+
+-color *color*
+       Set text color; as a color name (e.g. **green**), or hex digits: *rgb:RR/GG/BB* or *#RRGGBB*.
+
+-display *display*
+       X display to connect to (default: **:0**).
+
+-e *command*
+       Exec command. If the command has arguments, it must be quoted. If
+       any of the arguments have spaces, quote them again (e.g. use
+       double-quotes around the whole command, and single-quotes around
+       filenames with spaces).
+
+-geometry *geom*
+       Window size and placement. Not usually needed.
+
+-r
+       Start in chronograph (stopwatch) mode.
+
+-t *<hh:mm:ss>*
+       With **-a**, sets the alarm time. With **-c**, sets the initial time
+       to count down from. With **-r**, sets the initial time to count *up*
+       from. Without this option, the default time is **00:00:00**.
+
+-h     Show built-in help.
+
+-v     Print the version number and exit.
+
+COPYRIGHT
+=========
+
+See the file /usr/doc/wmtimer-|version|/COPYING for license information.
+
+AUTHORS
+=======
+
+wmtimer was written by Josh King <wmtimer@darkops.net>.
+
+This man page written for the SlackBuilds.org project
+by B. Watson, and is licensed under the WTFPL.
+
+SEE ALSO
+========
+
+/usr/doc/wmtimer-|version|/README