chore(docs): regenerate man page, HTML docs, and wiki
This commit is contained in:
@@ -493,16 +493,21 @@
|
||||
Configuration</h2>
|
||||
<p>Place machine-specific settings that should not be committed to git
|
||||
in:</p>
|
||||
<pre><code>~/.config/.user-dots/fish/local.fish</code></pre>
|
||||
<pre><code>$__fish_user_dots_path/local.fish</code></pre>
|
||||
<p><code>__fish_user_dots_path</code> defaults to
|
||||
<code>~/.config/.user-dots/fish</code>. Set a custom location with:</p>
|
||||
<pre><code>set -U __fish_user_dots_path /path/to/your/dots/fish</code></pre>
|
||||
<p>Typical uses: additional PATH entries, local aliases,
|
||||
hostname-specific env vars, work-specific tool configs.</p>
|
||||
<h2 data-number="11.2" id="secrets-and-api-keys">Secrets and API
|
||||
Keys</h2>
|
||||
<pre><code>~/.config/.user-dots/fish/secrets.fish</code></pre>
|
||||
<pre><code>$__fish_user_dots_path/secrets.fish</code></pre>
|
||||
<p>Store API tokens, GPG keys, private credentials here. This file is
|
||||
never committed.</p>
|
||||
<p>Both files are sourced at the end of config.fish on every interactive
|
||||
session, so they can override anything set earlier.</p>
|
||||
never committed. It is sourced by local.fish directly, not by
|
||||
config.fish.</p>
|
||||
<p><code>local.fish</code> is sourced at the end of config.fish on every
|
||||
interactive session, so it and its companion secrets.fish can override
|
||||
anything set earlier.</p>
|
||||
<h2 data-number="11.3"
|
||||
id="overriding-configuration-variables">Overriding Configuration
|
||||
Variables</h2>
|
||||
|
||||
@@ -490,11 +490,15 @@
|
||||
</nav>
|
||||
<h1 data-number="14" id="10-personalization">10. PERSONALIZATION</h1>
|
||||
<p>Sensitive credentials and machine-specific settings are kept out of
|
||||
version control in a private directory at ~/.config/.user-dots/fish/.
|
||||
Two files are sourced automatically by config.fish if they exist:</p>
|
||||
<pre><code>~/.config/.user-dots/fish/
|
||||
version control in a private directory. The path defaults to
|
||||
<code>~/.config/.user-dots/fish/</code> but can be overridden:</p>
|
||||
<pre><code>set -U __fish_user_dots_path /path/to/your/dots/fish</code></pre>
|
||||
<p>config.fish sources local.fish from that directory on every
|
||||
interactive session. local.fish is responsible for sourcing its own
|
||||
secrets.fish:</p>
|
||||
<pre><code>$__fish_user_dots_path/
|
||||
├── secrets.fish API keys, tokens, passwords, personal identifiers
|
||||
└── local.fish Machine-specific paths and environment variables</code></pre>
|
||||
└── local.fish Machine-specific paths, env vars, and sourcing secrets</code></pre>
|
||||
<p>fish_variables (auto-managed by fish) is excluded from this repo via
|
||||
.gitignore. Do not commit it.</p>
|
||||
<h2 data-number="14.1" id="secretsfish">secrets.fish</h2>
|
||||
@@ -524,9 +528,10 @@ abbr -a sshw 'ssh you@work-server.example.com'
|
||||
# Docker context shortcuts
|
||||
abbr -a dcr 'docker context use my-remote-server'
|
||||
abbr -a dcw 'docker context use work-server'</code></pre>
|
||||
<p>Both files are sourced at the end of config.fish with an existence
|
||||
<p>local.fish is sourced at the end of config.fish with an existence
|
||||
check so the public config works cleanly on any machine without the
|
||||
private repo.</p>
|
||||
private repo. local.fish in turn sources secrets.fish when it
|
||||
exists.</p>
|
||||
<hr />
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@@ -491,7 +491,8 @@
|
||||
<h1 data-number="5" id="1-configuration-variables">1. CONFIGURATION
|
||||
VARIABLES</h1>
|
||||
<p>These variables are exported from config.fish on every interactive
|
||||
session. Override them in ~/.config/.user-dots/fish/local.fish.</p>
|
||||
session. Override them in local.fish (see Section 10,
|
||||
Personalization).</p>
|
||||
<h2 data-number="5.1" id="environment-directories-xdg">Environment
|
||||
Directories (XDG)</h2>
|
||||
<pre><code>XDG_CONFIG_HOME ~/.config
|
||||
|
||||
Reference in New Issue
Block a user