homedir

Documentation

Index

• func Get() string
• func GetConfigHome() (string, error)
• func GetDataHome() (string, error)
• func GetRuntimeDir() (string, error)
• func GetShortcutString() string
• func GetStatic() (string, error)
• func Key() string
• func StickRuntimeDirContents(files []string) ([]string, error)

Functions

func Get

func Get() string

Get returns the home directory of the current user with the help of environment variables depending on the target operating system. Returned path should be used with "path/filepath" to form new paths.

func GetConfigHome

func GetConfigHome() (string, error)

GetConfigHome returns XDG_CONFIG_HOME. GetConfigHome returns $HOME/.config and nil error if XDG_CONFIG_HOME is not set.

See also https://standards.freedesktop.org/basedir-spec/latest/ar01s03.html

func GetDataHome

func GetDataHome() (string, error)

GetDataHome returns XDG_DATA_HOME. GetDataHome returns $HOME/.local/share and nil error if XDG_DATA_HOME is not set.

See also https://standards.freedesktop.org/basedir-spec/latest/ar01s03.html

func GetRuntimeDir

func GetRuntimeDir() (string, error)

GetRuntimeDir returns XDG_RUNTIME_DIR. XDG_RUNTIME_DIR is typically configured via pam_systemd. GetRuntimeDir returns non-nil error if XDG_RUNTIME_DIR is not set.

See also https://standards.freedesktop.org/basedir-spec/latest/ar01s03.html

func GetShortcutString

func GetShortcutString() string

GetShortcutString returns the string that is shortcut to user's home directory in the native shell of the platform running on.

func GetStatic

func GetStatic() (string, error)

GetStatic returns the home directory for the current user without calling os/user.Current(). This is useful for static-linked binary on glibc-based system, because a call to os/user.Current() in a static binary leads to segfault due to a glibc issue that won't be fixed in a short term. (#29344, golang/go#13470, https://sourceware.org/bugzilla/show_bug.cgi?id=19341)

func Key

func Key() string

Key returns the env var name for the user's home dir based on the platform being run on

func StickRuntimeDirContents

func StickRuntimeDirContents(files []string) ([]string, error)

StickRuntimeDirContents sets the sticky bit on files that are under XDG_RUNTIME_DIR, so that the files won't be periodically removed by the system.

StickyRuntimeDir returns slice of sticked files. StickyRuntimeDir returns nil error if XDG_RUNTIME_DIR is not set.

See also https://standards.freedesktop.org/basedir-spec/latest/ar01s03.html