Documented bitmap buttons in manpage

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

diff --git a/doc/openbox.1.in b/doc/openbox.1.in
index f2eeb53b7121c2c36f623093a52c8809f867b554..d17cb12b17fc959644a5d872c61f6d9b7246b4cf 100644 (file)
--- a/doc/openbox.1.in
+++ b/doc/openbox.1.in
@@ -69,9 +69,9 @@ openbox \- a window manager for X11
 .\".PP
 .\"Openbox uses its own graphics class to render its images on the fly.
 .\"By using style files, you can determine at a great level how your desktop looks.
 .\".PP
 .\"Openbox uses its own graphics class to render its images on the fly.
 .\"By using style files, you can determine at a great level how your desktop looks.

-.\"Openbox currently uses its own protocol to communicate with other clients such
-.\"as the pager.  Work is underway to support the new window manager specification
-.\"that both GNOME and KDE use.
+.\"Openbox currently uses the Blackbox protocol to communicate with other clients
+.\"such as the pager.  Work is underway to support the new window manager
+.\"specification that both GNOME and KDE use.

 .SH OPTIONS
 Openbox supports the following command line options:
 .TP
 .SH OPTIONS
 Openbox supports the following command line options:
 .TP


@@ -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.
 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
 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.
 .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.
 .IR bbkeys (1)
 for this.
 So, in this section, we will discuss all mouse commands.


@@ -312,8 +314,8 @@ An
 tag is required to end the submenu.
 .TP
 .B [reconfig] (label)
 tag is required to end the submenu.
 .TP
 .B [reconfig] (label)

-When selected, this item rereads the current style and menu files and
-applies any changes.
+When selected, this item rereads the current style, menu files and rc file,
+and applies any changes.

 This is useful for creating a new style or theme, as you don't have to
 constantly restart Openbox every time you save your style.
 However, Openbox automagically rereads the menu whenever it changes.
 This is useful for creating a new style or theme, as you don't have to
 constantly restart Openbox every time you save your style.
 However, Openbox automagically rereads the menu whenever it changes.


@@ -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
 
 ! 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
 ! 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.
 *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.
 .SH THE SLIT
 The slit is a special Openbox window frame that can contain dockable
 applications, e.g. the `bbtools' or WindowMaker's dockapps.


@@ -791,17 +814,12 @@ many individuals around the world.
 .PP
 The official Openbox website:
 .nh
 .PP
 The official Openbox website:
 .nh

-.B http://FILLMEINNOW/
-.hy
-.br
-The bug and feature request page, as well as current releases can be found at:
-.nh
-.B http://FILLMEINNOW/
+.B http://openbox.sunsite.dk/

 .hy
 .br
 Many themes and other contributions:
 .nh
 .hy
 .br
 Many themes and other contributions:
 .nh

-.B http://bb.themes.org/
+.B http://themes.freshmeat.net/

 .hy
 .PP
 This manpage was put together by Wilbert Berendsen
 .hy
 .PP
 This manpage was put together by Wilbert Berendsen


@@ -810,4 +828,4 @@ This manpage was put together by Wilbert Berendsen
 .hy
 Numerous other languages will be available.
 .SH SEE ALSO
 .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)