homedir
packageThis package is not in the latest version of its module.
Details
Valid go.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Index¶
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
funcGet¶
func Get()string
Get returns the home directory of the current user with the help ofenvironment variables depending on the target operating system.Returned path should be used with "path/filepath" to form new paths.
On non-Windows platforms, it falls back to nss lookups, if the homedirectory cannot be obtained from environment-variables.
If linking statically with cgo enabled against glibc, ensure theosusergo build tag is used.
If needing to do nss lookups, do not disable cgo or set osusergo.
funcGetConfigHome¶
GetConfigHome returns XDG_CONFIG_HOME.GetConfigHome returns $HOME/.config and nil error if XDG_CONFIG_HOME is not set.If HOME and XDG_CONFIG_HOME are not set, getpwent(3) is consulted to determine the users home directory.
See alsohttps://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
funcGetDataHome¶
GetDataHome returns XDG_DATA_HOME.GetDataHome returns $HOME/.local/share and nil error if XDG_DATA_HOME is not set.If HOME and XDG_DATA_HOME are not set, getpwent(3) is consulted to determine the users home directory.
See alsohttps://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
funcGetLibHome¶
GetLibHome returns $HOME/.local/libIf HOME is not set, getpwent(3) is consulted to determine the users home directory.
funcGetRuntimeDir¶
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 alsohttps://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
funcStickRuntimeDirContents¶
StickRuntimeDirContents sets the sticky bit on files that are underXDG_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 alsohttps://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
Types¶
This section is empty.