summaryrefslogtreecommitdiffstats
path: root/man/xdg-user-dir.xml
blob: 52ce179dea27671d3e69105f3a5179f538a8cdc7 (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
<?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.dirs</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>