userlogdir

Documentation

Overview

Package userlogdir has a single function, UserLogDir, that returns an OS-specific path for storing user logs.

Index

• func UserLogDir() (string, error)

Functions

func UserLogDir

func UserLogDir() (string, error)

UserLogDir returns the default root directory to use for user-specific log data. Users should create their own application-specific subdirectory within this one and use that.

On Unix systems, it returns $XDG_CACHE_HOME as specified by https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html if non-empty, else $HOME/.cache. On Darwin, it returns $HOME/Library/Logs. On Windows, it returns %LocalAppData%. On Plan 9, it returns $home/lib/cache.

If the location cannot be determined (for example, $HOME is not defined), then it will return an error.