Unused variable guint old
[mikachu/openbox.git] / doc / openbox.1.in
index 99196d4..d508e8c 100644 (file)
@@ -1,15 +1,14 @@
 .TH "OPENBOX" "1" 
 .SH "NAME" 
-openbox \(em Next generation, highly configurable window manager 
+openbox \(em A minimalistic, highly configurable, next generation window 
+manager with extensive standards support. 
 .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]  [\fB\-\-debug-xinerama\fP]  
+\fBopenbox\fR [\fB\-\-help\fP]  [\fB\-\-version\fP]  [\fB\-\-replace\fP]  [\fB\-\-reconfigure\fP]  [\fB\-\-restart\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 
-configurable window manager. Openbox is compliant with the 
-latest window manager standards. 
+Openbox is minimalistic, highly configurable, next generation window 
+manager with extensive standards support. 
 .PP 
 You can start Openbox in three ways: 
 .PP 
@@ -19,39 +18,42 @@ 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 
-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 & 
-exec \fBopenbox\fR 
 .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 
-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 
-is possible by editing the configuration files by hand. The default 
-configuration files are installed in @configdir@/openbox/, and the 
-user configuration is placed in ~/.config/openbox/. You can copy 
-the default configuration to ~/.config/openbox and edit it to your 
-liking. 
-.PP 
-There are 3 default configuration files, \fBrc.xml\fP, 
-\fBrc-gnome.xml\fP, and \fBrc-kde.xml\fP. The 
-rc-gnome.xml is used when you run 
-\fBopenbox-gnome-session\fR and the rc-kde.xml is used when 
-you run \fBopenbox-kde-session\fR. The configuration 
-files should be named the same in ~/.config/openbox/. 
+is possible by editing the configuration files by hand. 
+.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: 
@@ -63,7 +65,11 @@ 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 
-reload it's configuration. 
+reload its configuration. 
+.IP "\fB\-\-restart\fP" 10 
+If Openbox is already running on the display, tell it to 
+restart. This is useful if you have upgraded Openbox and don't 
+want to restart X. 
 .IP "\fB\-\-sm-disable\fP" 10 
 Do not connect to the session manager. 
 .IP "\fB\-\-sync\fP" 10 
@@ -78,12 +84,12 @@ 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). 
+obconf (1), openbox-session(1), openbox-gnome-session(1), 
+openbox-kde-session(1). 
 .PP 
 The program's full documentation is available on the website: 
 \fBhttp://openbox.org/\fP 
 .PP 
 Please report bugs to: \fBhttp://bugzilla.icculus.org/ 
 \fP 
-.\" created by instant / docbook-to-man, Sun 13 May 2007, 20:29 
+.\" created by instant / docbook-to-man, Wed 06 Jan 2010, 13:40