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>A minimalistic, highly configurable, next generation window
34 manager with extensive standards support.</refpurpose>
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>
52 <title>DESCRIPTION</title>
54 <para>Openbox is minimalistic, highly configurable, next generation window
55 manager with extensive standards support.</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>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
75 <blockquote><literallayout>
76 xsetroot -solid grey &
77 gnome-settings-daemon &</literallayout></blockquote>
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
84 <para>The default @configdir@/openbox/autostart.sh runs a number of things
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>
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>
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>
102 <title>OPTIONS</title>
104 <para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
107 <term><option>--help</option></term>
109 <para>Show a summary of the options available.</para>
113 <term><option>--version</option></term>
115 <para>Show the version of the program.</para>
119 <term><option>--replace</option></term>
121 <para>Replace the currently running window manager.</para>
125 <term><option>--reconfigure</option></term>
127 <para>If Openbox is already running on the display, tell it to
128 reload its configuration.</para>
132 <term><option>--restart</option></term>
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>
140 <term><option>--sm-disable</option></term>
142 <para>Do not connect to the session manager.</para>
146 <term><option>--sync</option></term>
148 <para>Run in synchronous mode (for debugging).</para>
152 <term><option>--debug</option></term>
154 <para>Display debugging output.</para>
158 <term><option>--debug-focus</option></term>
160 <para>Display debugging output for focus handling.</para>
164 <term><option>--debug-xinerama</option></term>
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>
174 <title>SEE ALSO</title>
176 <para>obconf (1), openbox-session(1), openbox-gnome-session(1),
177 openbox-kde-session(1).</para>
179 <para>The program's full documentation is available on the website:
180 <literal>http://icculus.org/openbox/</literal></para>
182 <para>Please report bugs to: <literal>http://bugzilla.icculus.org/
187 <!-- Keep this comment at the end of the file
192 sgml-minimize-attributes:nil
193 sgml-always-quote-attributes: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