X-Git-Url: https://git.brokenzipper.com/gitweb?a=blobdiff_plain;f=doc%2Fopenbox.1.in;h=ac9f5115d0df64caf2731f91eeb6668d98d23c4b;hb=b26635fe994a7cd1dc28893c0e40517b61036a9f;hp=8d53681af922df09d77992810cad33495a61d6c3;hpb=5c96972bfffacb7dc24c96673f85e413e5c87b94;p=chaz%2Fopenbox diff --git a/doc/openbox.1.in b/doc/openbox.1.in index 8d53681a..ac9f5115 100644 --- a/doc/openbox.1.in +++ b/doc/openbox.1.in @@ -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] +\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 -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. - - +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,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 -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 @@ -72,14 +74,18 @@ Run in synchronous mode (for debugging). 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). - +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 +\fBhttp://icculus.org/openbox/\fP .PP Please report bugs to: \fBhttp://bugzilla.icculus.org/ \fP -.\" created by instant / docbook-to-man, Sun 13 May 2007, 18:59 +.\" created by instant / docbook-to-man, Thu 17 May 2007, 12:52