diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 13:40:30 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 13:40:30 +0000 |
commit | ad8b856c3b0d4d6055141a74664dbea4416c198d (patch) | |
tree | 8596d1a11d20a850e3316e27e51e422baa0aa1e5 /man/user-dirs.dirs.xml | |
parent | Initial commit. (diff) | |
download | xdg-user-dirs-upstream.tar.xz xdg-user-dirs-upstream.zip |
Adding upstream version 0.17.upstream/0.17upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | man/user-dirs.dirs.xml | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/man/user-dirs.dirs.xml b/man/user-dirs.dirs.xml new file mode 100644 index 0000000..ec1c4c9 --- /dev/null +++ b/man/user-dirs.dirs.xml @@ -0,0 +1,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> |