updates to build debian and ubuntu debs. make man page say what webpage will probably...
[dana/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>A minimalistic, highly configurable, next generation window
34       manager with extensive standards support.</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 minimalistic, highly configurable, next generation window
54       manager with extensive standards support.</para>
55
56     <para>You can start Openbox in three ways:</para>
57
58     <para>If you run a display manager such as GDM, you will find 3 entries
59       in the login session type menu for Openbox:
60       <command>GNOME/Openbox</command>, <command>KDE/Openbox</command>
61       and <command>Openbox</command>. If you want to use Openbox
62       within GNOME or KDE, you can choose the appropriate entry, and it will
63       launch GNOME or KDE with Openbox as the window manager.</para>
64
65     <para>The third option at log in, which is <command>Openbox</command>
66       without a session manager, uses the <command>openbox-session</command>
67       command to start Openbox. On log in, <command>&dhpackage;</command> will
68       run the ~/.config/openbox/autostart.sh script if it exists, and will run
69       the system-wide script @configdir@/openbox/autostart.sh otherwise. You
70       may place anything you want to run automatically in those files, for
71       example:
72       </para>
73
74     <blockquote><literallayout>
75       xsetroot -solid grey &
76       gnome-settings-daemon &</literallayout></blockquote>
77
78     <para>Make sure that each line is followed by a "&" or else the script will
79       stop there and further commands will not be executed. You can use the
80       @configdir@/openbox/autostart.sh file as an example for creating your
81       own.</para>
82
83     <para>The default @configdir@/openbox/autostart.sh runs a number of things
84       with Openbox.</para>
85
86     <para>Lastly, if you use <command>startx</command> to launch your X
87       session, you can set up a ~/.xinitrc file to run
88       <command>openbox-session</command> and follow the same directions as
89       above regarding the autostart.sh file.</para>
90
91     <para>You can use the <command>obconf</command> tool to configure Openbox
92       easily with a graphical interface, however more in-depth configuration
93       is possible by editing the configuration files by hand. Please note that
94       <command>obconf</command> older than version 2.0 may not work at all
95       for you.</para>
96
97     <para>The default configuration and menu files are installed in
98       @configdir@/openbox/, and the user configuration is placed in
99       ~/.config/openbox/. You can copy the default configuration and menus
100       to ~/.config/openbox and edit it to your liking.</para>
101   </refsect1>
102   <refsect1>
103     <title>OPTIONS</title>
104
105     <para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
106     <variablelist>
107       <varlistentry>
108         <term><option>--help</option></term>
109         <listitem>
110           <para>Show a summary of the options available.</para>
111         </listitem>
112       </varlistentry>
113       <varlistentry>
114         <term><option>--version</option></term>
115         <listitem>
116           <para>Show the version of the program.</para>
117         </listitem>
118       </varlistentry>
119       <varlistentry>
120         <term><option>--replace</option></term>
121         <listitem>
122           <para>Replace the currently running window manager.</para>
123         </listitem>
124       </varlistentry>
125       <varlistentry>
126         <term><option>--reconfigure</option></term>
127         <listitem>
128           <para>If Openbox is already running on the display, tell it to
129             reload its configuration.</para>
130         </listitem>
131       </varlistentry>
132       <varlistentry>
133         <term><option>--sm-disable</option></term>
134         <listitem>
135           <para>Do not connect to the session manager.</para>
136         </listitem>
137       </varlistentry>
138       <varlistentry>
139         <term><option>--sync</option></term>
140         <listitem>
141           <para>Run in synchronous mode (for debugging).</para>
142         </listitem>
143       </varlistentry>
144       <varlistentry>
145         <term><option>--debug</option></term>
146         <listitem>
147           <para>Display debugging output.</para>
148         </listitem>
149       </varlistentry>
150       <varlistentry>
151         <term><option>--debug-focus</option></term>
152         <listitem>
153           <para>Display debugging output for focus handling.</para>
154         </listitem>
155       </varlistentry>
156       <varlistentry>
157         <term><option>--debug-xinerama</option></term>
158         <listitem>
159           <para>Split the display into two fake xinerama regions, if
160             xinerama is not already enabled. This is for debugging
161             xinerama support.</para>
162         </listitem>
163       </varlistentry>
164     </variablelist>
165   </refsect1>
166   <refsect1>
167     <title>SEE ALSO</title>
168
169     <para>obconf (1), openbox-session(1), openbox-gnome-session(1),
170       openbox-kde-session(1).</para>
171
172     <para>The program's full documentation is available on the website:
173       <literal>http://icculus.org/openbox/</literal></para>
174
175     <para>Please report bugs to: <literal>http://bugzilla.icculus.org/
176       </literal></para>
177   </refsect1>
178 </refentry>
179
180 <!-- Keep this comment at the end of the file
181 Local variables:
182 mode: sgml
183 sgml-omittag:t
184 sgml-shorttag:t
185 sgml-minimize-attributes:nil
186 sgml-always-quote-attributes:t
187 sgml-indent-step:2
188 sgml-indent-data:t
189 sgml-parent-document:nil
190 sgml-default-dtd-file:nil
191 sgml-exposed-tags:nil
192 sgml-local-catalogs:nil
193 sgml-local-ecat-files:nil
194 End:
195 -->
196
197