diff options
| author | johannst <johannst@users.noreply.github.com> | 2024-05-01 17:39:45 +0000 |
|---|---|---|
| committer | johannst <johannst@users.noreply.github.com> | 2024-05-01 17:39:45 +0000 |
| commit | 21a13652df728c9571f899caf4949d5d46f49db7 (patch) | |
| tree | dcd723453f6405c53a162da4c95896f5768f13d2 /tools/zsh.html | |
| parent | 269caa8ae18eb33e1286e4c21d434ea07228a619 (diff) | |
| download | notes-21a13652df728c9571f899caf4949d5d46f49db7.tar.gz notes-21a13652df728c9571f899caf4949d5d46f49db7.zip | |
deploy: 7ca41565c4e70b212cb88a4d18c18fa35768df6d
Diffstat (limited to 'tools/zsh.html')
| -rw-r--r-- | tools/zsh.html | 532 |
1 files changed, 0 insertions, 532 deletions
diff --git a/tools/zsh.html b/tools/zsh.html deleted file mode 100644 index e6ec715..0000000 --- a/tools/zsh.html +++ /dev/null @@ -1,532 +0,0 @@ -<!DOCTYPE HTML> -<html lang="en" class="light" dir="ltr"> - <head> - <!-- Book generated using mdBook --> - <meta charset="UTF-8"> - <title>zsh - Notes</title> - - - <!-- Custom HTML head --> - - <meta name="description" content=""> - <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="theme-color" content="#ffffff"> - - <link rel="icon" href="../favicon.svg"> - <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 rel="stylesheet" href="../fonts/fonts.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 class="sidebar-visible no-js"> - <div id="body-container"> - <!-- Provide site root to javascript --> - <script> - var path_to_root = "../"; - var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light"; - </script> - - <!-- Work around some values being stored in localStorage wrapped in quotes --> - <script> - 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> - 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('light') - html.classList.add(theme); - var body = document.querySelector('body'); - body.classList.remove('no-js') - body.classList.add('js'); - </script> - - <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> - - <!-- Hide / unhide sidebar before it is displayed --> - <script> - var body = document.querySelector('body'); - var sidebar = null; - var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); - if (document.body.clientWidth >= 1080) { - try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } - sidebar = sidebar || 'visible'; - } else { - sidebar = 'hidden'; - } - sidebar_toggle.checked = sidebar === 'visible'; - body.classList.remove('sidebar-visible'); - body.classList.add("sidebar-" + sidebar); - </script> - - <nav id="sidebar" class="sidebar" aria-label="Table of contents"> - <div class="sidebar-scrollbox"> - <ol class="chapter"><li class="chapter-item expanded affix "><a href="../intro.html">Introduction</a></li><li class="chapter-item expanded "><a href="../tools/index.html"><strong aria-hidden="true">1.</strong> Tools</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../tools/zsh.html" class="active"><strong aria-hidden="true">1.1.</strong> zsh</a></li><li class="chapter-item expanded "><a href="../tools/bash.html"><strong aria-hidden="true">1.2.</strong> bash</a></li><li class="chapter-item expanded "><a href="../tools/fish.html"><strong aria-hidden="true">1.3.</strong> fish</a></li><li class="chapter-item expanded "><a href="../tools/tmux.html"><strong aria-hidden="true">1.4.</strong> tmux</a></li><li class="chapter-item expanded "><a href="../tools/git.html"><strong aria-hidden="true">1.5.</strong> git</a></li><li class="chapter-item expanded "><a href="../tools/awk.html"><strong aria-hidden="true">1.6.</strong> awk</a></li><li class="chapter-item expanded "><a href="../tools/emacs.html"><strong aria-hidden="true">1.7.</strong> emacs</a></li><li class="chapter-item expanded "><a href="../tools/gpg.html"><strong aria-hidden="true">1.8.</strong> gpg</a></li><li class="chapter-item expanded "><a href="../tools/gdb.html"><strong aria-hidden="true">1.9.</strong> gdb</a></li><li class="chapter-item expanded "><a href="../tools/gdbserver.html"><strong aria-hidden="true">1.10.</strong> gdbserver</a></li><li class="chapter-item expanded "><a href="../tools/radare2.html"><strong aria-hidden="true">1.11.</strong> radare2</a></li><li class="chapter-item expanded "><a href="../tools/qemu.html"><strong aria-hidden="true">1.12.</strong> qemu</a></li><li class="chapter-item expanded "><a href="../tools/pacman.html"><strong aria-hidden="true">1.13.</strong> pacman</a></li><li class="chapter-item expanded "><a href="../tools/dot.html"><strong aria-hidden="true">1.14.</strong> dot</a></li><li class="chapter-item expanded "><a href="../tools/ffmpeg.html"><strong aria-hidden="true">1.15.</strong> ffmpeg</a></li><li class="chapter-item expanded "><a href="../tools/column.html"><strong aria-hidden="true">1.16.</strong> column</a></li><li class="chapter-item expanded "><a href="../tools/sort.html"><strong aria-hidden="true">1.17.</strong> sort</a></li><li class="chapter-item expanded "><a href="../tools/sed.html"><strong aria-hidden="true">1.18.</strong> sed</a></li><li class="chapter-item expanded "><a href="../tools/gnuplot.html"><strong aria-hidden="true">1.19.</strong> gnuplot</a></li></ol></li><li class="chapter-item expanded "><a href="../monitor/index.html"><strong aria-hidden="true">2.</strong> Resource analysis & monitor</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../monitor/lsof.html"><strong aria-hidden="true">2.1.</strong> lsof</a></li><li class="chapter-item expanded "><a href="../monitor/ss.html"><strong aria-hidden="true">2.2.</strong> ss</a></li><li class="chapter-item expanded "><a href="../monitor/pidstat.html"><strong aria-hidden="true">2.3.</strong> pidstat</a></li><li class="chapter-item expanded "><a href="../monitor/pgrep.html"><strong aria-hidden="true">2.4.</strong> pgrep</a></li><li class="chapter-item expanded "><a href="../monitor/ps.html"><strong aria-hidden="true">2.5.</strong> ps</a></li><li class="chapter-item expanded "><a href="../monitor/pmap.html"><strong aria-hidden="true">2.6.</strong> pmap</a></li><li class="chapter-item expanded "><a href="../monitor/pstack.html"><strong aria-hidden="true">2.7.</strong> pstack</a></li></ol></li><li class="chapter-item expanded "><a href="../trace_profile/index.html"><strong aria-hidden="true">3.</strong> Trace and Profile</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../trace_profile/time.html"><strong aria-hidden="true">3.1.</strong> time</a></li><li class="chapter-item expanded "><a href="../trace_profile/strace.html"><strong aria-hidden="true">3.2.</strong> strace</a></li><li class="chapter-item expanded "><a href="../trace_profile/ltrace.html"><strong aria-hidden="true">3.3.</strong> ltrace</a></li><li class="chapter-item expanded "><a href="../trace_profile/perf.html"><strong aria-hidden="true">3.4.</strong> perf</a></li><li class="chapter-item expanded "><a href="../trace_profile/oprofile.html"><strong aria-hidden="true">3.5.</strong> OProfile</a></li><li class="chapter-item expanded "><a href="../trace_profile/callgrind.html"><strong aria-hidden="true">3.6.</strong> callgrind</a></li></ol></li><li class="chapter-item expanded "><a href="../binary/index.html"><strong aria-hidden="true">4.</strong> Binary</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../binary/od.html"><strong aria-hidden="true">4.1.</strong> od</a></li><li class="chapter-item expanded "><a href="../binary/xxd.html"><strong aria-hidden="true">4.2.</strong> xxd</a></li><li class="chapter-item expanded "><a href="../binary/readelf.html"><strong aria-hidden="true">4.3.</strong> readelf</a></li><li class="chapter-item expanded "><a href="../binary/objdump.html"><strong aria-hidden="true">4.4.</strong> objdump</a></li><li class="chapter-item expanded "><a href="../binary/nm.html"><strong aria-hidden="true">4.5.</strong> nm</a></li></ol></li><li class="chapter-item expanded "><a href="../development/index.html"><strong aria-hidden="true">5.</strong> Development</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../development/c++filt.html"><strong aria-hidden="true">5.1.</strong> c++filt</a></li><li class="chapter-item expanded "><a href="../development/c++.html"><strong aria-hidden="true">5.2.</strong> c++</a></li><li class="chapter-item expanded "><a href="../development/glibc.html"><strong aria-hidden="true">5.3.</strong> glibc</a></li><li class="chapter-item expanded "><a href="../development/gcc.html"><strong aria-hidden="true">5.4.</strong> gcc</a></li><li class="chapter-item expanded "><a href="../development/cmake.html"><strong aria-hidden="true">5.5.</strong> cmake</a></li><li class="chapter-item expanded "><a href="../development/make.html"><strong aria-hidden="true">5.6.</strong> make</a></li><li class="chapter-item expanded "><a href="../development/ld.so.html"><strong aria-hidden="true">5.7.</strong> ld.so</a></li><li class="chapter-item expanded "><a href="../development/symbolver.html"><strong aria-hidden="true">5.8.</strong> symbol versioning</a></li><li class="chapter-item expanded "><a href="../development/python.html"><strong aria-hidden="true">5.9.</strong> python</a></li><li class="chapter-item expanded "><a href="../development/gcov.html"><strong aria-hidden="true">5.10.</strong> gcov</a></li><li class="chapter-item expanded "><a href="../development/pgo.html"><strong aria-hidden="true">5.11.</strong> pgo</a></li></ol></li><li class="chapter-item expanded "><a href="../linux/index.html"><strong aria-hidden="true">6.</strong> Linux</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../linux/systemd.html"><strong aria-hidden="true">6.1.</strong> systemd</a></li><li class="chapter-item expanded "><a href="../linux/coredump.html"><strong aria-hidden="true">6.2.</strong> coredump</a></li><li class="chapter-item expanded "><a href="../linux/ptrace_scope.html"><strong aria-hidden="true">6.3.</strong> ptrace_scope</a></li><li class="chapter-item expanded "><a href="../linux/cryptsetup.html"><strong aria-hidden="true">6.4.</strong> cryptsetup</a></li><li class="chapter-item expanded "><a href="../linux/swap.html"><strong aria-hidden="true">6.5.</strong> swap</a></li><li class="chapter-item expanded "><a href="../linux/input.html"><strong aria-hidden="true">6.6.</strong> input</a></li><li class="chapter-item expanded "><a href="../linux/acl.html"><strong aria-hidden="true">6.7.</strong> acl</a></li><li class="chapter-item expanded "><a href="../linux/zfs.html"><strong aria-hidden="true">6.8.</strong> zfs</a></li></ol></li><li class="chapter-item expanded "><a href="../network/index.html"><strong aria-hidden="true">7.</strong> Network</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../network/tcpdump.html"><strong aria-hidden="true">7.1.</strong> tcpdump</a></li><li class="chapter-item expanded "><a href="../network/tshark.html"><strong aria-hidden="true">7.2.</strong> tshark</a></li><li class="chapter-item expanded "><a href="../network/firewall-cmd.html"><strong aria-hidden="true">7.3.</strong> firewall-cmd</a></li><li class="chapter-item expanded "><a href="../network/nftables.html"><strong aria-hidden="true">7.4.</strong> nftables</a></li></ol></li><li class="chapter-item expanded "><a href="../web/index.html"><strong aria-hidden="true">8.</strong> Web</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../web/html.html"><strong aria-hidden="true">8.1.</strong> html</a></li><li class="chapter-item expanded "><a href="../web/css.html"><strong aria-hidden="true">8.2.</strong> css</a></li><li class="chapter-item expanded "><a href="../web/chartjs.html"><strong aria-hidden="true">8.3.</strong> chartjs</a></li></ol></li><li class="chapter-item expanded "><a href="../arch/index.html"><strong aria-hidden="true">9.</strong> Arch</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../arch/x86_64.html"><strong aria-hidden="true">9.1.</strong> x86_64</a></li><li class="chapter-item expanded "><a href="../arch/arm64.html"><strong aria-hidden="true">9.2.</strong> arm64</a></li><li class="chapter-item expanded "><a href="../arch/armv7.html"><strong aria-hidden="true">9.3.</strong> armv7</a></li><li class="chapter-item expanded "><a href="../arch/riscv.html"><strong aria-hidden="true">9.4.</strong> riscv</a></li></ol></li></ol> - </div> - <div id="sidebar-resize-handle" class="sidebar-resize-handle"> - <div class="sidebar-resize-indicator"></div> - </div> - </nav> - - <!-- Track and set sidebar scroll position --> - <script> - var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox'); - sidebarScrollbox.addEventListener('click', function(e) { - if (e.target.tagName === 'A') { - sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop); - } - }, { passive: true }); - var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll'); - sessionStorage.removeItem('sidebar-scroll'); - if (sidebarScrollTop) { - // preserve sidebar scroll position when navigating via links within sidebar - sidebarScrollbox.scrollTop = sidebarScrollTop; - } else { - // scroll sidebar to current active section when navigating via "next/previous chapter" buttons - var activeSection = document.querySelector('#sidebar .active'); - if (activeSection) { - activeSection.scrollIntoView({ block: 'center' }); - } - } - </script> - - <div id="page-wrapper" class="page-wrapper"> - - <div class="page"> - <div id="menu-bar-hover-placeholder"></div> - <div id="menu-bar" class="menu-bar sticky"> - <div class="left-buttons"> - <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> - <i class="fa fa-bars"></i> - </label> - <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</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> - <a href="https://github.com/johannst/notes" title="Git repository" aria-label="Git repository"> - <i id="git-repository-button" class="fa fa-github"></i> - </a> - - </div> - </div> - - <div id="search-wrapper" class="hidden"> - <form id="searchbar-outer" class="searchbar-outer"> - <input type="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> - 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 id="zsh1"><a class="header" href="#zsh1">zsh(1)</a></h1> -<h2 id="keybindings"><a class="header" href="#keybindings">Keybindings</a></h2> -<p>Change input mode:</p> -<pre><code class="language-zsh">bindkey -v change to vi keymap -bindkey -e change to emacs keymap -</code></pre> -<p>Define key-mappings:</p> -<pre><code class="language-zsh">bindkey list mappings in current keymap -bindkey in-str cmd create mapping for `in-str` to `cmd` -bindkey -r in-str remove binding for `in-str` - -# C-v <key> dump <key> code, which can be used in `in-str` -# zle -l list all functions for keybindings -# man zshzle(1) STANDARD WIDGETS: get description of functions -</code></pre> -<p>Access edit buffer in zle widget:</p> -<pre><code class="language-zsh">$BUFFER # Entire edit buffer content -$LBUFFER # Edit buffer content left to cursor -$RBUFFER # Edit buffer content right to cursor - -# create zle widget which adds text right of the cursor -function add-text() { - RBUFFER="some text $RBUFFER" -} -zle -N add-text - -bindkey "^p" add-text -</code></pre> -<h2 id="parameter"><a class="header" href="#parameter">Parameter</a></h2> -<p>Default value:</p> -<pre><code class="language-zsh"># default value -echo ${foo:-defval} # defval -foo=bar -echo ${foo:-defval} # bar -</code></pre> -<p>Alternative value:</p> -<pre><code class="language-zsh">echo ${foo:+altval} # '' -foo=bar -echo ${foo:+altval} # altval -</code></pre> -<p>Check variable set, error if not set:</p> -<pre><code class="language-zsh">echo ${foo:?msg} # print `msg` and return errno `1` -foo=bar -echo ${foo:?msg} # bar -</code></pre> -<p>Sub-string <code>${var:offset:length}</code>:</p> -<pre><code class="language-zsh">foo=abcdef -echo ${foo:1:3} # bcd -</code></pre> -<p>Trim prefix <code>${var#prefix}</code>:</p> -<pre><code class="language-zsh">foo=bar.baz -echo ${foo#bar} # .baz -</code></pre> -<p>Trim suffix <code>${var%suffix}</code>:</p> -<pre><code class="language-zsh">foo=bar.baz -echo ${foo%.baz} # bar -</code></pre> -<p>Substitute pattern <code>${var/pattern/replace}</code>:</p> -<pre><code class="language-zsh">foo=aabbccbbdd -echo ${foo/bb/XX} # aaXXccbbdd -echo ${foo//bb/XX} # aaXXccXXdd -# replace prefix -echo ${foo/#bb/XX} # aabbccbbdd -echo ${foo/#aa/XX} # XXbbccbbdd -# replace suffix -echo ${foo/%bb/XX} # aabbccbbdd -echo ${foo/%dd/XX} # aabbccbbXX -</code></pre> -<blockquote> -<p>Note: <code>prefix</code>/<code>suffix</code>/<code>pattern</code> are expanded as pathnames.</p> -</blockquote> -<h2 id="variables"><a class="header" href="#variables">Variables</a></h2> -<pre><code class="language-zsh"># Variable with local scope -local var=val - -# Read-only variable -readonly var=bal -</code></pre> -<p>Indexed arrays:</p> -<pre><code class="language-zsh">arr=(aa bb cc dd) -echo $arr[1] # aa -echo $arr[-1] # dd - -arr+=(ee) -echo $arr[-1] # ee - -echo $arr[1,3] # aa bb cc -</code></pre> -<p>Associative arrays:</p> -<pre><code class="language-zsh">typeset -A arr -arr[x]='aa' -arr[y]='bb' -echo $arr[x] # aa -</code></pre> -<p>Tied arrays:</p> -<pre><code class="language-zsh">typeset -T VEC vec=(1 2 3) '|' - -echo $vec # 1 2 3 -echo $VEC # 1|2|3 -</code></pre> -<p>Unique arrays (set):</p> -<pre><code>typeset -U vec=(1 2 3) - -echo $vec # 1 2 3 -vec+=(1 2 4) -echo $vec # 1 2 3 4 -</code></pre> -<h3 id="expansion-flags"><a class="header" href="#expansion-flags">Expansion Flags</a></h3> -<p>Join array to string <code>j:sep:</code>:</p> -<pre><code class="language-zsh">foo=(1 2 3 4) -echo ${(j:-:)foo} # 1-2-3-4 -echo ${(j:\n:)foo} # join with new lines -</code></pre> -<p>Split string to array <code>s:sep</code>:</p> -<pre><code class="language-zsh">foo='1-2-3-4' -bar=(${(s:-:)foo}) # capture as array -echo $bar # 1 2 3 4 -echo $bar[2] # 2 -</code></pre> -<p>Upper/Lower case string:</p> -<pre><code class="language-zsh">foo=aaBB -echo ${(L)foo} # aabb -echo ${(U)foo} # AABB -</code></pre> -<p>Key/values in associative arrays:</p> -<pre><code class="language-zsh">typeset -A vec; vec[a]='aa'; vec[b]='bb' - -echo ${(k)vec} # a b -echo ${(v)vec} # aa bb -echo ${(kv)vec} # a aa b bb - -# Iterate over key value pairs. -for k v in ${(kv)vec)}; do ...; done -</code></pre> -<h2 id="io-redirections"><a class="header" href="#io-redirections">I/O redirections</a></h2> -<p>See <a href="bash.html#io-redirection">bash - I/O redirection</a></p> -<h2 id="process-substitution"><a class="header" href="#process-substitution">Process substitution</a></h2> -<p>Process substitution allows to redirect the stdout of multiple processes at -once.</p> -<pre><code class="language-bash">vim -d <(grep foo bar) <(grep foo moose) -</code></pre> -<h2 id="argument-parsing-with-zparseopts"><a class="header" href="#argument-parsing-with-zparseopts">Argument parsing with <code>zparseopts</code></a></h2> -<pre><code class="language-zsh">zparseopts [-D] [-E] [-A assoc] specs -</code></pre> -<p>Arguments are copied into the associative array <code>assoc</code> according to <code>specs</code>. -Each spec is described by an entry as <code>opt[:][=array]</code>.</p> -<ul> -<li><code>opt</code> is the option without the <code>-</code> char. Passing <code>-f</code> is matched against <code>f</code> -opt, <code>--long</code> is matched against <code>-long</code>.</li> -<li>Using <code>:</code> means the option will take an argument.</li> -<li>The optional <code>=array</code> specifies an alternate storage container where this -option should be stored.</li> -</ul> -<blockquote> -<p>Documentation can be found in <code>man zshmodules</code>.</p> -</blockquote> -<h3 id="example"><a class="header" href="#example">Example</a></h3> -<pre><code class="language-zsh">#!/bin/zsh -function test() { - zparseopts -D -E -A opts f=flag o: -long: - echo "flag $flag" - echo "o $opts[-o]" - echo "long $opts[--long]" - echo "pos $1" -} - -test -f -o OPTION --long LONG_OPT POSITIONAL - -# Outputs: -# flag -f -# o OPTION -# long LONG_OPT -# pos POSITIONAL -</code></pre> -<h2 id="regular-expressions"><a class="header" href="#regular-expressions">Regular Expressions</a></h2> -<p>Zsh supports regular expression matching with the binary operator <code>=~</code>. -The match results can be accessed via the <code>$MATCH</code> variable and -<code>$match</code> indexed array:</p> -<ul> -<li><code>$MATCH</code> contains the full match</li> -<li><code>$match[1]</code> contains match of the first capture group</li> -</ul> -<pre><code class="language-zsh">INPUT='title foo : 1234' -REGEX='^title (.+) : ([0-9]+)$' -if [[ $INPUT =~ $REGEX ]]; then - echo "$MATCH" # title foo : 1234 - echo "$match[1]" # foo - echo "$match[2]" # 1234 -fi -</code></pre> -<h2 id="completion"><a class="header" href="#completion">Completion</a></h2> -<h3 id="installation"><a class="header" href="#installation">Installation</a></h3> -<p>Completion functions are provided via files and need to be placed in a location -covered by <code>$fpath</code>. By convention the completion files are names as <code>_<CMD></code>.</p> -<p>A completion skeleton for the command <code>foo</code>, stored in <code>_foo</code></p> -<pre><code class="language-zsh">#compdef _foo foo - -function _foo() { - ... -} -</code></pre> -<p>Alternatively one can install a completion function explicitly by calling <code>compdef <FUNC> <CMD></code>.</p> -<h3 id="completion-variables"><a class="header" href="#completion-variables">Completion Variables</a></h3> -<p>Following variables are available in Completion functions:</p> -<pre><code class="language-zsh">$words # array with command line in words -$#words # number words -$CURRENT # index into $words for cursor position -$words[CURRENT-1] # previous word (relative to cursor position) -</code></pre> -<h3 id="completion-functions"><a class="header" href="#completion-functions">Completion Functions</a></h3> -<ul> -<li><code>_describe</code> simple completion, just words + description</li> -<li><code>_arguments</code> sophisticated completion, allow to specify actions</li> -</ul> -<h4 id="completion-with-_describe"><a class="header" href="#completion-with-_describe">Completion with <a href="http://zsh.sourceforge.net/Doc/Release/Completion-System.html#Completion-Functions"><code>_describe</code></a></a></h4> -<pre><code class="language-zsh">_describe MSG COMP -</code></pre> -<ul> -<li><code>MSG</code> simple string with header message</li> -<li><code>COMP</code> array of completions where each entry is <code>"opt:description"</code></li> -</ul> -<pre><code class="language-zsh">function _foo() { - local -a opts - opts=('bla:desc for bla' 'blu:desc for blu') - _describe 'foo-msg' opts -} -compdef _foo foo - -foo <TAB><TAB> - -- foo-msg -- -bla -- desc for bla -blu -- desc for blu -</code></pre> -<h4 id="completion-with-_arguments"><a class="header" href="#completion-with-_arguments">Completion with <a href="http://zsh.sourceforge.net/Doc/Release/Completion-System.html#Completion-Functions"><code>_arguments</code></a></a></h4> -<pre><code class="language-zsh">_arguments SPEC [SPEC...] -</code></pre> -<p>where <code>SPEC</code> can have one of the following forms:</p> -<ul> -<li><code>OPT[DESC]:MSG:ACTION</code> for option flags</li> -<li><code>N:MSG:ACTION</code> for positional arguments</li> -</ul> -<p>Available actions</p> -<pre><code class="language-zsh">(op1 op2) list possible matches -->VAL set $state=VAL and continue, `$state` can be checked later in switch case -FUNC call func to generate matches -{STR} evaluate `STR` to generate matches -</code></pre> -<h3 id="example-1"><a class="header" href="#example-1">Example</a></h3> -<p>Skeleton to copy/paste for writing simple completions.</p> -<p>Assume a program <code>foo</code> with the following interface:</p> -<pre><code class="language-zsh">foo -c green|red|blue -s low|high -f <file> -d <dir> -h -</code></pre> -<p>The completion handler could be implemented as follows in a file called <code>_foo</code>:</p> -<pre><code class="language-zsh">#compdef _foo foo - -function _foo_color() { - local colors=() - colors+=('green:green color') - colors+=('red:red color') - colors+=('blue:blue color') - _describe "color" colors -} - -function _foo() { - _arguments \ - "-c[define color]:color:->s_color" \ - "-s[select sound]:sound:(low high)" \ - "-f[select file]:file:_files" \ - "-d[select dir]:dir:_files -/" \ - "-h[help]" - - case $state in - s_color) _foo_color;; - esac -} -</code></pre> -<h3 id="example-with-optional-arguments"><a class="header" href="#example-with-optional-arguments">Example with optional arguments</a></h3> -<p>For this example we assume that the command <code>foo</code> takes at least three optional -arguments such as</p> -<pre><code class="language-zsh">foo arg1 arg2 arg3 [argN..] -</code></pre> -<pre><code class="language-zsh">function _foo() { - _arguments \ - "1:opt 1:(a b c)" \ - ":opt next:(d e f)" \ - "*:opt all:(u v w)" -} -</code></pre> -<p>Explanation:</p> -<ul> -<li><code>1:MSG:ACTION</code> sets completion for the <strong>first</strong> optional argument</li> -<li><code>:MSG:ACTION</code> sets completion for the <strong>next</strong> optional argument</li> -<li><code>*:MSG:ACTION</code> sets completion for the optional argument where none of the -previous rules apply, so in our example for <code>arg3, argN..</code>.</li> -</ul> -<blockquote> -<p><code>_files</code> is a zsh builtin utility function to complete files/dirs see</p> -<ul> -<li><a href="http://zsh.sourceforge.net/Doc/Release/Completion-System.html#Completion-Functions">zsh completion functions</a></li> -<li><a href="https://github.com/zsh-users/zsh-completions/blob/master/zsh-completions-howto.org#utility-functions">zsh completion utility functions</a></li> -</ul> -</blockquote> - - </main> - - <nav class="nav-wrapper" aria-label="Page navigation"> - <!-- Mobile navigation buttons --> - <a rel="prev" href="../tools/index.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 prefetch" href="../tools/bash.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 rel="prev" href="../tools/index.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> - <i class="fa fa-angle-left"></i> - </a> - - <a rel="next prefetch" href="../tools/bash.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> - window.playground_copyable = true; - </script> - - - <script src="../elasticlunr.min.js"></script> - <script src="../mark.min.js"></script> - <script src="../searcher.js"></script> - - <script src="../clipboard.min.js"></script> - <script src="../highlight.js"></script> - <script src="../book.js"></script> - - <!-- Custom JS scripts --> - - - </div> - </body> -</html> |