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>--restart</option></arg>
  44       <arg><option>--config-file FILE</option></arg>
  45       <arg><option>--sm-disable</option></arg>
  46       <arg><option>--sync</option></arg>
  47       <arg><option>--debug</option></arg>
  48       <arg><option>--debug-focus</option></arg>
  49       <arg><option>--debug-xinerama</option></arg>
  50     </cmdsynopsis>
  51   </refsynopsisdiv>
  52   <refsect1>
  53     <title>DESCRIPTION</title>
  54
  55     <para>Openbox is minimalistic, highly configurable, next generation window
  56       manager with extensive standards support.</para>
  57
  58     <para>You can start Openbox in three ways:</para>
  59
  60     <para>If you run a display manager such as GDM, you will find 3 entries
  61       in the login session type menu for Openbox:
  62       <command>GNOME/Openbox</command>, <command>KDE/Openbox</command>
  63       and <command>Openbox</command>. If you want to use Openbox
  64       within GNOME or KDE, you can choose the appropriate entry, and it will
  65       launch GNOME or KDE with Openbox as the window manager.</para>
  66
  67     <para>The third option at log in, which is <command>Openbox</command>
  68       without a session manager, uses the <command>openbox-session</command>
  69       command to start Openbox. On log in, <command>&dhpackage;</command> will
  70       run the ~/.config/openbox/autostart.sh script if it exists, and will run
  71       the system-wide script @configdir@/openbox/autostart.sh otherwise. You
  72       may place anything you want to run automatically in those files, for
  73       example:
  74       </para>
  75
  76     <blockquote><literallayout>
  77       xsetroot -solid grey &
  78       gnome-settings-daemon &</literallayout></blockquote>
  79
  80     <para>Make sure that each line is followed by a "&" or else the script will
  81       stop there and further commands will not be executed. You can use the
  82       @configdir@/openbox/autostart.sh file as an example for creating your
  83       own.</para>
  84
  85     <para>The default @configdir@/openbox/autostart.sh runs a number of things
  86       with Openbox.</para>
  87
  88     <para>Lastly, if you use <command>startx</command> to launch your X
  89       session, you can set up a ~/.xinitrc file to run
  90       <command>openbox-session</command> and follow the same directions as
  91       above regarding the autostart.sh file.</para>
  92
  93     <para>You can use the <command>obconf</command> tool to configure Openbox
  94       easily with a graphical interface, however more in-depth configuration
  95       is possible by editing the configuration files by hand.</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>--restart</option></term>
 134         <listitem>
 135           <para>If Openbox is already running on the display, tell it to
 136             restart. This is useful if you have upgraded Openbox and don't
 137             want to restart X.</para>
 138         </listitem>
 139       </varlistentry>
 140       <varlistentry>
 141         <term><option>--config-file FILE</option></term>
 142         <listitem>
 143           <para>Use FILE for configuration instead of looking for rc.xml
 144             in the XDG search path. FILE is an absolute path.</para>
 145         </listitem>
 146       </varlistentry>
 147       <varlistentry>
 148         <term><option>--sm-disable</option></term>
 149         <listitem>
 150           <para>Do not connect to the session manager.</para>
 151         </listitem>
 152       </varlistentry>
 153       <varlistentry>
 154         <term><option>--sync</option></term>
 155         <listitem>
 156           <para>Run in synchronous mode (for debugging).</para>
 157         </listitem>
 158       </varlistentry>
 159       <varlistentry>
 160         <term><option>--debug</option></term>
 161         <listitem>
 162           <para>Display debugging output.</para>
 163         </listitem>
 164       </varlistentry>
 165       <varlistentry>
 166         <term><option>--debug-focus</option></term>
 167         <listitem>
 168           <para>Display debugging output for focus handling.</para>
 169         </listitem>
 170       </varlistentry>
 171       <varlistentry>
 172         <term><option>--debug-xinerama</option></term>
 173         <listitem>
 174           <para>Split the display into two fake xinerama regions, if
 175             xinerama is not already enabled. This is for debugging
 176             xinerama support.</para>
 177         </listitem>
 178       </varlistentry>
 179     </variablelist>
 180   </refsect1>
 181   <refsect1>
 182     <title>SEE ALSO</title>
 183
 184     <para>obconf (1), openbox-session(1), openbox-gnome-session(1),
 185       openbox-kde-session(1).</para>
 186
 187     <para>The program's full documentation is available on the website:
 188       <literal>http://openbox.org/</literal></para>
 189
 190     <para>Please report bugs to: <literal>http://bugzilla.icculus.org/
 191       </literal></para>
 192   </refsect1>
 193 </refentry>
 194
 195 <!-- Keep this comment at the end of the file
 196 Local variables:
 197 mode: sgml
 198 sgml-omittag:t
 199 sgml-shorttag:t
 200 sgml-minimize-attributes:nil
 201 sgml-always-quote-attributes:t
 202 sgml-indent-step:2
 203 sgml-indent-data:t
 204 sgml-parent-document:nil
 205 sgml-default-dtd-file:nil
 206 sgml-exposed-tags:nil
 207 sgml-local-catalogs:nil
 208 sgml-local-ecat-files:nil
 209 End:
 210 -->
 211
 212