aboutsummaryrefslogtreecommitdiffhomepage
path: root/tools/fish.html
diff options
context:
space:
mode:
authorjohannst <johannst@users.noreply.github.com>2020-09-16 22:23:09 +0000
committerjohannst <johannst@users.noreply.github.com>2020-09-16 22:23:09 +0000
commit449b66753370d6b64bc9aa7e5c0592ba0fe6f680 (patch)
treeb245d2a3825031336b4a5779f1ab9fc54ce88f2b /tools/fish.html
parent78ecd047f07df42673eb63436fe4508d1c3b22cd (diff)
downloadnotes-449b66753370d6b64bc9aa7e5c0592ba0fe6f680.tar.gz
notes-449b66753370d6b64bc9aa7e5c0592ba0fe6f680.zip
deploy: 2e329ad934ef010fd94afe965f14ab895dcb515e
Diffstat (limited to 'tools/fish.html')
-rw-r--r--tools/fish.html369
1 files changed, 369 insertions, 0 deletions
diff --git a/tools/fish.html b/tools/fish.html
new file mode 100644
index 0000000..a632bfb
--- /dev/null
+++ b/tools/fish.html
@@ -0,0 +1,369 @@
+<!DOCTYPE HTML>
+<html lang="en" class="sidebar-visible no-js light">
+ <head>
+ <!-- Book generated using mdBook -->
+ <meta charset="UTF-8">
+ <title>fish - Notes</title>
+
+
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+ <meta name="description" content="">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <meta name="theme-color" content="#ffffff" />
+
+ <link rel="shortcut icon" href="../favicon.png">
+ <link rel="stylesheet" href="../css/variables.css">
+ <link rel="stylesheet" href="../css/general.css">
+ <link rel="stylesheet" href="../css/chrome.css">
+ <link rel="stylesheet" href="../css/print.css" media="print">
+
+ <!-- Fonts -->
+ <link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
+ <link href="https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800" rel="stylesheet" type="text/css">
+ <link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500" rel="stylesheet" type="text/css">
+
+ <!-- Highlight.js Stylesheets -->
+ <link rel="stylesheet" href="../highlight.css">
+ <link rel="stylesheet" href="../tomorrow-night.css">
+ <link rel="stylesheet" href="../ayu-highlight.css">
+
+ <!-- Custom theme stylesheets -->
+
+
+
+ </head>
+ <body>
+ <!-- Provide site root to javascript -->
+ <script type="text/javascript">
+ var path_to_root = "../";
+ var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "light" : "light";
+ </script>
+
+ <!-- Work around some values being stored in localStorage wrapped in quotes -->
+ <script type="text/javascript">
+ try {
+ var theme = localStorage.getItem('mdbook-theme');
+ var sidebar = localStorage.getItem('mdbook-sidebar');
+
+ if (theme.startsWith('"') && theme.endsWith('"')) {
+ localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
+ }
+
+ if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
+ localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
+ }
+ } catch (e) { }
+ </script>
+
+ <!-- Set the theme before any content is loaded, prevents flash -->
+ <script type="text/javascript">
+ var theme;
+ try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
+ if (theme === null || theme === undefined) { theme = default_theme; }
+ var html = document.querySelector('html');
+ html.classList.remove('no-js')
+ html.classList.remove('light')
+ html.classList.add(theme);
+ html.classList.add('js');
+ </script>
+
+ <!-- Hide / unhide sidebar before it is displayed -->
+ <script type="text/javascript">
+ var html = document.querySelector('html');
+ var sidebar = 'hidden';
+ if (document.body.clientWidth >= 1080) {
+ try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
+ sidebar = sidebar || 'visible';
+ }
+ html.classList.remove('sidebar-visible');
+ html.classList.add("sidebar-" + sidebar);
+ </script>
+
+ <nav id="sidebar" class="sidebar" aria-label="Table of contents">
+ <div id="sidebar-scrollbox" class="sidebar-scrollbox">
+ <ol class="chapter"><li class="expanded "><a href="../tools/index.html"><strong aria-hidden="true">1.</strong> Tools</a></li><li><ol class="section"><li class="expanded "><a href="../tools/zsh.html"><strong aria-hidden="true">1.1.</strong> zsh</a></li><li class="expanded "><a href="../tools/bash.html"><strong aria-hidden="true">1.2.</strong> bash</a></li><li class="expanded "><a href="../tools/fish.html" class="active"><strong aria-hidden="true">1.3.</strong> fish</a></li><li class="expanded "><a href="../tools/tmux.html"><strong aria-hidden="true">1.4.</strong> tmux</a></li><li class="expanded "><a href="../tools/git.html"><strong aria-hidden="true">1.5.</strong> git</a></li><li class="expanded "><a href="../tools/awk.html"><strong aria-hidden="true">1.6.</strong> awk</a></li><li class="expanded "><a href="../tools/emacs.html"><strong aria-hidden="true">1.7.</strong> emacs</a></li><li class="expanded "><a href="../tools/gdb.html"><strong aria-hidden="true">1.8.</strong> gdb</a></li><li class="expanded "><a href="../tools/radare2.html"><strong aria-hidden="true">1.9.</strong> radare2</a></li></ol></li><li class="expanded "><a href="../monitor/index.html"><strong aria-hidden="true">2.</strong> Resource analysis &amp; monitor</a></li><li><ol class="section"><li class="expanded "><a href="../monitor/lsof.html"><strong aria-hidden="true">2.1.</strong> lsof</a></li><li class="expanded "><a href="../monitor/pidstat.html"><strong aria-hidden="true">2.2.</strong> pidstat</a></li><li class="expanded "><a href="../monitor/pgrep.html"><strong aria-hidden="true">2.3.</strong> pgrep</a></li><li class="expanded "><a href="../monitor/pmap.html"><strong aria-hidden="true">2.4.</strong> pmap</a></li><li class="expanded "><a href="../monitor/pstack.html"><strong aria-hidden="true">2.5.</strong> pstack</a></li></ol></li><li class="expanded "><a href="../trace_profile/index.html"><strong aria-hidden="true">3.</strong> Trace and Profile</a></li><li><ol class="section"><li class="expanded "><a href="../trace_profile/strace.html"><strong aria-hidden="true">3.1.</strong> strace</a></li><li class="expanded "><a href="../trace_profile/ltrace.html"><strong aria-hidden="true">3.2.</strong> ltrace</a></li><li class="expanded "><a href="../trace_profile/perf.html"><strong aria-hidden="true">3.3.</strong> perf</a></li><li class="expanded "><a href="../trace_profile/oprofile.html"><strong aria-hidden="true">3.4.</strong> OProfile</a></li><li class="expanded "><a href="../trace_profile/time.html"><strong aria-hidden="true">3.5.</strong> time</a></li></ol></li><li class="expanded "><a href="../binary/index.html"><strong aria-hidden="true">4.</strong> Binary</a></li><li><ol class="section"><li class="expanded "><a href="../binary/od.html"><strong aria-hidden="true">4.1.</strong> od</a></li><li class="expanded "><a href="../binary/xxd.html"><strong aria-hidden="true">4.2.</strong> xxd</a></li><li class="expanded "><a href="../binary/readelf.html"><strong aria-hidden="true">4.3.</strong> readelf</a></li><li class="expanded "><a href="../binary/objdump.html"><strong aria-hidden="true">4.4.</strong> objdump</a></li><li class="expanded "><a href="../binary/nm.html"><strong aria-hidden="true">4.5.</strong> nm</a></li></ol></li><li class="expanded "><a href="../development/index.html"><strong aria-hidden="true">5.</strong> Development</a></li><li><ol class="section"><li class="expanded "><a href="../development/c++filt.html"><strong aria-hidden="true">5.1.</strong> c++filt</a></li><li class="expanded "><a href="../development/c++.html"><strong aria-hidden="true">5.2.</strong> c++</a></li><li class="expanded "><a href="../development/glibc.html"><strong aria-hidden="true">5.3.</strong> glibc</a></li><li class="expanded "><a href="../development/gcc.html"><strong aria-hidden="true">5.4.</strong> gcc</a></li><li class="expanded "><a href="../development/ld.so.html"><strong aria-hidden="true">5.5.</strong> ld.so</a></li></ol></li><li class="expanded "><a href="../arch/index.html"><strong aria-hidden="true">6.</strong> Arch</a></li><li><ol class="section"><li class="expanded "><a href="../arch/x86_64.html"><strong aria-hidden="true">6.1.</strong> x86_64</a></li></ol></li></ol>
+ </div>
+ <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
+ </nav>
+
+ <div id="page-wrapper" class="page-wrapper">
+
+ <div class="page">
+
+ <div id="menu-bar" class="menu-bar">
+ <div id="menu-bar-sticky-container">
+ <div class="left-buttons">
+ <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
+ <i class="fa fa-bars"></i>
+ </button>
+ <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
+ <i class="fa fa-paint-brush"></i>
+ </button>
+ <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
+ <li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
+ <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
+ <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
+ <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
+ <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
+ </ul>
+
+ <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
+ <i class="fa fa-search"></i>
+ </button>
+
+ </div>
+
+ <h1 class="menu-title">Notes</h1>
+
+ <div class="right-buttons">
+ <a href="../print.html" title="Print this book" aria-label="Print this book">
+ <i id="print-button" class="fa fa-print"></i>
+ </a>
+
+ </div>
+ </div>
+ </div>
+
+
+ <div id="search-wrapper" class="hidden">
+ <form id="searchbar-outer" class="searchbar-outer">
+ <input type="search" name="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
+ </form>
+ <div id="searchresults-outer" class="searchresults-outer hidden">
+ <div id="searchresults-header" class="searchresults-header"></div>
+ <ul id="searchresults">
+ </ul>
+ </div>
+ </div>
+
+
+ <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
+ <script type="text/javascript">
+ document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
+ document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
+ Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
+ link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
+ });
+ </script>
+
+ <div id="content" class="content">
+ <main>
+ <h1><a class="header" href="#fish1" id="fish1">fish(1)</a></h1>
+<h2><a class="header" href="#quick-info" id="quick-info">Quick Info</a></h2>
+<p>Fish initialization file <code>~/.config/fish/config.fish</code></p>
+<p>Switch between different key bindings:</p>
+<ul>
+<li><code>fish_default_key_bindings</code> to use default key bindings</li>
+<li><code>fish_vi_key_bindings</code> to use vi key bindings</li>
+</ul>
+<h2><a class="header" href="#variables" id="variables">Variables</a></h2>
+<p>Available scopes</p>
+<ul>
+<li><code>local</code> variable local to a block</li>
+<li><code>global</code> variable global to shell instance</li>
+<li><code>universal</code> variable universal to all shell instances + preserved across
+shell restart</li>
+</ul>
+<h3><a class="header" href="#setunset-variables" id="setunset-variables">Set/Unset Variables</a></h3>
+<pre><code class="language-text">set &lt;name&gt; [&lt;values&gt;]
+ -l local scope
+ -g global scope
+ -U universal scope
+ -e erase variable
+ -S show verbose info
+ -x export to ENV
+ -u unexport from ENV
+</code></pre>
+<h3><a class="header" href="#lists" id="lists">Lists</a></h3>
+<p>In <code>fish</code> all variables are lists (start with index <code>1</code>, but lists can't
+contain lists.</p>
+<pre><code class="language-text">set foo a b c d
+
+echo $foo[1] # a
+echo $foo[-1] # d
+echo $foo[2..3] # b c
+echo $foo[1 3] # a c
+</code></pre>
+<p><code>$</code> can be seen as dereference operator.</p>
+<pre><code class="language-text">set foo a; set a 1337
+echo $$foo # outputs 1337
+</code></pre>
+<p>Cartesian product.</p>
+<pre><code class="language-text">echo file.{h,cc}
+# file.h file.cc
+
+echo {a,b}{1,2}
+# a1 b1 b2
+</code></pre>
+<h3><a class="header" href="#special-variables-lists" id="special-variables-lists">Special Variables (Lists)</a></h3>
+<pre><code class="language-text">$status # exit code of last command
+$pipestatus # list of exit codes of pipe chain
+
+$CMD_DURATION # runtime of last command in ms
+</code></pre>
+<h4><a class="header" href="#path" id="path"><code>*PATH</code></a></h4>
+<p>Lists ending with <code>PATH</code> are automatically split at <code>:</code> when used and joined
+with <code>:</code> when exported to the environment.</p>
+<pre><code class="language-text">set -x BLA_PATH a:b:c:d
+echo $BLA_PATH # a b c d
+env | grep BLA_PATH # BLA_PATH=a:b:c:d
+</code></pre>
+<h2><a class="header" href="#command-handling" id="command-handling">Command Handling</a></h2>
+<pre><code class="language-text"># sub-commands are not run in quotes
+echo &quot;ls output: &quot;(ls)
+</code></pre>
+<h3><a class="header" href="#io-redirection" id="io-redirection">I/O redirection</a></h3>
+<pre><code class="language-text"># 'noclobber', fail if 'log' already exists
+echo foo &gt;? log
+</code></pre>
+<h2><a class="header" href="#control-flow" id="control-flow">Control Flow</a></h2>
+<h3><a class="header" href="#if--else" id="if--else"><code>if</code> / <code>else</code></a></h3>
+<pre><code class="language-text">if grep foo bar
+ # do sth
+else if grep foobar bar
+ # do sth else
+else
+ # do sth else
+end
+</code></pre>
+<h3><a class="header" href="#switch" id="switch"><code>switch</code></a></h3>
+<pre><code class="language-text">switch (echo foo)
+case 'foo*'
+ # do start with foo
+case bar dudel
+ # do bar and dudel
+case '*'
+ # do else
+end
+</code></pre>
+<h3><a class="header" href="#while-loop" id="while-loop"><code>while</code> Loop</a></h3>
+<pre><code class="language-text">while true
+ echo foo
+end
+</code></pre>
+<h3><a class="header" href="#for-loop" id="for-loop"><code>for</code> Loop</a></h3>
+<pre><code class="language-text">for f in (ls)
+ echo $f
+end
+</code></pre>
+<h2><a class="header" href="#functions" id="functions">Functions</a></h2>
+<p>Function arguments are passed via <code>$argv</code> list.</p>
+<pre><code class="language-text">function fn_foo
+ echo $argv
+end
+</code></pre>
+<h3><a class="header" href="#autoloading" id="autoloading">Autoloading</a></h3>
+<p>When running a command fish attempts to autoload a function. The shell looks
+for <code>&lt;cmd&gt;.fish</code> in the locations defined by <code>$fish_function_path</code> and loads
+the function lazily if found.</p>
+<p>This is the preferred way over monolithically defining all functions in a
+startup script.</p>
+<h3><a class="header" href="#helper" id="helper">Helper</a></h3>
+<pre><code class="language-text">functions # list al functions
+functions foo # describe function 'foo'
+functions -e foo # erase function 'foo'
+
+funced foo # edit function 'foo'
+ # '-e vim' to edit in vim
+</code></pre>
+<h2><a class="header" href="#prompt" id="prompt">Prompt</a></h2>
+<p>The prompt is defined by the output of the <code>fish_prompt</code> function.</p>
+<pre><code class="language-text">function fish_prompt
+ set -l cmd_ret
+ echo &quot;&gt; &quot;(pwd) $cmd_ret&quot; &quot;
+end
+</code></pre>
+<blockquote>
+<p>Use <code>set_color</code> to manipulate terminal colors.</p>
+</blockquote>
+<h2><a class="header" href="#useful-builtins" id="useful-builtins">Useful Builtins</a></h2>
+<pre><code class="language-text"># history
+history search &lt;str&gt; # search history for &lt;str&gt;
+history merge # merge histories from fish sessions
+
+# list
+count $var # count elements in list
+
+# string
+string split SEP STRING
+</code></pre>
+<h2><a class="header" href="#keymaps" id="keymaps">Keymaps</a></h2>
+<pre><code class="language-text"> Shift-Tab ........... tab-completion with search
+ Alt-Up / Alt-Down ... search history with token under the cursor
+ Alt-l ............... list content of dir under cursor
+ Alt-p ............... append '2&gt;&amp;1 | less;' to current cmdline
+</code></pre>
+<h2><a class="header" href="#debug" id="debug">Debug</a></h2>
+<pre><code class="language-text"> status print-stack-trace .. prints function stacktrace (can be used in scripts)
+ breakpoint ................ halt script execution and gives shell (C-d | exit
+ to continue)
+</code></pre>
+
+ </main>
+
+ <nav class="nav-wrapper" aria-label="Page navigation">
+ <!-- Mobile navigation buttons -->
+
+ <a rel="prev" href="../tools/bash.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+ <i class="fa fa-angle-left"></i>
+ </a>
+
+
+
+ <a rel="next" href="../tools/tmux.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+ <i class="fa fa-angle-right"></i>
+ </a>
+
+
+ <div style="clear: both"></div>
+ </nav>
+ </div>
+ </div>
+
+ <nav class="nav-wide-wrapper" aria-label="Page navigation">
+
+ <a href="../tools/bash.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+ <i class="fa fa-angle-left"></i>
+ </a>
+
+
+
+ <a href="../tools/tmux.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+ <i class="fa fa-angle-right"></i>
+ </a>
+
+ </nav>
+
+ </div>
+
+
+
+
+
+
+
+
+ <script type="text/javascript">
+ window.playpen_copyable = true;
+ </script>
+
+
+
+
+
+ <script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
+ <script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
+ <script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
+
+
+ <script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
+ <script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
+ <script src="../book.js" type="text/javascript" charset="utf-8"></script>
+
+ <!-- Custom JS scripts -->
+
+
+
+
+ </body>
+</html>