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