1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
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:
8 manpage.1: manpage.sgml
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.
19 <!ENTITY dhsection "<manvolnum>1</manvolnum>">
20 <!ENTITY dhucpackage "<refentrytitle>OPENBOX</refentrytitle>">
21 <!ENTITY dhpackage "openbox">
31 <refname>&dhpackage;</refname>
33 <refpurpose>Next generation, highly configurable window manager
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>
51 <title>DESCRIPTION</title>
53 <para>Openbox is a next generation, highly
54 configurable window manager. Openbox is compliant with the
55 latest window manager standards.</para>
57 <para>You can start Openbox in three ways:</para>
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>
66 <para>If you don't want to run Openbox within 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 start any applications you want to run at startup, and then run
70 <command>&dhpackage;</command> at the end, such as:</para>
72 <blockquote><literallayout>
73 xsetroot -solid grey &
74 gnome-settings-daemon &
75 exec <command>&dhpackage;</command></literallayout></blockquote>
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>
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. Please note that
84 <command>obconf</command> older than version 2.0 may not work at all
87 <para>The default configuration files are installed in
88 @configdir@/openbox/rc.xml, and the user configuration is placed in
89 ~/.config/openbox/rc.xml. You can copy the default configuration
90 to ~/.config/openbox and edit it to your liking.</para>
93 <title>OPTIONS</title>
95 <para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
98 <term><option>--help</option></term>
100 <para>Show a summary of the options available.</para>
104 <term><option>--version</option></term>
106 <para>Show the version of the program.</para>
110 <term><option>--replace</option></term>
112 <para>Replace the currently running window manager.</para>
116 <term><option>--reconfigure</option></term>
118 <para>If Openbox is already running on the display, tell it to
119 reload its configuration.</para>
123 <term><option>--sm-disable</option></term>
125 <para>Do not connect to the session manager.</para>
129 <term><option>--sync</option></term>
131 <para>Run in synchronous mode (for debugging).</para>
135 <term><option>--debug</option></term>
137 <para>Display debugging output.</para>
141 <term><option>--debug-focus</option></term>
143 <para>Display debugging output for focus handling.</para>
147 <term><option>--debug-xinerama</option></term>
149 <para>Split the display into two fake xinerama regions, if
150 xinerama is not already enabled. This is for debugging
151 xinerama support.</para>
157 <title>SEE ALSO</title>
159 <para>obconf (1), openbox-gnome-session (1), openbox-kde-session (1).
162 <para>The program's full documentation is available on the website:
163 <literal>http://openbox.org/</literal></para>
165 <para>Please report bugs to: <literal>http://bugzilla.icculus.org/
170 <!-- Keep this comment at the end of the file
175 sgml-minimize-attributes:nil
176 sgml-always-quote-attributes:t
179 sgml-parent-document:nil
180 sgml-default-dtd-file:nil
181 sgml-exposed-tags:nil
182 sgml-local-catalogs:nil
183 sgml-local-ecat-files:nil