man-pages/man1/xdg-user-dirs-update.1.html
2021-03-31 01:06:50 +01:00

192 lines
4.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of XDG-USER-DIRS-UPD</TITLE>
</HEAD><BODY>
<H1>XDG-USER-DIRS-UPD</H1>
Section: User Commands (1)<BR>Updated: <BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
xdg-user-dirs-update - Update XDG user dir configuration
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<DL COMPACT>
<DT id="1">
<B>xdg-user-dirs-update</B> [OPTION...] [--set&nbsp;<I>NAME</I>&nbsp;<I>PATH</I>...]
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<B>xdg-user-dirs-update</B>
<DD>updates the current state of the users
user-dirs.dir. If none existed before then one is created based on the system default values, or falling back to the old non-translated filenames if such directories exists. The list of old directories used are:
~/Desktop,
~/Templates
and
~/Public.
<P>
If an old configuration exists it is updated with any new default directories. Additionally, any configured directories that point to non-existing locations are reset by pointing then to the users home directory. This typically happens when the users removed the directory, so they likely don't want to use it anymore.
<P>
On the first run a
user-dirs.locale
file is created containing the locale that was used for the translation. This is used later by GUI tools like
<B>xdg-user-dirs-gtk-update</B>
to detect if the locale was changed, letting you to migrate from the old names.
<P>
<B>xdg-user-dirs-update</B>
is normally run automatically at the start of a user session to update the XDG user dirs according to the users locale.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
The following options are understood:
<P>
<B>--help</B>
<DL COMPACT><DT id="2"><DD>
Print help output and exit.
</DL>
<P>
<B>--force</B>
<DL COMPACT><DT id="3"><DD>
Update existing
user-dirs.dir, but force a full reset. This means: Don't reset nonexisting directories to HOME, rather recreate the directory. Never use backwards compatible non-translated names. Always recreate
user-dirs.locale.
</DL>
<P>
<B>--dummy-output </B><B></B><I>PATH</I>
<DL COMPACT><DT id="4"><DD>
Write the configuration to
<I>PATH</I>
instead of the default configuration file. Also, no directories are created.
</DL>
<P>
<B>--set </B><B></B><I>NAME</I><B> </B><B></B><I>PATH</I>
<DL COMPACT><DT id="5"><DD>
Sets the XDG user dir with the given name.
<P>
<I>NAME</I>
should be one of the following:
<DL COMPACT><DT id="6"><DD>
DESKTOP
</DL>
<DL COMPACT><DT id="7"><DD>
DOWNLOAD
</DL>
<DL COMPACT><DT id="8"><DD>
TEMPLATES
</DL>
<DL COMPACT><DT id="9"><DD>
PUBLICSHARE
</DL>
<DL COMPACT><DT id="10"><DD>
DOCUMENTS
</DL>
<DL COMPACT><DT id="11"><DD>
MUSIC
</DL>
<DL COMPACT><DT id="12"><DD>
PICTURES
</DL>
<DL COMPACT><DT id="13"><DD>
VIDEOS
</DL>
<P>
<I>PATH</I>
must be an absolute path, e.g.
$HOME/Some/Directory.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>FILES</H2>
<P>
The XDG user dirs configuration is stored in the
user-dirs.dir
file in the location pointed to by the
<B>XDG_CONFIG_HOME</B>
environment variable.
<A NAME="lbAG">&nbsp;</A>
<H2>ENVIRONMENT</H2>
<P>
The
<B>XDG_CONFIG_HOME</B>
environment variable determines where the
user-dirs.dirs
file is located.
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+xdg-user-dir">xdg-user-dir</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?5+user-dirs.dirs">user-dirs.dirs</A></B>(5),
<B><A HREF="/cgi-bin/man/man2html?5+user-dirs.defaults">user-dirs.defaults</A></B>(5),
<B><A HREF="/cgi-bin/man/man2html?5+user-dirs.conf">user-dirs.conf</A></B>(5).
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="14"><A HREF="#lbAB">NAME</A><DD>
<DT id="15"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="16"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="17"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="18"><A HREF="#lbAF">FILES</A><DD>
<DT id="19"><A HREF="#lbAG">ENVIRONMENT</A><DD>
<DT id="20"><A HREF="#lbAH">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:30 GMT, March 31, 2021
</BODY>
</HTML>