ludic/os-config_dir.html
2026-09-17 22:10:03 +00:00

36 lines
No EOL
2.3 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Os.config_dir — Ludic</title>
<meta name="description" content="Per-user config directory for an app.">
<link rel="stylesheet" href="base.css">
<link rel="stylesheet" href="docs.css">
</head>
<body>
<header class="nav"><div class="wrap nav-in"><a class="brand" href="index.html"><span class="logo">L</span> Ludic</a><button class="nav-toggle" aria-label="Toggle menu" aria-expanded="false">☰</button><nav class="nav-links"><a href="index.html">Home</a><a href="api.html">API Reference</a><a class="nav-cta" href="https://git.workshopsoft.io/workshopsoft/ludic">Source ↗</a></nav></div></header>
<main class="wrap item">
<div class="crumbs"><a href="api.html">API Reference</a> <span>›</span> <a href="ns-os.html">Os</a> <span>›</span> <span class="here">Os.config_dir</span></div>
<div class="item-head">
<span class="kind-badge kind-method">method</span>
<h1 id="top">Os.config_dir</h1>
</div>
<code class="sig">Os.config_dir(app) -&gt; string</code>
<div class="desc"><p>The per-user directory where an application should store configuration, named for the app.</p><p>| | |
| --- | --- |
| macOS | <code>~/Library/Application Support/&lt;app&gt;</code> |
| Linux | <code>$XDG_CONFIG_HOME/&lt;app&gt;</code>, or <code>~/.config/&lt;app&gt;</code> |</p><p>On macOS this is the same directory as <a href="os-save_dir"><code>save_dir</code></a> — the platform keeps config and saves together, and Apple's home for a config file that is not an <code>NSUserDefaults</code> plist is Application Support. On Linux XDG separates the two. An XDG variable that is set but empty falls back to the default, as the spec requires.</p></div>
<div class="params"><h2>Parameters</h2><div class="param" id="param-app"><code class="pname">app</code><span class="pdesc">the application name (used as the folder name)</span></div></div>
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program ConfigDir {
entry {
let dir = Os.config_dir("MyGame")
print(len(dir))
}
}</pre></div>
<a class="back" href="api.html">← All symbols</a>
</main>
<script src="ludic-highlight.js"></script>
<script>Ludic.highlightAll(); Ludic.installCards(); Ludic.flashTarget();</script>
</body></html>