1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>fish_config - start the web-based configuration interface — fish-shell 4.2.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4da8bbd6" />
<link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=f89b4716" />
<script src="../_static/documentation_options.js?v=6fb65176"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="fish_default_key_bindings - set emacs key bindings for fish" href="fish_default_key_bindings.html" />
<link rel="prev" title="fish_command_not_found - what to do when a command wasn’t found" href="fish_command_not_found.html" />
<link rel="shortcut icon" type="image/png" href="../_static/fish.png" />
</head><body><div id="fmain">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li><img src="../_static/fish.png" alt=""
style="width: 80px; height: 80px; vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://fishshell.com/">fish-shell</a> »</li>
<a href="../index.html">fish-shell 4.2.1 documentation</a> »
<li class="nav-item nav-item-1"><a href="../commands.html" accesskey="U">Commands</a> »</li>
<li class="nav-item nav-item-this"><a href="">fish_config - start the web-based configuration interface</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</li>
<div id="old-docs-notice" style="display: none">
This documents an old version of fish.
<a href="../../current/">See the latest release.</a>
</div>
</ul>
</div>
<div class="document">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="../index.html">Documents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently asked questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../interactive.html">Interactive use</a></li>
<li class="toctree-l1"><a class="reference internal" href="../language.html">The fish language</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../commands.html">Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="../fish_for_bash_users.html">Fish for bash users</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../completions.html">Writing your own completions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../prompt.html">Writing your own prompt</a></li>
<li class="toctree-l1"><a class="reference internal" href="../design.html">Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="../relnotes.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../terminal-compatibility.html">Terminal Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing To Fish</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h4><a href="../index.html">Sections</a></h4>
<ul>
<li><a class="reference internal" href="#">fish_config - start the web-based configuration interface</a><ul>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#theme-files">Theme Files</a></li>
<li><a class="reference internal" href="#example">Example</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="fish-config-start-the-web-based-configuration-interface">
<h1>fish_config - start the web-based configuration interface<a class="headerlink" href="#fish-config-start-the-web-based-configuration-interface" title="Link to this heading">¶</a></h1>
<section id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Link to this heading">¶</a></h2>
<div class="highlight-fish-synopsis notranslate"><div class="highlight"><pre><span></span><span class="nf">fish_config</span><span class="w"> </span><span class="g g-Other">[</span><span class="no">browse</span><span class="g g-Other">]</span>
<span class="nf">fish_config</span><span class="w"> </span><span class="no">prompt</span><span class="w"> </span><span class="g g-Other">(</span><span class="no">choose</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">list</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">save</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">show</span><span class="g g-Other">)</span>
<span class="nf">fish_config</span><span class="w"> </span><span class="no">theme</span><span class="w"> </span><span class="g g-Other">(</span><span class="no">choose</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">demo</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">dump</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">list</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">save</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">show</span><span class="g g-Other">)</span>
</pre></div>
</div>
</section>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Link to this heading">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">fish_config</span></code> is used to configure fish.</p>
<p>Without arguments or with the <code class="docutils literal notranslate"><span class="pre">browse</span></code> command it starts the web-based configuration interface. The web interface allows you to view your functions, variables and history, and to make changes to your prompt and color configuration. It starts a local web server and opens a browser window. When you are finished, close the browser window and press the Enter key to terminate the configuration session.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">BROWSER</span></code> environment variable is set, it will be used as the name of the web browser to open instead of the system default.</p>
<p>With the <code class="docutils literal notranslate"><span class="pre">prompt</span></code> command <code class="docutils literal notranslate"><span class="pre">fish_config</span></code> can be used to view and choose a prompt from fish’s sample prompts inside the terminal directly.</p>
<p>Available subcommands for the <code class="docutils literal notranslate"><span class="pre">prompt</span></code> command:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">choose</span></code> loads a sample prompt in the current session.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">list</span></code> lists the names of the available sample prompts.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">save</span></code> saves the current prompt to a file (via <a class="reference internal" href="funcsave.html"><span class="doc">funcsave</span></a>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">show</span></code> shows what the given sample prompts (or all) would look like.</p></li>
</ul>
<p>With the <code class="docutils literal notranslate"><span class="pre">theme</span></code> command <code class="docutils literal notranslate"><span class="pre">fish_config</span></code> can be used to view and choose a theme (meaning a color scheme) inside the terminal.</p>
<p>Available subcommands for the <code class="docutils literal notranslate"><span class="pre">theme</span></code> command:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">choose</span></code> loads a sample theme in the current session.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">demo</span></code> displays some sample text in the current theme.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dump</span></code> prints the current theme in a loadable format.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">list</span></code> lists the names of the available sample themes.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">save</span></code> saves the given theme to <a class="reference internal" href="../language.html#variables-universal"><span class="std std-ref">universal variables</span></a>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">show</span></code> shows what the given sample theme (or all) would look like.</p></li>
</ul>
<p>The <strong>-h</strong> or <strong>--help</strong> option displays help about using this command.</p>
</section>
<section id="theme-files">
<h2>Theme Files<a class="headerlink" href="#theme-files" title="Link to this heading">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">fish_config</span> <span class="pre">theme</span></code> and the theme selector in the web config tool load their themes from theme files. These are stored in the fish configuration directory, typically <code class="docutils literal notranslate"><span class="pre">~/.config/fish/themes</span></code>, with a .theme ending.</p>
<p>You can add your own theme by adding a file in that directory.</p>
<p>To get started quickly:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">fish_config</span><span class="w"> </span><span class="no">theme</span><span class="w"> </span><span class="no">dump</span><span class="w"> </span><span class="p">></span><span class="w"> </span><span class="p">~/.config/fish/themes/my.theme</span>
</pre></div>
</div>
<p>which will save your current theme in .theme format.</p>
<p>The format looks like this:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span># name: 'Cool Beans'
# preferred_background: black
fish_color_autosuggestion 666
fish_color_cancel -r
fish_color_command normal
fish_color_comment '888' '--italics'
fish_color_cwd 0A0
fish_color_cwd_root A00
fish_color_end 009900
</pre></div>
</div>
<p>The two comments at the beginning are the name and background that the web config tool shows.</p>
<p>The other lines are just like <code class="docutils literal notranslate"><span class="pre">set</span> <span class="pre">variable</span> <span class="pre">value</span></code>, except that no expansions are allowed. Quotes are, but aren’t necessary.</p>
<p>Any color variable fish knows about that the theme doesn’t set will be set to empty when it is loaded, so the old theme is completely overwritten.</p>
<p>Other than that, .theme files can contain any variable with a name that matches the regular expression <code class="docutils literal notranslate"><span class="pre">'^fish_(?:pager_)?color.*$'</span></code> - starts with <code class="docutils literal notranslate"><span class="pre">fish_</span></code>, an optional <code class="docutils literal notranslate"><span class="pre">pager_</span></code>, then <code class="docutils literal notranslate"><span class="pre">color</span></code> and then anything.</p>
</section>
<section id="example">
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">fish_config</span></code> or <code class="docutils literal notranslate"><span class="pre">fish_config</span> <span class="pre">browse</span></code> opens a new web browser window and allows you to configure certain fish settings.</p>
<p><code class="docutils literal notranslate"><span class="pre">fish_config</span> <span class="pre">prompt</span> <span class="pre">show</span></code> demos the available sample prompts.</p>
<p><code class="docutils literal notranslate"><span class="pre">fish_config</span> <span class="pre">prompt</span> <span class="pre">choose</span> <span class="pre">disco</span></code> makes the disco prompt the prompt for the current session. This can also be used in <a class="reference internal" href="../language.html#configuration"><span class="std std-ref">config.fish</span></a> to set the prompt.</p>
<p><code class="docutils literal notranslate"><span class="pre">fish_config</span> <span class="pre">prompt</span> <span class="pre">save</span></code> saves the current prompt to an <a class="reference internal" href="../language.html#syntax-function-autoloading"><span class="std std-ref">autoloaded</span></a> file.</p>
<p><code class="docutils literal notranslate"><span class="pre">fish_config</span> <span class="pre">prompt</span> <span class="pre">save</span> <span class="pre">default</span></code> chooses the default prompt and saves it.</p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li><img src="../_static/fish.png" alt=""
style="width: 80px; height: 80px; vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://fishshell.com/">fish-shell</a> »</li>
<a href="../index.html">fish-shell 4.2.1 documentation</a> »
<li class="nav-item nav-item-1"><a href="../commands.html" >Commands</a> »</li>
<li class="nav-item nav-item-this"><a href="">fish_config - start the web-based configuration interface</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</li>
<div id="old-docs-notice" style="display: none">
This documents an old version of fish.
<a href="../../current/">See the latest release.</a>
</div>
</ul>
</div>
<div class="footer">
© Copyright fish-shell developers.
<br />
<a href="https://github.com/fish-shell/fish-shell/issues">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</div>
<script type="text/javascript">
FISH_DOCS_VERSION = "4.2";
function copy_to_clipboard(it) {
// Find the pre tag we're interested in.
var pre = it.target;
while (pre.tagName != "PRE") pre = pre.parentNode;
var txt = "";
// Cheesy: If we have a prompt,
// we only copy prompted lines,
// by splitting and matching and stuff
if (pre.querySelector('span.gp')) {
var texts= [];
for (var line of pre.innerText.split('\n')) {
if (line.match(/^>_?.*/)) {
texts.push(line.replace(/^>_?/, ""));
}
}
txt = texts.join("\n");
} else {
// Even cheesier: If we don't have a prompt, we remove the button text from the end.
var txt = pre.innerText.substring(0, pre.innerText.length - it.target.innerText.length).trim();
}
navigator.clipboard.writeText(txt).then(function() {
// Success - set the text to indicate it,
// then set it back after 2 seconds.
var span = pre.querySelector("button span");
if (span) {
var oldText = span.innerText;
span.innerText = "COPIED!";
setTimeout(function() {
span.innerText = oldText;
}, 2000);
}
}, function() {
});
}
(function () {
// Add copy buttons to all the codeblocks.
var codeblocks = document.querySelectorAll('div > pre');
var button = document.createElement('button');
var span = document.createElement('span');
span.innerText = "COPY";
button.appendChild(span);
for (var i of codeblocks) {
var newButton = button.cloneNode(true);
newButton.addEventListener('click', copy_to_clipboard);
i.appendChild(newButton);
}
})();
</script>
</body>
</html>
|
