updated documentation

1 files changed, 64 insertions, 191 deletions

diff --git a/doc/fluxbox-apps.5.in b/doc/fluxbox-apps.5.in
index 03f7fdc..cf57ba6 100644
--- a/doc/fluxbox-apps.5.in
+++ b/doc/fluxbox-apps.5.in
@@ -1,161 +1,22 @@
+'\" t
 .\"     Title: fluxbox-apps
 .\"    Author: [see the "AUTHORS" section]
-.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
-.\"      Date: 02/19/2009
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      Date: 02/19/2011
 .\"    Manual: Fluxbox Manual
-.\"    Source: fluxbox-apps.txt 1.1.2
+.\"    Source: fluxbox-apps.txt
 .\"  Language: English
 .\"
-.TH "FLUXBOX\-APPS" "5" "02/19/2009" "fluxbox\-apps\&.txt 1\&.1\&.2" "Fluxbox Manual"
+.TH "FLUXBOX\-APPS" "5" "02/19/2011" "fluxbox\-apps\&.txt" "Fluxbox Manual"
 .\" -----------------------------------------------------------------
-.\" * (re)Define some macros
+.\" * Define some portability stuff
 .\" -----------------------------------------------------------------
 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" toupper - uppercase a string (locale-aware)
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.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
-.\}
-..
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -166,9 +27,9 @@
 .\" -----------------------------------------------------------------
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
-.SH "Name"
+.SH "NAME"
 fluxbox-apps \- per\-window attribute configuration for fluxbox(1)
-.SH "Synopsis"
+.SH "SYNOPSIS"
 .sp
 ~/\&.fluxbox/apps
 .SH "SYNTAX"
@@ -178,9 +39,9 @@ Variable parameters are shown in emphasis: \fIargument\fR
 All other characters shown are required verbatim\&. Whitespce is only required to delimit words, but it is fine to add more whitespace\&.
 .SH "DESCRIPTION"
 .sp
-It is possible to force an application to always have the same dimensions, position, and other settings when it is first launched\&. These settings are saved in the `apps\' file\&.
+It is possible to force an application to always have the same dimensions, position, and other settings when it is first launched\&. These settings are saved in the \(oqapps\(cq file\&.
 .sp
-Most simple settings can be saved using the \(lqRemember\&...\(rq submenu of the window menu, which can usually be opened with a right\-click on the titlebar\&. More advanced features require manually editing the `apps\' file\&. This may include using \fBGROUP SECTIONS\fR to set up automatic window tab groups\&.
+Most simple settings can be saved using the \(lqRemember\&...\(rq submenu of the window menu, which can usually be opened with a right\-click on the titlebar\&. More advanced features require manually editing the \(oqapps\(cq file\&. This may include using \fBGROUP SECTIONS\fR to set up automatic window tab groups\&.
 .sp
 You do not need to \(lqreload\(rq fluxbox after editing the apps file, the changes should be rescanned when the next window is opened\&.
 .sp
@@ -189,7 +50,7 @@ The file is made up of two main types of sections, apps and groups, detailed bel
 .sp
 \fB[app]\fR sections provide settings for individual application windows\&.
 .PP
-These sections begin with a line of the format:
+These sections begin with a line of the format
 .RS 4
 
 \fB[app]\fR
@@ -203,7 +64,7 @@ The \fB{\fR\fIcount\fR\fB}\fR is optional\&. If specified, then the entry will o
 .sp
 This opening \fB[apps]\fR line is followed by any number of settings for the application\&. See \fBSETTINGS\fR for more details\&.
 .PP
-Each of these sections ends with the single line:
+Each of these sections ends with the single line
 .RS 4
 
 \fB[end]\fR
@@ -212,7 +73,7 @@ Each of these sections ends with the single line:
 .sp
 The primary purpose of \fB[group]\fR sections is to group windows together\&. All windows in a group will be tabbed together automatically\&.
 .PP
-These sections begin with a line of the format:
+These sections begin with a line of the format
 .RS 4
 
 \fB[group]\fR
@@ -223,7 +84,7 @@ Where the \fIpattern\fR item is optional\&. If specified, this pattern must matc
 .sp
 This is followed by any number of \fB[app]\fR lines\&. These have a simiar format to the \fB[app]\fR section detailed above in \fBAPP SECTIONS\fR, but do not contain any settings and do not have an associated \fB[end]\fR line\&.
 .PP
-Like this:
+Like this
 .RS 4
 
 \fB[app]\fR
@@ -232,16 +93,16 @@ Like this:
 .sp
 This section may also contain settings that are applied to every window in the group\&. See the \fBSETTINGS\fR section for details\&.
 .PP
-As with \fB[app]\fR sections, each of these sections ends with the single line:
+As with \fB[app]\fR sections, each of these sections ends with the single line
 .RS 4
 
 \fB[end]\fR
 .RE
 .SH "SETTINGS"
 .sp
-These settings may be stored in the `apps\' file\&. A settings line must appear inside either an \fB[app]\fR or \fB[group]\fR section\&.
+These settings may be stored in the \(oqapps\(cq file\&. A settings line must appear inside either an \fB[app]\fR or \fB[group]\fR section\&.
 .PP
-The general format is:
+The general format is
 .RS 4
 
 \fB[\fR\fIsetting\fR\fB]\fR
@@ -345,6 +206,11 @@ Whether the window is Shaded (rolled\-up) or not\&.
 Whether the window has tabs enabled\&.
 .RE
 .PP
+\fB[FocusNewWindow]\fR {\fIbool\fR}
+.RS 4
+If enabled, a new window will grab X focus as soon as it is opened\&. If disabled, a new window will not grab X focus as soon as it is opened\&.
+.RE
+.PP
 \fB[FocusHidden]\fR {\fIbool\fR}
 .RS 4
 If enabled, the window will not appear in
@@ -422,7 +288,7 @@ is an integer between 0 and 255\&.
 .RE
 .SH "CLIENT PATTERNS"
 .PP
-A \fIpattern\fR looks like this:
+A \fIpattern\fR looks like this
 .RS 4
 
 \fB(\fR[\fIpropertyname\fR[!]=]\fIregexp\fR\fB)\fR
@@ -437,7 +303,7 @@ If you specify multiple \fB(\fR\fB\fIpattern\fR\fR) arguments, this implies an A
 .sp
 You can use \fB=\fR to test for equality or \fB!=\fR to test for inequality\&.
 .PP
-The following values are accepted for \fIpropertyname\fR:
+The following values are accepted for \fIpropertyname\fR
 .RS 4
 .PP
 \fBName\fR
@@ -552,7 +418,7 @@ which refers to the head where the mouse pointer currently resides\&.
 .PP
 \fBLayer\fR
 .RS 4
-The string name of the window\'s layer, which is one of
+The string name of the window\(cqs layer, which is one of
 \fBAboveDock\fR,
 \fBDock\fR,
 \fBTop\fR,
@@ -560,61 +426,74 @@ The string name of the window\'s layer, which is one of
 \fBBottom\fR,
 \fBDesktop\fR
 .RE
+.PP
+\fBScreen\fR
+.RS 4
+The number of the currently used
+\fIscreen\fR\&. If the setup of the running xserver involves independant screens (\fInot Xinerama\fR), the $DISPLAY environment contains something like
+\fI:0\&.1\fR
+or
+\fI:1\&.0\fR\&. The part after the dot (\fI\&.\fR) is the number of the screen\&.
+.RE
+.PP
+\fB@XPROP\fR
+.RS 4
+A string, corresponding to any xproperty (Use either the
+\fBxprop(1)\fR
+utility or the
+\fISetXProp\fR
+command to set a xproperty to a window)
+.RE
 .RE
 .PP
-\fBExample\ \&1.\ \&Matches any windows with the CLASSNAME of "xterm"\fR
+\fBMatches any windows with the CLASSNAME of "xterm"\fR. 
 .sp
 .if n \{\
 .RS 4
 .\}
-.fam C
-.ps -1
 .nf
-.BB lightgray
 (xterm)
-.EB lightgray
 .fi
-.fam
-.ps +1
 .if n \{\
 .RE
 .\}
 .PP
-\fBExample\ \&2.\ \&Matches any windows with the same CLASSNAME as the currently focused window\fR
+\fBMatches any windows with the same CLASSNAME as the currently focused window\fR. 
 .sp
 .if n \{\
 .RS 4
 .\}
-.fam C
-.ps -1
 .nf
-.BB lightgray
 (Name=[current])
-.EB lightgray
 .fi
-.fam
-.ps +1
 .if n \{\
 .RE
 .\}
 .PP
-\fBExample\ \&3.\ \&Matches any windows on the same head as the mouse but on a different layer than the currently focused window\fR
+\fBMatches any windows on the same head as the mouse but on a different layer than the currently focused window\fR. 
 .sp
 .if n \{\
 .RS 4
 .\}
-.fam C
-.ps -1
 .nf
-.BB lightgray
 (Head=[mouse]) (Layer!=[current])
-.EB lightgray
 .fi
-.fam
-.ps +1
 .if n \{\
 .RE
 .\}
+.PP
+\fBMatches any windows having a xproperty named FOO with "bar" in it\fR. 
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+(@FOO=\&.*bar\&.*)
+.fi
+.if n \{\
+.RE
+.\}
+.sp
 .SH "FILES"
 .PP
 \fB~/\&.fluxbox/apps\fR
@@ -634,11 +513,8 @@ Here are some interesting and/or useful examples you can do with your apps file\
 .if n \{\
 .RS 4
 .\}
-.fam C
-.ps -1
 .nf
-.BB lightgray
-# Put the first two windows which end with \'term\' on workspace 1
+# Put the first two windows which end with \*(Aqterm\*(Aq on workspace 1
 [app] (name=\&.*[tT]erm) {2}
   [Workspace]   {1}
 [end]
@@ -669,10 +545,7 @@ Here are some interesting and/or useful examples you can do with your apps file\
   [app] (name=gimp) (role=gimp\-toolbox)
   [Layer]       {4}
 [end]
-.EB lightgray
 .fi
-.fam
-.ps +1
 .if n \{\
 .RE
 .\}