make doxygen skip stuff inside

[chaz/openbox] / doc / openbox.1.in

diff --git a/doc/openbox.1.in b/doc/openbox.1.in
index 75ab67c86fdb5d6a4f29f158443fcd68da1bde3c..674d8369fd6514d70737fce39c17f1513db09cdd 100644 (file)
--- a/doc/openbox.1.in
+++ b/doc/openbox.1.in
@@ -90,7 +90,7 @@ Start Openbox on the specified display.
 Programs started by Openbox will have the
 .B DISPLAY
 environment variable set to this value, too.
-.SH RUNNING BLACKBOX
+.SH RUNNING OPENBOX
 This program is usually started by the user's startup script, most times called
 .IR ~/.xinitrc .
 To run openbox, modify the script by adding
@@ -108,9 +108,11 @@ On exit or restart, Openbox will save user defaults in the file
 .I ~/.openbox/rc
 in the user's home directory.
 Some resources in this file can be edited by hand.
-.SH USING BLACKBOX
-From version 0.60.x, Openbox does no keyboard handling by itself; instead, it
-relies on an external program
+.SH USING OPENBOX
+Openbox does no keyboard handling by itself; instead, it relies on an external
+program
+.IR epist (1)
+or
 .IR bbkeys (1)
 for this.
 So, in this section, we will discuss all mouse commands.
@@ -486,7 +488,7 @@ which kind of value they can contain.
 Comments are preceded with an exclamation sign (!), which is also used for
 comments in Openbox style c.q. X resource files.
 .PP
-.ta \w'window.button.unfocus.picColor:\ 'u 
+.ta \w'window.button.unfocus.picColor: \ 'u 
 .nf
 .\"
 .\" The comments also to be translated!
@@ -533,9 +535,11 @@ toolbar.clock.textColor:   Color
 ! How the toolbar's text should be justified.
 toolbar.justify:       \fIcenter\fR, \fIleft\fR, or \fIright\fR
 
+.ta \w'toolbar.font:\ 'u 
 ! Font to be used for all toolbar components.
 toolbar.font:  Font \fI(e.g. -*-helvetica-medium-r-normal-*-*-100-*)\fR
 
+.ta \w'window.button.unfocus.picColor: \ 'u 
 ! The menu titlebar.
 menu.title:    Texture
 menu.title.color:      Color
@@ -617,6 +621,17 @@ window.button.pressed:     Texture (e.g. \fISunken\fR)
 window.button.pressed.color:   Color
 window.button.pressed.colorTo: Color
 
+.ta \w'window.button.pressed.unfocus.colorTo:\ 'u 
+! If either the focused, or unfocused pressed button isn't
+! defined, it will use the normal pressed: resource
+window.button.pressed.focus:   Texture (eg. \fISunken\fR)
+window.button.pressed.focus.color:     Color
+window.button.pressed.focus.colorTo:   Color
+window.button.pressed.unfocus: Texture (eg. \fISunken\fR)
+window.button.pressed.unfocus.color:   Color
+window.button.pressed.unfocus.colorTo: Color
+
+.ta \w'window.button.unfocus.picColor:\ 'u 
 ! Frame around window.
 window.frame.focusColor:       Color
 window.frame.unfocusColor:     Color
@@ -638,10 +653,9 @@ handleWidth:       a number of pixels > 0
 ! When not specified, frameWidth defaults to the value of bevelWidth.
 frameWidth:    a number of pixels >= 0
 
-
 ! This command is executed whenever this style is selected.
 ! Typically it sets the root window to a nice picture.
-rootCommand:   Shell command, e.g. \fIbsetroot -mod 4 4 -fg rgb:       5/6/6 -bg grey20\fR
+rootCommand: Shell command, e.g. \fIbsetroot -mod 4 4 -fg rgb: 5/6/6 -bg grey20\fR
 
 ! Some of the bbtools read these old 0.51 resources.
 menuFont:      Font
@@ -661,6 +675,28 @@ can easily set lots of keys with a single command, e.g.
 *font: lucidasans-10
 .EE
 This sets already nice defaults for many components.
+.PP
+Openbox also lets you pick what the small graphics in the buttons and in the manu look like. It uses the X Bitmap file format (.xbm extension). The style resources are as follows:
+.EX
+! Close, maximize, sticky and iconify
+! buttons on a window.
+window.button.close.mask:       xbm file
+window.button.max.mask:         xbm file
+window.button.stick.mask:       xbm file
+window.button.icon.mask:        xbm file
+
+! The icon for submenus in a menu.
+menu.arrow.mask:                xbm file
+
+! The icon for a selected option or workspace
+! in the menus.
+menu.selected.mask:             xbm file
+
+! The left and right buttons in the toolbar
+toolbar.button.left.mask:       xbm file
+toolbar.button.right.mask:      xbm file
+.EE
+If the xbm file value is the path to a .xbm image. If the value is absolute, it uses that file. If the file is just a file name, e.g. `close.xbm', it uses ~/.openbox/buttons/close.xbm.
 .SH THE SLIT
 The slit is a special Openbox window frame that can contain dockable
 applications, e.g. the `bbtools' or WindowMaker's dockapps.
@@ -742,6 +778,21 @@ server's memory.
 Default value is:
 .IR 5 .
 .TP
+.B session.titleBarLayout:
+The order of the elements of window titlebars. This is a string built
+of the following characters:
+.IP
+.nf I: Iconify button
+L: Label (window title)
+M: Maximize button
+S: Sticky button
+C: Close button 
+.fi
+.IP
+The order in which these character appear in the string is the order they will appear in window titlebars. You can also omit an item to not have it appear in the titlebar at all, except for the label which will always appear.
+Default value is:
+.IR ILMC
+.TP
 .B session.colorsPerChannel:
 This tells Openbox how many colors to take from the X server on pseudocolor
 displays.  A channel would be red, green, or blue.
@@ -805,4 +856,4 @@ This manpage was put together by Wilbert Berendsen
 .hy
 Numerous other languages will be available.
 .SH SEE ALSO
-.IR bsetroot (1), \ bbkeys (1)  \" not there, yet ;-(
+.IR bsetroot (1), \ bbkeys (1), \ xftlsfonts (1), \ epist (1)