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