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
286
287
288
|
<!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>functions - print or erase functions — 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="help - display fish documentation" href="help.html" />
<link rel="prev" title="function - create a function" href="function.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="">functions - print or erase functions</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="#">functions - print or erase functions</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="#examples">Examples</a></li>
<li><a class="reference internal" href="#see-more">See more</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="functions-print-or-erase-functions">
<h1>functions - print or erase functions<a class="headerlink" href="#functions-print-or-erase-functions" 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">functions</span><span class="w"> </span><span class="g g-Other">[</span><span class="no">-a</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--all</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">--names</span><span class="g g-Other">]</span>
<span class="nf">functions</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">--details</span><span class="g g-Other">]</span><span class="w"> </span><span class="g g-Other">[</span><span class="no">-v</span><span class="g g-Other">]</span><span class="w"> </span><span class="no">FUNCTION</span>
<span class="nf">functions</span><span class="w"> </span><span class="no">-c</span><span class="w"> </span><span class="no">OLDNAME</span><span class="w"> </span><span class="no">NEWNAME</span>
<span class="nf">functions</span><span class="w"> </span><span class="no">-d</span><span class="w"> </span><span class="no">DESCRIPTION</span><span class="w"> </span><span class="no">FUNCTION</span>
<span class="nf">functions</span><span class="w"> </span><span class="g g-Other">[</span><span class="no">-e</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">-q</span><span class="g g-Other">]</span><span class="w"> </span><span class="no">FUNCTION</span><span class="w"> </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">functions</span></code> prints or erases functions.</p>
<p>The following options are available:</p>
<dl>
<dt><strong>-a</strong> or <strong>--all</strong></dt><dd><p>Lists all functions, even those whose name starts with an underscore.</p>
</dd>
<dt><strong>-c</strong> or <strong>--copy</strong> <em>OLDNAME</em> <em>NEWNAME</em></dt><dd><p>Creates a new function named <em>NEWNAME</em>, using the definition of the <em>OLDNAME</em> function.</p>
</dd>
<dt><strong>-d</strong> or <strong>--description</strong> <em>DESCRIPTION</em></dt><dd><p>Changes the description of this function.</p>
</dd>
<dt><strong>-e</strong> or <strong>--erase</strong></dt><dd><p>Causes the specified functions to be erased. This also means that it is prevented from autoloading in the current session. Use <a class="reference internal" href="funcsave.html"><span class="doc">funcsave</span></a> to remove the saved copy.</p>
</dd>
<dt><strong>-D</strong> or <strong>--details</strong></dt><dd><p>Reports the path name where the specified function is defined or could be autoloaded, <code class="docutils literal notranslate"><span class="pre">stdin</span></code> if the function was defined interactively or on the command line or by reading standard input, <strong>-</strong> if the function was created via <a class="reference internal" href="source.html"><span class="doc">source</span></a>, and <code class="docutils literal notranslate"><span class="pre">n/a</span></code> if the function isn’t available. (Functions created via <a class="reference internal" href="alias.html"><span class="doc">alias</span></a> will return <strong>-</strong>, because <code class="docutils literal notranslate"><span class="pre">alias</span></code> uses <code class="docutils literal notranslate"><span class="pre">source</span></code> internally. Copied functions will return where the function was copied.) If the <strong>--verbose</strong> option is also specified then five lines are written:</p>
<ul class="simple">
<li><p>the path name as already described,</p></li>
<li><p>if the function was copied, the path name to where the function was originally defined, otherwise <code class="docutils literal notranslate"><span class="pre">autoloaded</span></code>, <code class="docutils literal notranslate"><span class="pre">not-autoloaded</span></code> or <code class="docutils literal notranslate"><span class="pre">n/a</span></code>,</p></li>
<li><p>the line number within the file or zero if not applicable,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">scope-shadowing</span></code> if the function shadows the vars in the calling function (the normal case if it wasn’t defined with <strong>--no-scope-shadowing</strong>), else <code class="docutils literal notranslate"><span class="pre">no-scope-shadowing</span></code>, or <code class="docutils literal notranslate"><span class="pre">n/a</span></code> if the function isn’t defined,</p></li>
<li><p>the function description minimally escaped so it is a single line, or <code class="docutils literal notranslate"><span class="pre">n/a</span></code> if the function isn’t defined or has no description.</p></li>
</ul>
<p>You should not assume that only five lines will be written since we may add additional information to the output in the future.</p>
</dd>
<dt><strong>--no-details</strong></dt><dd><p>Turns off function path reporting, so just the definition will be printed.</p>
</dd>
<dt><strong>-n</strong> or <strong>--names</strong></dt><dd><p>Lists the names of all defined functions.</p>
</dd>
<dt><strong>-q</strong> or <strong>--query</strong></dt><dd><p>Tests if the specified functions exist.</p>
</dd>
<dt><strong>-v</strong> or <strong>--verbose</strong></dt><dd><p>Make some output more verbose.</p>
</dd>
<dt><strong>-H</strong> or <strong>--handlers</strong></dt><dd><p>Show all event handlers.</p>
</dd>
<dt><strong>-t</strong> or <strong>--handlers-type</strong> <em>TYPE</em></dt><dd><p>Show all event handlers matching the given <em>TYPE</em>.</p>
</dd>
<dt><strong>-h</strong> or <strong>--help</strong></dt><dd><p>Displays help about using this command.</p>
</dd>
</dl>
<p>The default behavior of <code class="docutils literal notranslate"><span class="pre">functions</span></code>, when called with no arguments, is to print the names of all defined functions. Unless the <code class="docutils literal notranslate"><span class="pre">-a</span></code> option is given, no functions starting with underscores are included in the output.</p>
<p>If any non-option parameters are given, the definition of the specified functions are printed.</p>
<p>Copying a function using <code class="docutils literal notranslate"><span class="pre">-c</span></code> copies only the body of the function, and does not attach any event notifications from the original function.</p>
<p>Only one function’s description can be changed in a single invocation of <code class="docutils literal notranslate"><span class="pre">functions</span> <span class="pre">-d</span></code>.</p>
<p>The exit status of <code class="docutils literal notranslate"><span class="pre">functions</span></code> is the number of functions specified in the argument list that do not exist, which can be used in concert with the <code class="docutils literal notranslate"><span class="pre">-q</span></code> option.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">¶</a></h2>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">functions</span><span class="w"> </span><span class="no">-n</span>
<span class="c"># Displays a list of currently-defined functions</span>
<span class="nf">functions</span><span class="w"> </span><span class="no">-c</span><span class="w"> </span><span class="no">foo</span><span class="w"> </span><span class="no">bar</span>
<span class="c"># Copies the 'foo' function to a new function called 'bar'</span>
<span class="nf">functions</span><span class="w"> </span><span class="no">-e</span><span class="w"> </span><span class="no">bar</span>
<span class="c"># Erases the function ``bar``</span>
</pre></div>
</div>
</section>
<section id="see-more">
<h2>See more<a class="headerlink" href="#see-more" title="Link to this heading">¶</a></h2>
<p>For more explanation of how functions fit into fish, see <a class="reference internal" href="../language.html#syntax-function"><span class="std std-ref">Functions</span></a>.</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="">functions - print or erase functions</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>
|
