blob: 6664d94befc81e3ccb57726cce292614b3854b63 (
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
75
76
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 explicit 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>
|
