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     </cmdsynopsis>
  48   </refsynopsisdiv>
  49   <refsect1>
  50     <title>DESCRIPTION</title>
  51
  52     <para>Openbox is a next generation, highly
  53       configurable window manager. Openbox is compliant with the
  54       latest window manager standards.</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>If you don't want to run Openbox withing a desktop environment, then
  66       it is recommended that you instead set up a ~/.xsession file and
  67       use the <command>Default</command> session type. The ~/.xsession file
  68       should any applications you want to run at startup, and then run
  69       <command>&dhpackage;</command> at the end, such as:</para>
  70
  71       <blockquote><literallayout>
  72       xsetroot -solid grey &
  73       gnome-settings-daemon &
  74       exec <command>&dhpackage;</command></literallayout></blockquote>
  75
  76     <para>Lastly, if you use <command>startx</command> to launch your X
  77       session, you should set up a ~/.xinitrc file, exactly the same as the
  78       above ~/.xsession file.</para>
  79
  80     <para>You can use the <command>obconf</command> tool to configure Openbox
  81       easily with a graphical interface, however more in-depth configuration
  82       is possible by editing the configuration files by hand. The default
  83       configuration files are installed in @configdir@/openbox/, and the
  84       user configuration is placed in ~/.config/openbox/. You can copy
  85       the default configuration to ~/.config/openbox and edit it to your
  86       liking.</para>
  87
  88     <para>There are 3 default configuration files, <literal>rc.xml</literal>,
  89       <literal>rc-gnome.xml</literal>, and <literal>rc-kde.xml</literal>. The
  90       rc-gnome.xml is used when you run
  91       <command>openbox-gnome-session</command> and the rc-kde.xml is used when
  92       you run <command>openbox-kde-session</command>. The configuration
  93       files should be named the same in ~/.config/openbox/.</para>
  94
  95   </refsect1>
  96   <refsect1>
  97     <title>OPTIONS</title>
  98
  99     <para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
 100     <variablelist>
 101       <varlistentry>
 102         <term><option>--help</option></term>
 103         <listitem>
 104           <para>Show a summary of the options available.</para>
 105         </listitem>
 106       </varlistentry>
 107       <varlistentry>
 108         <term><option>--version</option></term>
 109         <listitem>
 110           <para>Show the version of the program.</para>
 111         </listitem>
 112       </varlistentry>
 113       <varlistentry>
 114         <term><option>--replace</option></term>
 115         <listitem>
 116           <para>Replace the currently running window manager.</para>
 117         </listitem>
 118       </varlistentry>
 119       <varlistentry>
 120         <term><option>--reconfigure</option></term>
 121         <listitem>
 122           <para>If Openbox is already running on the display, tell it to
 123             reload it's configuration.</para>
 124         </listitem>
 125       </varlistentry>
 126       <varlistentry>
 127         <term><option>--sm-disable</option></term>
 128         <listitem>
 129           <para>Do not connect to the session manager.</para>
 130         </listitem>
 131       </varlistentry>
 132       <varlistentry>
 133         <term><option>--sync</option></term>
 134         <listitem>
 135           <para>Run in synchronous mode (for debugging).</para>
 136         </listitem>
 137       </varlistentry>
 138       <varlistentry>
 139         <term><option>--debug</option></term>
 140         <listitem>
 141           <para>Display debugging output.</para>
 142         </listitem>
 143       </varlistentry>
 144       <varlistentry>
 145         <term><option>--debug-focus</option></term>
 146         <listitem>
 147           <para>Display debugging output for focus handling.</para>
 148         </listitem>
 149       </varlistentry>
 150     </variablelist>
 151   </refsect1>
 152   <refsect1>
 153     <title>SEE ALSO</title>
 154
 155     <para>obconf (1), openbox-gnome-session (1), openbox-kde-session (1).
 156       </para>
 157
 158     <para>The program's full documentation is available on the website:
 159       <literal>http://openbox.org/</literal></para>
 160
 161     <para>Please report bugs to: <literal>http://bugzilla.icculus.org/
 162       </literal></para>
 163   </refsect1>
 164 </refentry>
 165
 166 <!-- Keep this comment at the end of the file
 167 Local variables:
 168 mode: sgml
 169 sgml-omittag:t
 170 sgml-shorttag:t
 171 sgml-minimize-attributes:nil
 172 sgml-always-quote-attributes:t
 173 sgml-indent-step:2
 174 sgml-indent-data:t
 175 sgml-parent-document:nil
 176 sgml-default-dtd-file:nil
 177 sgml-exposed-tags:nil
 178 sgml-local-catalogs:nil
 179 sgml-local-ecat-files:nil
 180 End:
 181 -->
 182
 183