From b7653a59160a5043d57a9fbc815479a1ea03f70e Mon Sep 17 00:00:00 2001
From: Dave B <github@d10.karoo.co.uk>
Date: Tue, 10 Mar 2015 03:22:52 +0000
Subject: [PATCH] Provide project manual "man page"

kdocker.1      - man page generated from ...
kdocker.pod    - template, using ...
kdocker_man.sh - pod2man shell script
---
 helpers/kdocker.1      | 278 +++++++++++++++++++++++++++++++++++++++++++++++++
 helpers/kdocker.pod    | 121 +++++++++++++++++++++
 helpers/kdocker_man.sh |   8 ++
 3 files changed, 407 insertions(+)
 create mode 100644 helpers/kdocker.1
 create mode 100644 helpers/kdocker.pod
 create mode 100755 helpers/kdocker_man.sh

diff --git a/helpers/kdocker.1 b/helpers/kdocker.1
new file mode 100644
index 0000000..54e2daa
--- /dev/null
+++ b/helpers/kdocker.1
@@ -0,0 +1,278 @@
+.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+.    ds C`
+.    ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{
+.    if \nF \{
+.        de IX
+.        tm Index:\\$1\t\\n%\t"\\$2"
+..
+.        if !\nF==2 \{
+.            nr % 0
+.            nr F 2
+.        \}
+.    \}
+.\}
+.rr rF
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "KDOCKER 1"
+.TH KDOCKER 1 "10 March, 2015" "Version 4.9" "General Commands Manual"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+.Vb 1
+\& kdocker \- dock any application in the system tray
+.Ve
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+\&\fBkdocker\fR [\fIoptions\fR]\fI\fR
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+.Vb 1
+\& KDocker is a program that will dock any application to the system tray
+.Ve
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.IP "\fB\-a\fR" 4
+.IX Item "-a"
+.Vb 1
+\& Show author information
+.Ve
+.IP "\fB\-b\fR" 4
+.IX Item "-b"
+.Vb 1
+\& Suppress the warning dialog when docking non\-normal windows (blind mode)
+.Ve
+.IP "\fB\-d\fR \fIsecs\fR" 4
+.IX Item "-d secs"
+.Vb 2
+\& Maximum time in seconds to allow for a command to start and open a window
+\& [default: 5 seconds]
+.Ve
+.IP "\fB\-e\fR \fItype\fR" 4
+.IX Item "-e type"
+.Vb 6
+\& Name matching syntax. Choices are:
+\&  n = normal, substring matching [default]
+\&  r = regex (regular expression)
+\&  u = unix wildcard
+\&  w = wildcard
+\&  x = W3C XML Schema 1.1
+.Ve
+.IP "\fB\-f\fR" 4
+.IX Item "-f"
+.Vb 1
+\& Dock window that has focus (active window)
+.Ve
+.IP "\fB\-h\fR" 4
+.IX Item "-h"
+.Vb 1
+\& Display this help, then exit
+.Ve
+.IP "\fB\-i\fR \fIfile\fR" 4
+.IX Item "-i file"
+.Vb 1
+\& Custom icon path
+.Ve
+.IP "\fB\-j\fR" 4
+.IX Item "-j"
+.Vb 1
+\& Case sensitive name (title) matching
+.Ve
+.IP "\fB\-k\fR" 4
+.IX Item "-k"
+.Vb 1
+\& Regex minimal matching
+.Ve
+.IP "\fB\-l\fR" 4
+.IX Item "-l"
+.Vb 1
+\& Iconify when focus lost
+.Ve
+.IP "\fB\-m\fR" 4
+.IX Item "-m"
+.Vb 1
+\& Keep application window showing (don\*(Aqt hide on dock)
+.Ve
+.IP "\fB\-n\fR \fIname\fR" 4
+.IX Item "-n name"
+.Vb 1
+\& Match window based on its title
+.Ve
+.IP "\fB\-o\fR" 4
+.IX Item "-o"
+.Vb 1
+\& Iconify when obscured by other windows
+.Ve
+.IP "\fB\-p\fR \fIsecs\fR" 4
+.IX Item "-p secs"
+.Vb 3
+\& By default, when the title of the application changes,
+\& a popup is displayed from the system tray for 4 seconds
+\& Works well with xmms
+.Ve
+.IP "\fB\-q\fR" 4
+.IX Item "-q"
+.Vb 1
+\& Disable ballooning title changes (quiet)
+.Ve
+.IP "\fB\-r\fR" 4
+.IX Item "-r"
+.Vb 1
+\& Remove this application from the pager
+.Ve
+.IP "\fB\-s\fR" 4
+.IX Item "-s"
+.Vb 1
+\& Make the window sticky (appears on all desktops)
+.Ve
+.IP "\fB\-t\fR" 4
+.IX Item "-t"
+.Vb 1
+\& Remove this application from the taskbar
+.Ve
+.IP "\fB\-v, \-\-version\fR" 4
+.IX Item "-v, --version"
+.Vb 1
+\& Show the KDocker version string, then exit
+.Ve
+.IP "\fB\-w\fR \fIwid\fR" 4
+.IX Item "-w wid"
+.Vb 2
+\& Window id of the application to dock
+\& Assumes hex number of the form 0x###...
+.Ve
+.IP "\fB\-x\fR \fIpid\fR" 4
+.IX Item "-x pid"
+.Vb 2
+\& Process id of the application to dock
+\& Assumes decimal number of the form ###...
+.Ve
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+.Vb 2
+\& KDocker was written by Girish Ramakrishnan
+\& Revised and maintained by John Schember
+.Ve
+.SH "REPORTING BUGS"
+.IX Header "REPORTING BUGS"
+Bugs and wishes to the KDocker Home Page <https://github.com/user-none/KDocker>
diff --git a/helpers/kdocker.pod b/helpers/kdocker.pod
new file mode 100644
index 0000000..d3621c1
--- /dev/null
+++ b/helpers/kdocker.pod
@@ -0,0 +1,121 @@
+
+=head1 NAME
+
+ kdocker - dock any application in the system tray
+
+=head1 SYNOPSIS
+
+B<kdocker> [I<options>]I<>
+
+=head1 DESCRIPTION
+
+ KDocker is a program that will dock any application to the system tray
+
+=head1 OPTIONS
+
+=over
+
+=item B<-a>
+
+ Show author information
+
+=item B<-b>
+
+ Suppress the warning dialog when docking non-normal windows (blind mode)
+
+=item B<-d> I<secs>
+
+ Maximum time in seconds to allow for a command to start and open a window
+ [default: 5 seconds]
+
+=item B<-e> I<type>
+
+ Name matching syntax. Choices are:
+  n = normal, substring matching [default]
+  r = regex (regular expression)
+  u = unix wildcard
+  w = wildcard
+  x = W3C XML Schema 1.1
+
+=item B<-f>
+
+ Dock window that has focus (active window)
+
+=item B<-h>
+
+ Display this help, then exit
+
+=item B<-i> I<file>
+
+ Custom icon path
+
+=item B<-j>
+
+ Case sensitive name (title) matching
+
+=item B<-k>
+
+ Regex minimal matching
+
+=item B<-l>
+
+ Iconify when focus lost
+
+=item B<-m>
+
+ Keep application window showing (don't hide on dock)
+
+=item B<-n> I<name>
+
+ Match window based on its title
+
+=item B<-o>
+
+ Iconify when obscured by other windows
+
+=item B<-p> I<secs>
+
+ By default, when the title of the application changes,
+ a popup is displayed from the system tray for 4 seconds
+ Works well with xmms
+
+=item B<-q>
+
+ Disable ballooning title changes (quiet)
+
+=item B<-r>
+
+ Remove this application from the pager
+
+=item B<-s>
+
+ Make the window sticky (appears on all desktops)
+
+=item B<-t>
+
+ Remove this application from the taskbar
+
+=item B<-v, --version>
+
+ Show the KDocker version string, then exit
+
+=item B<-w> I<wid>
+
+ Window id of the application to dock
+ Assumes hex number of the form 0x###...
+
+=item B<-x> I<pid>
+
+ Process id of the application to dock
+ Assumes decimal number of the form ###...
+
+=back
+
+=head1 AUTHOR
+
+ KDocker was written by Girish Ramakrishnan
+ Revised and maintained by John Schember
+
+=head1 REPORTING BUGS
+
+Bugs and wishes to the L<KDocker Home Page|https://github.com/user-none/KDocker>
diff --git a/helpers/kdocker_man.sh b/helpers/kdocker_man.sh
new file mode 100755
index 0000000..b3f4db1
--- /dev/null
+++ b/helpers/kdocker_man.sh
@@ -0,0 +1,8 @@
+#!/bin/sh
+
+# Create man page (kdocker.1) from pod template
+
+pod2man --center  'General Commands Manual' \
+        --release 'Version 4.9'             \
+        --date    "$(date +'%e %B, %Y')"    \
+        kdocker.pod  kdocker.1
