Xdg.Directories/api/Xdg.Directories.Other.html

322 lines
12 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Class Other </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class Other ">
<meta name="description" content="Other useful directories that aren&#39;t specified by XDG.">
<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/new/master/apiSpec/new?filename=Xdg_Directories_Other.md&amp;value=---%0Auid%3A%20Xdg.Directories.Other%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<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">
</head>
<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>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<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" style="margin-top: -.65em; margin-left: -.8em" 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="Xdg.Directories.Other">
<h1 id="Xdg_Directories_Other" data-uid="Xdg.Directories.Other" class="text-break">
Class Other <a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/Other.cs/#L4"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Xdg.html">Xdg</a>.<a class="xref" href="Xdg.Directories.html">Directories</a></dd></dl>
<dl><dt>Assembly</dt><dd>Xdg.Directories.dll</dd></dl>
</div>
<div class="markdown summary"><p>Other useful directories that aren't specified by XDG.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class Other</code></pre>
</div>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">Other</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<h2 id="Xdg_Directories_Other_remarks">Remarks</h2>
<div class="markdown level0 remarks"><p>These variables were graciously stolen from the excellent <a href="https://github.com/adrg/xdg">Go XDG implementation</a>.
That library largely inspired this one, absolutely recommended if you're working in Go.</p>
</div>
<h2 class="section" id="properties">Properties
</h2>
<a id="Xdg_Directories_Other_Applications_" data-uid="Xdg.Directories.Other.Applications*"></a>
<h3 id="Xdg_Directories_Other_Applications" data-uid="Xdg.Directories.Other.Applications">
Applications
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/Other.cs/#L23"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Application directories</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IList&lt;string&gt; Applications { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>Common application directories.</p>
</dd>
</dl>
<h4 class="section" id="Xdg_Directories_Other_Applications_remarks">Remarks</h4>
<div class="markdown level1 remarks"><table><tbody><tr><td class="term">Windows</td><td class="description">
The <code>Programs</code> Special Folder,
the <code>Common Programs</code> Special Folder
</td></tr><tr><td class="term">macOS</td><td class="description">
<code>/Applications</code>
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
<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></tbody></table>
</div>
<a id="Xdg_Directories_Other_Fonts_" data-uid="Xdg.Directories.Other.Fonts*"></a>
<h3 id="Xdg_Directories_Other_Fonts" data-uid="Xdg.Directories.Other.Fonts">
Fonts
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/Other.cs/#L49"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Font directories</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IList&lt;string&gt; Fonts { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>Common font directories.</p>
</dd>
</dl>
<h4 class="section" id="Xdg_Directories_Other_Fonts_remarks">Remarks</h4>
<div class="markdown level1 remarks"><table><tbody><tr><td class="term">Windows</td><td class="description">
<code>%SYSTEMROOT%\Fonts</code>,
<code>%LOCALAPPDATA%\Microsoft\Windows\Fonts</code>
</td></tr><tr><td class="term">macOS</td><td class="description">
<code>$HOME/Library/Fonts</code>,
<code>/Library/Fonts</code>,
<code>/System/Library/Fonts</code>,
<code>/Network/Library/Fonts</code>
</td></tr><tr><td class="term">Linux/FreeBSD</td><td class="description">
<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>
</div>
<a id="Xdg_Directories_Other_Home_" data-uid="Xdg.Directories.Other.Home*"></a>
<h3 id="Xdg_Directories_Other_Home" data-uid="Xdg.Directories.Other.Home">
Home
<a class="header-action link-secondary" title="View source" href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/Other.cs/#L7"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Home Directory</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string Home { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The current user's home directory.</p>
</dd>
</dl>
<h4 class="section" id="Xdg_Directories_Other_Home_remarks">Remarks</h4>
<div class="markdown level1 remarks"><table><tbody><tr><td class="term">Windows</td><td class="description">
<code>%USERPROFILE%</code>
</td></tr><tr><td class="term">Unix (macOS/Linux/FreeBSD)</td><td class="description">
<code>$HOME</code>
</td></tr></tbody></table>
</div>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/xdg-net/Xdg.Directories/blob/master/src/Xdg.Directories/Other.cs/#L4" class="edit-link">Edit this page</a>
</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>