Add a manage

diff --git a/Makefile.am b/Makefile.am
index 35eaa47eb6b77ab59a471b91c594ae23edf62a21..a97020540552b2a5b4713dce38d8afb0f58bc6c9 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -364,6 +364,7 @@ dist_rc_DATA = \
 
 edit = $(SED) \
        -e 's!@version\@!$(VERSION)!' \
+       -e 's!@confdir\@!$(confdir)!' \
        -e 's!@bindir\@!$(bindir)!'
 
 data/xsession/openbox-gnome-session: Makefile data \
@@ -372,7 +373,7 @@ data/xsession/openbox-gnome-session: Makefile data \
        @mkdir data 2>/dev/null || true
        @mkdir data/xsession 2>/dev/null || true
        @$(edit) $(srcdir)/data/xsession/openbox-gnome-session.in >$@
-       @chmod +x $@
+       @chmod a+x $@
 
 data/xsession/openbox-kde-session: Makefile data \
                $(srcdir)/data/xsession/openbox-kde-session.in
@@ -380,7 +381,17 @@ data/xsession/openbox-kde-session: Makefile data \
        @mkdir data 2>/dev/null || true
        @mkdir data/xsession 2>/dev/null || true
        @$(edit) $(srcdir)/data/xsession/openbox-kde-session.in >$@
-       @chmod +x $@
+       @chmod a+x $@
+
+doc/openbox.1.in: Makefile doc $(srcdir)/doc/openbox.1.sgml
+       @echo make: creating $@
+       @mkdir doc 2>/dev/null || true
+       docbook-to-man $(srcdir)/doc/openbox.1.sgml > $@
+
+doc/openbox.1: Makefile doc doc/openbox.1.in
+       @echo make: creating $@
+       @mkdir doc 2>/dev/null || true
+       @$(edit) $(srcdir)/doc/openbox.1.in >$@
 
 dist_gnomewmfiles_DATA = \
        data/gnome-wm-properties/openbox.desktop
@@ -434,6 +445,9 @@ dist_doc_DATA = \
        data/menu.xsd \
        data/themerc.xsd
 
+man_MANS = \
+       doc/openbox.1
+
 EXTRA_DIST = \
        config.rpath \
        mkinstalldirs \

diff --git a/doc/openbox.1.sgml b/doc/openbox.1.sgml
new file mode 100644 (file)
index 0000000..f5e84ba
--- /dev/null
+++ b/doc/openbox.1.sgml
@@ -0,0 +1,190 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+
+<!-- Process this file with docbook-to-man to generate an nroff manual
+     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
+     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
+     less'.  A typical entry in a Makefile or Makefile.am is:
+
+manpage.1: manpage.sgml
+       docbook-to-man $< > $@
+
+    
+       The docbook-to-man binary is found in the docbook-to-man package.
+       Please remember that if you create the nroff version in one of the
+       debian/rules file targets (such as build), you will need to include
+       docbook-to-man in your Build-Depends control field.
+
+  -->
+
+  <!ENTITY dhfirstname "<firstname>Dana</firstname>">
+  <!ENTITY dhsurname   "<surname>Jansens</surname>">
+  <!-- Please adjust the date whenever revising the manpage. -->
+  <!ENTITY dhdate      "<date>May 13, 2007</date>">
+  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
+  <!ENTITY dhemail     "<email>danakj@orodu.net</email>">
+  <!ENTITY dhusername  "Dana Jansens">
+  <!ENTITY dhucpackage "<refentrytitle>OPENBOX</refentrytitle>">
+  <!ENTITY dhpackage   "openbox">
+
+  <!ENTITY gnu         "<acronym>GNU</acronym>">
+]>
+
+<refentry>
+  <refmeta>
+    &dhucpackage;
+
+    &dhsection;
+  </refmeta>
+  <refnamediv>
+    <refname>&dhpackage;</refname>
+
+    <refpurpose>Next generation window manager</refpurpose>
+  </refnamediv>
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>&dhpackage;</command>
+      <arg><option>--help</option></arg>
+      <arg><option>--version</option></arg>
+      <arg><option>--replace</option></arg>
+      <arg><option>--reconfigure</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>
+    </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>You can start Openbox in three ways:</para>
+
+    <para>If you run a display manager such as GDM, you will find 3 entries
+      in the login session type menu for Openbox:
+      <command>GNOME/Openbox</command>, <command>KDE/Openbox</command>
+      and <command>Openbox</command>. If you want to use Openbox
+      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>
+
+      <blockquote><literallayout>
+      xsetroot -solid grey &
+      gnome-settings-daemon &
+      exec <command>&dhpackage;</command></literallayout></blockquote>
+
+    <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>
+
+    <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>
+
+  </refsect1>
+  <refsect1>
+    <title>OPTIONS</title>
+
+    <para>These are the possible options that <command>&dhpackage;</command> accepts:</para>
+    <variablelist>
+      <varlistentry>
+        <term><option>--help</option></term>
+        <listitem>
+          <para>Show a summary of the options available.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--version</option></term>
+        <listitem>
+          <para>Show the version of the program.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--replace</option></term>
+        <listitem>
+          <para>Replace the currently running window manager.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--reconfigure</option></term>
+        <listitem>
+          <para>If Openbox is already running on the display, tell it to
+            reload it's configuration.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--sm-disable</option></term>
+        <listitem>
+          <para>Do not connect to the session manager.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--config<replaceable>TYPE</replaceable></option></term>
+        <listitem>
+          <para>Specify the configuration profile to use.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--sync</option></term>
+        <listitem>
+          <para>Run in synchronous mode (for debugging).</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--debug</option></term>
+        <listitem>
+          <para>Display debugging output.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--debug-focus</option></term>
+        <listitem>
+          <para>Display debugging output for focus handling.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+  <refsect1>
+    <title>SEE ALSO</title>
+
+    <para>obconf (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>
+
+    <para>Please report bugs to: <olink>http://bugzilla.icculus.org/</olink>
+      </para>
+  </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:2
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-default-dtd-file:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->
+
+