12780N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
12780N/A<!--ArborText, Inc., 1988-1999, v.4002-->
15916N/A<!--ARC : LSARC 2008/116 XDG User Dirs-->
12780N/A<!ENTITY cmd "xdg-user-dir">
12780N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
12780N/A%commonents;
12780N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
12780N/A%booktitles;
12780N/A<!ENTITY suncopy "Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.">
12780N/A]>
12780N/A<?Pub UDT _bookmark _target>
12780N/A<?Pub Inc>
12780N/A<refentry id="xdg-user-dir-1">
12780N/A<!-- %Z%%M% %I% %E% SMI; -->
12780N/A<refmeta><refentrytitle>xdg-user-dir</refentrytitle><manvolnum>1</manvolnum>
12780N/A<refmiscinfo class="date">03 Apr 2008</refmiscinfo>
12780N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
12780N/A<refmiscinfo class="software">&release;</refmiscinfo>
12780N/A<refmiscinfo class="arch">generic</refmiscinfo>
12780N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
12780N/A</refmeta>
12780N/A<indexterm><primary>xdg-user-dir</primary></indexterm><indexterm><primary>Get the path used for desktop user directory location.</primary></indexterm>
12780N/A<refnamediv id="xdg-user-dir-1-name"><refname>xdg-user-dir</refname><refpurpose>Get the path used for desktop user directory location.</refpurpose></refnamediv>
12780N/A
12780N/A<refsynopsisdiv id="xdg-user-dir-1-synp"><title>&synp-tt;</title>
12780N/A<cmdsynopsis><command>&cmd;</command>
12804N/A<arg choice="plain"><replaceable>DIR</replaceable></arg>
12780N/A</cmdsynopsis></refsynopsisdiv>
12780N/A
12780N/A<refsect1 id="xdg-user-dir-1-desc"><title>&desc-tt;</title>
12780N/A<para><command>&cmd;</command> is a utility that extracts the location of the specified desktop user directory from the file :
12780N/A</para>
12780N/A<para>
12780N/A <literal>${HOME}/.config/user-dirs.dirs</literal>
12780N/A</para>
12780N/A</refsect1>
12780N/A
12804N/A<refsect1 id="xdg-user-dir-1-oper"><title>&oper-tt;</title>
12804N/A<para>Valid desktop directories (<replaceable>DIR</replaceable>) are:
12780N/A
12780N/A DESKTOP
12780N/A DOWNLOAD
12780N/A TEMPLATES
12780N/A PUBLICSHARE
12780N/A DOCUMENTS
12780N/A MUSIC
12780N/A PICTURES
12780N/A VIDEOS
12780N/A
12780N/AIf an invalid directory is requested ${HOME} is returned.
12780N/A</para>
12780N/A</refsect1>
12780N/A
12804N/A<refsect1 id="xdg-user-dir-1-envr"><title>&envr-tt;</title>
12804N/A<para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>
12804N/A5</manvolnum></citerefentry> for descriptions of the following environment
12804N/Avariables:
12804N/A</para>
12804N/A<para>
12804N/A HOME.
12804N/A</para>
12804N/A
12804N/A<para>
12804N/AOther environment variable that are used are:
12804N/A</para>
12804N/A<variablelist termlength="short">
12804N/A<varlistentry>
12804N/A<term>XDG_CONFIG_HOME</term>
12804N/A<listitem><para>Base directory for storge of XDG configuration files. Defaults to <filename>${HOME}/.config</filename></para></listitem>
12804N/A</varlistentry>
12804N/A</variablelist>
12804N/A</refsect1>
12804N/A
12804N/A<refsect1 id="xdg-user-dir-1-file"><title>&file-tt;</title>
12804N/A<para>The following files are used by this application:</para>
12804N/A<variablelist termlength="short">
12804N/A
12804N/A<varlistentry>
12804N/A<term><filename>/usr/bin/&cmd;</filename></term>
12804N/A<listitem><para>XDG Directory expansion utility.</para></listitem>
12804N/A</varlistentry>
12804N/A
12804N/A<varlistentry>
12804N/A<term><filename>${XDG_CONFIG_HOME}/user-dirs.dirs</filename></term>
12804N/A<listitem><para>Location of the user-specific configuration including the current
12804N/Alist of directories and what they map to.</para></listitem>
12804N/A</varlistentry>
12804N/A
12804N/A</variablelist>
12804N/A</refsect1>
12804N/A
12780N/A<refsect1 id="xdg-user-dir-1-exam"><title>&exam-tt;</title>
12780N/A<example role="example">
12780N/A<title>Location of user's documents directory</title>
12780N/A<para>
12780N/A<userinput>% &cmd; DOCUMENTS</userinput>
12780N/A<screen>/home/user/Documents</screen>
12780N/A</para>
12780N/A</example>
12780N/A
12780N/A</refsect1>
12780N/A
12804N/A
12780N/A<refsect1 id="xdg-user-dir-1-attr"><title>&attr-tt;</title>
12780N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
12780N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
12780N/Afor descriptions of the following attributes:</para>
12780N/A<informaltable frame="all">
12780N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
12780N/A<colspec colname="COLSPEC1" colwidth="1*">
12780N/A<thead>
12780N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
12780N/Avalign="middle">ATTRIBUTE VALUE</entry></row>
12780N/A</thead>
12780N/A<tbody>
18745N/A<row><entry><para>Availability</para></entry><entry><para>library/xdg/xdg-user-dirs</para></entry>
12780N/A</row>
12780N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
12780N/Acolname="COLSPEC1"><para>Uncommitted</para></entry></row>
12780N/A</tbody>
12780N/A</tgroup>
12780N/A</informaltable>
12780N/A</refsect1>
12780N/A<refsect1 id="xdg-user-dir-1-also"><title>&also-tt;</title>
12780N/A<!--Reference to another man page-->
12780N/A<!--Reference to a Help manual-->
12780N/A<!--Reference to a book.-->
12780N/A<para>
12780N/AMore information can be found at:
12780N/A</para>
12780N/A<para>
12780N/A<literal>http://www.freedesktop.org/wiki/Software/xdg-user-dirs</literal>
12780N/A</para>
12780N/A<para>
12780N/A<citerefentry><refentrytitle>xdg-user-dirs-update</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
12780N/A<citerefentry><refentrytitle>xdg-user-dirs-gtk-update</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
12780N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
12780N/A</para>
12780N/A</refsect1>
12780N/A
12780N/A<refsect1 id="xdg-user-dir-1-note"><title>&note-tt;</title>
12780N/A<para>Written by Darren Kenny, Sun Microsystems Inc, 2008</para>
12780N/A</refsect1>
12780N/A</refentry>