README

xdg

Package xdg provides access to the FreeDesktop.org (XDG) specs.

GoDoc Build Status Go Report Card

Documentation

Documentation is available via godoc. Here are direct links to the documentation pages for each package:

  • xdg - Provides xdg.Open function to call xdg-open command.
  • xdg/basedir - Provides access to the xdg basedir spec.
  • xdg/desktop - Read desktop files (w/ localization support).
  • xdg/keyfile - Provides access to xdg key file format (w/ localization support).
  • xdg/trash - Provides access to xdg trash spec.
  • xdg/userdirs - Provides access to common user directories.

Testing

Tests can be run with go test.

The tests for the xdg/trash package expect the trash to exist ($XDG_DATA_HOME/Trash/files (or $HOME/.local/share/Trash/files if $XDG_DATA_HOME is undefined)).

The tests for the xdg/userdirs package require the xdg-user-dir command.

TODO

  • autostart
  • desktop.Launch (in progress on desktop-launch branch)
  • trash.New (requires checking for a "sticky bit" on the filesystem of the drive on which the trash exists; in addition to other (easier) checks)

License

See LICENSE.

Expand ▾ Collapse ▴

Documentation

Overview

    Package xdg provides access to the XDG specs. Most of the functionality can be found in the subpackages.

    Index

    Constants

    This section is empty.

    Variables

    View Source
    var (
    	ErrSyntax       = errors.New("error in command line syntax")
    	ErrFileNotFound = errors.New("one of the files passed on the command line did not exist")
    	ErrToolNotFound = errors.New("a required tool could not be found")
    	ErrFailed       = errors.New("the action failed")
    )

      These errors can be returned by Open.

      Functions

      func Open

      func Open(uri string) error

        Open runs the command xdg-open with the given uri as an argument.

        Types

        This section is empty.

        Source Files

        Directories

        Path Synopsis
        Package basedir provides access to XDG base directory spec.
        Package basedir provides access to XDG base directory spec.
        cmd
        xdg-trash
        xdg-trash is a command line interface to the trash package for the purposes of debugging.
        xdg-trash is a command line interface to the trash package for the purposes of debugging.
        Package desktop implements the Desktop Entry Spec.
        Package desktop implements the Desktop Entry Spec.
        Package keyfile implements the ini file format that is used in many of the xdg specs.
        Package keyfile implements the ini file format that is used in many of the xdg specs.
        Package trash provides easy access to the trash bin.
        Package trash provides easy access to the trash bin.
        Package userdirs provides easy access to "well known" user directories.
        Package userdirs provides easy access to "well known" user directories.