summaryrefslogtreecommitdiffstats
path: root/man/user-dirs.dirs.xml
blob: ec1c4c97ef96b2c73c7342c767124664f2aacb58 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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>