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


1. Introduction
   1.1. Project/Component Working Name:

        XDG Utils

   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-utils is an open source set of command line tools that assist
        applications with a variety of desktop integration tasks. 

        Portland is a joint OSDL/Freedesktop.org initiative to provide
        independent software developers (ISDs) with stable APIs into Desktop
        Linux and other Free Desktop platforms. 
        
        One result of the Portland initiative is Xdg-utils, a free set
        of open source tools that allows applications to easily integrate with
        the desktop configuration your customer has chosen to work with.
        
        About half of the tools focus on tasks commonly required during the
        installation of a desktop application and the other half focuses on
        integration with the desktop environment while the application is
        running. 
        
        Even if the desktop components of your application are limited to an
        installer, configuration or management tool, Xdg-utils provides you
        with an easy way to enhance the usage experience of your customers by
        improving the integration of these components in the user's
        environment. 

        Xdg-utils consists of the following installation related tools:

            - xdg-desktop-menu:     Install desktop menu items
            - xdg-desktop-icon:     Install icons to the desktop
            - xdg-icon-resource:    Install icon resources
            - xdg-mime:             Query information about file type handling
                                    and add descriptions for new file types 

        It also contains the following runtime integration tools:

            - xdg-open:             Open a file or URL in the user's preferred
                                    application
            - xdg-email:            Send mail using the user's preferred
                                    e-mail composer
            - xdg-screensaver:      Control the screensaver
        

        While xscreensaver's CLI interface is largely Volatile, the plan would
        be to maintain xdg-screensaver such that it will remain working. A
        contract will be sought to ensure notification of i/f changes.

    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-utils               Uncommitted     Package name            
        /usr/bin/xdg-desktop-icon   Uncommitted                
        /usr/bin/xdg-desktop-menu   Uncommitted                
        /usr/bin/xdg-email          Uncommitted        
        /usr/bin/xdg-icon-resource  Uncommitted                
        /usr/bin/xdg-mime           Uncommitted        
        /usr/bin/xdg-open           Uncommitted        
        /usr/bin/xdg-screensaver    Uncommitted

                                                                            
                                                                            
        --------------------------------------------------------------------
        Imported                    Stability       Comments                
        --------------------------------------------------------------------
        /usr/bin/bash               Contracted      PSARC 1999/555
                                    External        
        /usr/openwin/bin/xprop      Committed       LSARC 2008/048
        /usr/bin/gnome-open         Volatile        LSARC 2007/520 (GNOME2.20)
        Base Directory Specification
                                    Committed       LSARC 2005/734 (GNOME For Nevada)
        Desktop Specification       Committed       LSARC 2005/734 (GNOME For Nevada)
        Menu Specification          Committed       LSARC 2005/734 (GNOME For Nevada)
        Shared MIME Database        Committed       LSARC 2007/146 (GNOME2.18)
        xscreensaver -lock          Uncommitted     LSARC 2006/446 (XScreenSaver 5)
        Rest of xscreensaver CLI    Volatile        LSARC 2006/446 (XScreenSaver 5)

    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-utils, approx 208 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 Utils Project   -   http://portland.freedesktop.org/wiki/XdgUtils