source: general/genutils/xdg-user-dirs.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY xdg-user-dirs-download-http "https://user-dirs.freedesktop.org/releases/xdg-user-dirs-&xdg-user-dirs-version;.tar.gz">
  <!ENTITY xdg-user-dirs-download-ftp  " ">
  <!ENTITY xdg-user-dirs-md5sum        "dc7decea7ffb58cd067eff1fe1798cae">
  <!ENTITY xdg-user-dirs-size          "267 KB">
  <!ENTITY xdg-user-dirs-buildsize     "3.0 MB">
  <!ENTITY xdg-user-dirs-time          "less than 0.1 SBU">
]>

<sect1 id="xdg-user-dirs" xreflabel="Xdg-user-dirs-&xdg-user-dirs-version;">
  <?dbhtml filename="xdg-user-dirs.html"?>


  <!-- No other tags inside any title.
       Use Title Case in All Titles -->
  <title>Xdg-user-dirs-&xdg-user-dirs-version;</title>

  <indexterm zone="xdg-user-dirs">
    <primary sortas="a-xdg-user-dirs">xdg-user-dirs</primary>
  </indexterm>

  <!--Required section-->
  <sect2 role="package">
    <title>Introduction to Xdg-user-dirs</title>

    <para>
      <application>Xdg-user-dirs</application> is a tool to help manage <quote>well
      known</quote> user directories like the desktop folder and the music folder.
      It also handles localization (i.e. translation) of the filenames.
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&xdg-user-dirs-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&xdg-user-dirs-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &xdg-user-dirs-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &xdg-user-dirs-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &xdg-user-dirs-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &xdg-user-dirs-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Xdg-user-dirs Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="DocBook"/>,
      <xref linkend="docbook-xsl"/>, and
      <xref linkend="libxslt"/> (all three for building the man pages)
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Xdg-user-dirs</title>

    <para>
      Install <application>xdg-user-dirs</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr           \
            --sysconfdir=/etc       \
            --disable-documentation &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>
  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>--disable-documentation</parameter>: Disable the
      installation of the man pages.  Remove this switch if you've installed
      the optional dependencies and you wish to install the man pages of
      this package.
    </para>
  </sect2>

  <sect2 role="configuration">
    <title>Configuring Xdg-user-dirs</title>

    <sect3 id="xdg-user-dirs-config">
      <title>Config Files</title>
      <para>
        <filename>~/.config/user-dirs.dirs</filename>,
        <filename>/etc/xdg/user-dirs.conf</filename>, and
        <filename>/etc/xdg/user-dirs.defaults</filename>. Those default
        locations can be overridden by <envar>XDG_CONFIG_HOME</envar> and
        <envar>XDG_CONFIG_DIRS</envar>
      </para>

      <indexterm zone="xdg-user-dirs xdg-user-dirs-config">
        <primary sortas="e-AA.config-user-dirs.dirs">~/.config/user-dirs.dirs</primary>
      </indexterm>

      <indexterm zone="xdg-user-dirs xdg-user-dirs-config">
        <primary
        sortas="e-etc-xdg-user-dirs.conf">/etc/xdg/user-dirs.conf</primary>
      </indexterm>

      <indexterm zone="xdg-user-dirs xdg-user-dirs-config">
        <primary
        sortas="e-etc-xdg-user-dirs.defaults">/etc/xdg/user-dirs.defaults</primary>
      </indexterm>
    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          xdg-user-dir and xdg-user-dirs-update
        </seg>
        <seg>
          None
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="xdg-user-dir">
        <term><command>xdg-user-dir</command></term>
        <listitem>
          <para>
            looks up the current path for one of the XDG user directories
          </para>
          <indexterm zone="xdg-user-dirs xdg-user-dir">
            <primary sortas="b-xdg-user-dir">xdg-user-dir</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xdg-user-dirs-update">
        <term><command>xdg-user-dirs-update</command></term>
        <listitem>
          <para>
            creates localized versions of the user directories
          </para>
          <indexterm zone="xdg-user-dirs xdg-user-dirs-update">
            <primary sortas="b-xdg-user-dirs-update">xdg-user-dirs-update</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>
  </sect2>

</sect1>