Template Version: @(#)onepager.txt 1.35 07/11/07 SMI
Copyright 2007 Sun Microsystems


1. Introduction
   1.1. Project/Component Working Name:

        XDG User Dirs

   1.2. Name of Document Author/Supplier:

        Darren Kenny

   1.3. Date of This Document:

        02/11/08
        
   1.3.1. Date this project was conceived:

        01/01/08

   1.4. Name of Major Document Customer(s)/Consumer(s):

        1.4.1. The PAC or CPT you expect to review your project:

                Solaris PAC

        1.4.2. The ARC(s) you expect to review your project:

                LSARC

        1.4.3. The Director/VP who is "Sponsoring" this project:

                robert.odea@sun.com

        1.4.4. The name of your business unit:

                OPG / OpenSource.

   1.5. Email Aliases:
        1.5.1. Responsible Manager:

                leo.binchy@sun.com

        1.5.2. Responsible Engineer:

                darren.kenny@sun.com

        1.5.3. Marketing Manager:

                dan.roberts@sun.com

        1.5.4. Interest List:

                desktop-discuss@opensolaris.org

4. Technical Description:
    4.1. Details:

        XDG User Dirs is a tool to help manage "well known" user directories
        like the desktop folder and the music folder. It also handles
        localization (i.e. translation) of the filenames.

        Typically these directories are accessed in applications using the
        Committed glib 2.14 function:
        
            g_get_user_special_dir()

        The command xdg-user-dirs-update is run very early in the
        login phase. This program reads a configuration file, and a set of
        default directories. It then creates localized versions of these
        directories in the users home directory and sets up a config file in
        $(XDG_CONFIG_HOME)/user-dirs.dirs (XDG_CONFIG_HOME defaults to
        ~/.config) that applications can read to find these directories.

        Sysadmins can configure things by editing /etc/xdg/user-dirs.conf. 
        At the moment there are only two settings, you can disable the whole
        thing, and you can specify the charset encoding used for filenames.
        They can also set or change the default directories and their initial
        values in /etc/xdg/user-dirs.defaults.

        $(XDG_CONFIG_HOME)/user-dirs.dirs specifies the current set of
        directories for the user. This file is in a shell format, so its easy
        to access from a shell script. This file can also be modified by users
        (manually or via applications) to change the directories used. 
        
        The xdg-user-dir CLI can be used to get the path of a typcial
        directory in the case where a user doesn't have the appropriate XDG
        environment variable set.


    4.2. Bug/RFE Number(s):

        None.

    4.3. In Scope:

        See above.

    4.4. Out of Scope:

        See above.

    4.5. Interfaces:

        --------------------------------------------------------------------
        Exported                    Stability       Comments                
        --------------------------------------------------------------------
        SUNWxdg-user-dirs           Uncommitted     Package name            
        /usr/bin/xdg-user-dir       Uncommitted                
        /usr/bin/xdg-user-dirs-update
                                    Uncommitted                
        /etc/xdg/user-dirs.conf     Uncommitted     Behaviour Configuration
        /etc/xdg/user-dirs.defaults Uncommitted     System Default Dir Names
        ${HOME}/.config/user-dirs.dirs
                                    Uncommitted     User's Dir Names at first
                                                    creation. 
        ${HOME}/.config/user-dirs.locale
                                    Uncommitted     Locale used during first
                                                    creation.
        XDG_DESKTOP_DIR             Uncommitted     Environment Variable
        XDG_DOWNLOAD_DIR            Uncommitted     Environment Variable
        XDG_TEMPLATES_DIR           Uncommitted     Environment Variable
        XDG_PUBLICSHARE_DIR         Uncommitted     Environment Variable
        XDG_DOCUMENTS_DIR           Uncommitted     Environment Variable
        XDG_MUSIC_DIR               Uncommitted     Environment Variable
        XDG_PICTURES_DIR            Uncommitted     Environment Variable
        XDG_VIDEOS_DIR              Uncommitted     Environment Variable
                                                                            
                                                                            
        --------------------------------------------------------------------
        Imported                    Stability       Comments                
        --------------------------------------------------------------------
        /usr/bin/bash               External        PSARC 1999/555


    4.6. Doc Impact:

        Community provided man pages for each tool will be installed. 

    4.7. Admin/Config Impact:

        None.

    4.8. HA Impact:

        None.

    4.9. I18N/L10N Impact:

        The JDS team and the G11N are working together to evaluation and
        provide I18N/L10N support.

    4.10. Packaging & Delivery:
    
        Adds new package, SUNWxdg-user-dirs, approx 58 KB and
        SUNWxdg-user-dirs-root, approx 13 KB.

        Package will go into SUNWCall, SUNWCXall and SUNWCuser clusters.

    4.11. Security Impact:

        None.

    4.12. Dependencies:

        The following versions of the imported interfaces are required:

        GNOME 2.20 Upwards

5. Reference Documents:

        XDG User Dirs Project 
        - http://www.freedesktop.org/wiki/Software/xdg-user-dirs