275c3246ee075516d239e5477b272374707663b8
[dana/openbox.git] / doc / openbox.1.sgml
1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3 <!-- Process this file with docbook-to-man to generate an nroff manual
4      page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
5      the manual page with: `docbook-to-man manpage.sgml | nroff -man |
6      less'.  A typical entry in a Makefile or Makefile.am is:
7
8 manpage.1: manpage.sgml
9         docbook-to-man $< > $@
10
11     
12         The docbook-to-man binary is found in the docbook-to-man package.
13         Please remember that if you create the nroff version in one of the
14         debian/rules file targets (such as build), you will need to include
15         docbook-to-man in your Build-Depends control field.
16
17   -->
18
19   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
20   <!ENTITY dhucpackage "<refentrytitle>OPENBOX</refentrytitle>">
21   <!ENTITY dhpackage   "openbox">
22 ]>
23
24 <refentry>
25   <refmeta>
26     &dhucpackage;
27
28     &dhsection;
29   </refmeta>
30   <refnamediv>
31     <refname>&dhpackage;</refname>
32
33     <refpurpose>A minimalistic, highly configurable, next generation window
34       manager with extensive standards support.</refpurpose>
35   </refnamediv>
36   <refsynopsisdiv>
37     <cmdsynopsis>
38       <command>&dhpackage;</command>
39       <arg><option>--help</option></arg>
40       <arg><option>--version</option></arg>
41       <arg><option>--replace</option></arg>
42       <arg><option>--reconfigure</option></arg>
43       <arg><option>--restart</option></arg>
44       <arg><option>--sm-disable</option></arg>
45       <arg><option>--sync</option></arg>
46       <arg><option>--debug</option></arg>
47       <arg><option>--debug-focus</option></arg>
48       <arg><option>--debug-xinerama</option></arg>
49     </cmdsynopsis>
50   </refsynopsisdiv>
51   <refsect1>
52     <title>DESCRIPTION</title>
53
54     <para>Openbox is minimalistic, highly configurable, next generation window
55       manager with extensive standards support.</para>
56
57     <para>You can start Openbox in three ways:</para>
58
59     <para>If you run a display manager such as GDM, you will find 3 entries
60       in the login session type menu for Openbox:
61       <command>GNOME/Openbox</command>, <command>KDE/Openbox</command>
62       and <command>Openbox</command>. If you want to use Openbox
63       within GNOME or KDE, you can choose the appropriate entry, and it will
64       launch GNOME or KDE with Openbox as the window manager.</para>
65
66     <para>The third option at log in, which is <command>Openbox</command>
67       without a session manager, uses the <command>openbox-session</command>
68       command to start Openbox. On log in, <command>&dhpackage;</command> will
69       run the ~/.config/openbox/autostart.sh script if it exists, and will run
70       the system-wide script @configdir@/openbox/autostart.sh otherwise. You
71       may place anything you want to run automatically in those files, for
72       example:
73       </para>
74
75     <blockquote><literallayout>
76       xsetroot -solid grey &
77       gnome-settings-daemon &</literallayout></blockquote>
78
79     <para>Make sure that each line is followed by a "&" or else the script will
80       stop there and further commands will not be executed. You can use the
81       @configdir@/openbox/autostart.sh file as an example for creating your
82       own.</para>
83
84     <para>The default @configdir@/openbox/autostart.sh runs a number of things
85       with Openbox.</para>
86
87     <para>Lastly, if you use <command>startx</command> to launch your X
88       session, you can set up a ~/.xinitrc file to run
89       <command>openbox-session</command> and follow the same directions as
90       above regarding the autostart.sh file.</para>
91
92     <para>You can use the <command>obconf</command> tool to configure Openbox
93       easily with a graphical interface, however more in-depth configuration
94       is possible by editing the configuration files by hand.</para>
95
96     <para>The default configuration and menu files are installed in
97       @configdir@/openbox/, and the user configuration is placed in
98       ~/.config/openbox/. You can copy the default configuration and menus
99       to ~/.config/openbox and edit it to your liking.</para>
100   </refsect1>
101   <refsect1>
102     <title>OPTIONS</title>
103
104     <para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
105     <variablelist>
106       <varlistentry>
107         <term><option>--help</option></term>
108         <listitem>
109           <para>Show a summary of the options available.</para>
110         </listitem>
111       </varlistentry>
112       <varlistentry>
113         <term><option>--version</option></term>
114         <listitem>
115           <para>Show the version of the program.</para>
116         </listitem>
117       </varlistentry>
118       <varlistentry>
119         <term><option>--replace</option></term>
120         <listitem>
121           <para>Replace the currently running window manager.</para>
122         </listitem>
123       </varlistentry>
124       <varlistentry>
125         <term><option>--reconfigure</option></term>
126         <listitem>
127           <para>If Openbox is already running on the display, tell it to
128             reload its configuration.</para>
129         </listitem>
130       </varlistentry>
131       <varlistentry>
132         <term><option>--restart</option></term>
133         <listitem>
134           <para>If Openbox is already running on the display, tell it to
135             restart. This is useful if you have upgraded Openbox and don't
136             want to restart X.</para>
137         </listitem>
138       </varlistentry>
139       <varlistentry>
140         <term><option>--sm-disable</option></term>
141         <listitem>
142           <para>Do not connect to the session manager.</para>
143         </listitem>
144       </varlistentry>
145       <varlistentry>
146         <term><option>--sync</option></term>
147         <listitem>
148           <para>Run in synchronous mode (for debugging).</para>
149         </listitem>
150       </varlistentry>
151       <varlistentry>
152         <term><option>--debug</option></term>
153         <listitem>
154           <para>Display debugging output.</para>
155         </listitem>
156       </varlistentry>
157       <varlistentry>
158         <term><option>--debug-focus</option></term>
159         <listitem>
160           <para>Display debugging output for focus handling.</para>
161         </listitem>
162       </varlistentry>
163       <varlistentry>
164         <term><option>--debug-xinerama</option></term>
165         <listitem>
166           <para>Split the display into two fake xinerama regions, if
167             xinerama is not already enabled. This is for debugging
168             xinerama support.</para>
169         </listitem>
170       </varlistentry>
171     </variablelist>
172   </refsect1>
173   <refsect1>
174     <title>SEE ALSO</title>
175
176     <para>obconf (1), openbox-session(1), openbox-gnome-session(1),
177       openbox-kde-session(1).</para>
178
179     <para>The program's full documentation is available on the website:
180       <literal>http://openbox.org/</literal></para>
181
182     <para>Please report bugs to: <literal>http://bugzilla.icculus.org/
183       </literal></para>
184   </refsect1>
185 </refentry>
186
187 <!-- Keep this comment at the end of the file
188 Local variables:
189 mode: sgml
190 sgml-omittag:t
191 sgml-shorttag:t
192 sgml-minimize-attributes:nil
193 sgml-always-quote-attributes:t
194 sgml-indent-step:2
195 sgml-indent-data:t
196 sgml-parent-document:nil
197 sgml-default-dtd-file:nil
198 sgml-exposed-tags:nil
199 sgml-local-catalogs:nil
200 sgml-local-ecat-files:nil
201 End:
202 -->
203
204