package homedir

import "github.com/dotcloud/docker/pkg/homedir"

Index ¶

• func Get() string
• func GetConfigHome() (string, error)
• func GetDataHome() (string, error)
• func GetLibHome() (string, error)
• func GetRuntimeDir() (string, error)
• func GetShortcutString() string
• 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.

If linking statically with cgo enabled against glibc, ensure the osusergo build tag is used.

If needing to do nss lookups, do not disable cgo or set osusergo.

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 GetLibHome ¶

func GetLibHome() (string, error)

GetLibHome returns $HOME/.local/lib

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 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

Source Files ¶

homedir_linux.go homedir_unix.go