Add manpages for all files and commands

8 files changed, 457 insertions, 2 deletions

diff --git a/Makefile.am b/Makefile.am
index dcdf7a2..c01c54f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,6 +1,6 @@
 NULL =
 
-SUBDIRS=po
+SUBDIRS=po man
 
 INCLUDES =					\
 	-I$(top_srcdir)				\
diff --git a/configure.ac b/configure.ac
index 1120925..e3fc0bc 100644
--- a/configure.ac
+++ b/configure.ac
@@ -64,7 +64,20 @@ if test "$GCC" = "yes" -a "$set_more_warnings" != "no"; then
 else
 	AC_MSG_RESULT(no)
 fi
-			       
+
+AC_ARG_ENABLE(documentation,
+              AC_HELP_STRING([--enable-documentation],
+                             [build documentation]),,
+              enable_documentation=yes)
+if test x$enable_documentation = xyes; then
+   AC_PATH_PROG([XSLTPROC], [xsltproc])
+   if test x$XSLTPROC = x; then
+      AC_MSG_ERROR([xsltproc is required to build documentation])
+   fi
+fi
+AM_CONDITIONAL(BUILD_DOCUMENTATION, test x$enable_documentation = xyes)
+
 AC_OUTPUT([ po/Makefile.in
 Makefile
+man/Makefile
 ])
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..06dc093
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,26 @@
+XSLTPROC_FLAGS = \
+        --nonet \
+        --stringparam man.output.quietly 1 \
+        --stringparam funcsynopsis.style ansi \
+        --stringparam man.th.extra1.suppress 1 \
+        --stringparam man.authors.section.enabled 0 \
+        --stringparam man.copyright.section.enabled 0
+
+.xml.1:
+	$(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+.xml.5:
+	$(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+man_MANS = \
+	xdg-user-dir.1 \
+	xdg-user-dirs-update.1 \
+	user-dirs.conf.5 \
+	user-dirs.defaults.5 \
+	user-dirs.dirs.5
+
+xml_files = $($(man_MANS:.1=.xml):.5=.xml)
+
+EXTRA_DIST = $(xml_files)
+
+DISTCLEANFILES = $(man_MANS)
diff --git a/man/user-dirs.conf.xml b/man/user-dirs.conf.xml
new file mode 100644
index 0000000..40c0205
--- /dev/null
+++ b/man/user-dirs.conf.xml
@@ -0,0 +1,77 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+]>
+<refentry id="user-dirs.conf">
+
+<refentryinfo>
+  <title>user-dirs.conf</title>
+  <productname>XDG</productname>
+  <authorgroup>
+    <author>
+      <contrib>Developer</contrib>
+      <firstname>Alexander</firstname>
+      <surname>Larsson</surname>
+      <email>alexl@redhat.com</email>
+    </author>
+  </authorgroup>
+</refentryinfo>
+
+<refmeta>
+  <refentrytitle>user-dirs.conf</refentrytitle>
+  <manvolnum>5</manvolnum>
+  <refmiscinfo class="manual">File Formats</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+  <refname>user-dirs.conf</refname>
+  <refpurpose>configuration for xdg-user-dirs-update</refpurpose>
+</refnamediv>
+
+<refsect1><title>Description</title>
+<para>The <filename>/etc/xdg/user-dirs.conf</filename> file is a
+text file that controls the behavior of the xdg-user-dirs-update
+command. Users can have their own
+<filename>~/.config/user-dirs.conf</filename> file, which overrides
+the system-wide configuration.</para>
+
+<para>The following keys are recognised:</para>
+<variablelist>
+<varlistentry>
+<term>enabled=<replaceable>boolean</replaceable></term>
+<listitem><para>When set to False, xdg-user-dirs-update will not
+change the XDG user dirs configuration.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>filename_encoding=<replaceable>encoding</replaceable></term>
+<listitem><para>This sets the filename encoding to use.
+<replaceable>encoding</replaceable> can be an explict encoding name,
+such as UTF-8, or "locale", which means the encoding of the users
+locale will be used.</para></listitem>
+</varlistentry>
+</variablelist>
+<para>Lines beginning with a # character are ignored.</para>
+</refsect1>
+
+<refsect1><title>Environment</title>
+<variablelist>
+<varlistentry>
+<term><envar>XDG_CONFIG_DIRS</envar></term>
+<listitem><para>The system-wide <filename>user-dirs.conf</filename> file
+is located in this directory. The default is <filename>/etc/xdg</filename>.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><envar>XDG_CONFIG_HOME</envar></term>
+<listitem><para>The per-user <filename>user-dirs.conf</filename> file
+is located in this directory. The default is <filename>$HOME/.config</filename>.</para></listitem>
+</varlistentry>
+</variablelist>
+</refsect1>
+
+<refsect1><title>See Also</title>
+  <para>
+    <citerefentry><refentrytitle>xdg-user-dirs-update</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+  </para>
+</refsect1>
+
+</refentry>
diff --git a/man/user-dirs.defaults.xml b/man/user-dirs.defaults.xml
new file mode 100644
index 0000000..025ece3
--- /dev/null
+++ b/man/user-dirs.defaults.xml
@@ -0,0 +1,72 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+]>
+<refentry id="user-dirs.defaults">
+
+<refentryinfo>
+  <title>user-dirs.defaults</title>
+  <productname>XDG</productname>
+  <authorgroup>
+    <author>
+      <contrib>Developer</contrib>
+      <firstname>Alexander</firstname>
+      <surname>Larsson</surname>
+      <email>alexl@redhat.com</email>
+    </author>
+  </authorgroup>
+</refentryinfo>
+
+<refmeta>
+  <refentrytitle>user-dirs.defaults</refentrytitle>
+  <manvolnum>5</manvolnum>
+  <refmiscinfo class="manual">File Formats</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+  <refname>user-dirs.defaults</refname>
+  <refpurpose>default settings for XDG user dirs</refpurpose>
+</refnamediv>
+
+<refsect1><title>Description</title>
+<para>The <filename>/etc/xdg/user-dirs.defaults</filename> file is a
+text file that contains the default values for the XDG user dirs which
+are used by the xdg-user-dirs-update command.</para>
+<para>This file contains lines of the form
+<screen>
+<replaceable>NAME</replaceable>=<replaceable>VALUE</replaceable>
+</screen>
+</para>
+<para>The following names are recognised:
+<simplelist>
+    <member>DESKTOP</member>
+    <member>DOWNLOAD</member>
+    <member>TEMPLATES</member>
+    <member>PUBLICSHARE</member>
+    <member>DOCUMENTS</member>
+    <member>MUSIC</member>
+    <member>PICTURES</member>
+    <member>VIDEOS</member>
+</simplelist></para>
+<para>The values are relative pathnames from the home directory and
+will be translated on a per-path-element basis into the users locale.</para>
+<para>Lines beginning with a # character are ignored.</para>
+</refsect1>
+
+<refsect1><title>Environment</title>
+<variablelist>
+<varlistentry>
+<term><envar>XDG_CONFIG_DIRS</envar></term>
+<listitem><para>The <filename>user-dirs.defaults</filename> file
+is located in this directory. The default is <filename>/etc/xdg</filename>.</para></listitem>
+</varlistentry>
+</variablelist>
+</refsect1>
+
+<refsect1><title>See Also</title>
+  <para>
+    <citerefentry><refentrytitle>xdg-user-dirs-update</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+  </para>
+</refsect1>
+
+</refentry>
diff --git a/man/user-dirs.dirs.xml b/man/user-dirs.dirs.xml
new file mode 100644
index 0000000..ec1c4c9
--- /dev/null
+++ b/man/user-dirs.dirs.xml
@@ -0,0 +1,74 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+]>
+<refentry id="user-dirs.dirs">
+
+<refentryinfo>
+  <title>user-dirs.dirs</title>
+  <productname>XDG</productname>
+  <authorgroup>
+    <author>
+      <contrib>Developer</contrib>
+      <firstname>Alexander</firstname>
+      <surname>Larsson</surname>
+      <email>alexl@redhat.com</email>
+    </author>
+  </authorgroup>
+</refentryinfo>
+
+<refmeta>
+  <refentrytitle>user-dirs.dirs</refentrytitle>
+  <manvolnum>5</manvolnum>
+  <refmiscinfo class="manual">File Formats</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+  <refname>user-dirs.dirs</refname>
+  <refpurpose>settings for XDG user dirs</refpurpose>
+</refnamediv>
+
+<refsect1><title>Description</title>
+<para>The <filename>$HOME/.config/user-dirs.dirs</filename> file is a
+text file that contains the user-specific values for the XDG user dirs.
+It is created and updated by the xdg-user-dirs-update command.</para>
+<para>This file contains lines of the form
+<screen>
+XDG_<replaceable>NAME</replaceable>_DIR=<replaceable>VALUE</replaceable>
+</screen>
+</para>
+<para>The following names are recognised:
+<simplelist>
+    <member>DESKTOP</member>
+    <member>DOWNLOAD</member>
+    <member>TEMPLATES</member>
+    <member>PUBLICSHARE</member>
+    <member>DOCUMENTS</member>
+    <member>MUSIC</member>
+    <member>PICTURES</member>
+    <member>VIDEOS</member>
+</simplelist></para>
+<para><replaceable>VALUE</replaceable> must be of the form
+"$HOME/Path" or "/Path".</para>
+<para>Lines beginning with a # character are ignored.</para>
+<para>The format of <filename>user-dirs.dirs</filename> is
+designed to allow direct sourcing of this file in shell scripts.</para>
+</refsect1>
+
+<refsect1><title>Environment</title>
+<variablelist>
+<varlistentry>
+<term><envar>XDG_CONFIG_DIRS</envar></term>
+<listitem><para>The <filename>user-dirs.defaults</filename> file
+is located in this directory. The default is <filename>/etc/xdg</filename>.</para></listitem>
+</varlistentry>
+</variablelist>
+</refsect1>
+
+<refsect1><title>See Also</title>
+  <para>
+    <citerefentry><refentrytitle>xdg-user-dirs-update</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+  </para>
+</refsect1>
+
+</refentry>
diff --git a/man/xdg-user-dir.xml b/man/xdg-user-dir.xml
new file mode 100644
index 0000000..141eeb8
--- /dev/null
+++ b/man/xdg-user-dir.xml
@@ -0,0 +1,70 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+]>
+<refentry id="xdg-user-dir">
+
+<refentryinfo>
+  <title>xdg-user-dir</title>
+  <productname>XDG</productname>
+  <authorgroup>
+    <author>
+      <contrib>Developer</contrib>
+      <firstname>Alexander</firstname>
+      <surname>Larsson</surname>
+      <email>alexl@redhat.com</email>
+    </author>
+  </authorgroup>
+</refentryinfo>
+
+<refmeta>
+  <refentrytitle>xdg-user-dir</refentrytitle>
+  <manvolnum>1</manvolnum>
+  <refmiscinfo class="manual">User Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+  <refname>xdg-user-dir</refname>
+  <refpurpose>Find an XDG user dir</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>xdg-user-dir</command> <arg>NAME</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para><command>xdg-user-dir</command> looks up the current path for one
+of the special XDG user dirs.</para>
+<para>This command expects the name of an XDG user dir as argument.
+The possible names are:
+<simplelist>
+    <member>DESKTOP</member>
+    <member>DOWNLOAD</member>
+    <member>TEMPLATES</member>
+    <member>PUBLICSHARE</member>
+    <member>DOCUMENTS</member>
+    <member>MUSIC</member>
+    <member>PICTURES</member>
+    <member>VIDEOS</member>
+</simplelist></para>
+</refsect1>
+
+<refsect1><title>Files</title>
+  <para>The values are looked up in the <filename>user-dirs.dir</filename>
+  file. This file is created by the xdg-user-dirs-update utility.</para>
+</refsect1>
+
+<refsect1><title>Environment</title>
+  <para>The <envar>XDG_CONFIG_HOME</envar> environment variable determines
+  where the <filename>user-dirs.dirs</filename> file is located.</para>
+</refsect1>
+
+<refsect1><title>See Also</title>
+  <para>
+    <citerefentry><refentrytitle>xdg-user-dirs-update</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+  </para>
+</refsect1>
+
+</refentry>
diff --git a/man/xdg-user-dirs-update.xml b/man/xdg-user-dirs-update.xml
new file mode 100644
index 0000000..dfc4561
--- /dev/null
+++ b/man/xdg-user-dirs-update.xml
@@ -0,0 +1,123 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+]>
+<refentry id="xdg-user-dirs-update">
+
+<refentryinfo>
+  <title>xdg-user-dirs-update</title>
+  <productname>XDG</productname>
+  <authorgroup>
+    <author>
+      <contrib>Developer</contrib>
+      <firstname>Alexander</firstname>
+      <surname>Larsson</surname>
+      <email>alexl@redhat.com</email>
+    </author>
+  </authorgroup>
+</refentryinfo>
+
+<refmeta>
+  <refentrytitle>xdg-user-dirs-update</refentrytitle>
+  <manvolnum>1</manvolnum>
+  <refmiscinfo class="manual">User Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+  <refname>xdg-user-dirs-update</refname>
+  <refpurpose>Update XDG user dir configuration</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>xdg-user-dirs-update</command> <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt" rep="repeat">--set <replaceable>NAME</replaceable> <replaceable>PATH</replaceable></arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para><command>xdg-user-dirs-update</command> updates the current
+state of the users <filename>user-dirs.dir</filename>. If none existed
+before then one is created based on the system default values, or
+falling back to the old non-translated filenames if such directories
+exists. The list of old directories used are: <filename>~/Desktop</filename>,
+<filename>~/Templates</filename> and <filename>~/Public</filename>.
+</para>
+<para>
+If an old configuration exists it is updated with any new default
+directories. Additionally, any configured directories that point to
+non-existing locations are reset by pointing then to the users home
+directory. This typically happens when the users removed the
+directory, so they likely don't want to use it anymore.
+</para>
+<para>
+On the first run a <filename>user-dirs.locale</filename> file is
+created containing the locale that was used for the translation. This
+is used later by gui tools like
+<command>xdg-user-dirs-gtk-update</command> to detect if the locale
+was changed, letting you to migrate from the old names.</para>
+
+<para>xdg-user-dirs-update is normally run automatically at the start
+of a user session to update the XDG user dirs according to the users
+locale.</para>
+</refsect1>
+
+<refsect1><title>Options</title>
+<para>The following options are understood:</para>
+<variablelist>
+  <varlistentry>
+    <term><option>--help</option></term>
+    <listitem><para>Print help output and exit.</para></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><option>--force</option></term>
+    <listitem><para>Update existing <filename>user-dirs.dir</filename>, but force a full reset.
+    This means: Don't reset nonexisting directories to HOME, rather recreate the directory.
+    Never use backwards compatible non-translated names. Always recreate <filename>user-dirs.locale</filename>.
+    </para></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><option>--dummy-output <replaceable>PATH</replaceable></option></term>
+    <listitem><para>Write the configuration to <replaceable>PATH</replaceable>
+    instead of the default configuration file. Also, no directories are created.</para></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><option>--set <replaceable>NAME</replaceable> <replaceable>PATH</replaceable></option></term>
+    <listitem><para>Sets the XDG user dir with the given name.</para>
+    <para><replaceable>NAME</replaceable> should be one of the following:
+      <simplelist>
+        <member>DESKTOP</member>
+        <member>DOWNLOAD</member>
+        <member>TEMPLATES</member>
+        <member>PUBLICSHARE</member>
+        <member>DOCUMENTS</member>
+        <member>MUSIC</member>
+        <member>PICTURES</member>
+        <member>VIDEOS</member>
+      </simplelist></para>
+   <para><replaceable>PATH</replaceable> must be an absolute path,
+   e.g. <filename>$HOME/Some/Directory</filename>.</para></listitem>
+   </varlistentry>
+   </variablelist>
+</refsect1>
+
+<refsect1><title>Files</title>
+  <para>The XDG user dirs configuration is stored in the
+  <filename>user-dirs.dir</filename> file in the location pointed to
+  by the <envar>XDG_CONFIG_HOME</envar> environment variable.</para>
+</refsect1>
+
+<refsect1><title>Environment</title>
+  <para>The <envar>XDG_CONFIG_HOME</envar> environment variable determines
+  where the <filename>user-dirs.dirs</filename> file is located.</para>
+</refsect1>
+
+<refsect1><title>See Also</title>
+  <para>
+    <citerefentry><refentrytitle>xdg-user-dir</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>user-dirs.dirs</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>user-dirs.defaults</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>user-dirs.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+  </para>
+</refsect1>
+
+</refentry>