update website in man pages. also update the see-also's
[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\-\-sync\fP]  [\fB\-\-debug\fP]  [\fB\-\-debug-focus\fP]  [\fB\-\-debug-xinerama\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 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 
23 run the ~/.config/openbox/autostart.sh script if it exists, and will run 
24 the system-wide script @configdir@/openbox/autostart.sh otherwise. You 
25 may place anything you want to run automatically in those files, for 
26 example: 
27  
28 .PP 
29 .RS 
30 .PP 
31 .nf 
32 xsetroot \-solid grey & 
33 gnome-settings-daemon & 
34 .fi 
35 .RE 
36 .PP 
37 Make sure that each line is followed by a "&" or else the script will 
38 stop there and further commands will not be executed. You can use the 
39 @configdir@/openbox/autostart.sh file as an example for creating your 
40 own. 
41 .PP 
42 The default @configdir@/openbox/autostart.sh runs a number of things 
43 with Openbox. 
44 .PP 
45 Lastly, if you use \fBstartx\fR to launch your X 
46 session, you can set up a ~/.xinitrc file to run 
47 \fBopenbox-session\fR and follow the same directions as 
48 above regarding the autostart.sh file. 
49 .PP 
50 You can use the \fBobconf\fR tool to configure Openbox 
51 easily with a graphical interface, however more in-depth configuration 
52 is possible by editing the configuration files by hand. Please note that 
53 \fBobconf\fR older than version 2.0 may not work at all 
54 for you. 
55 .PP 
56 The default configuration and menu files are installed in 
57 @configdir@/openbox/, and the user configuration is placed in 
58 ~/.config/openbox/. You can copy the default configuration and menus 
59 to ~/.config/openbox and edit it to your liking. 
60 .SH "OPTIONS" 
61 .PP 
62 These are the possible options that \fBopenbox\fR accepts: 
63 .IP "\fB\-\-help\fP" 10 
64 Show a summary of the options available. 
65 .IP "\fB\-\-version\fP" 10 
66 Show the version of the program. 
67 .IP "\fB\-\-replace\fP" 10 
68 Replace the currently running window manager. 
69 .IP "\fB\-\-reconfigure\fP" 10 
70 If Openbox is already running on the display, tell it to 
71 reload its configuration. 
72 .IP "\fB\-\-sm-disable\fP" 10 
73 Do not connect to the session manager. 
74 .IP "\fB\-\-sync\fP" 10 
75 Run in synchronous mode (for debugging). 
76 .IP "\fB\-\-debug\fP" 10 
77 Display debugging output. 
78 .IP "\fB\-\-debug-focus\fP" 10 
79 Display debugging output for focus handling. 
80 .IP "\fB\-\-debug-xinerama\fP" 10 
81 Split the display into two fake xinerama regions, if 
82 xinerama is not already enabled. This is for debugging 
83 xinerama support. 
84 .SH "SEE ALSO" 
85 .PP 
86 obconf (1), openbox-session(1), openbox-gnome-session(1), 
87 openbox-kde-session(1). 
88 .PP 
89 The program's full documentation is available on the website: 
90 \fBhttp://icculus.org/openbox/\fP 
91 .PP 
92 Please report bugs to: \fBhttp://bugzilla.icculus.org/ 
93 \fP 
94 .\" created by instant / docbook-to-man, Wed 16 May 2007, 01:19