A Github-free mirror of https://github.com/xdg-net/Xdg.Directories https://xdg-net.github.io/Xdg.Directories

Find a file

dependabot[bot] 808f29e866 build(deps): Bump Microsoft.NET.Test.Sdk from 17.6.0 to 17.6.2 Bumps [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest) from 17.6.0 to 17.6.2. - [Release notes](https://github.com/microsoft/vstest/releases) - [Changelog](https://github.com/microsoft/vstest/blob/main/docs/releases.md) - [Commits](https://github.com/microsoft/vstest/compare/v17.6.0...v17.6.2) --- updated-dependencies: - dependency-name: Microsoft.NET.Test.Sdk dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>		2023-10-25 15:55:57 +02:00
.github	revert: Get rid of benchmark action	2023-10-25 15:55:57 +02:00
src	build(deps): Bump Microsoft.NET.Test.Sdk from 17.6.0 to 17.6.2	2023-10-25 15:55:57 +02:00
.drone.yml	feat(ci): Add Gitea CI for public preview packages	2023-05-15 18:24:24 +02:00
.editorconfig	refactor: Put FFI in its own project	2023-10-25 15:55:52 +02:00
.gitattributes	feat: Initial commit	2023-05-13 20:10:14 +02:00
.gitignore	feat: Initial commit	2023-05-13 20:10:14 +02:00
GNUmakefile	refactor: Put FFI in its own project	2023-10-25 15:55:52 +02:00
LICENSE	feat: Initial commit	2023-05-13 20:10:14 +02:00
README.md	misc: Don't benchmark everything; correct README	2023-10-25 15:55:57 +02:00
Xdg.Net.sln	refactor: Put FFI in its own project	2023-10-25 15:55:52 +02:00

README.md

Xdg

A .NET (and an experimental C-compatible FFI) implementation of the XDG Base Directory Specification and XDG user directories.

Default Locations

If any of the respective XDG environment are specified, the variable will always be returned. Otherwise, the value depends on the operating system.

Inspiration is taken from the Go implementation for Windows and MacOS directories.

Base Directory

Environment Variable	Windows	macOS	Linux/FreeBSD
`XDG_DATA_HOME`	`%LOCALAPPDATA%`	`$HOME/Library/Application Support`	`$HOME/.local/share`
`XDG_CONFIG_HOME`	`%LOCALAPPDATA%`	`$HOME/Library/Application Support`	`$HOME/.config`
`XDG_STATE_HOME`	`%LOCALAPPDATA%`	`$HOME/Library/Application Support`	`$HOME/.local/state`
`XDG_BIN_HOME`	`null`	`null`	`$HOME/.local/bin`
`XDG_DATA_DIRS`	`%APPDATA%:%PROGRAMDATA%`	`/Library/Application Support`	`/usr/local/share:/usr/share`
`XDG_CONFIG_DIRS`	`%LOCALAPPDATA%`	`$HOME/Library/Preferences:/Library/Application Support:/Library/Preferences`	`/etc/xdg`
`XDG_CACHE_HOME`	`%LOCALAPPDATA%`	`$HOME/Library/Application Support`	`$HOME/.config`
`XDG_RUNTIME_HOME`	`%LOCALAPPDATA%`	`$HOME/Library/Application Support`	`/run/user/$UID`

User Directory

User directories on Windows use Known Folders as a fallback.

Environment Variable	Windows	macOS	Linux/FreeBSD
`XDG_DESKTOP_DIR`	`Desktop`	`$HOME/Desktop`	`$HOME/Desktop`
`XDG_DOWNLOAD_DIR`	`null`	`$HOME/Downloads`	`$HOME/Downloads`
`XDG_DOCUMENTS_DIR`	`My Documents`	`$HOME/Documents`	`$HOME/Documents`
`XDG_MUSIC_DIR`	`My Music`	`$HOME/Music`	`$HOME/Music`
`XDG_PICTURES_DIRS`	`My Pictures`	`$HOME/Pictures`	`$HOME/Pictures`
`XDG_VIDEOS_DIR`	`My Videos`	`$HOME/Movies`	`$HOME/Videos`
`XDG_TEMPLATES_DIR`	`Templates`	`$HOME/Templates`	`$HOME/Templates`
`XDG_PUBLICSHARE_DIR`	`%PUBLIC%`	`$HOME/Public`	`$HOME/Public`

Extra Directories

	Windows	macOS	Linux/FreeBSD
Home	`%USERPROFILE%`	`$HOME`	`$HOME`

Packaging

Stable releases will be uploaded to nuget.org, and preview releases are uploaded to both GitHub packages (need GitHub account to download) and Gitea packages (no login required).

dotnet add package Xdg.Directories

Native Library

View the README here

License

MIT