[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[6e32f417] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY xdg-user-dirs-download-http "https://user-dirs.freedesktop.org/releases/xdg-user-dirs-&xdg-user-dirs-version;.tar.gz">
|
---|
[6e32f417] | 8 | <!ENTITY xdg-user-dirs-download-ftp " ">
|
---|
[1bf1c7c] | 9 | <!ENTITY xdg-user-dirs-md5sum "dc7decea7ffb58cd067eff1fe1798cae">
|
---|
| 10 | <!ENTITY xdg-user-dirs-size "267 KB">
|
---|
[c18fd2e6] | 11 | <!ENTITY xdg-user-dirs-buildsize "3.0 MB">
|
---|
[1ae4746] | 12 | <!ENTITY xdg-user-dirs-time "less than 0.1 SBU">
|
---|
[6e32f417] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="xdg-user-dirs" xreflabel="Xdg-user-dirs-&xdg-user-dirs-version;">
|
---|
| 16 | <?dbhtml filename="xdg-user-dirs.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <!-- No other tags inside any title.
|
---|
| 20 | Use Title Case in All Titles -->
|
---|
| 21 | <title>Xdg-user-dirs-&xdg-user-dirs-version;</title>
|
---|
| 22 |
|
---|
| 23 | <indexterm zone="xdg-user-dirs">
|
---|
| 24 | <primary sortas="a-xdg-user-dirs">xdg-user-dirs</primary>
|
---|
| 25 | </indexterm>
|
---|
| 26 |
|
---|
| 27 | <!--Required section-->
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to Xdg-user-dirs</title>
|
---|
| 30 |
|
---|
| 31 | <para>
|
---|
| 32 | <application>Xdg-user-dirs</application> is a tool to help manage <quote>well
|
---|
| 33 | known</quote> user directories like the desktop folder and the music folder.
|
---|
| 34 | It also handles localization (i.e. translation) of the filenames.
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
[56b0b0b] | 37 | &lfs122_checked;
|
---|
[6e32f417] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&xdg-user-dirs-download-http;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&xdg-user-dirs-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download MD5 sum: &xdg-user-dirs-md5sum;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download size: &xdg-user-dirs-size;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated disk space required: &xdg-user-dirs-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &xdg-user-dirs-time;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
[1f2235c] | 73 | <bridgehead renderas="sect3">Xdg-user-dirs Dependencies</bridgehead>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 76 | <para role="optional">
|
---|
| 77 | <xref linkend="DocBook"/>,
|
---|
| 78 | <xref linkend="docbook-xsl"/>, and
|
---|
| 79 | <xref linkend="libxslt"/> (all three for building the man pages)
|
---|
| 80 | </para>
|
---|
[6e32f417] | 81 | </sect2>
|
---|
| 82 |
|
---|
| 83 | <sect2 role="installation">
|
---|
| 84 | <title>Installation of Xdg-user-dirs</title>
|
---|
| 85 |
|
---|
| 86 | <para>
|
---|
| 87 | Install <application>xdg-user-dirs</application> by running the following
|
---|
| 88 | commands:
|
---|
| 89 | </para>
|
---|
| 90 |
|
---|
[1f2235c] | 91 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 92 | --sysconfdir=/etc \
|
---|
| 93 | --disable-documentation &&
|
---|
[6e32f417] | 94 | make</userinput></screen>
|
---|
| 95 |
|
---|
| 96 | <para>
|
---|
| 97 | This package does not come with a test suite.
|
---|
| 98 | </para>
|
---|
| 99 |
|
---|
| 100 | <para>
|
---|
| 101 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 102 | </para>
|
---|
| 103 |
|
---|
| 104 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 105 | </sect2>
|
---|
| 106 |
|
---|
[1f2235c] | 107 | <sect2 role="commands">
|
---|
| 108 | <title>Command Explanations</title>
|
---|
| 109 |
|
---|
| 110 | <para>
|
---|
| 111 | <parameter>--disable-documentation</parameter>: Disable the
|
---|
| 112 | installation of the man pages. Remove this switch if you've installed
|
---|
| 113 | the optional dependencies and you wish to install the man pages of
|
---|
| 114 | this package.
|
---|
| 115 | </para>
|
---|
| 116 | </sect2>
|
---|
| 117 |
|
---|
[c18fd2e6] | 118 | <sect2 role="configuration">
|
---|
| 119 | <title>Configuring Xdg-user-dirs</title>
|
---|
| 120 |
|
---|
| 121 | <sect3 id="xdg-user-dirs-config">
|
---|
| 122 | <title>Config Files</title>
|
---|
| 123 | <para>
|
---|
| 124 | <filename>~/.config/user-dirs.dirs</filename>,
|
---|
| 125 | <filename>/etc/xdg/user-dirs.conf</filename>, and
|
---|
| 126 | <filename>/etc/xdg/user-dirs.defaults</filename>. Those default
|
---|
[2c87187] | 127 | locations can be overridden by <envar>XDG_CONFIG_HOME</envar> and
|
---|
[c18fd2e6] | 128 | <envar>XDG_CONFIG_DIRS</envar>
|
---|
| 129 | </para>
|
---|
| 130 |
|
---|
| 131 | <indexterm zone="xdg-user-dirs xdg-user-dirs-config">
|
---|
| 132 | <primary sortas="e-AA.config-user-dirs.dirs">~/.config/user-dirs.dirs</primary>
|
---|
| 133 | </indexterm>
|
---|
| 134 |
|
---|
| 135 | <indexterm zone="xdg-user-dirs xdg-user-dirs-config">
|
---|
| 136 | <primary
|
---|
| 137 | sortas="e-etc-xdg-user-dirs.conf">/etc/xdg/user-dirs.conf</primary>
|
---|
| 138 | </indexterm>
|
---|
| 139 |
|
---|
| 140 | <indexterm zone="xdg-user-dirs xdg-user-dirs-config">
|
---|
| 141 | <primary
|
---|
| 142 | sortas="e-etc-xdg-user-dirs.defaults">/etc/xdg/user-dirs.defaults</primary>
|
---|
| 143 | </indexterm>
|
---|
| 144 | </sect3>
|
---|
| 145 |
|
---|
| 146 | </sect2>
|
---|
| 147 |
|
---|
[6e32f417] | 148 | <sect2 role="content">
|
---|
| 149 | <title>Contents</title>
|
---|
| 150 |
|
---|
| 151 | <segmentedlist>
|
---|
[c18fd2e6] | 152 | <segtitle>Installed Programs</segtitle>
|
---|
| 153 | <segtitle>Installed Library</segtitle>
|
---|
| 154 | <segtitle>Installed Directory</segtitle>
|
---|
[6e32f417] | 155 |
|
---|
| 156 | <seglistitem>
|
---|
| 157 | <seg>
|
---|
[c18fd2e6] | 158 | xdg-user-dir and xdg-user-dirs-update
|
---|
[6e32f417] | 159 | </seg>
|
---|
| 160 | <seg>
|
---|
[c18fd2e6] | 161 | None
|
---|
[6e32f417] | 162 | </seg>
|
---|
| 163 | <seg>
|
---|
[c18fd2e6] | 164 | None
|
---|
[6e32f417] | 165 | </seg>
|
---|
| 166 | </seglistitem>
|
---|
| 167 | </segmentedlist>
|
---|
| 168 |
|
---|
| 169 | <variablelist>
|
---|
| 170 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 171 | <?dbfo list-presentation="list"?>
|
---|
| 172 | <?dbhtml list-presentation="table"?>
|
---|
| 173 |
|
---|
| 174 | <varlistentry id="xdg-user-dir">
|
---|
| 175 | <term><command>xdg-user-dir</command></term>
|
---|
| 176 | <listitem>
|
---|
| 177 | <para>
|
---|
[4c24eb0a] | 178 | looks up the current path for one of the XDG user directories
|
---|
[6e32f417] | 179 | </para>
|
---|
| 180 | <indexterm zone="xdg-user-dirs xdg-user-dir">
|
---|
| 181 | <primary sortas="b-xdg-user-dir">xdg-user-dir</primary>
|
---|
| 182 | </indexterm>
|
---|
| 183 | </listitem>
|
---|
| 184 | </varlistentry>
|
---|
| 185 |
|
---|
| 186 | <varlistentry id="xdg-user-dirs-update">
|
---|
| 187 | <term><command>xdg-user-dirs-update</command></term>
|
---|
| 188 | <listitem>
|
---|
| 189 | <para>
|
---|
[4c24eb0a] | 190 | creates localized versions of the user directories
|
---|
[6e32f417] | 191 | </para>
|
---|
| 192 | <indexterm zone="xdg-user-dirs xdg-user-dirs-update">
|
---|
| 193 | <primary sortas="b-xdg-user-dirs-update">xdg-user-dirs-update</primary>
|
---|
| 194 | </indexterm>
|
---|
| 195 | </listitem>
|
---|
| 196 | </varlistentry>
|
---|
| 197 |
|
---|
| 198 | </variablelist>
|
---|
| 199 | </sect2>
|
---|
[4c24eb0a] | 200 |
|
---|
[6e32f417] | 201 | </sect1>
|
---|