xdg

README

xdg

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

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.

Documentation

Overview

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

Index

• Variables
• func Open(uri string) error

Variables

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.