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/, and the user configuration is placed in
89 ~/.config/openbox/. You can copy the default configuration
90 to ~/.config/openbox and edit it to your liking.</para>
92 <para>There are 3 default configuration files, <literal>rc.xml</literal>,
93 <literal>rc-gnome.xml</literal>, and <literal>rc-kde.xml</literal>. The
94 rc-gnome.xml is used when you run
95 <command>openbox-gnome-session</command> and the rc-kde.xml is used when
96 you run <command>openbox-kde-session</command>. The configuration
97 files should be named the same in ~/.config/openbox/.</para>
101 <title>OPTIONS</title>
103 <para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
106 <term><option>--help</option></term>
108 <para>Show a summary of the options available.</para>
112 <term><option>--version</option></term>
114 <para>Show the version of the program.</para>
118 <term><option>--replace</option></term>
120 <para>Replace the currently running window manager.</para>
124 <term><option>--reconfigure</option></term>
126 <para>If Openbox is already running on the display, tell it to
127 reload its configuration.</para>
131 <term><option>--sm-disable</option></term>
133 <para>Do not connect to the session manager.</para>
137 <term><option>--sync</option></term>
139 <para>Run in synchronous mode (for debugging).</para>
143 <term><option>--debug</option></term>
145 <para>Display debugging output.</para>
149 <term><option>--debug-focus</option></term>
151 <para>Display debugging output for focus handling.</para>
155 <term><option>--debug-xinerama</option></term>
157 <para>Split the display into two fake xinerama regions, if
158 xinerama is not already enabled. This is for debugging
159 xinerama support.</para>
165 <title>SEE ALSO</title>
167 <para>obconf (1), openbox-gnome-session (1), openbox-kde-session (1).
170 <para>The program's full documentation is available on the website:
171 <literal>http://openbox.org/</literal></para>
173 <para>Please report bugs to: <literal>http://bugzilla.icculus.org/
178 <!-- Keep this comment at the end of the file
183 sgml-minimize-attributes:nil
184 sgml-always-quote-attributes:t
187 sgml-parent-document:nil
188 sgml-default-dtd-file:nil
189 sgml-exposed-tags:nil
190 sgml-local-catalogs:nil
191 sgml-local-ecat-files:nil