desktop/wmtime: Add man page.

3 files changed, 179 insertions, 1 deletions

diff --git a/desktop/wmtime/wmtime.1 b/desktop/wmtime/wmtime.1
new file mode 100644
index 0000000000..d5397a0cbd
--- /dev/null
+++ b/desktop/wmtime/wmtime.1
@@ -0,0 +1,93 @@
+.\" Man page generated from reStructuredText.
+.
+.TH WMTIME 1 "2017-02-11" "1.0b2" "SlackBuilds.org"
+.SH NAME
+wmtime \- clock/calendar dockapp for windowmaker
+.
+.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
+..
+.\" RST source for wmtime(1) man page. Convert with:
+.
+.\" rst2man.py wmtime.rst > wmtime.1
+.
+.\" rst2man.py comes from the SBo development/docutils package.
+.
+.SH SYNOPSIS
+.sp
+wmtime [\-digital] [\-display \fIdpy\fP] [\-h] [\-v]
+.SH DESCRIPTION
+.sp
+wmtime is a clock and calendar dockapp for windowmaker. It can display
+an analog\-style clock face or a digital\-style readout. The current month,
+day, and day of week are displayed also.
+.sp
+wmtime supports multiple languages for the weekday and month names. See
+\fIFILES\fP below for details on how to change the language.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \-h
+Print usage message and exit.
+.TP
+.B \-v
+Print version number and exit.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \fB\-digital\fP
+Display a digital clock face (default is analog).
+.TP
+.B \fB\-display\fP \fIdpy\fP
+X11 display. Default is to read the DISPLAY environment variable.
+.UNINDENT
+.SH FILES
+.INDENT 0.0
+.TP
+.B /usr/share/wmtime/languages/*.lang
+Language support files. Each is a text file with exactly 19 lines. The
+first 7 lines are the 2\-letter weekday name abbreviations, starting
+with Sunday. The other 12 lines are the 3\-letter month name abbreviations,
+starting with January. Only ASCII is supported, no Unicode or extended 8859\-*
+character sets.
+.TP
+.B /usr/share/wmtime/language
+Symlink to one of the files in /usr/share/wmtime/languages/. This is the
+language the application will use. The system administrator can adjust the
+symlink, but there\(aqs no way for a normal user to use a different language
+than the system default.
+.UNINDENT
+.SH COPYRIGHT
+.sp
+See the file /usr/doc/wmtime\-1.0b2/COPYING for license information.
+.SH AUTHORS
+.sp
+wmtime was written by tijno and warp.
+.sp
+This man page written for the SlackBuilds.org project
+by B. Watson, and is licensed under the WTFPL.
+.\" Generated by docutils manpage writer.
+.
diff --git a/desktop/wmtime/wmtime.SlackBuild b/desktop/wmtime/wmtime.SlackBuild
index 4ba166cf0f..d2cb2df416 100644
--- a/desktop/wmtime/wmtime.SlackBuild
+++ b/desktop/wmtime/wmtime.SlackBuild
@@ -8,6 +8,9 @@
 # had no license, modified version released under the WTFPL. See
 # http://www.wtfpl.net/txt/copying/ for details.
 
+# 20170211 bkw:
+# - Add man page, BUILD=3
+
 # 20170210 bkw:
 # - Take over maintenance, BUILD=2
 # - i486 => i586
@@ -16,7 +19,7 @@
 
 PRGNAM=wmtime
 VERSION=${VERSION:-1.0b2}
-BUILD=${BUILD:-2}
+BUILD=${BUILD:-3}
 TAG=${TAG:-_SBo}
 
 if [ -z "$ARCH" ]; then
@@ -84,6 +87,10 @@ else
   exit 1
 fi
 
+# man page written for this slackbuild
+mkdir -p $PKG/usr/man/man1
+gzip -9c < $CWD/$PRGNAM.1 > $PKG/usr/man/man1/$PRGNAM.1.gz
+
 mkdir -p $PKG/usr/doc/$PRGNAM-$VERSION
 cp -a BUGS CHANGES COPYING HINTS README TODO $PKG/usr/doc/$PRGNAM-$VERSION
 cat $CWD/$PRGNAM.SlackBuild > $PKG/usr/doc/$PRGNAM-$VERSION/$PRGNAM.SlackBuild
diff --git a/desktop/wmtime/wmtime.rst b/desktop/wmtime/wmtime.rst
new file mode 100644
index 0000000000..b72e406838
--- /dev/null
+++ b/desktop/wmtime/wmtime.rst
@@ -0,0 +1,78 @@
+.. RST source for wmtime(1) man page. Convert with:
+..   rst2man.py wmtime.rst > wmtime.1
+.. rst2man.py comes from the SBo development/docutils package.
+
+.. |version| replace:: 1.0b2
+.. |date| date::
+
+======
+wmtime
+======
+
+--------------------------------------
+clock/calendar dockapp for windowmaker
+--------------------------------------
+
+:Manual section: 1
+:Manual group: SlackBuilds.org
+:Date: |date|
+:Version: |version|
+
+SYNOPSIS
+========
+
+wmtime [-digital] [-display *dpy*] [-h] [-v]
+
+DESCRIPTION
+===========
+
+wmtime is a clock and calendar dockapp for windowmaker. It can display
+an analog-style clock face or a digital-style readout. The current month,
+day, and day of week are displayed also.
+
+wmtime supports multiple languages for the weekday and month names. See
+*FILES* below for details on how to change the language.
+
+OPTIONS
+=======
+
+-h
+    Print usage message and exit.
+ 
+-v
+    Print version number and exit.
+
+**-digital**
+    Display a digital clock face (default is analog).
+
+**-display** *dpy*
+    X11 display. Default is to read the DISPLAY environment variable.
+
+FILES
+=====
+
+/usr/share/wmtime/languages/\*.lang
+    Language support files. Each is a text file with exactly 19 lines. The
+    first 7 lines are the 2-letter weekday name abbreviations, starting
+    with Sunday. The other 12 lines are the 3-letter month name abbreviations,
+    starting with January. Only ASCII is supported, no Unicode or extended 8859-*
+    character sets.
+
+/usr/share/wmtime/language
+    Symlink to one of the files in /usr/share/wmtime/languages/. This is the
+    language the application will use. The system administrator can adjust the
+    symlink, but there's no way for a normal user to use a different language
+    than the system default.
+
+COPYRIGHT
+=========
+
+See the file /usr/doc/wmtime-|version|/COPYING for license information.
+
+AUTHORS
+=======
+
+wmtime was written by tijno and warp.
+
+This man page written for the SlackBuilds.org project
+by B. Watson, and is licensed under the WTFPL.