Documented bitmap buttons in manpage

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

diff --git a/doc/openbox.1.in b/doc/openbox.1.in
index 75ab67c86fdb5d6a4f29f158443fcd68da1bde3c..d17cb12b17fc959644a5d872c61f6d9b7246b4cf 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.
@@ -638,7 +640,6 @@ 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
@@ -661,6 +662,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.
@@ -805,4 +828,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)