Xdg.Directories/docs/defaults.html
2024-07-10 19:39:30 +00:00

279 lines
9.1 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Default Locations </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Default Locations ">
<link rel="icon" href="../images/icon.png">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="docfx:docurl" content="https://github.com/xdg-net/Xdg.Directories/blob/master/docs/docs/defaults.md/#L1">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/icon.svg" alt="Xdg.Directories">
Xdg.Directories
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="">
<h1 id="default-locations">Default Locations</h1>
<p>If any of the respective XDG environment are specified, the variable will always be returned.
Otherwise, the value depends on the operating system.</p>
<p>Inspiration is taken from the <a href="https://github.com/adrg/xdg">Go implementation</a> for Windows and MacOS directories.</p>
<details open="">
<summary>Base Directory</summary>
<table>
<thead>
<tr>
<th>Environment Variable</th>
<th>Windows</th>
<th>macOS</th>
<th>Linux/FreeBSD</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>XDG_DATA_HOME</code></td>
<td><code>%LOCALAPPDATA%</code></td>
<td><code>$HOME/Library/Application Support</code></td>
<td><code>$HOME/.local/share</code></td>
</tr>
<tr>
<td><code>XDG_CONFIG_HOME</code></td>
<td><code>%LOCALAPPDATA%</code></td>
<td><code>$HOME/Library/Application Support</code></td>
<td><code>$HOME/.config</code></td>
</tr>
<tr>
<td><code>XDG_STATE_HOME</code></td>
<td><code>%LOCALAPPDATA%</code></td>
<td><code>$HOME/Library/Application Support</code></td>
<td><code>$HOME/.local/state</code></td>
</tr>
<tr>
<td><code>XDG_BIN_HOME</code></td>
<td><code>null</code></td>
<td><code>null</code></td>
<td><code>$HOME/.local/bin</code></td>
</tr>
<tr>
<td><code>XDG_DATA_DIRS</code></td>
<td><code>%APPDATA%:%PROGRAMDATA%</code></td>
<td><code>/Library/Application Support</code></td>
<td><code>/usr/local/share:/usr/share</code></td>
</tr>
<tr>
<td><code>XDG_CONFIG_DIRS</code></td>
<td><code>%LOCALAPPDATA%</code></td>
<td><code>$HOME/Library/Preferences:/Library/Application Support:/Library/Preferences</code></td>
<td><code>/etc/xdg</code></td>
</tr>
<tr>
<td><code>XDG_CACHE_HOME</code></td>
<td><code>%LOCALAPPDATA%</code></td>
<td><code>$HOME/Library/Application Support</code></td>
<td><code>$HOME/.config</code></td>
</tr>
<tr>
<td><code>XDG_RUNTIME_HOME</code></td>
<td><code>%LOCALAPPDATA%</code></td>
<td><code>$HOME/Library/Application Support</code></td>
<td><code>/run/user/$UID</code></td>
</tr>
</tbody>
</table>
</details>
<details open="">
<summary>User Directory</summary>
<p>User directories on Windows use <a href="https://learn.microsoft.com/en-us/windows/win32/shell/known-folders">Known Folders</a>.</p>
<table>
<thead>
<tr>
<th>Environment Variable</th>
<th>Windows</th>
<th>macOS</th>
<th>Linux/FreeBSD</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>XDG_DESKTOP_DIR</code></td>
<td><code>Desktop</code></td>
<td><code>$HOME/Desktop</code></td>
<td><code>$HOME/Desktop</code></td>
</tr>
<tr>
<td><code>XDG_DOWNLOAD_DIR</code></td>
<td><code>null</code></td>
<td><code>$HOME/Downloads</code></td>
<td><code>$HOME/Downloads</code></td>
</tr>
<tr>
<td><code>XDG_DOCUMENTS_DIR</code></td>
<td><code>My Documents</code></td>
<td><code>$HOME/Documents</code></td>
<td><code>$HOME/Documents</code></td>
</tr>
<tr>
<td><code>XDG_MUSIC_DIR</code></td>
<td><code>My Music</code></td>
<td><code>$HOME/Music</code></td>
<td><code>$HOME/Music</code></td>
</tr>
<tr>
<td><code>XDG_PICTURES_DIRS</code></td>
<td><code>My Pictures</code></td>
<td><code>$HOME/Pictures</code></td>
<td><code>$HOME/Pictures</code></td>
</tr>
<tr>
<td><code>XDG_VIDEOS_DIR</code></td>
<td><code>My Videos</code></td>
<td><code>$HOME/Movies</code></td>
<td><code>$HOME/Videos</code></td>
</tr>
<tr>
<td><code>XDG_TEMPLATES_DIR</code></td>
<td><code>Templates</code></td>
<td><code>$HOME/Templates</code></td>
<td><code>$HOME/Templates</code></td>
</tr>
<tr>
<td><code>XDG_PUBLICSHARE_DIR</code></td>
<td><code>%PUBLIC%</code></td>
<td><code>$HOME/Public</code></td>
<td><code>$HOME/Public</code></td>
</tr>
</tbody>
</table>
</details>
<details open="">
<summary>Extra Directories</summary>
<table>
<thead>
<tr>
<th></th>
<th>Windows</th>
<th>macOS</th>
<th>Linux/FreeBSD</th>
</tr>
</thead>
<tbody>
<tr>
<td>Home</td>
<td><code>%USERPROFILE%</code></td>
<td><code>$HOME</code></td>
<td><code>$HOME</code></td>
</tr>
<tr>
<td>Applications</td>
<td><code>Programs</code>, <code>Common Programs</code></td>
<td><code>/Applications</code></td>
<td><code>$XDG_DATA_HOME/applications</code>, <code>$HOME/.local/share/applications</code>, <code>/usr/local/share/applications</code>, <code>/usr/share/applications</code></td>
</tr>
<tr>
<td>Fonts</td>
<td><code>%SYSTEMROOT%\Fonts</code>, <code>%LOCALAPPDATA%\Microsoft\Windows\Fonts</code></td>
<td><code>$HOME/Library/Fonts</code>, <code>/Library/Fonts</code>, <code>/System/Library/Fonts</code>, <code>/Network/Library/Fonts</code></td>
<td><code>$XDG_DATA_HOME/fonts</code>, <code>$HOME/.fonts</code>, <code>$HOME/.local/share/fonts</code>, <code>/usr/local/share/fonts</code>, <code>/usr/share/fonts</code></td>
</tr>
</tbody>
</table>
</details>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/xdg-net/Xdg.Directories/blob/master/docs/docs/defaults.md/#L1" class="edit-link">Edit this page</a>
</div>
<div class="next-article d-print-none border-top" id="nextArticle"></div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>