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.conf.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.conf.xml | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/man/user-dirs.conf.xml b/man/user-dirs.conf.xml new file mode 100644 index 0000000..6664d94 --- /dev/null +++ b/man/user-dirs.conf.xml @@ -0,0 +1,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> |