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 dhfirstname "<firstname>Dana</firstname>">
20 <!ENTITY dhsurname "<surname>Jansens</surname>">
21 <!-- Please adjust the date whenever revising the manpage. -->
22 <!ENTITY dhdate "<date>May 13, 2007</date>">
23 <!ENTITY dhsection "<manvolnum>1</manvolnum>">
24 <!ENTITY dhemail "<email>danakj@orodu.net</email>">
25 <!ENTITY dhusername "Dana Jansens">
26 <!ENTITY dhucpackage "<refentrytitle>OPENBOX</refentrytitle>">
27 <!ENTITY dhpackage "openbox">
29 <!ENTITY gnu "<acronym>GNU</acronym>">
39 <refname>&dhpackage;</refname>
41 <refpurpose>Next generation window manager</refpurpose>
45 <command>&dhpackage;</command>
46 <arg><option>--help</option></arg>
47 <arg><option>--version</option></arg>
48 <arg><option>--replace</option></arg>
49 <arg><option>--reconfigure</option></arg>
50 <arg><option>--sm-disable</option></arg>
51 <arg><option>--config <replaceable>TYPE</replaceable></option></arg>
52 <arg><option>--sync</option></arg>
53 <arg><option>--debug</option></arg>
54 <arg><option>--debug-focus</option></arg>
58 <title>DESCRIPTION</title>
60 <para>Openbox is a next generation, highly
61 configurable window manager. Openbox is compliant with the
62 latest window manager standards.</para>
64 <para>You can start Openbox in three ways:</para>
66 <para>If you run a display manager such as GDM, you will find 3 entries
67 in the login session type menu for Openbox:
68 <command>GNOME/Openbox</command>, <command>KDE/Openbox</command>
69 and <command>Openbox</command>. If you want to use Openbox
70 within GNOME or KDE, you can choose the appropriate entry, and it will
71 launch GNOME or KDE with Openbox as the window manager.</para>
73 <para>If you don't want to run Openbox withing a desktop environment, then
74 it is recommended that you instead set up a ~/.xsession file and
75 use the <command>Default</command> session type. The ~/.xsession file
76 should any applications you want to run at startup, and then run
77 <command>&dhpackage;</command> at the end, such as:</para>
79 <blockquote><literallayout>
80 xsetroot -solid grey &
81 gnome-settings-daemon &
82 exec <command>&dhpackage;</command></literallayout></blockquote>
84 <para>Lastly, if you use <command>startx</command> to launch your X
85 session, you should set up a ~/.xinitrc file, exactly the same as the
86 above ~/.xsession file.</para>
88 <para>You can use the <command>obconf</command> tool to configure Openbox
89 easily with a graphical interface, however more in-depth configuration
90 is possible by editing the configuration files by hand. The default
91 configuration file is installed in @confdir@/xdg/openbox/rc.xml, and the
92 user configuration is placed in ~/.config/openbox/rc.xml. You can copy
93 the default configuration to ~/.config/openbox and edit it to your
98 <title>OPTIONS</title>
100 <para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
103 <term><option>--help</option></term>
105 <para>Show a summary of the options available.</para>
109 <term><option>--version</option></term>
111 <para>Show the version of the program.</para>
115 <term><option>--replace</option></term>
117 <para>Replace the currently running window manager.</para>
121 <term><option>--reconfigure</option></term>
123 <para>If Openbox is already running on the display, tell it to
124 reload it's configuration.</para>
128 <term><option>--sm-disable</option></term>
130 <para>Do not connect to the session manager.</para>
134 <term><option>--config<replaceable>TYPE</replaceable></option></term>
136 <para>Specify the configuration profile to use.</para>
140 <term><option>--sync</option></term>
142 <para>Run in synchronous mode (for debugging).</para>
146 <term><option>--debug</option></term>
148 <para>Display debugging output.</para>
152 <term><option>--debug-focus</option></term>
154 <para>Display debugging output for focus handling.</para>
160 <title>SEE ALSO</title>
162 <para>obconf (1), openbox-gnome-session (1), openbox-kde-session (1).
165 <para>The program's full documentation is available on the website:
166 <olink>http://openbox.org/</olink></para>
168 <para>Please report bugs to: <olink>http://bugzilla.icculus.org/</olink>
173 <!-- Keep this comment at the end of the file
178 sgml-minimize-attributes:nil
179 sgml-always-quote-attributes:t
182 sgml-parent-document:nil
183 sgml-default-dtd-file:nil
184 sgml-exposed-tags:nil
185 sgml-local-catalogs:nil
186 sgml-local-ecat-files:nil