paths

Documentation

Overview

Package paths provides platform-specific directory paths for sensorpanel.

Directory structure varies by platform:

Linux:

• Config: $XDG_CONFIG_HOME/sensorpanel/ (default: ~/.config/sensorpanel/)
• Data: $XDG_DATA_HOME/sensorpanel/ (default: ~/.local/share/sensorpanel/)
• Cache: $XDG_CACHE_HOME/sensorpanel/ (default: ~/.cache/sensorpanel/)

macOS:

• Config: ~/Library/Application Support/sensorpanel/
• Data: ~/Library/Application Support/sensorpanel/
• Cache: ~/Library/Caches/sensorpanel/

Windows:

• Config: %APPDATA%\sensorpanel\
• Data: %LOCALAPPDATA%\sensorpanel\
• Cache: %LOCALAPPDATA%\sensorpanel\cache\

Subdirectories:

• themes/ -> in Data directory (user-installed themes)
• browser/ -> in Cache directory (headless browser binary)

Index

• func BrowserDir() (string, error)
• func CacheDir() (string, error)
• func ConfigDir() (string, error)
• func DataDir() (string, error)
• func EnsureBrowserDir() (string, error)
• func EnsureDir(path string) error
• func EnsureThemesDir() (string, error)
• func ThemeDir(themeName string) (string, error)
• func ThemesDir() (string, error)

Functions

func BrowserDir

func BrowserDir() (string, error)

BrowserDir returns the directory where the headless browser is stored.

func CacheDir

func CacheDir() (string, error)

CacheDir returns the XDG cache directory for sensorpanel. Default: ~/.cache/sensorpanel/

func ConfigDir

func ConfigDir() (string, error)

ConfigDir returns the XDG config directory for sensorpanel. Default: ~/.config/sensorpanel/

func DataDir

func DataDir() (string, error)

DataDir returns the XDG data directory for sensorpanel. Default: ~/.local/share/sensorpanel/

func EnsureBrowserDir

func EnsureBrowserDir() (string, error)

EnsureBrowserDir creates the browser cache directory if it doesn't exist.

func EnsureDir

func EnsureDir(path string) error

EnsureDir creates a directory if it doesn't exist.

func EnsureThemesDir

func EnsureThemesDir() (string, error)

EnsureThemesDir creates the themes directory if it doesn't exist.

func ThemeDir

func ThemeDir(themeName string) (string, error)

ThemeDir returns the directory for a specific theme.

func ThemesDir

func ThemesDir() (string, error)

ThemesDir returns the directory where themes are stored.