chore(docs): regenerate man page, HTML docs, and wiki
This commit is contained in:
+34
-11
@@ -176,7 +176,7 @@ docs/ Offline documentation and compiled man page
|
|||||||
.PP
|
.PP
|
||||||
These variables are exported from config.fish on every interactive
|
These variables are exported from config.fish on every interactive
|
||||||
session.
|
session.
|
||||||
Override them in \[ti]/.config/.user-dots/fish/local.fish.
|
Override them in local.fish (see Section 10, Personalization).
|
||||||
.SS Environment Directories (XDG)
|
.SS Environment Directories (XDG)
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
@@ -1966,7 +1966,17 @@ Place machine-specific settings that should not be committed to git in:
|
|||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
\f[C]
|
\f[C]
|
||||||
\[ti]/.config/.user-dots/fish/local.fish
|
$__fish_user_dots_path/local.fish
|
||||||
|
\f[R]
|
||||||
|
.fi
|
||||||
|
.PP
|
||||||
|
\f[V]__fish_user_dots_path\f[R] defaults to
|
||||||
|
\f[V]\[ti]/.config/.user-dots/fish\f[R].
|
||||||
|
Set a custom location with:
|
||||||
|
.IP
|
||||||
|
.nf
|
||||||
|
\f[C]
|
||||||
|
set -U __fish_user_dots_path /path/to/your/dots/fish
|
||||||
\f[R]
|
\f[R]
|
||||||
.fi
|
.fi
|
||||||
.PP
|
.PP
|
||||||
@@ -1976,15 +1986,17 @@ env vars, work-specific tool configs.
|
|||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
\f[C]
|
\f[C]
|
||||||
\[ti]/.config/.user-dots/fish/secrets.fish
|
$__fish_user_dots_path/secrets.fish
|
||||||
\f[R]
|
\f[R]
|
||||||
.fi
|
.fi
|
||||||
.PP
|
.PP
|
||||||
Store API tokens, GPG keys, private credentials here.
|
Store API tokens, GPG keys, private credentials here.
|
||||||
This file is never committed.
|
This file is never committed.
|
||||||
|
It is sourced by local.fish directly, not by config.fish.
|
||||||
.PP
|
.PP
|
||||||
Both files are sourced at the end of config.fish on every interactive
|
\f[V]local.fish\f[R] is sourced at the end of config.fish on every
|
||||||
session, so they can override anything set earlier.
|
interactive session, so it and its companion secrets.fish can override
|
||||||
|
anything set earlier.
|
||||||
.SS Overriding Configuration Variables
|
.SS Overriding Configuration Variables
|
||||||
.PP
|
.PP
|
||||||
Any variable set in local.fish after the main config loads takes effect.
|
Any variable set in local.fish after the main config loads takes effect.
|
||||||
@@ -2621,15 +2633,25 @@ Run exec fish after a successful update to reload.
|
|||||||
.SH 10. PERSONALIZATION
|
.SH 10. PERSONALIZATION
|
||||||
.PP
|
.PP
|
||||||
Sensitive credentials and machine-specific settings are kept out of
|
Sensitive credentials and machine-specific settings are kept out of
|
||||||
version control in a private directory at
|
version control in a private directory.
|
||||||
\[ti]/.config/.user-dots/fish/.
|
The path defaults to \f[V]\[ti]/.config/.user-dots/fish/\f[R] but can be
|
||||||
Two files are sourced automatically by config.fish if they exist:
|
overridden:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
\f[C]
|
\f[C]
|
||||||
\[ti]/.config/.user-dots/fish/
|
set -U __fish_user_dots_path /path/to/your/dots/fish
|
||||||
|
\f[R]
|
||||||
|
.fi
|
||||||
|
.PP
|
||||||
|
config.fish sources local.fish from that directory on every interactive
|
||||||
|
session.
|
||||||
|
local.fish is responsible for sourcing its own secrets.fish:
|
||||||
|
.IP
|
||||||
|
.nf
|
||||||
|
\f[C]
|
||||||
|
$__fish_user_dots_path/
|
||||||
├── secrets.fish API keys, tokens, passwords, personal identifiers
|
├── secrets.fish API keys, tokens, passwords, personal identifiers
|
||||||
└── local.fish Machine-specific paths and environment variables
|
└── local.fish Machine-specific paths, env vars, and sourcing secrets
|
||||||
\f[R]
|
\f[R]
|
||||||
.fi
|
.fi
|
||||||
.PP
|
.PP
|
||||||
@@ -2676,9 +2698,10 @@ abbr -a dcw \[aq]docker context use work-server\[aq]
|
|||||||
\f[R]
|
\f[R]
|
||||||
.fi
|
.fi
|
||||||
.PP
|
.PP
|
||||||
Both files are sourced at the end of config.fish with an existence check
|
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
|
so the public config works cleanly on any machine without the private
|
||||||
repo.
|
repo.
|
||||||
|
local.fish in turn sources secrets.fish when it exists.
|
||||||
.PP
|
.PP
|
||||||
* * * * *
|
* * * * *
|
||||||
.SH 11. VIEWING THIS MANUAL
|
.SH 11. VIEWING THIS MANUAL
|
||||||
|
|||||||
@@ -493,16 +493,21 @@
|
|||||||
Configuration</h2>
|
Configuration</h2>
|
||||||
<p>Place machine-specific settings that should not be committed to git
|
<p>Place machine-specific settings that should not be committed to git
|
||||||
in:</p>
|
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,
|
<p>Typical uses: additional PATH entries, local aliases,
|
||||||
hostname-specific env vars, work-specific tool configs.</p>
|
hostname-specific env vars, work-specific tool configs.</p>
|
||||||
<h2 data-number="11.2" id="secrets-and-api-keys">Secrets and API
|
<h2 data-number="11.2" id="secrets-and-api-keys">Secrets and API
|
||||||
Keys</h2>
|
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
|
<p>Store API tokens, GPG keys, private credentials here. This file is
|
||||||
never committed.</p>
|
never committed. It is sourced by local.fish directly, not by
|
||||||
<p>Both files are sourced at the end of config.fish on every interactive
|
config.fish.</p>
|
||||||
session, so they can override anything set earlier.</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"
|
<h2 data-number="11.3"
|
||||||
id="overriding-configuration-variables">Overriding Configuration
|
id="overriding-configuration-variables">Overriding Configuration
|
||||||
Variables</h2>
|
Variables</h2>
|
||||||
|
|||||||
@@ -490,11 +490,15 @@
|
|||||||
</nav>
|
</nav>
|
||||||
<h1 data-number="14" id="10-personalization">10. PERSONALIZATION</h1>
|
<h1 data-number="14" id="10-personalization">10. PERSONALIZATION</h1>
|
||||||
<p>Sensitive credentials and machine-specific settings are kept out of
|
<p>Sensitive credentials and machine-specific settings are kept out of
|
||||||
version control in a private directory at ~/.config/.user-dots/fish/.
|
version control in a private directory. The path defaults to
|
||||||
Two files are sourced automatically by config.fish if they exist:</p>
|
<code>~/.config/.user-dots/fish/</code> but can be overridden:</p>
|
||||||
<pre><code>~/.config/.user-dots/fish/
|
<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
|
├── 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
|
<p>fish_variables (auto-managed by fish) is excluded from this repo via
|
||||||
.gitignore. Do not commit it.</p>
|
.gitignore. Do not commit it.</p>
|
||||||
<h2 data-number="14.1" id="secretsfish">secrets.fish</h2>
|
<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
|
# Docker context shortcuts
|
||||||
abbr -a dcr 'docker context use my-remote-server'
|
abbr -a dcr 'docker context use my-remote-server'
|
||||||
abbr -a dcw 'docker context use work-server'</code></pre>
|
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
|
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 />
|
<hr />
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -491,7 +491,8 @@
|
|||||||
<h1 data-number="5" id="1-configuration-variables">1. CONFIGURATION
|
<h1 data-number="5" id="1-configuration-variables">1. CONFIGURATION
|
||||||
VARIABLES</h1>
|
VARIABLES</h1>
|
||||||
<p>These variables are exported from config.fish on every interactive
|
<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
|
<h2 data-number="5.1" id="environment-directories-xdg">Environment
|
||||||
Directories (XDG)</h2>
|
Directories (XDG)</h2>
|
||||||
<pre><code>XDG_CONFIG_HOME ~/.config
|
<pre><code>XDG_CONFIG_HOME ~/.config
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
---
|
---
|
||||||
|
|
||||||
These variables are exported from config.fish on every interactive session.
|
These variables are exported from config.fish on every interactive session.
|
||||||
Override them in ~/.config/.user-dots/fish/local.fish.
|
Override them in local.fish (see Section 10, Personalization).
|
||||||
|
|
||||||
## Environment Directories (XDG)
|
## Environment Directories (XDG)
|
||||||
|
|
||||||
|
|||||||
@@ -5,12 +5,17 @@
|
|||||||
---
|
---
|
||||||
|
|
||||||
Sensitive credentials and machine-specific settings are kept out of version
|
Sensitive credentials and machine-specific settings are kept out of version
|
||||||
control in a private directory at ~/.config/.user-dots/fish/. Two files are
|
control in a private directory. The path defaults to
|
||||||
sourced automatically by config.fish if they exist:
|
`~/.config/.user-dots/fish/` but can be overridden:
|
||||||
|
|
||||||
~/.config/.user-dots/fish/
|
set -U __fish_user_dots_path /path/to/your/dots/fish
|
||||||
|
|
||||||
|
config.fish sources local.fish from that directory on every interactive
|
||||||
|
session. local.fish is responsible for sourcing its own secrets.fish:
|
||||||
|
|
||||||
|
$__fish_user_dots_path/
|
||||||
├── secrets.fish API keys, tokens, passwords, personal identifiers
|
├── secrets.fish API keys, tokens, passwords, personal identifiers
|
||||||
└── local.fish Machine-specific paths and environment variables
|
└── local.fish Machine-specific paths, env vars, and sourcing secrets
|
||||||
|
|
||||||
fish_variables (auto-managed by fish) is excluded from this repo via
|
fish_variables (auto-managed by fish) is excluded from this repo via
|
||||||
.gitignore. Do not commit it.
|
.gitignore. Do not commit it.
|
||||||
@@ -48,7 +53,8 @@ wrong on any other system.
|
|||||||
abbr -a dcr 'docker context use my-remote-server'
|
abbr -a dcr 'docker context use my-remote-server'
|
||||||
abbr -a dcw 'docker context use work-server'
|
abbr -a dcw 'docker context use work-server'
|
||||||
|
|
||||||
Both files are sourced at the end of config.fish with an existence check so
|
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.
|
the public config works cleanly on any machine without the private repo.
|
||||||
|
local.fish in turn sources secrets.fish when it exists.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -8,20 +8,26 @@
|
|||||||
|
|
||||||
Place machine-specific settings that should not be committed to git in:
|
Place machine-specific settings that should not be committed to git in:
|
||||||
|
|
||||||
~/.config/.user-dots/fish/local.fish
|
$__fish_user_dots_path/local.fish
|
||||||
|
|
||||||
|
`__fish_user_dots_path` defaults to `~/.config/.user-dots/fish`. Set a
|
||||||
|
custom location with:
|
||||||
|
|
||||||
|
set -U __fish_user_dots_path /path/to/your/dots/fish
|
||||||
|
|
||||||
Typical uses: additional PATH entries, local aliases, hostname-specific env
|
Typical uses: additional PATH entries, local aliases, hostname-specific env
|
||||||
vars, work-specific tool configs.
|
vars, work-specific tool configs.
|
||||||
|
|
||||||
## Secrets and API Keys
|
## Secrets and API Keys
|
||||||
|
|
||||||
~/.config/.user-dots/fish/secrets.fish
|
$__fish_user_dots_path/secrets.fish
|
||||||
|
|
||||||
Store API tokens, GPG keys, private credentials here. This file is never
|
Store API tokens, GPG keys, private credentials here. This file is never
|
||||||
committed.
|
committed. It is sourced by local.fish directly, not by config.fish.
|
||||||
|
|
||||||
Both files are sourced at the end of config.fish on every interactive
|
`local.fish` is sourced at the end of config.fish on every interactive
|
||||||
session, so they can override anything set earlier.
|
session, so it and its companion secrets.fish can override anything set
|
||||||
|
earlier.
|
||||||
|
|
||||||
## Overriding Configuration Variables
|
## Overriding Configuration Variables
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user