add --debug-xinerama
[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>Next generation, highly configurable window manager
34       </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>--sm-disable</option></arg>
44       <arg><option>--sync</option></arg>
45       <arg><option>--debug</option></arg>
46       <arg><option>--debug-focus</option></arg>
47       <arg><option>--debug-xinerama</option></arg>
48     </cmdsynopsis>
49   </refsynopsisdiv>
50   <refsect1>
51     <title>DESCRIPTION</title>
52
53     <para>Openbox is a next generation, highly
54       configurable window manager. Openbox is compliant with the
55       latest window manager standards.</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>If you don't want to run Openbox withing a desktop environment, then
67       it is recommended that you instead set up a ~/.xsession file and
68       use the <command>Default</command> session type. The ~/.xsession file
69       should any applications you want to run at startup, and then run
70       <command>&dhpackage;</command> at the end, such as:</para>
71
72       <blockquote><literallayout>
73       xsetroot -solid grey &
74       gnome-settings-daemon &
75       exec <command>&dhpackage;</command></literallayout></blockquote>
76
77     <para>Lastly, if you use <command>startx</command> to launch your X
78       session, you should set up a ~/.xinitrc file, exactly the same as the
79       above ~/.xsession file.</para>
80
81     <para>You can use the <command>obconf</command> tool to configure Openbox
82       easily with a graphical interface, however more in-depth configuration
83       is possible by editing the configuration files by hand. The default
84       configuration files are installed in @configdir@/openbox/, and the
85       user configuration is placed in ~/.config/openbox/. You can copy
86       the default configuration to ~/.config/openbox and edit it to your
87       liking.</para>
88
89     <para>There are 3 default configuration files, <literal>rc.xml</literal>,
90       <literal>rc-gnome.xml</literal>, and <literal>rc-kde.xml</literal>. The
91       rc-gnome.xml is used when you run
92       <command>openbox-gnome-session</command> and the rc-kde.xml is used when
93       you run <command>openbox-kde-session</command>. The configuration
94       files should be named the same in ~/.config/openbox/.</para>
95
96   </refsect1>
97   <refsect1>
98     <title>OPTIONS</title>
99
100     <para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
101     <variablelist>
102       <varlistentry>
103         <term><option>--help</option></term>
104         <listitem>
105           <para>Show a summary of the options available.</para>
106         </listitem>
107       </varlistentry>
108       <varlistentry>
109         <term><option>--version</option></term>
110         <listitem>
111           <para>Show the version of the program.</para>
112         </listitem>
113       </varlistentry>
114       <varlistentry>
115         <term><option>--replace</option></term>
116         <listitem>
117           <para>Replace the currently running window manager.</para>
118         </listitem>
119       </varlistentry>
120       <varlistentry>
121         <term><option>--reconfigure</option></term>
122         <listitem>
123           <para>If Openbox is already running on the display, tell it to
124             reload it's configuration.</para>
125         </listitem>
126       </varlistentry>
127       <varlistentry>
128         <term><option>--sm-disable</option></term>
129         <listitem>
130           <para>Do not connect to the session manager.</para>
131         </listitem>
132       </varlistentry>
133       <varlistentry>
134         <term><option>--sync</option></term>
135         <listitem>
136           <para>Run in synchronous mode (for debugging).</para>
137         </listitem>
138       </varlistentry>
139       <varlistentry>
140         <term><option>--debug</option></term>
141         <listitem>
142           <para>Display debugging output.</para>
143         </listitem>
144       </varlistentry>
145       <varlistentry>
146         <term><option>--debug-focus</option></term>
147         <listitem>
148           <para>Display debugging output for focus handling.</para>
149         </listitem>
150       </varlistentry>
151       <varlistentry>
152         <term><option>--debug-xinerama</option></term>
153         <listitem>
154           <para>Split the display into two fake xinerama regions, if
155             xinerama is not already enabled. This is for debugging
156             xinerama support.</para>
157         </listitem>
158       </varlistentry>
159     </variablelist>
160   </refsect1>
161   <refsect1>
162     <title>SEE ALSO</title>
163
164     <para>obconf (1), openbox-gnome-session (1), openbox-kde-session (1).
165       </para>
166
167     <para>The program's full documentation is available on the website:
168       <literal>http://openbox.org/</literal></para>
169
170     <para>Please report bugs to: <literal>http://bugzilla.icculus.org/
171       </literal></para>
172   </refsect1>
173 </refentry>
174
175 <!-- Keep this comment at the end of the file
176 Local variables:
177 mode: sgml
178 sgml-omittag:t
179 sgml-shorttag:t
180 sgml-minimize-attributes:nil
181 sgml-always-quote-attributes:t
182 sgml-indent-step:2
183 sgml-indent-data:t
184 sgml-parent-document:nil
185 sgml-default-dtd-file:nil
186 sgml-exposed-tags:nil
187 sgml-local-catalogs:nil
188 sgml-local-ecat-files:nil
189 End:
190 -->
191
192