Add include of cairo.h when using librsvg
[dana/openbox.git] / doc / openbox.1.in
1 .TH "OPENBOX" "1" 
2 .SH "NAME" 
3 openbox \(em A minimalistic, highly configurable, next generation window 
4 manager with extensive standards support. 
5 .SH "SYNOPSIS" 
6 .PP 
7 \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]  
8 .SH "DESCRIPTION" 
9 .PP 
10 Openbox is minimalistic, highly configurable, next generation window 
11 manager with extensive standards support. 
12 .PP 
13 You can start Openbox in three ways: 
14 .PP 
15 If you run a display manager such as GDM, you will find 3 entries 
16 in the login session type menu for Openbox: 
17 \fBGNOME/Openbox\fR, \fBKDE/Openbox\fR       and \fBOpenbox\fR. If you want to use Openbox 
18 within GNOME or KDE, you can choose the appropriate entry, and it will 
19 launch GNOME or KDE with Openbox as the window manager. 
20 .PP 
21 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 
22 run the ~/.config/openbox/autostart.sh script if it exists, and will run 
23 the system-wide script @configdir@/openbox/autostart.sh otherwise. You 
24 may place anything you want to run automatically in those files, for 
25 example: 
26  
27 .PP 
28 .RS 
29 .PP 
30 .nf 
31 xsetroot \-solid grey & 
32 gnome-settings-daemon & 
33 .fi 
34 .RE 
35 .PP 
36 Make sure that each line is followed by a "&" or else the script will 
37 stop there and further commands will not be executed. You can use the 
38 @configdir@/openbox/autostart.sh file as an example for creating your 
39 own. 
40 .PP 
41 The default @configdir@/openbox/autostart.sh runs a number of things 
42 with Openbox. 
43 .PP 
44 Lastly, if you use \fBstartx\fR to launch your X 
45 session, you can set up a ~/.xinitrc file to run 
46 \fBopenbox-session\fR and follow the same directions as 
47 above regarding the autostart.sh file. 
48 .PP 
49 You can use the \fBobconf\fR tool to configure Openbox 
50 easily with a graphical interface, however more in-depth configuration 
51 is possible by editing the configuration files by hand. 
52 .PP 
53 The default configuration and menu files are installed in 
54 @configdir@/openbox/, and the user configuration is placed in 
55 ~/.config/openbox/. You can copy the default configuration and menus 
56 to ~/.config/openbox and edit it to your liking. 
57 .SH "OPTIONS" 
58 .PP 
59 These are the possible options that \fBopenbox\fR accepts: 
60 .IP "\fB\-\-help\fP" 10 
61 Show a summary of the command line options available 
62 and exit. 
63 .IP "\fB\-\-version\fP" 10 
64 Show the version of the program and exit. 
65 .IP "\fB\-\-replace\fP" 10 
66 Replace the currently running window manager. 
67 .IP "\fB\-\-config-file FILE\fP" 10 
68 Specify the path to the config file to use. 
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\-\-restart\fP" 10 
73 If Openbox is already running on the display, tell it to 
74 restart. This is useful if you have upgraded Openbox and don't 
75 want to restart X. 
76 .IP "\fB\-\-exit\fP" 10 
77 Exit Openbox. 
78 .IP "\fB\-\-sm-disable\fP" 10 
79 Do not connect to the session manager. 
80 .IP "\fB\-\-sync\fP" 10 
81 Run in synchronous mode (for debugging). 
82 .IP "\fB\-\-startup CMD\fP" 10 
83 Run CMD after starting. 
84 .IP "\fB\-\-debug\fP" 10 
85 Display debugging output. 
86 .IP "\fB\-\-debug-focus\fP" 10 
87 Display debugging output for focus handling. 
88 .IP "\fB\-\-debug-session\fP" 10 
89 Display debugging output for session management. 
90 .IP "\fB\-\-debug-xinerama\fP" 10 
91 Split the display into two fake xinerama regions, if 
92 xinerama is not already enabled. This is for debugging 
93 xinerama support. 
94 .SH "SEE ALSO" 
95 .PP 
96 obconf (1), openbox-session(1), openbox-gnome-session(1), 
97 openbox-kde-session(1). 
98 .PP 
99 The program's full documentation is available on the website: 
100 \fBhttp://openbox.org/\fP 
101 .PP 
102 Please report bugs to: \fBhttp://bugzilla.icculus.org/ 
103 \fP 
104 .\" created by instant / docbook-to-man, Sun 30 Sep 2012, 17:58