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
|
<!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_delta - compare functions and completions to the default — 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_git_prompt - output git information for use in a prompt" href="fish_git_prompt.html" />
<link rel="prev" title="fish_default_key_bindings - set emacs key bindings for fish" href="fish_default_key_bindings.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_delta - compare functions and completions to the default</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_delta - compare functions and completions to the default</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="#options">Options</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-delta-compare-functions-and-completions-to-the-default">
<h1>fish_delta - compare functions and completions to the default<a class="headerlink" href="#fish-delta-compare-functions-and-completions-to-the-default" 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_delta</span><span class="w"> </span><span class="no">name</span><span class="w"> </span><span class="g g-Other">...</span>
<span class="nf">fish_delta</span><span class="w"> </span><span class="g g-Other">[</span><span class="no">-f</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--no-functions</span><span class="g g-Other">]</span><span class="w"> </span><span class="g g-Other">[</span><span class="no">-c</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--no-completions</span><span class="g g-Other">]</span><span class="w"> </span><span class="g g-Other">[</span><span class="no">-C</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--no-config</span><span class="g g-Other">]</span><span class="w"> </span><span class="g g-Other">[</span><span class="no">-d</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--no-diff</span><span class="g g-Other">]</span><span class="w"> </span><span class="g g-Other">[</span><span class="no">-n</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--new</span><span class="g g-Other">]</span><span class="w"> </span><span class="g g-Other">[</span><span class="no">-V</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--vendor=</span><span class="g g-Other">]</span>
<span class="nf">fish_delta</span><span class="w"> </span><span class="g g-Other">[</span><span class="no">-h</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--help</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>The <code class="docutils literal notranslate"><span class="pre">fish_delta</span></code> function tells you, at a glance, which of your functions and completions differ from the set that fish ships.</p>
<p>It does this by going through the relevant variables (<span class="target" id="index-0"></span><a class="reference internal" href="../language.html#envvar-fish_function_path"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">fish_function_path</span></code></a> for functions and <span class="target" id="index-1"></span><a class="reference internal" href="../language.html#envvar-fish_complete_path"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">fish_complete_path</span></code></a> for completions) and comparing the files against fish’s default directories.</p>
<p>If any names are given, it will only compare files by those names (plus a “.fish” extension).</p>
<p>By default, it will also use <code class="docutils literal notranslate"><span class="pre">diff</span></code> to display the difference between the files. If <code class="docutils literal notranslate"><span class="pre">diff</span></code> is unavailable, it will skip it, but in that case it also cannot figure out if the files really differ.</p>
<p>The exit status is 1 if there was a difference and 2 for other errors, otherwise 0.</p>
</section>
<section id="options">
<h2>Options<a class="headerlink" href="#options" title="Link to this heading">¶</a></h2>
<p>The following options are available:</p>
<dl class="simple">
<dt><strong>-f</strong> or <strong>--no-functions</strong></dt><dd><p>Stops checking functions</p>
</dd>
<dt><strong>-c</strong> or <strong>--no-completions</strong></dt><dd><p>Stops checking completions</p>
</dd>
<dt><strong>-C</strong> or <strong>--no-config</strong></dt><dd><p>Stops checking configuration files like config.fish or snippets in the conf.d directories.</p>
</dd>
<dt><strong>-d</strong> or <strong>--no-diff</strong></dt><dd><p>Removes the diff display (this happens automatically if <code class="docutils literal notranslate"><span class="pre">diff</span></code> can’t be found)</p>
</dd>
<dt><strong>-n</strong> or <strong>--new</strong></dt><dd><p>Also prints new files (i.e. those that can’t be found in fish’s default directories).</p>
</dd>
<dt><strong>-Vvalue</strong> or <strong>--vendor=value</strong></dt><dd><p>Determines how the vendor directories are counted. Valid values are:</p>
<ul class="simple">
<li><p>“default” - counts vendor files as belonging to the defaults. Any changes in other directories will be counted as changes over them. This is the default.</p></li>
<li><p>“user” - counts vendor files as belonging to the user files. Any changes in them will be counted as new or changed files.</p></li>
<li><p>“ignore” - ignores vendor directories. Files of the same name will be counted as “new” if no file of the same name in fish’s default directories exists.</p></li>
</ul>
</dd>
<dt><strong>-h</strong> or <strong>--help</strong></dt><dd><p>Prints <code class="docutils literal notranslate"><span class="pre">fish_delta</span></code>’s help (this).</p>
</dd>
</dl>
</section>
<section id="example">
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
<p>Running just:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">fish_delta</span>
</pre></div>
</div>
<p>will give you a list of all your changed functions and completions, including diffs (if you have the <code class="docutils literal notranslate"><span class="pre">diff</span></code> command).</p>
<p>It might look like this:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="gp">> </span><span class="nf">fish_delta</span>
<span class="go">New: /home/alfa/.config/fish/functions/battery.fish</span>
<span class="go">Changed: /home/alfa/.config/fish/test/completions/cargo.fish</span>
<span class="go">--- /home/alfa/.config/fish/test/completions/cargo.fish 2022-09-02 12:57:55.579229959 +0200</span>
<span class="go">+++ /usr/share/fish/completions/cargo.fish 2022-09-25 17:51:53.000000000 +0200</span>
<span class="go"># the output of `diff` follows</span>
</pre></div>
</div>
<p>The options are there to select which parts of the output you want. With <code class="docutils literal notranslate"><span class="pre">--no-completions</span></code> you can compare just functions, and with <code class="docutils literal notranslate"><span class="pre">--no-diff</span></code> you can turn off the <code class="docutils literal notranslate"><span class="pre">diff</span></code> display.</p>
<p>To only compare your <code class="docutils literal notranslate"><span class="pre">fish_git_prompt</span></code>, you might use:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">fish_delta</span><span class="w"> </span><span class="no">--no-completions</span><span class="w"> </span><span class="no">fish_git_prompt</span>
</pre></div>
</div>
<p>which will only compare files called “fish_git_prompt.fish”.</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_delta - compare functions and completions to the default</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>
|
