Documentation
¶
Overview ¶
Package xdg provides an implementation of the XDG Base Directory Specification. The specification defines a set of standard paths for storing application files including data and configuration files. For portability and flexibility reasons, applications should use the XDG defined locations instead of hardcoding paths. The package also includes the locations of well known user directories.
The current implementation supports most flavors of Unix, Windows, Mac OS and Plan 9.
For more information regarding the XDG Base Directory Specification see: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html For more information regarding the XDG user directories see: https://wiki.archlinux.org/index.php/XDG_user_directories For more information regarding the Windows Known Folders see: https://docs.microsoft.com/en-us/windows/win32/shell/known-folders
Usage ¶
XDG Base Directory
package main import ( "log" "github.com/adrg/xdg" ) func main() { // XDG Base Directory paths. log.Println("Home data directory:", xdg.DataHome) log.Println("Data directories:", xdg.DataDirs) log.Println("Home config directory:", xdg.ConfigHome) log.Println("Config directories:", xdg.ConfigDirs) log.Println("Home state directory:", xdg.StateHome) log.Println("Cache directory:", xdg.CacheHome) log.Println("Runtime directory:", xdg.RuntimeDir) log.Println("Home binaries directory:", xdg.BinHome) // Other common directories. log.Println("Home directory:", xdg.Home) log.Println("Application directories:", xdg.ApplicationDirs) log.Println("Font directories:", xdg.FontDirs) // Obtain a suitable location for application config files. // ConfigFile takes one parameter which must contain the name of the file, // but it can also contain a set of parent directories. If the directories // don't exist, they will be created relative to the base config directory. // It is recommended for files to be saved inside an application directory // relative to the base directory rather than directly inside the base // directory (e.g. `appname/config.yaml` instead of `appname-config.yaml`). configFilePath, err := xdg.ConfigFile("appname/config.yaml") if err != nil { log.Fatal(err) } log.Println("Save the config file at:", configFilePath) // For other types of application files use: // xdg.DataFile() // xdg.StateFile() // xdg.CacheFile() // xdg.RuntimeFile() // Finding application config files. // SearchConfigFile takes one parameter which must contain the name of // the file, but it can also contain a set of parent directories relative // to the config search paths (xdg.ConfigHome and xdg.ConfigDirs). configFilePath, err = xdg.SearchConfigFile("appname/config.yaml") if err != nil { log.Fatal(err) } log.Println("Config file was found at:", configFilePath) // For other types of application files use: // xdg.SearchDataFile() // xdg.SearchStateFile() // xdg.SearchCacheFile() // xdg.SearchRuntimeFile() }
XDG user directories
package main import ( "log" "github.com/adrg/xdg" ) func main() { // XDG user directories. log.Println("Desktop directory:", xdg.UserDirs.Desktop) log.Println("Download directory:", xdg.UserDirs.Download) log.Println("Documents directory:", xdg.UserDirs.Documents) log.Println("Music directory:", xdg.UserDirs.Music) log.Println("Pictures directory:", xdg.UserDirs.Pictures) log.Println("Videos directory:", xdg.UserDirs.Videos) log.Println("Templates directory:", xdg.UserDirs.Templates) log.Println("Public directory:", xdg.UserDirs.PublicShare) }
Index ¶
- Variables
- func CacheFile(relPath string) (string, error)
- func ConfigFile(relPath string) (string, error)
- func DataFile(relPath string) (string, error)
- func Reload()
- func RuntimeFile(relPath string) (string, error)
- func SearchCacheFile(relPath string) (string, error)
- func SearchConfigFile(relPath string) (string, error)
- func SearchDataFile(relPath string) (string, error)
- func SearchRuntimeFile(relPath string) (string, error)
- func SearchStateFile(relPath string) (string, error)
- func StateFile(relPath string) (string, error)
- type UserDirectories
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var ( // Home contains the path of the user's home directory. Home string // DataHome defines the base directory relative to which user-specific // data files should be stored. This directory is defined by the // $XDG_DATA_HOME environment variable. If the variable is not set, // a default equal to $HOME/.local/share should be used. DataHome string // DataDirs defines the preference-ordered set of base directories to // search for data files in addition to the DataHome base directory. // This set of directories is defined by the $XDG_DATA_DIRS environment // variable. If the variable is not set, the default directories // to be used are /usr/local/share and /usr/share, in that order. The // DataHome directory is considered more important than any of the // directories defined by DataDirs. Therefore, user data files should be // written relative to the DataHome directory, if possible. DataDirs []string // ConfigHome defines the base directory relative to which user-specific // configuration files should be written. This directory is defined by // the $XDG_CONFIG_HOME environment variable. If the variable is // not set, a default equal to $HOME/.config should be used. ConfigHome string // ConfigDirs defines the preference-ordered set of base directories to // search for configuration files in addition to the ConfigHome base // directory. This set of directories is defined by the $XDG_CONFIG_DIRS // environment variable. If the variable is not set, a default equal // to /etc/xdg should be used. The ConfigHome directory is considered // more important than any of the directories defined by ConfigDirs. // Therefore, user config files should be written relative to the // ConfigHome directory, if possible. ConfigDirs []string // StateHome defines the base directory relative to which user-specific // state files should be stored. This directory is defined by the // $XDG_STATE_HOME environment variable. If the variable is not set, // a default equal to ~/.local/state should be used. StateHome string // CacheHome defines the base directory relative to which user-specific // non-essential (cached) data should be written. This directory is // defined by the $XDG_CACHE_HOME environment variable. If the variable // is not set, a default equal to $HOME/.cache should be used. CacheHome string // RuntimeDir defines the base directory relative to which user-specific // non-essential runtime files and other file objects (such as sockets, // named pipes, etc.) should be stored. This directory is defined by the // $XDG_RUNTIME_DIR environment variable. If the variable is not set, // applications should fall back to a replacement directory with similar // capabilities. Applications should use this directory for communication // and synchronization purposes and should not place larger files in it, // since it might reside in runtime memory and cannot necessarily be // swapped out to disk. RuntimeDir string // BinHome defines the base directory relative to which user-specific // binary files should be written. This directory is defined by // the non-standard $XDG_BIN_HOME environment variable. If the variable is // not set, a default equal to $HOME/.local/bin should be used. BinHome string // UserDirs defines the locations of well known user directories. UserDirs UserDirectories // FontDirs defines the common locations where font files are stored. FontDirs []string // ApplicationDirs defines the common locations of applications. ApplicationDirs []string )
Functions ¶
func CacheFile ¶
CacheFile returns a suitable location for the specified cache file. The relPath parameter must contain the name of the cache file, and optionally, a set of parent directories (e.g. appname/app.cache). If the specified directories do not exist, they will be created relative to the base cache directory. On failure, an error containing the attempted paths is returned.
Example ¶
package main import ( "fmt" "github.com/adrg/xdg" ) func main() { cacheFilePath, err := xdg.CacheFile("appname/app.cache") if err != nil { // Treat error. } fmt.Println("Save cache file at:", cacheFilePath) }
Output:
func ConfigFile ¶
ConfigFile returns a suitable location for the specified config file. The relPath parameter must contain the name of the config file, and optionally, a set of parent directories (e.g. appname/app.yaml). If the specified directories do not exist, they will be created relative to the base config directory. On failure, an error containing the attempted paths is returned.
Example ¶
package main import ( "fmt" "github.com/adrg/xdg" ) func main() { configFilePath, err := xdg.ConfigFile("appname/app.yaml") if err != nil { // Treat error. } fmt.Println("Save config file at:", configFilePath) }
Output:
func DataFile ¶
DataFile returns a suitable location for the specified data file. The relPath parameter must contain the name of the data file, and optionally, a set of parent directories (e.g. appname/app.data). If the specified directories do not exist, they will be created relative to the base data directory. On failure, an error containing the attempted paths is returned.
Example ¶
package main import ( "fmt" "github.com/adrg/xdg" ) func main() { dataFilePath, err := xdg.DataFile("appname/app.data") if err != nil { // Treat error. } fmt.Println("Save data file at:", dataFilePath) }
Output:
func Reload ¶ added in v0.2.0
func Reload()
Reload refreshes base and user directories by reading the environment. Defaults are applied for XDG variables which are empty or not present in the environment.
func RuntimeFile ¶
RuntimeFile returns a suitable location for the specified runtime file. The relPath parameter must contain the name of the runtime file, and optionally, a set of parent directories (e.g. appname/app.pid). If the specified directories do not exist, they will be created relative to the base runtime directory. If the base runtime directory does not exist, the operating system's temporary directory is used as a fallback. On failure, an error containing the attempted paths is returned.
Example ¶
package main import ( "fmt" "github.com/adrg/xdg" ) func main() { runtimeFilePath, err := xdg.RuntimeFile("appname/app.pid") if err != nil { // Treat error. } fmt.Println("Save runtime file at:", runtimeFilePath) }
Output:
func SearchCacheFile ¶
SearchCacheFile searches for the specified file in the cache search path. The relPath parameter must contain the name of the cache file, and optionally, a set of parent directories (e.g. appname/app.cache). If the file cannot be found, an error specifying the searched path is returned.
Example ¶
package main import ( "fmt" "github.com/adrg/xdg" ) func main() { cacheFilePath, err := xdg.SearchCacheFile("appname/app.cache") if err != nil { // The cache file could not be found. } fmt.Println("The cache file was found at:", cacheFilePath) }
Output:
func SearchConfigFile ¶
SearchConfigFile searches for the specified file in config search paths. The relPath parameter must contain the name of the config file, and optionally, a set of parent directories (e.g. appname/app.yaml). If the file cannot be found, an error specifying the searched paths is returned.
Example ¶
package main import ( "fmt" "github.com/adrg/xdg" ) func main() { configFilePath, err := xdg.SearchConfigFile("appname/app.yaml") if err != nil { // The config file could not be found. } fmt.Println("The config file was found at:", configFilePath) }
Output:
func SearchDataFile ¶
SearchDataFile searches for specified file in the data search paths. The relPath parameter must contain the name of the data file, and optionally, a set of parent directories (e.g. appname/app.data). If the file cannot be found, an error specifying the searched paths is returned.
Example ¶
package main import ( "fmt" "github.com/adrg/xdg" ) func main() { dataFilePath, err := xdg.SearchDataFile("appname/app.data") if err != nil { // The data file could not be found. } fmt.Println("The data file was found at:", dataFilePath) }
Output:
func SearchRuntimeFile ¶
SearchRuntimeFile searches for the specified file in the runtime search path. The relPath parameter must contain the name of the runtime file, and optionally, a set of parent directories (e.g. appname/app.pid). The runtime file is also searched in the operating system's temporary directory in order to cover cases in which the runtime base directory does not exist or is not accessible. If the file cannot be found, an error specifying the searched paths is returned.
Example ¶
package main import ( "fmt" "github.com/adrg/xdg" ) func main() { runtimeFilePath, err := xdg.SearchRuntimeFile("appname/app.pid") if err != nil { // The runtime file could not be found. } fmt.Println("The runtime file was found at:", runtimeFilePath) }
Output:
func SearchStateFile ¶ added in v0.3.0
SearchStateFile searches for the specified file in the state search path. The relPath parameter must contain the name of the state file, and optionally, a set of parent directories (e.g. appname/app.state). If the file cannot be found, an error specifying the searched path is returned.
Example ¶
package main import ( "fmt" "github.com/adrg/xdg" ) func main() { stateFilePath, err := xdg.SearchStateFile("appname/app.state") if err != nil { // The state file could not be found. } fmt.Println("The state file was found at:", stateFilePath) }
Output:
func StateFile ¶ added in v0.3.0
StateFile returns a suitable location for the specified state file. State files are usually volatile data files, not suitable to be stored relative to the $XDG_DATA_HOME directory. The relPath parameter must contain the name of the state file, and optionally, a set of parent directories (e.g. appname/app.state). If the specified directories do not exist, they will be created relative to the base state directory. On failure, an error containing the attempted paths is returned.
Example ¶
package main import ( "fmt" "github.com/adrg/xdg" ) func main() { stateFilePath, err := xdg.DataFile("appname/app.state") if err != nil { // Treat error. } fmt.Println("Save state file at:", stateFilePath) }
Output:
Types ¶
type UserDirectories ¶ added in v0.2.0
type UserDirectories = userdirs.Directories
UserDirectories defines the locations of well known user directories.