xdg-user-dir.1 revision 12780
<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY cmd "xdg-user-dir">
%commonents;
%booktitles;
<!ENTITY suncopy "Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="xdg-user-dir-1">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>xdg-user-dir</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">03 Apr 2008</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<indexterm><primary>xdg-user-dir</primary></indexterm><indexterm><primary>Get the path used for desktop user directory location.</primary></indexterm>
<refnamediv id="xdg-user-dir-1-name"><refname>xdg-user-dir</refname><refpurpose>Get the path used for desktop user directory location.</refpurpose></refnamediv>
<refsynopsisdiv id="xdg-user-dir-1-synp"><title>&synp-tt;</title>
<cmdsynopsis><command>&cmd;</command>
<arg choice="plain">DIR</arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1 id="xdg-user-dir-1-desc"><title>&desc-tt;</title>
<para><command>&cmd;</command> is a utility that extracts the location of the specified desktop user directory from the file :
</para>
<para>
</para>
</refsect1>
<refsect1 id="xdg-user-dir-1-opts"><title>&opts-tt;</title>
<para>Valid desktop directories (DIR) are:
DESKTOP
DOWNLOAD
TEMPLATES
PUBLICSHARE
DOCUMENTS
MUSIC
PICTURES
VIDEOS
If an invalid directory is requested ${HOME} is returned.
</para>
</refsect1>
<refsect1 id="xdg-user-dir-1-exam"><title>&exam-tt;</title>
<example role="example">
<title>Location of user's documents directory</title>
<para>
<userinput>% &cmd; DOCUMENTS</userinput>
</para>
</example>
</refsect1>
<refsect1 id="xdg-user-dir-1-attr"><title>&attr-tt;</title>
<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
for descriptions of the following attributes:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
<colspec colname="COLSPEC1" colwidth="1*">
<thead>
<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
valign="middle">ATTRIBUTE VALUE</entry></row>
</thead>
<tbody>
<row><entry><para>Availability</para></entry><entry><para>SUNWxdg-user-dirs</para></entry>
</row>
<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
colname="COLSPEC1"><para>Uncommitted</para></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="xdg-user-dir-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
More information can be found at:
</para>
<para>
</para>
<para>
<citerefentry><refentrytitle>xdg-user-dirs-update</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>xdg-user-dirs-gtk-update</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1 id="xdg-user-dir-1-note"><title>¬e-tt;</title>
<para>Written by Darren Kenny, Sun Microsystems Inc, 2008</para>
</refsect1>
</refentry>