don't queue showmenu events, and set button to 0 when a grab is in place after the...

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

diff --git a/doc/openbox.1.in b/doc/openbox.1.in
index e1e177a7f6c45b945060064fa0606d4d03649865..d7387ac5402b1372b8650a5fd81168ae783ff201 100644 (file)
--- a/doc/openbox.1.in
+++ b/doc/openbox.1.in
@@ -4,7 +4,7 @@ openbox \(em Next generation, highly configurable window manager
  
 .SH "SYNOPSIS" 
 .PP 
  
 .SH "SYNOPSIS" 
 .PP 

-\fBopenbox\fR [\fB\-\-help\fP]  [\fB\-\-version\fP]  [\fB\-\-replace\fP]  [\fB\-\-reconfigure\fP]  [\fB\-\-sm-disable\fP]  [\fB\-\-sync\fP]  [\fB\-\-debug\fP]  [\fB\-\-debug-focus\fP]  
+\fBopenbox\fR [\fB\-\-help\fP]  [\fB\-\-version\fP]  [\fB\-\-replace\fP]  [\fB\-\-reconfigure\fP]  [\fB\-\-sm-disable\fP]  [\fB\-\-sync\fP]  [\fB\-\-debug\fP]  [\fB\-\-debug-focus\fP]  [\fB\-\-debug-xinerama\fP]  

 .SH "DESCRIPTION" 
 .PP 
 Openbox is a next generation, highly 
 .SH "DESCRIPTION" 
 .PP 
 Openbox is a next generation, highly 


@@ -19,32 +19,44 @@ in the login session type menu for Openbox:
 within GNOME or KDE, you can choose the appropriate entry, and it will 
 launch GNOME or KDE with Openbox as the window manager. 
 .PP 
 within GNOME or KDE, you can choose the appropriate entry, and it will 
 launch GNOME or KDE with Openbox as the window manager. 
 .PP 

-If you don't want to run Openbox withing a desktop environment, then 
-it is recommended that you instead set up a ~/.xsession file and 
-use the \fBDefault\fR session type. The ~/.xsession file 
-should any applications you want to run at startup, and then run 
-\fBopenbox\fR at the end, such as: 
+The third option at log in, which is \fBOpenbox\fR       without a session manager, uses the \fBopenbox-session\fR       command to start Openbox. On log in, \fBopenbox\fR will 
+run the ~/.config/openbox/autostart.sh script if it exists, and will run 
+the system-wide script @configdir@/openbox/autostart.sh otherwise. You 
+may place anything you want to run automatically in those files, for 
+example: 
+ 

 .PP 
 .RS 
 .PP 
 .nf 
 xsetroot \-solid grey & 
 gnome-settings-daemon & 
 .PP 
 .RS 
 .PP 
 .nf 
 xsetroot \-solid grey & 
 gnome-settings-daemon & 

-exec \fBopenbox\fR 

 .fi 
 .RE 
 .PP 
 .fi 
 .RE 
 .PP 

+Make sure that each line is followed by a "&" or else the script will 
+stop there and further commands will not be executed. You can use the 
+@configdir@/openbox/autostart.sh file as an example for creating your 
+own. 
+.PP 
+The default @configdir@/openbox/autostart.sh runs a number of things 
+with Openbox. 
+.PP 

 Lastly, if you use \fBstartx\fR to launch your X 
 Lastly, if you use \fBstartx\fR to launch your X 

-session, you should set up a ~/.xinitrc file, exactly the same as the 
-above ~/.xsession file. 
+session, you can set up a ~/.xinitrc file to run 
+\fBopenbox-session\fR and follow the same directions as 
+above regarding the autostart.sh file. 

 .PP 
 You can use the \fBobconf\fR tool to configure Openbox 
 easily with a graphical interface, however more in-depth configuration 
 .PP 
 You can use the \fBobconf\fR tool to configure Openbox 
 easily with a graphical interface, however more in-depth configuration 

-is possible by editing the configuration files by hand. The default 
-configuration file is installed in @configdir@/openbox/rc.xml, and the 
-user configuration is placed in ~/.config/openbox/rc.xml. You can copy 
-the default configuration to ~/.config/openbox and edit it to your 
-liking. 
+is possible by editing the configuration files by hand. Please note that 
+\fBobconf\fR older than version 2.0 may not work at all 
+for you. 
+.PP 
+The default configuration and menu files are installed in 
+@configdir@/openbox/, and the user configuration is placed in 
+~/.config/openbox/. You can copy the default configuration and menus 
+to ~/.config/openbox and edit it to your liking. 

 .SH "OPTIONS" 
 .PP 
 These are the possible options that \fBopenbox\fR accepts: 
 .SH "OPTIONS" 
 .PP 
 These are the possible options that \fBopenbox\fR accepts: 


@@ -56,7 +68,7 @@ Show the version of the program.
 Replace the currently running window manager. 
 .IP "\fB\-\-reconfigure\fP" 10 
 If Openbox is already running on the display, tell it to 
 Replace the currently running window manager. 
 .IP "\fB\-\-reconfigure\fP" 10 
 If Openbox is already running on the display, tell it to 

-reload it's configuration. 
+reload its configuration. 

 .IP "\fB\-\-sm-disable\fP" 10 
 Do not connect to the session manager. 
 .IP "\fB\-\-sync\fP" 10 
 .IP "\fB\-\-sm-disable\fP" 10 
 Do not connect to the session manager. 
 .IP "\fB\-\-sync\fP" 10 


@@ -65,6 +77,10 @@ Run in synchronous mode (for debugging).
 Display debugging output. 
 .IP "\fB\-\-debug-focus\fP" 10 
 Display debugging output for focus handling. 
 Display debugging output. 
 .IP "\fB\-\-debug-focus\fP" 10 
 Display debugging output for focus handling. 

+.IP "\fB\-\-debug-xinerama\fP" 10 
+Split the display into two fake xinerama regions, if 
+xinerama is not already enabled. This is for debugging 
+xinerama support. 

 .SH "SEE ALSO" 
 .PP 
 obconf (1), openbox-gnome-session (1), openbox-kde-session (1). 
 .SH "SEE ALSO" 
 .PP 
 obconf (1), openbox-gnome-session (1), openbox-kde-session (1). 


@@ -75,4 +91,4 @@ The program's full documentation is available on the website:
 .PP 
 Please report bugs to: \fBhttp://bugzilla.icculus.org/ 
 \fP 
 .PP 
 Please report bugs to: \fBhttp://bugzilla.icculus.org/ 
 \fP 

-.\" created by instant / docbook-to-man, Sun 13 May 2007, 18:47 
+.\" created by instant / docbook-to-man, Tue 15 May 2007, 20:08