add the generated from docbook man pages, for people who don't have docbook-to-man
[mikachu/openbox.git] / doc / openbox.1.in
1 .TH "OPENBOX" "1" 
2 .SH "NAME" 
3 openbox \(em Next generation, highly configurable window manager 
4  
5 .SH "SYNOPSIS" 
6 .PP 
7 \fBopenbox\fR [\fB\-\-help\fP]  [\fB\-\-version\fP]  [\fB\-\-replace\fP]  [\fB\-\-reconfigure\fP]  [\fB\-\-sm-disable\fP]  [\fB\-\-config \fITYPE\fR\fP]  [\fB\-\-sync\fP]  [\fB\-\-debug\fP]  [\fB\-\-debug-focus\fP]  
8 .SH "DESCRIPTION" 
9 .PP 
10 Openbox is a next generation, highly 
11 configurable window manager. Openbox is compliant with the 
12 latest window manager standards. 
13 .PP 
14 You can start Openbox in three ways: 
15 .PP 
16 If you run a display manager such as GDM, you will find 3 entries 
17 in the login session type menu for Openbox: 
18 \fBGNOME/Openbox\fR, \fBKDE/Openbox\fR       and \fBOpenbox\fR. If you want to use Openbox 
19 within GNOME or KDE, you can choose the appropriate entry, and it will 
20 launch GNOME or KDE with Openbox as the window manager. 
21 .PP 
22 If you don't want to run Openbox withing a desktop environment, then 
23 it is recommended that you instead set up a ~/.xsession file and 
24 use the \fBDefault\fR session type. The ~/.xsession file 
25 should any applications you want to run at startup, and then run 
26 \fBopenbox\fR at the end, such as: 
27 .PP 
28 .RS 
29 .PP 
30 .nf 
31 xsetroot \-solid grey & 
32 gnome-settings-daemon & 
33 exec \fBopenbox\fR 
34 .fi 
35 .RE 
36 .PP 
37 Lastly, if you use \fBstartx\fR to launch your X 
38 session, you should set up a ~/.xinitrc file, exactly the same as the 
39 above ~/.xsession file. 
40 .PP 
41 You can use the \fBobconf\fR tool to configure Openbox 
42 easily with a graphical interface, however more in-depth configuration 
43 is possible by editing the configuration files by hand. The default 
44 configuration file is installed in @configdir@/openbox/rc.xml, and the 
45 user configuration is placed in ~/.config/openbox/rc.xml. You can copy 
46 the default configuration to ~/.config/openbox and edit it to your 
47 liking. 
48 .SH "OPTIONS" 
49 .PP 
50 These are the possible options that \fBopenbox\fR accepts: 
51 .IP "\fB\-\-help\fP" 10 
52 Show a summary of the options available. 
53 .IP "\fB\-\-version\fP" 10 
54 Show the version of the program. 
55 .IP "\fB\-\-replace\fP" 10 
56 Replace the currently running window manager. 
57 .IP "\fB\-\-reconfigure\fP" 10 
58 If Openbox is already running on the display, tell it to 
59 reload it's configuration. 
60 .IP "\fB\-\-sm-disable\fP" 10 
61 Do not connect to the session manager. 
62 .IP "\fB\-\-config\fITYPE\fR\fP" 10 
63 Specify the configuration profile to use. 
64 .IP "\fB\-\-sync\fP" 10 
65 Run in synchronous mode (for debugging). 
66 .IP "\fB\-\-debug\fP" 10 
67 Display debugging output. 
68 .IP "\fB\-\-debug-focus\fP" 10 
69 Display debugging output for focus handling. 
70 .SH "SEE ALSO" 
71 .PP 
72 obconf (1), openbox-gnome-session (1), openbox-kde-session (1). 
73  
74 .PP 
75 The program's full documentation is available on the website: 
76 \fBhttp://openbox.org/\fP 
77 .PP 
78 Please report bugs to: \fBhttp://bugzilla.icculus.org/ 
79 \fP 
80 .\" created by instant / docbook-to-man, Sun 13 May 2007, 18:06