changes to the manual pages.
[mikachu/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>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
72       example:
73       </para>
74
75     <blockquote><literallayout>
76       xsetroot -solid grey &
77       gnome-settings-daemon &</literallayout></blockquote>
78
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
82       own.</para>
83
84     <para>The default @configdir@/openbox/autostart.sh runs a number of things
85       with Openbox.</para>
86
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>
91
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. Please note that
95       <command>obconf</command> older than version 2.0 may not work at all
96       for you.</para>
97
98     <para>The default configuration and menu files are installed in
99       @configdir@/openbox/, and the user configuration is placed in
100       ~/.config/openbox/. You can copy the default configuration and menus
101       to ~/.config/openbox and edit it to your liking.</para>
102   </refsect1>
103   <refsect1>
104     <title>OPTIONS</title>
105
106     <para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
107     <variablelist>
108       <varlistentry>
109         <term><option>--help</option></term>
110         <listitem>
111           <para>Show a summary of the options available.</para>
112         </listitem>
113       </varlistentry>
114       <varlistentry>
115         <term><option>--version</option></term>
116         <listitem>
117           <para>Show the version of the program.</para>
118         </listitem>
119       </varlistentry>
120       <varlistentry>
121         <term><option>--replace</option></term>
122         <listitem>
123           <para>Replace the currently running window manager.</para>
124         </listitem>
125       </varlistentry>
126       <varlistentry>
127         <term><option>--reconfigure</option></term>
128         <listitem>
129           <para>If Openbox is already running on the display, tell it to
130             reload its configuration.</para>
131         </listitem>
132       </varlistentry>
133       <varlistentry>
134         <term><option>--sm-disable</option></term>
135         <listitem>
136           <para>Do not connect to the session manager.</para>
137         </listitem>
138       </varlistentry>
139       <varlistentry>
140         <term><option>--sync</option></term>
141         <listitem>
142           <para>Run in synchronous mode (for debugging).</para>
143         </listitem>
144       </varlistentry>
145       <varlistentry>
146         <term><option>--debug</option></term>
147         <listitem>
148           <para>Display debugging output.</para>
149         </listitem>
150       </varlistentry>
151       <varlistentry>
152         <term><option>--debug-focus</option></term>
153         <listitem>
154           <para>Display debugging output for focus handling.</para>
155         </listitem>
156       </varlistentry>
157       <varlistentry>
158         <term><option>--debug-xinerama</option></term>
159         <listitem>
160           <para>Split the display into two fake xinerama regions, if
161             xinerama is not already enabled. This is for debugging
162             xinerama support.</para>
163         </listitem>
164       </varlistentry>
165     </variablelist>
166   </refsect1>
167   <refsect1>
168     <title>SEE ALSO</title>
169
170     <para>obconf (1), openbox-gnome-session (1), openbox-kde-session (1).
171       </para>
172
173     <para>The program's full documentation is available on the website:
174       <literal>http://openbox.org/</literal></para>
175
176     <para>Please report bugs to: <literal>http://bugzilla.icculus.org/
177       </literal></para>
178   </refsect1>
179 </refentry>
180
181 <!-- Keep this comment at the end of the file
182 Local variables:
183 mode: sgml
184 sgml-omittag:t
185 sgml-shorttag:t
186 sgml-minimize-attributes:nil
187 sgml-always-quote-attributes:t
188 sgml-indent-step:2
189 sgml-indent-data:t
190 sgml-parent-document:nil
191 sgml-default-dtd-file:nil
192 sgml-exposed-tags:nil
193 sgml-local-catalogs:nil
194 sgml-local-ecat-files:nil
195 End:
196 -->
197
198