Converted fbsetroot(1) to asciidoc format

5 files changed, 372 insertions, 119 deletions

diff --git a/doc/Makefile.am b/doc/Makefile.am
index b4ffd9f..e7309d8 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -2,14 +2,14 @@
 # Makefile.am for fluxbox/doc
 
 SUBDIRS = ru
-CLEANFILES = fluxbox.1 fbrun.1 fbsetbg.1 fluxbox-apps.5 \
+CLEANFILES = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 fluxbox-apps.5 \
         fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5
 MAINTAINERCLEANFILES = Makefile.in
-man_MANS = fluxbox.1 fbrun.1 fbsetbg.1 fluxbox-apps.5 \
+man_MANS = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 fluxbox-apps.5 \
         fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 \
-        fbsetroot.1 startfluxbox.1
-EXTRA_DIST=fbsetroot.1 startfluxbox.1 CODESTYLE \
-        fluxbox.1.in fbrun.1.in fbsetbg.1.in fluxbox-apps.5.in \
+        startfluxbox.1
+EXTRA_DIST=startfluxbox.1 CODESTYLE \
+        fluxbox.1.in fbrun.1.in fbsetbg.1.in fbsetroot.1.in fluxbox-apps.5.in \
         fluxbox-keys.5.in fluxbox-menu.5.in fluxbox-remote.1.in fluxbox-style.5.in
 distclean-local:
         rm -f *\~
diff --git a/doc/asciidoc/Makefile b/doc/asciidoc/Makefile
index e169230..bb48c1e 100644
--- a/doc/asciidoc/Makefile
+++ b/doc/asciidoc/Makefile
@@ -2,7 +2,7 @@
 # create manpages from the asciidoc files
 #
 
-SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt fbsetbg.txt
+SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt fbsetbg.txt fbsetroot.txt
 SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt
 
 MAN = $(SRC1:.txt=.1.in) $(SRC5:.txt=.5.in)
diff --git a/doc/asciidoc/fbsetroot.txt b/doc/asciidoc/fbsetroot.txt
new file mode 100644
index 0000000..a41733d
--- /dev/null
+++ b/doc/asciidoc/fbsetroot.txt
@@ -0,0 +1,87 @@
+fbsetroot(1)
+============
+Jim Ramsay <i.am@jimramsay.com>
+v1.1.2, 18 February 2009
+:man source:   fbsetroot.txt
+:man version:  {revision}
+:man manual:   Fluxbox Manual  
+
+NAME
+----
+fbsetroot - a simple background utility used by the fluxbox(1) window manager,
+originally written for and by the original blackbox(1) window manager.
+
+SYNOPSIS
+--------
+*fbsetroot* [-display 'display'] -solid 'color'
+
+*fbsetroot* [-display 'display'] -mod 'x' 'y' -fg 'color' -bg 'color'
+
+*fbsetroot* [-display 'display'] -gradient 'texture' -from 'color' -to 'color'
+
+*fbsetroot* -help
+
+DESCRIPTION
+-----------
+*fbsetroot(1)* is a utility that can control the appearance of the root window
+in three ways: Either give it a solid color, or write a two color modula pattern
+to it, or render a gradient texture, based on two different colors.
+
+fbsetroot resembles *xsetroot(1)* in this functionality but it supports
+multiple-screen displays, and gradient textures the same way as blackbox or
+fluxbox does. It doesn't handle cursors etc. fbsetroot was originally part of
+the Blackbox package and was carried over with the code that became Fluxbox. It
+was called bsetroot back in those days.
+
+OPTIONS
+-------
+fbsetroot operates in three ways, you must choose one of  the  first  3
+options:
+
+*-solid* 'color'::
+Sets the root window to specified color.
+
+*-mod* 'x' 'y'::
+Creates a modula pattern. You must specify *-bg* and *-fg* colors.
+
+*-gradient* 'texturestring'::
+Renders the specified texture string to the root window.
++
+'texturestring' may be one of:;;
+        *Horizontal  /  Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic /
+Rectangle / Pyramid*
++
+Select one of these texture types, they only apply when  *-gradient* is
+specifed.  You must also specify both a *-from* and a *-to* color.
+
+*-display* 'display'::
+Tells fbsetroot to connect to the specified display.
+
+*-bg, -background* 'color'::
+Background color.  Needed for *-mod* patterns.
+
+*-fg, -foreground* 'color'::
+Foreground color.  Needed for *-mod* patterns.
+
+*-from* 'color'::
+Start color for rendering textures.  Needed for *-gradient* patterns.
+
+*-to* 'color'::
+Ending color for rendering textures.  Needed for *-gradient* patterns.
+
+*-help*::
+Prints version info and short help text.
+
+AUTHORS
+-------
+fbsetroot is written and maintained by the Fluxbox Development Team
+
+This manpage was modified by Curt "Asenchi" Micol <asenchi@asenchi.com>
+for the Fluxbox window manager.
+
+Further updates for fluxbox-1.1.2 and conversion to asciidoc format by Jim
+Ramsay <i.am@jimramsay.com>
+
+SEE ALSO
+--------
+fluxbox(1) fbsetbg(1)
diff --git a/doc/fbsetroot.1 b/doc/fbsetroot.1
deleted file mode 100644
index ec8c088..0000000
--- a/doc/fbsetroot.1
+++ /dev/null
@@ -1,113 +0,0 @@
-.\"
-.\" Man page for fbsetroot
-.\"
-.\" Copyright (c) 2000 by Wilbert Berendsen <wbsoft@xs4all.nl>
-.\" Copyright (c) 2004 by Curt "Asenchi" Micol <asenchi@asenchi.com>
-.\" 
-.\" This page was updated for Fluxbox by Curt "Asenchi" Micol on June 25, 2004
-.\"
-.\" Permission to use, copy, modify, and distribute this documentation for
-.\" any purpose with or without fee is hereby granted, provided that the
-.\" above copyright notice and this permission notice appear in all copies.
-.\"
-.\" THE DOCUMENTATION IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
-.\" WARRANTIES WITH REGARD TO THIS DOCUMENTATION INCLUDING ALL IMPLIED
-.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
-.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
-.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
-.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
-.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-.\" PERFORMANCE OF THIS DOCUMENTATION
-.\"
-.TH fbsetroot 1 "July 8th, 2005" "0.9.13"
-.SH NAME
-fbsetroot \- a simple background utility used by the Fluxbox window manager, originally 
-written for and by the original Blackbox window manager team.
-.SH SYNOPSIS
-.BR fbsetroot " \-help"
-.br
-.B fbsetroot
-.RI "[ \-display " display " ] \-solid " color
-.br
-.B fbsetroot
-.RI "[ \-display " display " ] \-mod " "x y" " \-fg " color " \-bg " color
-.br
-.B fbsetroot
-.RI "[ \-display " display " ] \-gradient " texture " \-from " color " \-to " color
-.SH DESCRIPTION
-fbsetroot is a utility that can control the appearance of the root window in
-three ways: Either give it a solid color, or write a two color modula pattern
-to it, or render a gradient texture, based on two different colors.
-.PP
-fbsetroot resembles
-.IR xsetroot (1)
-in this functionality but it supports multiple screen displays, and gradient
-textures the same way as Blackbox or Fluxbox does.
-It doesn't handle cursors etc.
-fbsetroot was originally part of the Blackbox package and was carried over with
-the code that became Fluxbox. It was called bsetroot back in those days.
-.SH OPTIONS
-fbsetroot operates in three ways, you must choose one of the first 3 options:
-.TP
-.BI \-solid " color"
-Sets the root window to specified color.
-.TP
-.BI \-mod " x y"
-Creates a modula pattern. You must specify
-.BR \-bg " and " \-fg
-colors.
-.TP
-.BI \-gradient " texturestring"
-Renders the specified texture string to the root window.
-.RS
-.PP
-.I texturestring
-may be one of:
-.PP
-.B Horizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic / Rectangle / Pyramid
-.PP
-Select one of these texture types, they only apply when
-.B \-gradient
-is specifed. You must also specify both a
-.BR \-from " and a " \-to
-color.
-.RE
-.TP
-.BI \-display " display"
-Tells fbsetroot to connect to the specified display.
-.TP
-.BI "\-bg, \-background " color
-Background color.
-Needed for
-.B \-mod
-patterns.
-.TP
-.BI "\-fg, \-foreground " color
-Foreground color.
-Needed for
-.B \-mod
-patterns.
-.TP
-.BI \-from " color"
-Start color for rendering textures.
-Needed for
-.B \-gradient
-operation mode.
-.TP
-.BI \-to " color"
-Ending color for rendering textures.
-Needed for
-.B \-gradient
-operation mode.
-.TP
-.B \-help
-Prints version info and short help text.
-.SH AUTHOR
-fbsetroot is written and maintained by the Fluxbox Development Team
-.PP
-This manpage was modified by Curt "Asenchi" Micol <asenchi@asenchi.com> for
-the Fluxbox window manager.
-.hy
-.SH SEE ALSO
-.IR fluxbox (1)
-.IR fbsetbg (1)
diff --git a/doc/fbsetroot.1.in b/doc/fbsetroot.1.in
new file mode 100644
index 0000000..ddef0d7
--- /dev/null
+++ b/doc/fbsetroot.1.in
@@ -0,0 +1,279 @@
+.\"     Title: fbsetroot
+.\"    Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
+.\"      Date: 02/18/2009
+.\"    Manual: Fluxbox Manual
+.\"    Source: fbsetroot.txt 1.1.2
+.\"  Language: English
+.\"
+.TH "FBSETROOT" "1" "02/18/2009" "fbsetroot\&.txt 1\&.1\&.2" "Fluxbox Manual"
+.\" -----------------------------------------------------------------
+.\" * (re)Define some macros
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" toupper - uppercase a string (locale-aware)
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de toupper
+.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
+\\$*
+.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH-xref - format a cross-reference to an SH section
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de SH-xref
+.ie n \{\
+.\}
+.toupper \\$*
+.el \{\
+\\$*
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH - level-one heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SH
+.\" put an extra blank line of space above the head in non-TTY output
+.if t \{\
+.sp 1
+.\}
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[an-margin]u
+.ti 0
+.HTML-TAG ".NH \\n[an-level]"
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+\." make the size of the head bigger
+.ps +3
+.ft B
+.ne (2v + 1u)
+.ie n \{\
+.\" if n (TTY output), use uppercase
+.toupper \\$*
+.\}
+.el \{\
+.nr an-break-flag 0
+.\" if not n (not TTY), use normal case (not uppercase)
+\\$1
+.in \\n[an-margin]u
+.ti 0
+.\" if not n (not TTY), put a border/line under subheading
+.sp -.6
+\l'\n(.lu'
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SS - level-two heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SS
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[IN]u
+.ti \\n[SN]u
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.ps \\n[PS-SS]u
+\." make the size of the head bigger
+.ps +2
+.ft B
+.ne (2v + 1u)
+.if \\n[.$] \&\\$*
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BB/BE - put background/screen (filled box) around block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BB
+.if t \{\
+.sp -.5
+.br
+.in +2n
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EB
+.if t \{\
+.if "\\$2"adjust-for-leading-newline" \{\
+.sp -1
+.\}
+.br
+.di
+.in
+.ll
+.gcolor
+.nr BW \\n(.lu-\\n(.i
+.nr BH \\n(dn+.5v
+.ne \\n(BHu+.5v
+.ie "\\$2"adjust-for-leading-newline" \{\
+\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.el \{\
+\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.in 0
+.sp -.5v
+.nf
+.BX
+.in
+.sp .5v
+.fi
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BM/EM - put colored marker in margin next to block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BM
+.if t \{\
+.br
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EM
+.if t \{\
+.br
+.di
+.ll
+.gcolor
+.nr BH \\n(dn
+.ne \\n(BHu
+\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
+.in 0
+.nf
+.BX
+.in
+.fi
+.\}
+..
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+fbsetroot \- a simple background utility used by the fluxbox(1) window manager, originally written for and by the original blackbox(1) window manager\&.
+.SH "Synopsis"
+.sp
+\fBfbsetroot\fR [\-display \fIdisplay\fR ] \-solid \fIcolor\fR
+.sp
+\fBfbsetroot\fR [\-display \fIdisplay\fR ] \-mod \fIx\fR \fIy\fR \-fg \fIcolor\fR \-bg \fIcolor\fR
+.sp
+\fBfbsetroot\fR [\-display \fIdisplay\fR ] \-gradient \fItexture\fR \-from \fIcolor\fR \-to \fIcolor\fR
+.sp
+\fBfbsetroot\fR \-help
+.SH "DESCRIPTION"
+.sp
+\fBfbsetroot(1)\fR is a utility that can control the appearance of the root window in three ways: Either give it a solid color, or write a two color modula pattern to it, or render a gradient texture, based on two different colors\&.
+.sp
+fbsetroot resembles \fBxsetroot(1)\fR in this functionality but it supports multiple\-screen displays, and gradient textures the same way as blackbox or fluxbox does\&. It doesn\'t handle cursors etc\&. fbsetroot was originally part of the Blackbox package and was carried over with the code that became Fluxbox\&. It was called bsetroot back in those days\&.
+.SH "OPTIONS"
+.sp
+fbsetroot operates in three ways, you must choose one of the first 3 options:
+.PP
+\fB\-solid\fR \fIcolor\fR
+.RS 4
+Sets the root window to specified color\&.
+.RE
+.PP
+\fB\-mod\fR \fIx\fR \fIy\fR
+.RS 4
+Creates a modula pattern\&. You must specify
+\fB\-bg\fR
+and
+\fB\-fg\fR
+colors\&.
+.RE
+.PP
+\fB\-gradient\fR \fItexturestring\fR
+.RS 4
+Renders the specified texture string to the root window\&.
+.PP
+\fItexturestring\fR may be one of:
+.RS 4
+
+\fBHorizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic / Rectangle / Pyramid\fR
+.sp
+Select one of these texture types, they only apply when
+\fB\-gradient\fR
+is specifed\&. You must also specify both a
+\fB\-from\fR
+and a
+\fB\-to\fR
+color\&.
+.RE
+.RE
+.PP
+\fB\-display\fR \fIdisplay\fR
+.RS 4
+Tells fbsetroot to connect to the specified display\&.
+.RE
+.PP
+\fB\-bg, \-background\fR \fIcolor\fR
+.RS 4
+Background color\&. Needed for
+\fB\-mod\fR
+patterns\&.
+.RE
+.PP
+\fB\-fg, \-foreground\fR \fIcolor\fR
+.RS 4
+Foreground color\&. Needed for
+\fB\-mod\fR
+patterns\&.
+.RE
+.PP
+\fB\-from\fR \fIcolor\fR
+.RS 4
+Start color for rendering textures\&. Needed for
+\fB\-gradient\fR
+patterns\&.
+.RE
+.PP
+\fB\-to\fR \fIcolor\fR
+.RS 4
+Ending color for rendering textures\&. Needed for
+\fB\-gradient\fR
+patterns\&.
+.RE
+.PP
+\fB\-help\fR
+.RS 4
+Prints version info and short help text\&.
+.RE
+.SH "AUTHORS"
+.sp
+fbsetroot is written and maintained by the Fluxbox Development Team
+.sp
+This manpage was modified by Curt "Asenchi" Micol <\m[blue]\fBasenchi@asenchi\&.com\fR\m[]\&\s-2\u[1]\d\s+2> for the Fluxbox window manager\&.
+.sp
+Further updates for fluxbox\-1\&.1\&.2 and conversion to asciidoc format by Jim Ramsay <\m[blue]\fBi\&.am@jimramsay\&.com\fR\m[]\&\s-2\u[2]\d\s+2>
+.SH "SEE ALSO"
+.sp
+fluxbox(1) fbsetbg(1)
+.SH "Notes"
+.IP " 1." 4
+asenchi@asenchi.com
+.RS 4
+\%mailto:asenchi@asenchi.com
+.RE
+.IP " 2." 4
+i.am@jimramsay.com
+.RS 4
+\%mailto:i.am@jimramsay.com
+.RE