X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=doc%2Fopenbox.1.sgml;h=275c3246ee075516d239e5477b272374707663b8;hb=8ed0970b65e2a74c122059aed8c69057c129db35;hp=04ce70829b3703163eaac96daccfb45e09f2cd32;hpb=02f6e4509eef69883bce2de1f316983a5d94326f;p=chaz%2Fopenbox

diff --git a/doc/openbox.1.sgml b/doc/openbox.1.sgml
index 04ce7082..275c3246 100644
--- a/doc/openbox.1.sgml
+++ b/doc/openbox.1.sgml
@@ -30,8 +30,8 @@ manpage.1: manpage.sgml
   <refnamediv>
     <refname>&dhpackage;</refname>
 
-    <refpurpose>Next generation, highly configurable window manager
-      </refpurpose>
+    <refpurpose>A minimalistic, highly configurable, next generation window
+      manager with extensive standards support.</refpurpose>
   </refnamediv>
   <refsynopsisdiv>
     <cmdsynopsis>
@@ -40,19 +40,19 @@ manpage.1: manpage.sgml
       <arg><option>--version</option></arg>
       <arg><option>--replace</option></arg>
       <arg><option>--reconfigure</option></arg>
+      <arg><option>--restart</option></arg>
       <arg><option>--sm-disable</option></arg>
-      <arg><option>--config <replaceable>TYPE</replaceable></option></arg>
       <arg><option>--sync</option></arg>
       <arg><option>--debug</option></arg>
       <arg><option>--debug-focus</option></arg>
+      <arg><option>--debug-xinerama</option></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
   <refsect1>
     <title>DESCRIPTION</title>
 
-    <para>Openbox is a next generation, highly
-      configurable window manager. Openbox is compliant with the
-      latest window manager standards.</para>
+    <para>Openbox is minimalistic, highly configurable, next generation window
+      manager with extensive standards support.</para>
 
     <para>You can start Openbox in three ways:</para>
 
@@ -63,29 +63,40 @@ manpage.1: manpage.sgml
       within GNOME or KDE, you can choose the appropriate entry, and it will
       launch GNOME or KDE with Openbox as the window manager.</para>
 
-    <para>If you don't want to run Openbox withing a desktop environment, then
-      it is recommended that you instead set up a ~/.xsession file and
-      use the <command>Default</command> session type. The ~/.xsession file
-      should any applications you want to run at startup, and then run
-      <command>&dhpackage;</command> at the end, such as:</para>
+    <para>The third option at log in, which is <command>Openbox</command>
+      without a session manager, uses the <command>openbox-session</command>
+      command to start Openbox. On log in, <command>&dhpackage;</command> will
+      run the ~/.config/openbox/autostart.sh script if it exists, and will run
+      the system-wide script @configdir@/openbox/autostart.sh otherwise. You
+      may place anything you want to run automatically in those files, for
+      example:
+      </para>
 
-      <blockquote><literallayout>
+    <blockquote><literallayout>
       xsetroot -solid grey &
-      gnome-settings-daemon &
-      exec <command>&dhpackage;</command></literallayout></blockquote>
+      gnome-settings-daemon &</literallayout></blockquote>
+
+    <para>Make sure that each line is followed by a "&" or else the script will
+      stop there and further commands will not be executed. You can use the
+      @configdir@/openbox/autostart.sh file as an example for creating your
+      own.</para>
+
+    <para>The default @configdir@/openbox/autostart.sh runs a number of things
+      with Openbox.</para>
 
     <para>Lastly, if you use <command>startx</command> to launch your X
-      session, you should set up a ~/.xinitrc file, exactly the same as the
-      above ~/.xsession file.</para>
+      session, you can set up a ~/.xinitrc file to run
+      <command>openbox-session</command> and follow the same directions as
+      above regarding the autostart.sh file.</para>
 
     <para>You can use the <command>obconf</command> tool to configure Openbox
       easily with a graphical interface, however more in-depth configuration
-      is possible by editing the configuration files by hand. The default
-      configuration file is installed in @confdir@/xdg/openbox/rc.xml, and the
-      user configuration is placed in ~/.config/openbox/rc.xml. You can copy
-      the default configuration to ~/.config/openbox and edit it to your
-      liking.</para>
+      is possible by editing the configuration files by hand.</para>
 
+    <para>The default configuration and menu files are installed in
+      @configdir@/openbox/, and the user configuration is placed in
+      ~/.config/openbox/. You can copy the default configuration and menus
+      to ~/.config/openbox and edit it to your liking.</para>
   </refsect1>
   <refsect1>
     <title>OPTIONS</title>
@@ -114,19 +125,21 @@ manpage.1: manpage.sgml
         <term><option>--reconfigure</option></term>
         <listitem>
           <para>If Openbox is already running on the display, tell it to
-            reload it's configuration.</para>
+            reload its configuration.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term><option>--sm-disable</option></term>
+        <term><option>--restart</option></term>
         <listitem>
-          <para>Do not connect to the session manager.</para>
+          <para>If Openbox is already running on the display, tell it to
+            restart. This is useful if you have upgraded Openbox and don't
+            want to restart X.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term><option>--config<replaceable>TYPE</replaceable></option></term>
+        <term><option>--sm-disable</option></term>
         <listitem>
-          <para>Specify the configuration profile to use.</para>
+          <para>Do not connect to the session manager.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -147,19 +160,27 @@ manpage.1: manpage.sgml
           <para>Display debugging output for focus handling.</para>
         </listitem>
       </varlistentry>
+      <varlistentry>
+        <term><option>--debug-xinerama</option></term>
+        <listitem>
+          <para>Split the display into two fake xinerama regions, if
+	    xinerama is not already enabled. This is for debugging
+	    xinerama support.</para>
+        </listitem>
+      </varlistentry>
     </variablelist>
   </refsect1>
   <refsect1>
     <title>SEE ALSO</title>
 
-    <para>obconf (1), openbox-gnome-session (1), openbox-kde-session (1).
-      </para>
+    <para>obconf (1), openbox-session(1), openbox-gnome-session(1),
+      openbox-kde-session(1).</para>
 
     <para>The program's full documentation is available on the website:
-      <olink>http://openbox.org/</olink></para>
+      <literal>http://openbox.org/</literal></para>
 
-    <para>Please report bugs to: <olink>http://bugzilla.icculus.org/</olink>
-      </para>
+    <para>Please report bugs to: <literal>http://bugzilla.icculus.org/
+      </literal></para>
   </refsect1>
 </refentry>