libs/env-windows
libs
/
env-windows
4
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update clink

This commit is contained in:
Meco Man 2023-08-28 00:58:57 -04:00
parent 7eedfd97b1
commit e863a8c47d
12 changed files with 1091 additions and 904 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
tools/ConEmu/ConEmu/clink/CHANGES
View File

@ -2,6 +2,31 @@
### Releases from [chrisant996/clink](https://github.com/chrisant996/clink) fork ### Releases from [chrisant996/clink](https://github.com/chrisant996/clink) fork
#### v1.5.4
- Further contrast improvements for default colors to be readable in both Dark and Light terminal themes.
- Added `arginfo` field in `builder:addmatches()` and in match display filtering.
- Auto-suggestions are no longer shown while searching history; it was too distracting and confusing.
- Fixed updating the input line display after using `clink-popup-history` or `win-popup-history` (regression introduced in v1.5.3).
- Fixed `old-menu-complete` and `menu-complete` when there's only one match. The first time it should insert the match, and subsequent times should ding instead of cycling through the same match over and over and requiring an equal number of `undo` to undo.
- Fixed match display filtering to support the `match.substring` setting.
- Fixed match display filtering to support the `files.system` setting.
- Fixed the cursor position if match display filtering happens the first time `clink-select-complete` is used in a session.
- Fixed a case where two `undo` were required to fully undo what `menu-complete` inserted.
- Fixed <kbd>Esc</kbd> during incremental history search mode so it cancels the search.
- Fixed input line coloring after `non-incremental-reverse-search-history` or `non-incremental-forward-search-history` finds an exact match for the search text (since v1.1.5).
- Internal changes and optimizations.
#### v1.5.3
- Added `builder:setfullyqualified()` to force completions to be inserted as fully qualified path names.
- Completions for <code>clink set <span class="arg">setting_name</span> <span class="arg">input</span></code> use fully qualified path names for <span class="arg">input</span>. This helps avoid accidentally setting relative paths in global settings; since the current directory changes frequently, setting relative paths usually leads to unintended consequences.
- Only load a script from a `completions\` directory if the associated command exists in the file system. Also, pass the fully qualified file name as input to the script (in Lua, use `...` to get script arguments, e.g. `local command = ...`).
- `clink info` now reports whether Clink is injected.
- Improve efficiency of updating the input line display. This eliminates some redundant processing in the Readline library and in Clink.
- Fixed input line parsing and coloring when the `doskey.enhanced` setting is off or when doskey macro expansion is suppressed.
- Fixed `line_state:getwordinfo()` to accurately set the `.alias` field when the `doskey.enhanced` setting is off or when doskey macro expansion is suppressed.
- Fixed coloring the command word in the command line when queued keys select and accept a command line from history instantly (it could accidentally continue without applying the appropriate coloring).
- Fixed script error in `clink.filematches(nil)` and `clink.dirmatches(nil)`; they were meant to behave the same as passing an empty string.
#### v1.5.2 #### v1.5.2
- Adjusted the colors in "Use enhanced defaults" to have sufficient contrast to be readable in both Dark and Light terminal themes. - Adjusted the colors in "Use enhanced defaults" to have sufficient contrast to be readable in both Dark and Light terminal themes.
- More reliably detect whether hosted in Windows Terminal, and even when Windows Terminal is set as the default terminal application. - More reliably detect whether hosted in Windows Terminal, and even when Windows Terminal is set as the default terminal application.

1350
tools/ConEmu/ConEmu/clink/LICENSE
View File

File diff suppressed because it is too large Load Diff

26
tools/ConEmu/ConEmu/clink/_default_inputrc
View File

@ -1,13 +1,13 @@
# When this file is named "default_inputrc" and is in the binaries # When this file is named "default_inputrc" and is in the binaries
# directory or profile directory, it provides enhanced default settings. # directory or profile directory, it provides enhanced default settings.
# Override the built-in Readline defaults with ones that provide a more # Override the built-in Readline defaults with ones that provide a more
# enhanced Clink experience. # enhanced Clink experience.
colored-completion-prefix on colored-completion-prefix on
colored-stats on colored-stats on
mark-symlinked-directories on mark-symlinked-directories on
completion-auto-query-items on completion-auto-query-items on
history-point-at-end-of-anchored-search on history-point-at-end-of-anchored-search on
search-ignore-case on search-ignore-case on

67
tools/ConEmu/ConEmu/clink/_default_settings
View File

@ -1,34 +1,33 @@
# When this file is named "default_settings" and is in the binaries # When this file is named "default_settings" and is in the binaries
# directory or profile directory, it provides enhanced default settings. # directory or profile directory, it provides enhanced default settings.
# Override built-in default settings with ones that provide a more # Override built-in default settings with ones that provide a more
# enhanced Clink experience. # enhanced Clink experience.
autosuggest.enable = True autosuggest.enable = True
clink.default_bindings = windows clink.default_bindings = windows
cmd.ctrld_exits = False cmd.ctrld_exits = False
color.arginfo = sgr 38;5;172 color.arginfo = sgr 38;5;172
color.argmatcher = sgr 1;38;5;40 color.argmatcher = sgr 1;38;5;40
color.cmd = bold color.cmd = bold
color.cmdredir = sgr 38;5;172 color.cmdredir = sgr 38;5;172
color.cmdsep = sgr 38;5;214 color.cmdsep = sgr 38;5;135
color.comment_row = sgr 38;5;87;48;5;18 color.comment_row = sgr 38;5;87;48;5;18
color.description = sgr 38;5;39 color.description = sgr 38;5;39
color.doskey = sgr 1;38;5;75 color.doskey = sgr 1;38;5;75
color.executable = sgr 1;38;5;33 color.executable = sgr 1;38;5;33
color.filtered = bold color.filtered = bold
color.flag = sgr 38;5;117 color.flag = sgr 38;5;117
color.hidden = sgr 38;5;160 color.hidden = sgr 38;5;160
color.histexpand = sgr 97;48;5;55 color.histexpand = sgr 97;48;5;55
color.horizscroll = sgr 38;5;16;48;5;30 color.horizscroll = sgr 38;5;16;48;5;30
color.input = sgr 38;5;222 color.input = sgr 38;5;214
color.readonly = sgr 38;5;28 color.readonly = sgr 38;5;28
color.selected_completion = sgr 7 color.selected_completion = sgr 7
color.selection = sgr 38;5;16;48;5;179 color.selection = sgr 38;5;16;48;5;179
color.suggestion = sgr 38;5;239 color.unrecognized = sgr 38;5;203
color.unrecognized = sgr 38;5;203 history.max_lines = 25000
history.max_lines = 25000 history.time_stamp = show
history.time_stamp = show match.expand_envvars = True
match.expand_envvars = True match.substring = True
match.substring = True

517
tools/ConEmu/ConEmu/clink/clink.html
View File

@ -3,7 +3,7 @@
<!-- ----------------------------------------------------- --> <!-- ----------------------------------------------------- -->
<head> <head>
<title>Clink v1.5.2</title> <title>Clink v1.5.4</title>
<style> <style>
@import url('https://fonts.googleapis.com/css2?family=Rambla:wght@400;700&family=Roboto&family=Fira+Mono&display=swap'); @import url('https://fonts.googleapis.com/css2?family=Rambla:wght@400;700&family=Roboto&family=Fira+Mono&display=swap');
html { html {
@ -30,6 +30,23 @@ a code:hover {
text-decoration: underline; text-decoration: underline;
} }
.promo_box {
display: flex;
flex-direction: row;
flex-wrap: wrap;
gap: 1rem 2rem;
width: 100%;
}
.promo_block {
flex:1 1 480px;
background-color: #f8f8f8;
border: 1px solid #ddd;
border-radius: 0.2rem;
padding-left: 1rem;
padding-right: 1rem;
}
.wlink { .wlink {
opacity: 0%; opacity: 0%;
width: 100px; width: 100px;
@ -178,11 +195,11 @@ kbd {
white-space:nowrap; white-space:nowrap;
} }
#content table:not(.linkmenu) td:nth-child(1) { #content table:not(.linkmenu,.console) td:nth-child(1) {
white-space: nowrap; white-space: nowrap;
} }
#content table:not(.linkmenu) td:nth-child(1) code { #content table:not(.linkmenu,.console) td:nth-child(1) code {
border: none; border: none;
padding: 0 0 0 0; padding: 0 0 0 0;
border-radius: 0; border-radius: 0;
@ -197,11 +214,45 @@ kbd {
.console { .console {
border: none; border: none;
color: #c0c0c0;
background-color: transparent; background-color: transparent;
font-size: 0.9rem;
margin-left: 0; margin-left: 0;
width: 100%; width: 100%;
} }
.color_default { color: #c0c0c0 }
.color_arg { color: #ffffff }
.color_arginfo { color: #d78700 }
.color_argmatcher { color: #00d700 }
.color_cmd { color: #ffffff }
.color_cmdredir { color: #d78700 }
.color_cmdsep { color: #af5fff }
.color_description { color: #00afff }
.color_doskey { color: #5fafff }
.color_executable { color: #0087ff }
.color_flag { color: #87d7ff }
.color_input { color: #ffaf00 }
.color_suggestion { color: #808080 }
.color_unexpected { color: #c0c0c0 }
.color_unrecognized { color: #ff5f5f }
.right_gray {
color: #d7d7d7;
text-align:right;
font-style:italic;
}
.cursor {
animation: blinker 1s steps(1, end) infinite;
color: #ffffff;
}
@keyframes blinker {
0% { opacity: 1; }
50% { opacity: 0; }
}
.section { .section {
} }
@ -248,7 +299,7 @@ kbd {
background-color: #eee; background-color: #eee;
} }
#content table:not(.linkmenu) td, #content th { #content table:not(.linkmenu,.console) td, #content th {
vertical-align: text-top; vertical-align: text-top;
padding: 0.2rem 0.5rem; padding: 0.2rem 0.5rem;
} }
@ -804,6 +855,12 @@ name:"Plain text",aliases:["text","txt"],disableAutodetect:!0})})());
function go() function go()
{ {
// Apply syntax highlighting. // Apply syntax highlighting.
const COMMENT=hljs.COMMENT("#", "$");
const STRING={className:'string',begin:'"',end:'"',contains:[hljs.BACKSLASH_ESCAPE]};
const OPERATOR={className:'name',begin:/\:/};
const PREPROCESSOR={className:'meta',begin:/\$[a-z]+\b/,end:/$/,keywords:{keyword:'$if $else $endif $include'},contains:[{begin:/\\\n/,relevance:0},COMMENT]};
const INPUTRC={name:"inputrc",case_insensitive:true,keywords:{keyword:"set",literal:"on off true false"},contains:[COMMENT,STRING,OPERATOR,PREPROCESSOR]};
hljs.registerLanguage("inputrc",function(){"use strict";return function(e){return INPUTRC}}());
hljs.initHighlighting(); hljs.initHighlighting();
// Fix hyperlink styling inside highlighted comments. // Fix hyperlink styling inside highlighted comments.
@ -853,6 +910,7 @@ name:"Plain text",aliases:["text","txt"],disableAutodetect:!0})})());
<div><a class="h2" href="#saved-command-history">Saved Command History</a></div> <div><a class="h2" href="#saved-command-history">Saved Command History</a></div>
<div><a class="h2" href="#using-history-expansion">Using History Expansion</a></div> <div><a class="h2" href="#using-history-expansion">Using History Expansion</a></div>
<div><a class="h2" href="#directory-shortcuts">Directory Shortcuts</a></div> <div><a class="h2" href="#directory-shortcuts">Directory Shortcuts</a></div>
<div><a class="h2" href="#enhanced-doskey-expansion">Enhanced Doskey Expansion</a></div>
<div><a class="h2" href="#popular-scripts">Popular Scripts</a></div> <div><a class="h2" href="#popular-scripts">Popular Scripts</a></div>
<div><a class="h2" href="#terminal-support">Terminal Support</a></div> <div><a class="h2" href="#terminal-support">Terminal Support</a></div>
<div><a class="h2" href="#troubleshooting-tips">Troubleshooting Tips</a></div> <div><a class="h2" href="#troubleshooting-tips">Troubleshooting Tips</a></div>
@ -865,7 +923,7 @@ name:"Plain text",aliases:["text","txt"],disableAutodetect:!0})})());
</td> </td>
<td style="text-align:right"> <td style="text-align:right">
<div id="header"> <div id="header">
<div id="title">Clink v1.5.2</div> <div id="title">Clink v1.5.4</div>
<div id="url"> <div id="url">
<a href="https://github.com/chrisant996/clink"> <a href="https://github.com/chrisant996/clink">
https://github.com/chrisant996/clink https://github.com/chrisant996/clink
@ -884,44 +942,82 @@ name:"Plain text",aliases:["text","txt"],disableAutodetect:!0})})());
<div class="section" id="documentation"> <div class="section" id="documentation">
<h1 id="what-is-clink"><div class="wlink"><a href="#what-is-clink"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>What is Clink?</h1> <h1 id="what-is-clink"><div class="wlink"><a href="#what-is-clink"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>What is Clink?</h1>
<p>Clink combines the native Windows shell cmd.exe with the powerful command line editing features of the GNU Readline library, which provides rich completion, history, and line-editing capabilities. Readline is best known for its use in the Unix shell Bash, the standard shell for Mac OS X and many Linux distributions.</p> <p>Clink combines the native Windows shell cmd.exe with the powerful command line editing features of the GNU Readline library, which provides rich completion, history, and line-editing capabilities. Readline is best known for its use in the Unix shell Bash, the standard shell for Mac OS X and many Linux distributions.</p>
<h3 id="features"><div class="wlink"><a href="#features"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Features</h3> <p><a name="features"></a></p>
<p>Here are some highlights of what Clink provides:</p> <h3 id="feature-highlights"><div class="wlink"><a href="#features"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Feature Highlights</h3>
<div class="promo_box">
<div class="promo_box">
<div class="promo_block">
<p><strong>Auto-Suggestions</strong></p>
<p>Clink offers suggestions as you type based on history, files, and completions.</p>
<pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"><span class="color_default">C:\dir></span><span class="color_executable">findstr</span><span class="cursor">_</span><span class="color_suggestion">/s needle haystack\*</span></span>
</code></pre>
<p>Press <kbd>Right</kbd> or <kbd>End</kbd> to accept a suggestion (shown in a muted color).</p>
<p>See <a href="#gettingstarted_autosuggest">Auto-Suggest</a> to learn more.</p>
</div>
<div class="promo_block">
<p><strong>Completions</strong></p>
<p>Clink can complete words when you press <kbd>Tab</kbd> or <kbd>Ctrl</kbd>-<kbd>Space</kbd>.</p>
<p>Built-in completions are available for executables, aliases, command names, directory commands, and environment variables. You can use Lua scripts to add <a href="#extending-clink">custom completions</a>.</p>
<p>See <a href="#how-completion-works">How Completion Works</a> to learn more.</p>
</div>
</div>
<div class="promo_box">
<div class="promo_block">
<p><strong>Persistent History</strong></p>
<p>Clink stores persistent history between sessions.</p>
<ul> <ul>
<li>The same line editing as Bash (from the <a href="https://tiswww.case.edu/php/chet/readline/rltop.html">GNU Readline library</a> version 8.1).</li> <li><kbd>Up</kbd> and <kbd>Down</kbd> cycle through history entries.</li>
<li>History persistence between sessions.</li> <li><kbd>PgUp</kbd> and <kbd>PgDn</kbd> cycle through history entries matching the typed prefix.</li>
<li>Context sensitive completion;<ul> <li><kbd>F7</kbd> show a popup list of selectable history entries.</li>
<li>Executables (and aliases).</li> <li><kbd>Ctrl</kbd>-<kbd>R</kbd> and <kbd>Ctrl</kbd>-<kbd>S</kbd> search history incrementally.</li>
<li>Directory commands.</li>
<li>Environment variables.</li>
</ul> </ul>
</li> <p>See <a href="#saved-command-history">Saved Command History</a> to learn more.</p>
<li>Context sensitive colored input text.</li> </div>
<li>Automatic suggestions from history and completions.</li> <div class="promo_block">
<li>New keyboard shortcuts;<ul>
<li>Interactive completion list (<kbd>Ctrl</kbd>-<kbd>Space</kbd>).</li> <p><strong>Scriptable Prompt and Colored Input</strong></p>
<li>Incremental history search (<kbd>Ctrl</kbd>-<kbd>R</kbd> and <kbd>Ctrl</kbd>-<kbd>S</kbd>).</li> <p>You can customize the prompt dynamically with Lua scripts -- like in other shells -- but never before possible in cmd.exe!</p>
<li>Powerful completion (<kbd>Tab</kbd>).</li> <pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"><span class="color_default"><span style="color:#0087ff">C:\repos\clink</span> <span style="color:#888">git</span> <span style="color:#ff0">main</span><span style="color:#888">-></span><span style="color:#ff0">origin *3</span> <span style="color:#f33">!1</span>
<li>Undo (<kbd>Ctrl</kbd>-<kbd>Z</kbd>).</li> <span style="color:#0f0">></span> <span class="color_argmatcher">git</span> <span class="color_arg">merge</span> <span class="color_flag">--help</span><span class="cursor">_</span></span>
<li>Environment variable expansion (<kbd>Ctrl</kbd>-<kbd>Alt</kbd>-<kbd>E</kbd>).</li> </code></pre>
<li>Doskey alias expansion (<kbd>Ctrl</kbd>-<kbd>Alt</kbd>-<kbd>F</kbd>).</li>
<li>Scroll the screen buffer (<kbd>Alt</kbd>-<kbd>Up</kbd>, etc).</li> <p>Your input is colored by context sensitive completion scripts.</p>
<li><kbd>Shift</kbd>-Arrow keys to select text, typing replaces selected text, etc.</li> <p>See <a href="#popular-scripts">Popular Scripts</a> and <a href="#gettingstarted_colors">Colors</a> and <a href="#customizing-the-prompt">Customizing the Prompt</a> to learn more.</p>
<li>(press <kbd>Alt</kbd>-<kbd>H</kbd> for many more...)</li> </div>
</div>
<div class="promo_box">
<div class="promo_block">
<p><strong>Command Line Editing Improvements</strong></p>
<p>Clink supercharges the command line with new input editing commands and configurable key bindings. For example,</p>
<ul>
<li><kbd>Alt</kbd>-<kbd>H</kbd> to display all key bindings.</li>
<li><kbd>Tab</kbd> for completion.</li>
<li><kbd>Ctrl</kbd>-<kbd>Space</kbd> for an interactive completion list.</li>
<li><kbd>Ctrl</kbd>-<kbd>Z</kbd> to undo input.</li>
<li><kbd>Shift</kbd>-<kbd>Arrows</kbd> to select text, and type to replace selected text.</li>
</ul> </ul>
</li> <p>See <a href="#gettingstarted_keybindings">Key Bindings</a> to learn more.</p>
<li>Directory shortcuts;<ul> </div>
<li>Typing a directory name followed by a path separator is a shortcut for <code>cd /d</code> to that directory.</li> <div class="promo_block">
<li>Typing <code>..</code> or <code>...</code> is a shortcut for <code>cd ..</code> or <code>cd ..\..</code> (each additional <code>.</code> adds another <code>\..</code>).</li>
<li>Typing <code>-</code> or <code>cd -</code> changes to the previous current working directory.</li> <p><strong>Convenience</strong></p>
<p>Optional auto-answering of the &quot;<a href="#cmd_auto_answer">Terminate batch job?</a>&quot; prompt.</p>
<p><a href="#enhanced-doskey-expansion">Enhanced doskey expansion</a> even after <code>&amp;</code> and <code>|</code>.</p>
<p><a href="#directory-shortcuts">Directory shortcuts</a>:</p>
<ul>
<li><code>dirname\</code> is a shortcut for <code>cd /d</code> to that directory.</li>
<li><code>..</code> or <code>...</code> are shortcuts for <code>cd ..</code> or <code>cd ..\..</code> (etc).</li>
<li><code>-</code> or <code>cd -</code> changes to the previous current working directory.</li>
</ul> </ul>
</li> </div>
<li>Scriptable autosuggest with Lua.</li> </div>
<li>Scriptable completion with Lua.</li> </div>
<li>Scriptable key bindings with Lua.</li>
<li>Colored and scriptable prompt.</li>
<li>Auto-answering of the &quot;Terminate batch job?&quot; prompt.</li>
</ul>
<p>By default Clink binds <kbd>Alt</kbd>-<kbd>H</kbd> to display the current key bindings.</p>
<h1 id="usage"><div class="wlink"><a href="#usage"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Usage</h1> <h1 id="usage"><div class="wlink"><a href="#usage"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Usage</h1>
<p>There are several ways to start Clink.</p> <p>There are several ways to start Clink.</p>
<ol> <ol>
@ -934,18 +1030,41 @@ name:"Plain text",aliases:["text","txt"],disableAutodetect:!0})})());
<p>You can use Clink right away without configuring anything:</p> <p>You can use Clink right away without configuring anything:</p>
<ul> <ul>
<li>Searchable <a href="#saved-command-history">command history</a> will be saved between sessions.</li> <li>Searchable <a href="#saved-command-history">command history</a> will be saved between sessions.</li>
<li><kbd>Tab</kbd> and <kbd>Ctrl</kbd>-<kbd>Space</kbd> will do match completion two different ways.</li> <li><a href="#gettingstarted_autosuggest">Suggestions</a> are automatically offered as you type; press <kbd>Right</kbd> or <kbd>End</kbd> to accept a suggestion.</li>
<li><kbd>Tab</kbd> and <kbd>Ctrl</kbd>-<kbd>Space</kbd> provide match <a href="#how-completion-works">completion</a> two different ways.</li>
<li>Press <kbd>Alt</kbd>-<kbd>H</kbd> to see a list of the current key bindings.</li> <li>Press <kbd>Alt</kbd>-<kbd>H</kbd> to see a list of the current key bindings.</li>
<li>Press <kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>/</kbd> followed by another key to see what command is bound to the key.</li> <li>Press <kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>/</kbd> followed by another key to see what command is bound to the key.</li>
</ul> </ul>
<p>There are three main ways of customizing Clink to your preferences: the <a href="#init-file">Readline init file</a> (the <code>.inputrc</code> file), the <a href="#clink-settings">Clink settings</a> (the <code>clink set</code> command), and <a href="#extending-clink-with-lua">Lua</a> scripts.</p> <p>There are three main ways of customizing Clink to your preferences: the <a href="#init-file">Readline init file</a> (the <code>.inputrc</code> file), the <a href="#clink-settings">Clink settings</a> (the <code>clink set</code> command), and <a href="#extending-clink-with-lua">Lua</a> scripts.</p>
<p><a name="how-completion-works"></a></p>
<h2 id="how-completion-works"><div class="wlink"><a href="#how-completion-works"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>How Completion Works</h2> <h2 id="how-completion-works"><div class="wlink"><a href="#how-completion-works"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>How Completion Works</h2>
<p>Clink can offer possible completions for the word at the cursor, and can insert them for you. Clink can complete file names, directories, environment variables, and commands. It also allows you to provide custom completion generators using Lua scripts that execute inside Clink (see <a href="#extending-clink-with-lua">Extending Clink With Lua</a>).</p> <p>&quot;Completion&quot; is for the word at the cursor; Clink can complete it for you when you press <kbd>Tab</kbd>.</p>
<p>By default, pressing <kbd>Tab</kbd> performs completion the same way that bash does on Unix and Linux. When you press <kbd>Tab</kbd>, Clink finds matches for how to complete the word at the cursor. It automatically inserts the longest common prefix shared by the possible completions. If you press <kbd>Tab</kbd> again, it also lists the possible completions.</p> <p>&quot;Suggestions&quot; are for the whole command line; Clink offers <a href="#gettingstarted_autosuggest">automatic suggestions</a> for the whole input line, which you can accept by pressing <kbd>Right</kbd> or <kbd>End</kbd>.</p>
<p>If you install Clink with &quot;Use enhanced defaults&quot; or if you set <a href="#clink_default_bindings"><code>clink.default_bindings</code></a> to use &quot;windows&quot; defaults, then pressing <kbd>Tab</kbd> cycles through the possible completions, replacing the word with the next possible completion each time.</p> <p>Some examples of what completions can offer:</p>
<p>Pressing <kbd>Ctrl</kbd>-<kbd>Space</kbd> shows an interactive list of possible completions. You can use the arrow keys to choose which completion to insert, and you can type to filter the list. <kbd>Enter</kbd> inserts the selected completion, or <kbd>Space</kbd> inserts the selected completion and makes sure a space follows it to allow typing a next argument.</p> <ul>
<p>The first word of each command line is the command or program to execute, or a file to open. By default, Clink provides completions for the first word based on all executable programs on the system PATH and the current directory, but not non-executable files. You can turn off executable completion by running <code>clink set <a href="#exec_enable">exec.enable</a> false</code>, or you can adjust its behavior by changing the various <a href="#exec.aliases"><code>exec.*</code></a> settings.</p> <li>File names,</li>
<li>Directories,</li>
<li>Environment variables,</li>
<li>Commands,</li>
<li>Command <a href="#argument-completion">arguments and flags</a>,</li>
<li>You can provide custom completion generators using Lua scripts that execute inside Clink (see <a href="#extending-clink-with-lua">Extending Clink With Lua</a> and <a href="#popular-scripts">Popular Scripts</a>).</li>
</ul>
<h3 id="completion-keys"><div class="wlink"><a href="#completion-keys"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Completion Keys</h3>
<p><kbd>Tab</kbd> completes the word at the cursor:</p>
<ul>
<li>If you installed Clink with &quot;Use enhanced defaults&quot; or if you set <a href="#clink_default_bindings"><code>clink.default_bindings</code></a> to use &quot;windows&quot; defaults, then <kbd>Tab</kbd> cycles through the possible completions, replacing the word with the next possible completion each time.</li>
<li>Otherwise, <kbd>Tab</kbd> performs completion the same way that bash does on Unix and Linux: When you press <kbd>Tab</kbd>, Clink finds matches for how to complete the word at the cursor. It automatically inserts the longest common prefix shared by the possible completions. If you press <kbd>Tab</kbd> again, it also lists the possible completions.</li>
</ul>
<p><kbd>Ctrl</kbd>-<kbd>Space</kbd> shows an interactive list of possible completions:</p>
<ul>
<li>You can use the arrow keys to choose which completion to insert, and you can type to filter the list.</li>
<li>Pressing <kbd>Enter</kbd> in the list inserts the selected completion.</li>
<li>Pressing <kbd>Space</kbd> in the list inserts the selected completion and makes sure a space follows it to allow typing a next argument.</li>
</ul>
<p>See <a href="#completion-commands">Completion Commands</a> and <a href="#clink-commands">Clink Commands</a> for more available completion commands.</p> <p>See <a href="#completion-commands">Completion Commands</a> and <a href="#clink-commands">Clink Commands</a> for more available completion commands.</p>
<h3 id="executable-completion"><div class="wlink"><a href="#executable-completion"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Executable Completion</h3>
<p>By default, Clink completes the first word of each command based on all executable programs on the system PATH and the current directory, but not non-executable files.</p>
<p>You can turn off the &quot;executable completion&quot; behavior by running <code>clink set <a href="#exec_enable">exec.enable</a> false</code>, or you can adjust its behavior by changing the various <a href="#exec.aliases"><code>exec.*</code></a> settings.</p>
<h2 id="common-configuration"><div class="wlink"><a href="#common-configuration"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Common Configuration</h2> <h2 id="common-configuration"><div class="wlink"><a href="#common-configuration"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Common Configuration</h2>
<p>The following sections describe some ways to begin customizing Clink to your taste.</p> <p>The following sections describe some ways to begin customizing Clink to your taste.</p>
<table class="linkmenu"> <table class="linkmenu">
@ -968,7 +1087,6 @@ name:"Plain text",aliases:["text","txt"],disableAutodetect:!0})})());
<p>If you install Clink from the .zip file then enhanced default settings are activated when the <code>default_settings</code> and <code>default_inputrc</code> files are present in the binaries directory or in the profile directory. The .zip file comes with the files, but their names have a <code>_</code> prefix so that enhanced defaults won&#39;t automatically take effect. You can activate the enhanced default settings by renaming the files to remove the <code>_</code> prefix.</p> <p>If you install Clink from the .zip file then enhanced default settings are activated when the <code>default_settings</code> and <code>default_inputrc</code> files are present in the binaries directory or in the profile directory. The .zip file comes with the files, but their names have a <code>_</code> prefix so that enhanced defaults won&#39;t automatically take effect. You can activate the enhanced default settings by renaming the files to remove the <code>_</code> prefix.</p>
<p>Here are some of the enhanced defaults. Review the <code>default_settings</code> and <code>default_inputrc</code> files for the full list.</p> <p>Here are some of the enhanced defaults. Review the <code>default_settings</code> and <code>default_inputrc</code> files for the full list.</p>
<ul> <ul>
<li><a href="#gettingstarted_autosuggest">Automatic suggestions</a> are enabled.</li>
<li>Many <a href="#gettingstarted_colors">color settings</a> have colorful defaults.</li> <li>Many <a href="#gettingstarted_colors">color settings</a> have colorful defaults.</li>
<li>Uses <a href="#gettingstarted_defaultbindings">Windows key bindings</a> by default.</li> <li>Uses <a href="#gettingstarted_defaultbindings">Windows key bindings</a> by default.</li>
<li>The <a href="#saved-command-history">command history</a>&#39;s default <a href="#history_max_lines">limit</a> is increased to 25,000 entries.</li> <li>The <a href="#saved-command-history">command history</a>&#39;s default <a href="#history_max_lines">limit</a> is increased to 25,000 entries.</li>
@ -985,7 +1103,7 @@ name:"Plain text",aliases:["text","txt"],disableAutodetect:!0})})());
<pre><code class="language-cmd">notepad %userprofile%\.inputrc <pre><code class="language-cmd">notepad %userprofile%\.inputrc
</code></pre> </code></pre>
<p>You may want to copy/paste the following sample text into the file as a starting point, and then press <kbd>Ctrl</kbd>-<kbd>S</kbd> to save the file.</p> <p>You may want to copy/paste the following sample text into the file as a starting point, and then press <kbd>Ctrl</kbd>-<kbd>S</kbd> to save the file.</p>
<pre><code class="language-plaintext"># Some common Readline config settings. <pre><code class="language-inputrc"># Some common Readline config settings.
set colored-stats on # Turn on completion colors. set colored-stats on # Turn on completion colors.
set colored-completion-prefix on # Color the typed completion prefix. set colored-completion-prefix on # Color the typed completion prefix.
@ -1059,9 +1177,19 @@ $endif
<p><a name="gettingstarted_autosuggest"></a></p> <p><a name="gettingstarted_autosuggest"></a></p>
<h3 id="auto-suggest"><div class="wlink"><a href="#gettingstarted_autosuggest"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Auto-suggest</h3> <h3 id="auto-suggest"><div class="wlink"><a href="#gettingstarted_autosuggest"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Auto-suggest</h3>
<p>Clink can suggest commands as you type, based on command history and completions.</p> <p>Clink can suggest commands as you type, based on command history and completions.</p>
<p>To turn on automatic suggestions, run <code>clink set <a href="#autosuggest_enable">autosuggest.enable</a> true</code>. When the cursor is at the end of the input line, a suggestion may appear in a muted color. If the suggestion isn&#39;t what you want, just ignore it. Or accept the whole suggestion with the <kbd>Right</kbd> arrow or <kbd>End</kbd> key, accept the next word of the suggestion with <kbd>Ctrl</kbd>-<kbd>Right</kbd>, or accept the next full word of the suggestion up to a space with <kbd>Shift</kbd>-<kbd>Right</kbd>.</p> <p>You can turn off automatic suggestions with <code>clink set <a href="#autosuggest_enable">autosuggest.enable</a> false</code>, or turn them on with <code>clink set autosuggest.enable true</code>.</p>
<p>The <a href="#autosuggest_strategy"><code>autosuggest.strategy</code></a> setting determines how a suggestion is chosen.</p> <p>When automatic suggestions are enabled and the cursor is at the end of the input line, a suggestion may appear in a muted color. If the suggestion isn&#39;t what you want, just ignore it. Or you can accept the whole suggestion with the <kbd>Right</kbd> arrow or <kbd>End</kbd> key, accept the next word of the suggestion with <kbd>Ctrl</kbd>-<kbd>Right</kbd>, or accept the next full word of the suggestion up to a space with <kbd>Shift</kbd>-<kbd>Right</kbd>.</p>
<p>Or, if you use the setup program with &quot;Use enhanced default settings&quot; checked then automatic suggestions are enabled by default.</p> <p>The <a href="#autosuggest_strategy"><code>autosuggest.strategy</code></a> setting determines how suggestions are chosen.</p>
<p>Here&#39;s an example of how auto-suggestion works. Suppose you ran a command, so now it&#39;s in your command history:</p>
<pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"><span class="color_default">C:\dir&gt;<span class="color_executable">findstr</span>&nbsp; <span class="color_input">/s needle haystack\*</span></span>
</code></pre>
<p>Later, you start to type a new command, and it matches the earlier command from the history:</p>
<pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"><span class="color_default">C:\dir&gt;<span class="color_executable">findstr</span>&nbsp;<span class="cursor">_</span><span class="color_suggestion">/s needle haystack\*</span></span>
</code></pre>
<p>The muted text shows a suggestion that might be what you intend to type. You can accept the muted text into the input line by pressing the <kbd>Right</kbd> key.</p>
<p>If you press <kbd>Tab</kbd> then that invokes <a href="#how-completion-works">completion</a> instead. Completion is something you manually invoke to offer possible completions for a word or argument position. Auto-suggestion automatically offers suggestions for a whole input line, and the suggestions can come from the saved command history or from the list of possible completions.</p>
<p><a name="gettingstarted_colors"></a></p> <p><a name="gettingstarted_colors"></a></p>
<h3 id="colors"><div class="wlink"><a href="#gettingstarted_colors"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Colors</h3> <h3 id="colors"><div class="wlink"><a href="#gettingstarted_colors"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Colors</h3>
<p>Clink has many configurable colors for match completions, input line coloring, popup lists, and more.</p> <p>Clink has many configurable colors for match completions, input line coloring, popup lists, and more.</p>
@ -1072,30 +1200,18 @@ $endif
<p>See the <a href="#completion-colors">Completion Colors</a> section for how to configure the colors for match completions.</p> <p>See the <a href="#completion-colors">Completion Colors</a> section for how to configure the colors for match completions.</p>
<h4 id="other-colors"><div class="wlink"><a href="#other-colors"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Other colors</h4> <h4 id="other-colors"><div class="wlink"><a href="#other-colors"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Other colors</h4>
<p>Clink adds color to the input line by highlighting arguments, flags, doskey macros, and more. If you don&#39;t want input line colors, you can turn it off by running <code>clink set <a href="#clink_colorize_input">clink.colorize_input</a> false</code>.</p> <p>Clink adds color to the input line by highlighting arguments, flags, doskey macros, and more. If you don&#39;t want input line colors, you can turn it off by running <code>clink set <a href="#clink_colorize_input">clink.colorize_input</a> false</code>.</p>
<p>There are also colors for popup lists, and some other things.</p> <p>Here are examples, using the colors from the <a href="#gettingstarted_enhanceddefaults">Use enhanced defaults</a> installation option:</p>
<p>To configure a color, run <code>clink set <span class="arg">colorname</span> <span class="arg">colorvalue</span></code>.</p> <pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"><table class="console" cellpadding=0 cellspacing=0>
<p>Match completions make it easy to change Clink settings: type <code>clink set color.</code> and then use completion (e.g. <kbd>Tab</kbd> or <kbd>Ctrl</kbd>-<kbd>Space</kbd>) to see the available color settings, and to fill in a color value.</p> <tr><td class="color_default">c:\dir><span class="color_argmatcher">clink</span> <span class="color_arg">set</span> <span class="color_flag">--help</span></td><td class="right_gray">'clink' has an argmatcher</td></tr>
<p>Here are some colors you may want to set up right away:</p> <tr><td class="color_default">c:\dir><span class="color_cmd">attrib</span></td><td class="right_gray">'attrib' is a CMD command</td></tr>
<table> <tr><td class="color_default">c:\dir><span class="color_doskey">myalias</span></td><td class="right_gray">if 'myalias' is a doskey alias</td></tr>
<thead> <tr><td class="color_default">c:\dir><span class="color_executable">control</span></td><td class="right_gray">'control' is an executable</td></tr>
<tr> <tr><td class="color_default">c:\dir><span class="color_unrecognized">xyzabc123</span></td><td class="right_gray">unrecognized</td></tr>
<th>Color</th> <tr><td class="color_default">c:\dir><span class="color_input">whatever</span></td><td class="right_gray">if executable and unrecognized colors are not set</td></tr>
<th>Description</th> </table></code></pre>
<th>Recommended</th>
</tr> <p>To configure a color, run <code>clink set <span class="arg">colorname</span> <span class="arg">colorvalue</span></code>. Match completions make it easy to change Clink settings: type <code>clink set color.</code> and then use completion (e.g. <kbd>Tab</kbd> or <kbd>Ctrl</kbd>-<kbd>Space</kbd>) to see the available color settings, and to fill in a color value.</p>
</thead> <p>See the <a href="#classifywords">Coloring the Input Text</a> and <a href="#color-settings">Color Settings</a> sections for more information on Clink color settings.</p>
<tbody><tr>
<td><a href="#color_executable"><code>color.executable</code></a></td>
<td>Apply color when the command is an executable file.</td>
<td><code>clink set color.executable sgr 38;5;32</code></td>
</tr>
<tr>
<td><a href="#color_unexpected"><code>color.unrecognized</code></a></td>
<td>Apply color when the command is not recognized.</td>
<td><code>clink set color.unrecognized sgr 38;5;203</code></td>
</tr>
</tbody></table>
<p>See the <a href="#clink-settings">Clink Settings</a>, <a href="#color-settings">Color Settings</a>, and <a href="#classifywords">Coloring the Input Text</a> sections for more information on Clink color settings.</p>
<p><a name="gettingstarted_keybindings"></a></p> <p><a name="gettingstarted_keybindings"></a></p>
<h3 id="key-bindings"><div class="wlink"><a href="#gettingstarted_keybindings"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Key Bindings</h3> <h3 id="key-bindings"><div class="wlink"><a href="#gettingstarted_keybindings"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Key Bindings</h3>
<p>You can customize your key bindings (keyboard shortcuts) by assigning key bindings in the <a href="#gettingstarted_inputrc">.inputrc file</a>. See <a href="#keybindings">Customizing Key Bindings</a> for more information.</p> <p>You can customize your key bindings (keyboard shortcuts) by assigning key bindings in the <a href="#gettingstarted_inputrc">.inputrc file</a>. See <a href="#keybindings">Customizing Key Bindings</a> for more information.</p>
@ -1190,7 +1306,8 @@ $endif
<p><a name="clinksettings"></a></p> <p><a name="clinksettings"></a></p>
<h2 id="clink-settings"><div class="wlink"><a href="#clinksettings"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Clink Settings</h2> <h2 id="clink-settings"><div class="wlink"><a href="#clinksettings"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Clink Settings</h2>
<p>The easiest way to configure Clink is to use the <code>clink set</code> command. This can list, query, and set Clink&#39;s settings. Run <code>clink set --help</code> from a Clink-installed cmd.exe process to learn more both about how to use it and to get descriptions for Clink&#39;s various options.</p> <p>The easiest way to configure Clink is to use the <code>clink set</code> command to list, query, and set Clink&#39;s settings.</p>
<p>Run <code>clink set --help</code> from a Clink-installed cmd.exe process to learn more.</p>
<p>The following table describes the available Clink settings:</p> <p>The following table describes the available Clink settings:</p>
<table> <table>
<thead> <thead>
@ -1207,7 +1324,7 @@ $endif
</tr> </tr>
<tr> <tr>
<td align="center"><a name="autosuggest_enable"></a><code>autosuggest.enable</code></td> <td align="center"><a name="autosuggest_enable"></a><code>autosuggest.enable</code></td>
<td align="center">False <a href="#alternatedefault">*</a></td> <td align="center">True</td>
<td>When this is <code>true</code> a suggested command may appear in <a href="#color_suggestion"><code>color.suggestion</code></a> color after the cursor. If the suggestion isn&#39;t what you want, just ignore it. Or accept the whole suggestion with the <kbd>Right</kbd> arrow or <kbd>End</kbd> key, accept the next word of the suggestion with <kbd>Ctrl</kbd>-<kbd>Right</kbd>, or accept the next full word of the suggestion up to a space with <kbd>Shift</kbd>-<kbd>Right</kbd>. The <a href="#autosuggest_strategy"><code>autosuggest.strategy</code></a> setting determines how a suggestion is chosen.</td> <td>When this is <code>true</code> a suggested command may appear in <a href="#color_suggestion"><code>color.suggestion</code></a> color after the cursor. If the suggestion isn&#39;t what you want, just ignore it. Or accept the whole suggestion with the <kbd>Right</kbd> arrow or <kbd>End</kbd> key, accept the next word of the suggestion with <kbd>Ctrl</kbd>-<kbd>Right</kbd>, or accept the next full word of the suggestion up to a space with <kbd>Shift</kbd>-<kbd>Right</kbd>. The <a href="#autosuggest_strategy"><code>autosuggest.strategy</code></a> setting determines how a suggestion is chosen.</td>
</tr> </tr>
<tr> <tr>
@ -1443,7 +1560,7 @@ $endif
<tr> <tr>
<td align="center"><a name="doskey_enhanced"></a><code>doskey.enhanced</code></td> <td align="center"><a name="doskey_enhanced"></a><code>doskey.enhanced</code></td>
<td align="center">True</td> <td align="center">True</td>
<td>Enhanced Doskey adds the expansion of macros that follow <code>|</code> and <code>&amp;</code> command separators and respects quotes around words when parsing <code>$1</code>...<code>$9</code> tags. Note that these features do not apply to Doskey use in Batch files.</td> <td>Enhanced Doskey adds the expansion of macros that follow <code>|</code> and <code>&amp;</code> command separators and respects quotes around words when parsing <code>$1</code>...<code>$9</code> tags. To suppress macro expansion for an individual command, prefix the command with a space or semicolon (<code>&nbsp;foo</code> or <code>;foo</code>). Or following <code>|</code> or <code>&amp;</code>, prefix with two spaces or a semicolon (<code>foo|&nbsp; bar</code> or <code>foo|;bar</code>).</td>
</tr> </tr>
<tr> <tr>
<td align="center"><a name="exec_aliases"></a><code>exec.aliases</code></td> <td align="center"><a name="exec_aliases"></a><code>exec.aliases</code></td>
@ -1724,6 +1841,8 @@ $endif
</blockquote> </blockquote>
<p><a name="colorsettings"></a></p> <p><a name="colorsettings"></a></p>
<h2 id="color-settings"><div class="wlink"><a href="#colorsettings"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Color Settings</h2> <h2 id="color-settings"><div class="wlink"><a href="#colorsettings"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Color Settings</h2>
<p>This section describes how to set a color.</p>
<p>For information on what color settings are available and how they&#39;re used, see the <a href="#classifywords">Coloring the Input Text</a> section and the <a href="#color_arg">color.*</a> settings.</p>
<h3 id="friendly-color-names"><div class="wlink"><a href="#friendly-color-names"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Friendly Color Names</h3> <h3 id="friendly-color-names"><div class="wlink"><a href="#friendly-color-names"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Friendly Color Names</h3>
<p>The Clink color <a href="#clinksettings">settings</a> are the ones whose names begin with <code>color.</code>. Color settings use the following syntax:</p> <p>The Clink color <a href="#clinksettings">settings</a> are the ones whose names begin with <code>color.</code>. Color settings use the following syntax:</p>
<p><code>[<span class="arg">attributes</span>] [<span class="arg">foreground_color</span>] [on [<span class="arg">background_color</span>]]</code></p> <p><code>[<span class="arg">attributes</span>] [<span class="arg">foreground_color</span>] [on [<span class="arg">background_color</span>]]</code></p>
@ -1760,7 +1879,7 @@ $endif
<blockquote> <blockquote>
<p><strong>Notes:</strong></p> <p><strong>Notes:</strong></p>
<ul> <ul>
<li>Clink performs tilde expansion on the <code>%CLINK_PROFILE%</code> environment variable value. If the path begins with <code>~\</code> then it is replaced with the current user&#39;s home directory (<code>%HOMEDRIVE%%HOMEPATH%</code> or <code>%USERPROFILE%</code>).</li> <li>Clink performs tilde expansion on the <code>%CLINK_PROFILE%</code> environment variable value. If the path begins with <code>~\</code> then it is replaced with the current user&#39;s home directory (<code>%HOME%</code> or <code>%HOMEDRIVE%%HOMEPATH%</code> or <code>%USERPROFILE%</code>).</li>
<li>The <code>--profile</code> flag has a quirk for backward compatibility with older versions of Clink: <code>~\</code> in <code>--profile</code> is expanded to <code>%LOCALAPPDATA%</code> instead.</li> <li>The <code>--profile</code> flag has a quirk for backward compatibility with older versions of Clink: <code>~\</code> in <code>--profile</code> is expanded to <code>%LOCALAPPDATA%</code> instead.</li>
</ul> </ul>
</blockquote> </blockquote>
@ -1829,7 +1948,7 @@ See <code>clink inject --help</code> for more information.</dd>
</p> </p>
<blockquote> <blockquote>
<p><strong>Note:</strong> If the <code>--profile</code> path begins with <code>~\</code> then it is replaced with the current user&#39;s home directory (<code>%HOMEDRIVE%%HOMEPATH%</code> or <code>%USERPROFILE%</code>).</p> <p><strong>Note:</strong> If the <code>--profile</code> path begins with <code>~\</code> then it is replaced with the current user&#39;s home directory (<code>%HOME%</code> or <code>%HOMEDRIVE%%HOMEPATH%</code> or <code>%USERPROFILE%</code>).</p>
</blockquote> </blockquote>
<p> <p>
<dt>clink autorun</dt> <dt>clink autorun</dt>
@ -2062,7 +2181,7 @@ call &quot;%~dp0clink.bat&quot; inject --profile &quot;%TEMP%\clink_portable&quo
<li><code>%USERPROFILE%</code></li> <li><code>%USERPROFILE%</code></li>
<li><code>%LOCALAPPDATA%</code></li> <li><code>%LOCALAPPDATA%</code></li>
<li><code>%APPDATA%</code></li> <li><code>%APPDATA%</code></li>
<li><code>%HOME%</code></li> <li><code>%HOME%</code> or <code>%HOMEDRIVE%%HOMEPATH%</code></li>
</ul> </ul>
<p>Other software that also uses the Readline library will also look for the <code>.inputrc</code> file (and possibly the <code>_inputrc</code> file too). To set macros and keybindings intended only for Clink, one can use the Readline init file conditional construct like this; <code>$if clink [...] $endif</code>.</p> <p>Other software that also uses the Readline library will also look for the <code>.inputrc</code> file (and possibly the <code>_inputrc</code> file too). To set macros and keybindings intended only for Clink, one can use the Readline init file conditional construct like this; <code>$if clink [...] $endif</code>.</p>
<p>You can use <code>clink info</code> to find the directories and configuration file for the current Clink session.</p> <p>You can use <code>clink info</code> to find the directories and configuration file for the current Clink session.</p>
@ -2108,11 +2227,11 @@ call &quot;%~dp0clink.bat&quot; inject --profile &quot;%TEMP%\clink_portable&quo
</tr> </tr>
<tr> <tr>
<td><a name="configcoloredcompletionprefix"></a><code>colored-completion-prefix</code></td> <td><a name="configcoloredcompletionprefix"></a><code>colored-completion-prefix</code></td>
<td>If set to &quot;on&quot;, when listing completions, Readline displays the common prefix of the set of possible completions using a different color. The color definitions are taken from the value of the <code>%LS_COLORS%</code> environment variable. The default is &quot;off&quot;.</td> <td>If set to &quot;on&quot;, when listing completions, Readline displays the common prefix of the set of possible completions using a different color. The color definitions are taken from the value of the <a href="#completioncolors"><code>%LS_COLORS%</code></a> environment variable. The default is &quot;off&quot;.</td>
</tr> </tr>
<tr> <tr>
<td><a name="configcoloredstats"></a><code>colored-stats</code></td> <td><a name="configcoloredstats"></a><code>colored-stats</code></td>
<td>If set to &quot;on&quot;, Readline displays possible completions using different colors to indicate their file type. The color definitions are taken from the value of the <code>%LS_COLORS%</code> environment variable. The default is &quot;off&quot;.</td> <td>If set to &quot;on&quot;, Readline displays possible completions using different colors to indicate their file type. The color definitions are taken from the value of the <a href="#completioncolors"><code>%LS_COLORS%</code></a> environment variable. The default is &quot;off&quot;.</td>
</tr> </tr>
<tr> <tr>
<td><a name="configcommentbegin"></a><code>comment-begin</code></td> <td><a name="configcommentbegin"></a><code>comment-begin</code></td>
@ -2447,12 +2566,12 @@ Key bindings can be either functions or macros (literal text). Functions are no
<li><code>&quot;blah-blah&quot;</code> is a macro that inserts the literal text &quot;blah-blah&quot; into the line.</li> <li><code>&quot;blah-blah&quot;</code> is a macro that inserts the literal text &quot;blah-blah&quot; into the line.</li>
</ul> </ul>
<p>When entering the text of a macro, single or double quotes must be used to indicate a macro definition. Unquoted text is assumed to be a function name. In the macro body, the backslash escapes described above are expanded. Backslash will quote any other character in the macro text, including <code>&quot;</code> and <code>&#39;</code>. For example, the following binding will make pressing <kbd>Ctrl</kbd>-<kbd>x</kbd> <kbd>\</kbd> insert a single <code>\</code> into the line:</p> <p>When entering the text of a macro, single or double quotes must be used to indicate a macro definition. Unquoted text is assumed to be a function name. In the macro body, the backslash escapes described above are expanded. Backslash will quote any other character in the macro text, including <code>&quot;</code> and <code>&#39;</code>. For example, the following binding will make pressing <kbd>Ctrl</kbd>-<kbd>x</kbd> <kbd>\</kbd> insert a single <code>\</code> into the line:</p>
<pre><code class="language-plaintext">&quot;\C-x\\&quot;: &quot;\\&quot; <pre><code class="language-inputrc">&quot;\C-x\\&quot;: &quot;\\&quot;
</code></pre> </code></pre>
<p> <p>
<dt>Examples</dt> <dt>Examples</dt>
<pre><code class="language-plaintext"># Using key names. <pre><code class="language-inputrc"># Using key names.
C-u: universal-argument # Bind Ctrl-u to invoke the universal-argument command. C-u: universal-argument # Bind Ctrl-u to invoke the universal-argument command.
C-o: &quot;&gt; output&quot; # Bind Ctrl-o to insert the text &quot;&gt; output&quot; into the line. C-o: &quot;&gt; output&quot; # Bind Ctrl-o to insert the text &quot;&gt; output&quot; into the line.
@ -2471,24 +2590,24 @@ C-o: &quot;&gt; output&quot; # Bind Ctrl-o to insert the text &q
<p>The <code>$if</code> construct allows bindings to be made based on the editing mode, the terminal being used, or the application using Readline. The text of the test, after any comparison operator, extends to the end of the line; unless otherwise noted, no characters are required to isolate it.</p> <p>The <code>$if</code> construct allows bindings to be made based on the editing mode, the terminal being used, or the application using Readline. The text of the test, after any comparison operator, extends to the end of the line; unless otherwise noted, no characters are required to isolate it.</p>
<p>The <code>$if mode=</code> form of the <code>$if</code> directive is used to test whether Readline is in <code>emacs</code> or <code>vi</code> mode. This may be used in conjunction with the &quot;set keymap&quot; command, for instance, to set bindings in the <code>emacs-standard</code> and <code>emacs-ctlx</code> keymaps only if Readline is starting out in <code>emacs</code> mode. (The directive is only tested during startup.)</p> <p>The <code>$if mode=</code> form of the <code>$if</code> directive is used to test whether Readline is in <code>emacs</code> or <code>vi</code> mode. This may be used in conjunction with the &quot;set keymap&quot; command, for instance, to set bindings in the <code>emacs-standard</code> and <code>emacs-ctlx</code> keymaps only if Readline is starting out in <code>emacs</code> mode. (The directive is only tested during startup.)</p>
<pre><code class="language-plaintext">$if mode == emacs <pre><code class="language-inputrc">$if mode == emacs
set show-mode-in-prompt on set show-mode-in-prompt on
$endif $endif
</code></pre> </code></pre>
<p>The <code>$if term=</code> form may be used to include terminal-specific key bindings, perhaps to bind the key sequences output by the terminal&#39;s function keys. The word on the right side of the &quot;=&quot; is tested against both the full name of the terminal and the portion of the terminal name before the first &quot;-&quot;. This allows <code>sun</code> to match both <code>sun</code> and <code>sun-cmd</code>, for instance. This is not useful with Clink, because Clink has its own terminal driver.</p> <p>The <code>$if term=</code> form may be used to include terminal-specific key bindings, perhaps to bind the key sequences output by the terminal&#39;s function keys. The word on the right side of the &quot;=&quot; is tested against both the full name of the terminal and the portion of the terminal name before the first &quot;-&quot;. This allows <code>sun</code> to match both <code>sun</code> and <code>sun-cmd</code>, for instance. This is not useful with Clink, because Clink has its own terminal driver.</p>
<p>The <code>$if version</code> test may be used to perform comparisons against specific Readline versions. The <code>version</code> expands to the current Readline version. The set of comparison operators includes <code>=</code> (and <code>==</code>), <code>!=</code>, <code>&lt;=</code>, <code>&gt;=</code>, <code>&lt;</code>, and <code>&gt;</code>. The version number supplied on the right side of the operator consists of a major version number, an optional decimal point, and an optional minor version (e.g., &quot;7.1&quot;). If the minor version is omitted, it is assumed to be &quot;0&quot;. The operator may be separated from the string <code>version</code> and from the version number argument by whitespace. The following example sets a variable if the Readline version being used is 7.0 or newer:</p> <p>The <code>$if version</code> test may be used to perform comparisons against specific Readline versions. The <code>version</code> expands to the current Readline version. The set of comparison operators includes <code>=</code> (and <code>==</code>), <code>!=</code>, <code>&lt;=</code>, <code>&gt;=</code>, <code>&lt;</code>, and <code>&gt;</code>. The version number supplied on the right side of the operator consists of a major version number, an optional decimal point, and an optional minor version (e.g., &quot;7.1&quot;). If the minor version is omitted, it is assumed to be &quot;0&quot;. The operator may be separated from the string <code>version</code> and from the version number argument by whitespace. The following example sets a variable if the Readline version being used is 7.0 or newer:</p>
<pre><code class="language-plaintext">$if version &gt;= 7.0 <pre><code class="language-inputrc">$if version &gt;= 7.0
set show-mode-in-prompt on set show-mode-in-prompt on
$endif $endif
</code></pre> </code></pre>
<p>The <code>$if application</code> construct is used to include application-specific settings. Each program using the Readline library sets the <em>application name</em>, and you can test for a particular value. This could be used to bind key sequences to functions useful for a specific program. For instance, the following command adds a key sequence that quotes the current or previous word, but only in Clink:</p> <p>The <code>$if application</code> construct is used to include application-specific settings. Each program using the Readline library sets the <em>application name</em>, and you can test for a particular value. This could be used to bind key sequences to functions useful for a specific program. For instance, the following command adds a key sequence that quotes the current or previous word, but only in Clink:</p>
<pre><code class="language-plaintext">$if clink <pre><code class="language-inputrc">$if clink
# Quote the current or previous word # Quote the current or previous word
&quot;\C-xq&quot;: &quot;\eb\&quot;\ef\&quot;&quot; &quot;\C-xq&quot;: &quot;\eb\&quot;\ef\&quot;&quot;
$endif $endif
</code></pre> </code></pre>
<p>The <code>$if variable</code> construct provides simple equality tests for Readline variables and values. The permitted comparison operators are <code>=</code>, <code>==</code>, and <code>!=</code>. The variable name must be separated from the comparison operator by whitespace; the operator may be separated from the value on the right hand side by whitespace. Both string and boolean variables may be tested. Boolean variables must be tested against the values <em>on</em> and <em>off</em>. The following example is equivalent to the <code>mode=emacs</code> test described above:</p> <p>The <code>$if variable</code> construct provides simple equality tests for Readline variables and values. The permitted comparison operators are <code>=</code>, <code>==</code>, and <code>!=</code>. The variable name must be separated from the comparison operator by whitespace; the operator may be separated from the value on the right hand side by whitespace. Both string and boolean variables may be tested. Boolean variables must be tested against the values <em>on</em> and <em>off</em>. The following example is equivalent to the <code>mode=emacs</code> test described above:</p>
<pre><code class="language-plaintext">$if editing-mode == emacs <pre><code class="language-inputrc">$if editing-mode == emacs
set show-mode-in-prompt on set show-mode-in-prompt on
$endif $endif
</code></pre> </code></pre>
@ -2507,63 +2626,62 @@ $endif
<p><dt class="toppadding">$include</dt></p><dd> <p><dt class="toppadding">$include</dt></p><dd>
<p>This directive takes a single filename as an argument and reads commands and bindings from that file. For example, the following directive reads from &quot;c:\dir\inputrc&quot;:</p> <p>This directive takes a single filename as an argument and reads commands and bindings from that file. For example, the following directive reads from &quot;c:\dir\inputrc&quot;:</p>
<pre><code class="language-plaintext">$include c:\dir\inputrc <pre><code class="language-inputrc">$include c:\dir\inputrc
</code></pre> </code></pre>
</dd> </dd>
<h4 id="sample-inputrc-file"><div class="wlink"><a href="#sample-inputrc-file"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Sample .inputrc file</h4> <h4 id="sample-inputrc-file"><div class="wlink"><a href="#sample-inputrc-file"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Sample .inputrc file</h4>
<p>Here is a sample <code>.inputrc</code> file with some of the variables and key bindings that I use:</p> <p>Here is a sample <code>.inputrc</code> file with some of the variables and key bindings that I use:</p>
<pre><code class="plaintext"><span class="hljs-meta">$if clink</span> <span class="hljs-comment"># begin clink-only section</span> <pre><code class="language-inputrc">$if clink # begin clink-only section
<span class="hljs-meta">set colored-completion-prefix on</span> set colored-completion-prefix on
<span class="hljs-meta">set colored-stats on</span> set colored-stats on
<span class="hljs-meta">set mark-symlinked-directories on</span> set mark-symlinked-directories on
<span class="hljs-meta">set visible-stats off</span> set visible-stats off
<span class="hljs-meta">set completion-auto-query-items on</span> set completion-auto-query-items on
<span class="hljs-meta">set history-point-at-end-of-anchored-search on</span> set history-point-at-end-of-anchored-search on
<span class="hljs-meta">set menu-complete-wraparound off</span> set menu-complete-wraparound off
<span class="hljs-meta">set search-ignore-case on</span> set search-ignore-case on
<span class="hljs-comment"># The following key bindings are for emacs mode.</span> # The following key bindings are for emacs mode.
<span class="hljs-meta">set keymap emacs</span> set keymap emacs
<span class="hljs-string">"\e[27;8;72~"</span>: clink-popup-show-help <span class="hljs-comment"># Alt-Ctrl-Shift-H</span> &quot;\e[27;8;72~&quot;: clink-popup-show-help # Alt-Ctrl-Shift-H
<span class="hljs-comment"># Completion key bindings.</span> # Completion key bindings.
<span class="hljs-string">"\t"</span>: old-menu-complete <span class="hljs-comment"># Tab</span> &quot;\t&quot;: old-menu-complete # Tab
<span class="hljs-string">"\e[Z"</span>: old-menu-complete-backward <span class="hljs-comment"># Shift-Tab</span> &quot;\e[Z&quot;: old-menu-complete-backward # Shift-Tab
<span class="hljs-string">"\e[27;5;32~"</span>: clink-select-complete <span class="hljs-comment"># Ctrl-Space</span> &quot;\e[27;5;32~&quot;: clink-select-complete # Ctrl-Space
<span class="hljs-comment"># Some key bindings I got used to from 4Dos/4NT/Take Command.</span> # Some key bindings I got used to from 4Dos/4NT/Take Command.
C-b: <span class="hljs-comment"># Ctrl-B (cleared because I redefined Ctrl-F)</span> C-b: # Ctrl-B (cleared because I redefined Ctrl-F)
C-d: remove-history <span class="hljs-comment"># Ctrl-D (replaces `delete-char`)</span> C-d: remove-history # Ctrl-D (replaces `delete-char`)
C-f: clink-expand-doskey-alias <span class="hljs-comment"># Ctrl-F (replaces `forward-char`)</span> C-f: clink-expand-doskey-alias # Ctrl-F (replaces `forward-char`)
C-k: add-history <span class="hljs-comment"># Ctrl-K (replaces `kill-line`)</span> C-k: add-history # Ctrl-K (replaces `kill-line`)
<span class="hljs-string">"\e[A"</span>: history-search-backward <span class="hljs-comment"># Up (replaces `previous-history`)</span> &quot;\e[A&quot;: history-search-backward # Up (replaces `previous-history`)
<span class="hljs-string">"\e[B"</span>: history-search-forward <span class="hljs-comment"># Down (replaces `next-history`)</span> &quot;\e[B&quot;: history-search-forward # Down (replaces `next-history`)
<span class="hljs-string">"\e[5~"</span>: clink-popup-history <span class="hljs-comment"># PgUp (replaces `history-search-backward`)</span> &quot;\e[5~&quot;: clink-popup-history # PgUp (replaces `history-search-backward`)
<span class="hljs-string">"\e[6~"</span>: <span class="hljs-comment"># PgDn (cleared because I redefined PgUp)</span> &quot;\e[6~&quot;: # PgDn (cleared because I redefined PgUp)
<span class="hljs-string">"\e[1;5F"</span>: end-of-line <span class="hljs-comment"># Ctrl-End (replaces `kill-line`)</span> &quot;\e[1;5F&quot;: end-of-line # Ctrl-End (replaces `kill-line`)
<span class="hljs-string">"\e[1;5H"</span>: beginning-of-line <span class="hljs-comment"># Ctrl-Home (replaces `backward-kill-line`)</span> &quot;\e[1;5H&quot;: beginning-of-line # Ctrl-Home (replaces `backward-kill-line`)
<span class="hljs-comment"># Some key bindings handy in default (conhost) console windows.</span> # Some key bindings handy in default (conhost) console windows.
M-b: <span class="hljs-comment"># Alt-B (cleared because I redefined Alt-F)</span> M-b: # Alt-B (cleared because I redefined Alt-F)
M-f: clink-find-conhost <span class="hljs-comment"># Alt-F for "Find..." from the console's system menu</span> M-f: clink-find-conhost # Alt-F for &quot;Find...&quot; from the console&#39;s system menu
M-m: clink-mark-conhost <span class="hljs-comment"># Alt-M for "Mark" from the console's system menu</span> M-m: clink-mark-conhost # Alt-M for &quot;Mark&quot; from the console&#39;s system menu
<span class="hljs-comment"># Some key bindings for interrogating the Readline configuration.</span> # Some key bindings for interrogating the Readline configuration.
<span class="hljs-string">"\C-x\C-f"</span>: dump-functions <span class="hljs-comment"># Ctrl-X, Ctrl-F</span> &quot;\C-x\C-f&quot;: dump-functions # Ctrl-X, Ctrl-F
<span class="hljs-string">"\C-x\C-m"</span>: dump-macros <span class="hljs-comment"># Ctrl-X, Ctrl-M</span> &quot;\C-x\C-m&quot;: dump-macros # Ctrl-X, Ctrl-M
<span class="hljs-string">"\C-x\C-v"</span>: dump-variables <span class="hljs-comment"># Ctrl-X, Ctrl-V</span> &quot;\C-x\C-v&quot;: dump-variables # Ctrl-X, Ctrl-V
<span class="hljs-comment"># Misc other key bindings.</span> # Misc other key bindings.
<span class="hljs-string">"\e[27;2;32~"</span>: clink-magic-suggest-space <span class="hljs-comment"># Shift-Space</span> &quot;\e[27;2;32~&quot;: clink-magic-suggest-space # Shift-Space
<span class="hljs-string">"\e[5;6~"</span>: clink-popup-directories <span class="hljs-comment"># Ctrl-Shift-PgUp</span> &quot;\e[5;6~&quot;: clink-popup-directories # Ctrl-Shift-PgUp
C-_: kill-line <span class="hljs-comment"># Ctrl-- (replaces `undo`)</span> C-_: kill-line # Ctrl-- (replaces `undo`)
<span class="hljs-meta">$endif</span> <span class="hljs-comment"># end clink-only section</span> $endif # end clink-only section
</code></pre> </code></pre>
<h2 id="bindable-commands"><div class="wlink"><a href="#bindable-commands"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Bindable Commands</h2> <h2 id="bindable-commands"><div class="wlink"><a href="#bindable-commands"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Bindable Commands</h2>
<h3 id="commands-for-moving"><div class="wlink"><a href="#commands-for-moving"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Commands For Moving</h3> <h3 id="commands-for-moving"><div class="wlink"><a href="#commands-for-moving"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Commands For Moving</h3>
<table> <table>
@ -3663,7 +3781,7 @@ C-_: kill-line <span class="hljs-comment">#
<p><strong>Notes:</strong></p> <p><strong>Notes:</strong></p>
<ul> <ul>
<li>&quot;completions&quot; is a special reserved directory name: a &quot;completions&quot; directory under any of the Lua script directories listed in <code>clink info</code> has special meaning, and should not contain scripts unless they are specially written to be put in a &quot;completions&quot; directory. See <a href="#completion-directories">Completion directories</a> for more information.</li> <li>&quot;completions&quot; is a special reserved directory name: a &quot;completions&quot; directory under any of the Lua script directories listed in <code>clink info</code> has special meaning, and should not contain scripts unless they are specially written to be put in a &quot;completions&quot; directory. See <a href="#completion-directories">Completion directories</a> for more information.</li>
<li>Clink performs tilde expansion on the Lua script directory names. If the path begins with <code>~\</code> then it is replaced with the current user&#39;s home directory (<code>%HOMEDRIVE%%HOMEPATH%</code> or <code>%USERPROFILE%</code>).</li> <li>Clink performs tilde expansion on the Lua script directory names. If the path begins with <code>~\</code> then it is replaced with the current user&#39;s home directory (<code>%HOME%</code> or <code>%HOMEDRIVE%%HOMEPATH%</code> or <code>%USERPROFILE%</code>).</li>
</ul> </ul>
</blockquote> </blockquote>
<h3 id="completion-directories"><div class="wlink"><a href="#completion-directories"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Completion directories</h3> <h3 id="completion-directories"><div class="wlink"><a href="#completion-directories"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Completion directories</h3>
@ -3675,6 +3793,7 @@ C-_: kill-line <span class="hljs-comment">#
<li>Any directories listed in the <code>%CLINK_COMPLETIONS_DIR%</code> environment variable (multiple directories may be separated by semicolons).</li> <li>Any directories listed in the <code>%CLINK_COMPLETIONS_DIR%</code> environment variable (multiple directories may be separated by semicolons).</li>
<li>A <code>completions\</code> subdirectory under each scripts directory listed by <code>clink info</code> (see <a href="#lua-scripts-location">Location of Lua Scripts</a>).</li> <li>A <code>completions\</code> subdirectory under each scripts directory listed by <code>clink info</code> (see <a href="#lua-scripts-location">Location of Lua Scripts</a>).</li>
</ol> </ol>
<p>In v1.5.3 and higher, when a <code>completions\</code> script is loaded on demand the script receives as an argument the fully qualified path name to the typed program or file. The script can access the argument by using <code>local fullname = ...</code> (literally three dots). For example, that can be useful for checking whether it&#39;s a supported program, registering different argmatchers for different copies of the program or file, checking whether it&#39;s a supported program, and so on.</p>
<blockquote> <blockquote>
<p><strong>Note:</strong> If you download scripts, then don&#39;t put them in a &quot;completions&quot; directory unless they specifically say they can be put there.</p> <p><strong>Note:</strong> If you download scripts, then don&#39;t put them in a &quot;completions&quot; directory unless they specifically say they can be put there.</p>
<p>If a script defines more than an argmatcher, then putting it in a completions directory may cause its other functionality to not work until a command is typed with the same name as the script. For example, if a script in a completions directory defines an argmatcher and also a prompt filter, the prompt filter won&#39;t be loaded until the corresponding command name is typed. Whether that is desirable depends on the script and on your preference.</p> <p>If a script defines more than an argmatcher, then putting it in a completions directory may cause its other functionality to not work until a command is typed with the same name as the script. For example, if a script in a completions directory defines an argmatcher and also a prompt filter, the prompt filter won&#39;t be loaded until the corresponding command name is typed. Whether that is desirable depends on the script and on your preference.</p>
@ -3977,7 +4096,11 @@ function my_match_generator:generate(line_state, match_builder)
end end
</code></pre> </code></pre>
<blockquote> <blockquote>
<p><strong>Note:</strong> In v1.3.1 and higher, the table received by the registered ondisplaymatches function includes all the match fields (such as <code>display</code>, <code>description</code>, <code>appendchar</code>, etc), and the returned table can also include any of these fields. In other words, in v1.3.1 and higher match filtering supports all the same fields as <a href="#builder:addmatch">builder:addmatch()</a>.</p> <p><strong>Compatibility Notes:</strong></p>
<ul>
<li>In v1.3.1 and higher, the table received by the registered ondisplaymatches function includes all the match fields (such as <code>display</code>, <code>description</code>, <code>appendchar</code>, etc), and the function can include any of these fields in the table it returns. In other words, in v1.3.1 and higher match filtering supports all the same fields as <a href="#builder:addmatch">builder:addmatch()</a>.</li>
<li>In v1.5.4 and higher, the table received by the registered ondisplaymatches function can include an <code>arginfo</code> field, and the function can include <code>arginfo</code> in the table it returns.</li>
</ul>
</blockquote> </blockquote>
<p><a name="argumentcompletion"></a></p> <p><a name="argumentcompletion"></a></p>
<h2 id="argument-completion"><div class="wlink"><a href="#argumentcompletion"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Argument Completion</h2> <h2 id="argument-completion"><div class="wlink"><a href="#argumentcompletion"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Argument Completion</h2>
@ -4010,15 +4133,15 @@ end
<p>Arguments are positional. Each <code>:addarg()</code> adds a new argument position and defines the possible completions for that argument position.</p> <p>Arguments are positional. Each <code>:addarg()</code> adds a new argument position and defines the possible completions for that argument position.</p>
<p>Flags are position independent. Any <code>:addflags()</code> add to the set of possible flag completions. Any word that begins with the flag prefix character (in this example <code>-</code>) is considered to be a flag, even if it is not listed as a possible completion. The flags may be input at any position; before arguments, between arguments, and after arguments.</p> <p>Flags are position independent. Any <code>:addflags()</code> add to the set of possible flag completions. Any word that begins with the flag prefix character (in this example <code>-</code>) is considered to be a flag, even if it is not listed as a possible completion. The flags may be input at any position; before arguments, between arguments, and after arguments.</p>
<p>On the command line completion would look something like this, if <kbd>Alt</kbd>-<kbd>=</kbd> were pressed at the end of each input line below:</p> <p>On the command line completion would look something like this, if <kbd>Alt</kbd>-<kbd>=</kbd> were pressed at the end of each input line below:</p>
<pre style="border-radius:initial;border:initial"><code class="plaintext" style="background-color:black;color:#cccccc">C:\&gt;foobar - <pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"><span class="color_default">C:\&gt;<span class="color_argmatcher">foobar</span> <span class="color_input">-</span>
-bar -foo -bar -foo
C:\&gt;foobar -bar hello C:\&gt;<span class="color_argmatcher">foobar</span> <span class="color_flag">-bar</span> <span class="color_arg">hello</span>
wombles world xyzzy wombles world xyzzy
C:\&gt;foobar -bar hello wo C:\&gt;<span class="color_argmatcher">foobar</span> <span class="color_flag">-bar</span> <span class="color_arg">hello</span> <span class="color_input">wo</span>
wombles world wombles world
C:\&gt;foobar -bar hello wombles - C:\&gt;<span class="color_argmatcher">foobar</span> <span class="color_flag">-bar</span> <span class="color_arg">hello</span> <span class="color_arg">wombles</span> <span class="color_input">-</span>
-bar -foo -bar -foo
C:\&gt;foobar -bar hello wombles -foo <span style="color:#ffffff">_</span> C:\&gt;<span class="color_argmatcher">foobar</span> <span class="color_flag">-bar</span> <span class="color_arg">hello</span> <span class="color_arg">wombles</span> <span class="color_flag">-foo</span> <span class="cursor">_</span></span>
</code></pre> </code></pre>
<p>When displaying possible completions, flag matches are only shown if the flag character has been input. So <code>foobar </code> and <kbd>Alt</kbd>-<kbd>=</kbd> would list matches for the first argument position, or <code>foobar some_word </code> and <kbd>Alt</kbd>-<kbd>=</kbd> would list matches for the second argument position, or <code>foobar -</code> and <kbd>Alt</kbd>-<kbd>=</kbd> would list only flag matches.</p> <p>When displaying possible completions, flag matches are only shown if the flag character has been input. So <code>foobar </code> and <kbd>Alt</kbd>-<kbd>=</kbd> would list matches for the first argument position, or <code>foobar some_word </code> and <kbd>Alt</kbd>-<kbd>=</kbd> would list matches for the second argument position, or <code>foobar -</code> and <kbd>Alt</kbd>-<kbd>=</kbd> would list only flag matches.</p>
@ -4036,9 +4159,9 @@ C:\&gt;foobar -bar hello wombles -foo <span style="color:#ffffff">_</span>
:addflags(&quot;-foo&quot;, &quot;-bar&quot;) -- Flags. :addflags(&quot;-foo&quot;, &quot;-bar&quot;) -- Flags.
</code></pre> </code></pre>
<p>When completing a word that doesn&#39;t have a corresponding argument position the argmatcher will automatically use filename completion. For example, the <code>foobar</code> argmatcher has two argument positions, and completing a third word uses filename completion.</p> <p>When completing a word that doesn&#39;t have a corresponding argument position the argmatcher will automatically use filename completion. For example, the <code>foobar</code> argmatcher has two argument positions, and completing a third word uses filename completion.</p>
<pre style="border-radius:initial;border:initial"><code class="plaintext" style="background-color:black;color:#cccccc">C:\&gt;foobar hello world pro <pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"><span class="color_default">C:\&gt;<span class="color_argmatcher">foobar</span> <span class="color_arg">hello</span> <span class="color_arg">world</span> <span class="color_input">pro</span>
Program Files\ Program Files(x86)\ ProgramData\ Program Files\ Program Files(x86)\ ProgramData\
C:\&gt;foobar hello world pro<span style="color:#ffffff">_</span> C:\&gt;<span class="color_argmatcher">foobar</span> <span class="color_arg">hello</span> <span class="color_arg">world</span> <span class="color_input">pro</span><span class="cursor">_</span></span>
</code></pre> </code></pre>
<p>Use <a href="#_argmatcher:nofiles">_argmatcher:nofiles()</a> if you want to disable the automatic filename completion and &quot;dead end&quot; an argmatcher for extra words. This stops all further parsing for the command.</p> <p>Use <a href="#_argmatcher:nofiles">_argmatcher:nofiles()</a> if you want to disable the automatic filename completion and &quot;dead end&quot; an argmatcher for extra words. This stops all further parsing for the command.</p>
@ -4311,7 +4434,7 @@ clink.argmatcher()
<p>With the shorthand form flags are implied rather than declared. When a shorthand table&#39;s first value is a string starting with <code>-</code> or <code>/</code> then the table is interpreted as flags. Note that it&#39;s still possible with shorthand form to mix flag prefixes, and even add additional flag prefixes, such as <code>{ <span class="hljs-string">'-a'</span>, <span class="hljs-string">'/b'</span>, <span class="hljs-string">'=c'</span> }</code>.</p> <p>With the shorthand form flags are implied rather than declared. When a shorthand table&#39;s first value is a string starting with <code>-</code> or <code>/</code> then the table is interpreted as flags. Note that it&#39;s still possible with shorthand form to mix flag prefixes, and even add additional flag prefixes, such as <code>{ <span class="hljs-string">'-a'</span>, <span class="hljs-string">'/b'</span>, <span class="hljs-string">'=c'</span> }</code>.</p>
<p><a name="classifywords"></a></p> <p><a name="classifywords"></a></p>
<h2 id="coloring-the-input-text"><div class="wlink"><a href="#classifywords"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Coloring the Input Text</h2> <h2 id="coloring-the-input-text"><div class="wlink"><a href="#classifywords"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Coloring the Input Text</h2>
<p>When the <code><a href="#clink_colorize_input">clink.colorize_input</a></code> setting is disabled, then the entire input line is colored by the <code><a href="#color_input">color.input</a></code> setting. When the setting is enabled, then <a href="#argumentcompletion">argmatchers</a> automatically apply colors to the input text as they parse it.</p> <p>When the <code><a href="#clink_colorize_input">clink.colorize_input</a></code> setting is enabled, then <a href="#argumentcompletion">argmatchers</a> automatically apply colors to the input text as they parse it. When the setting is disabled, then the entire input line is colored by the <code><a href="#color_input">color.input</a></code> setting.</p>
<table class="linkmenu"> <table class="linkmenu">
<tr><td><a href="#inputcolor_command">Coloring the Command Word</a></td><td>How the command word is colored.</td></tr> <tr><td><a href="#inputcolor_command">Coloring the Command Word</a></td><td>How the command word is colored.</td></tr>
<tr><td><a href="#inputcolor_redir">Coloring Command Separators and Redirection</a></td><td>How special characters are colored.</td></tr> <tr><td><a href="#inputcolor_redir">Coloring Command Separators and Redirection</a></td><td>How special characters are colored.</td></tr>
@ -4333,13 +4456,13 @@ clink.argmatcher()
<li>If none of the above apply, then <code><a href="#color_input">color.input</a></code> is used.</li> <li>If none of the above apply, then <code><a href="#color_input">color.input</a></code> is used.</li>
</ol> </ol>
<p>Here are examples, using the colors from the <a href="#gettingstarted_enhanceddefaults">Use enhanced defaults</a> installation option:</p> <p>Here are examples, using the colors from the <a href="#gettingstarted_enhanceddefaults">Use enhanced defaults</a> installation option:</p>
<pre style="border-radius:initial;border:initial"><code class="plaintext" style="background-color:black"><table class="console" cellpadding=0 cellspacing=0> <pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"><table class="console" cellpadding=0 cellspacing=0>
<tr><td><span style="color:#c0c0c0">c:\dir></span><span style="color:#00d700">clink</span></td><td style="color:#d7d7d7;text-align:right"><em>'clink' has an argmatcher</em></td></tr> <tr><td class="color_default">c:\dir><span class="color_argmatcher">clink</span></td><td class="right_gray">'clink' has an argmatcher</td></tr>
<tr><td><span style="color:#c0c0c0">c:\dir></span><span style="color:#ffffff">attrib</span></td><td style="color:#d7d7d7;text-align:right"><em>'attrib' is a CMD command</em></td></tr> <tr><td class="color_default">c:\dir><span class="color_cmd">attrib</span></td><td class="right_gray">'attrib' is a CMD command</td></tr>
<tr><td><span style="color:#c0c0c0">c:\dir></span><span style="color:#5fafff">myalias</span></td><td style="color:#d7d7d7;text-align:right"><em>if 'myalias' is a doskey alias</em></td></tr> <tr><td class="color_default">c:\dir><span class="color_doskey">myalias</span></td><td class="right_gray">if 'myalias' is a doskey alias</td></tr>
<tr><td><span style="color:#c0c0c0">c:\dir></span><span style="color:#0087ff">control</span></td><td style="color:#d7d7d7;text-align:right"><em>'control' is an executable</em></td></tr> <tr><td class="color_default">c:\dir><span class="color_executable">control</span></td><td class="right_gray">'control' is an executable</td></tr>
<tr><td><span style="color:#c0c0c0">c:\dir></span><span style="color:#ff5f5f">xyzabc123</span></td><td style="color:#d7d7d7;text-align:right"><em>unrecognized</em></td></tr> <tr><td class="color_default">c:\dir><span class="color_unrecognized">xyzabc123</span></td><td class="right_gray">unrecognized</td></tr>
<tr><td><span style="color:#c0c0c0">c:\dir></span><span style="color:#ffd787">whatever</span></td><td style="color:#d7d7d7;text-align:right"><em>if executable and unrecognized colors are not set</em></td></tr> <tr><td class="color_default">c:\dir><span class="color_input">whatever</span></td><td class="right_gray">if executable and unrecognized colors are not set</td></tr>
</table></code></pre> </table></code></pre>
<p><a name="inputcolor_redir"></a></p> <p><a name="inputcolor_redir"></a></p>
@ -4351,9 +4474,9 @@ clink.argmatcher()
<li>Redirected files use <code><a href="#color_input">color.input</a></code>.</li> <li>Redirected files use <code><a href="#color_input">color.input</a></code>.</li>
</ul> </ul>
<p>Here are examples, using the colors from the <a href="#gettingstarted_enhanceddefaults">Use enhanced defaults</a> installation option:</p> <p>Here are examples, using the colors from the <a href="#gettingstarted_enhanceddefaults">Use enhanced defaults</a> installation option:</p>
<pre style="border-radius:initial;border:initial"><code class="plaintext" style="background-color:black"><table class="console" cellpadding=0 cellspacing=0> <pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"><table class="console" cellpadding=0 cellspacing=0>
<tr><td><span style="color:#c0c0c0">c:\dir></span><span style="color:#ffffff">pushd</span> <span style="color:#ffaf00">&</span> <span style="color:#ffffff">popd</span></td><td style="color:#d7d7d7;text-align:right"><em>'&' is the command separator</em></td></tr> <tr><td class="color_default">c:\dir><span class="color_cmd">pushd</span> <span class="color_cmdsep">&</span> <span class="color_cmd">popd</span></td><td class="right_gray">'&' is the command separator</td></tr>
<tr><td><span style="color:#c0c0c0">c:\dir></span><span style="color:#ffffff">set</span> <span style="color:#d78700">&gt;</span><span style="color:#ffd787">file</span></td><td style="color:#d7d7d7;text-align:right"><em>redirecting 'set' to 'file'</em></td></tr> <tr><td class="color_default">c:\dir><span class="color_cmd">set</span> <span class="color_cmdredir">&gt;</span><span class="color_input">file</span></td><td class="right_gray">redirecting 'set' to 'file'</td></tr>
</table></code></pre> </table></code></pre>
<p><a name="inputcolor_other"></a></p> <p><a name="inputcolor_other"></a></p>
@ -4363,15 +4486,17 @@ clink.argmatcher()
<li>If an argmatcher isn&#39;t defined for a command, then the input text is colored using <code><a href="#color_input">color.input</a></code>.</li> <li>If an argmatcher isn&#39;t defined for a command, then the input text is colored using <code><a href="#color_input">color.input</a></code>.</li>
<li>Flags defined by the command&#39;s argmatcher use <code><a href="#color_flag">color.flag</a></code>.</li> <li>Flags defined by the command&#39;s argmatcher use <code><a href="#color_flag">color.flag</a></code>.</li>
<li>Arguments defined by the command&#39;s argmatcher use <code><a href="#color_arg">color.arg</a></code>.</li> <li>Arguments defined by the command&#39;s argmatcher use <code><a href="#color_arg">color.arg</a></code>.</li>
<li>Text the goes past what the command&#39;s argmatcher expects uses <code><a href="#color_unexpected">color.unexpected</a></code>.</li> <li>Text that goes past what the command&#39;s argmatcher expects uses <code><a href="#color_unexpected">color.unexpected</a></code>.</li>
<li><a href="#gettingstarted_autosuggest">Auto-suggestion</a> text uses <code><a href="#color_suggestion">color.suggestion</a></code>.</li>
</ul> </ul>
<p>Here are examples, using the colors from the <a href="#gettingstarted_enhanceddefaults">Use enhanced defaults</a> installation option:</p> <p>Here are examples, using the colors from the <a href="#gettingstarted_enhanceddefaults">Use enhanced defaults</a> installation option:</p>
<pre style="border-radius:initial;border:initial"><code class="plaintext" style="background-color:black"><table class="console" cellpadding=0 cellspacing=0> <pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"><table class="console" cellpadding=0 cellspacing=0>
<tr><td><span style="color:#c0c0c0">c:\dir></span><span style="color:#00d700">clink</span> <span style="color:#87d7ff">--help</span></td><td style="color:#d7d7d7;text-align:right"><em>'--help' is defined as a flag for 'clink'</em></td></tr> <tr><td class="color_default">c:\dir><span class="color_argmatcher">clink</span> <span class="color_flag">--help</span></td><td class="right_gray">'--help' is defined as a flag for 'clink'</td></tr>
<tr><td><span style="color:#c0c0c0">c:\dir></span><span style="color:#00d700">clink</span> <span style="color:#ffffff">set</span></td><td style="color:#d7d7d7;text-align:right"><em>'set' is defined as an argument for 'clink'</em></td></tr> <tr><td class="color_default">c:\dir><span class="color_argmatcher">clink</span> <span class="color_arg">set</span></td><td class="right_gray">'set' is defined as an argument for 'clink'</td></tr>
<tr><td><span style="color:#c0c0c0">c:\dir></span><span style="color:#00d700">clink</span> <span style="color:#ffffff">set</span> <span style="color:#ffffff">color.arg</span></td><td style="color:#d7d7d7;text-align:right"><em>'color.arg' is defined as an argument for 'clink set'</em></td></tr> <tr><td class="color_default">c:\dir><span class="color_argmatcher">clink</span> <span class="color_arg">set</span> <span class="color_arg">color.arg</span></td><td class="right_gray">'color.arg' is defined as an argument for 'clink set'</td></tr>
<tr><td><span style="color:#c0c0c0">c:\dir></span><span style="color:#00d700">clink</span> <span style="color:#ffffff">set</span> <span style="color:#c0c0c0">abc.xyz</span></td><td style="color:#d7d7d7;text-align:right"><em>'abc.xyz' is not a recognized argument for 'clink set'</em></td></tr> <tr><td class="color_default">c:\dir><span class="color_argmatcher">clink</span> <span class="color_arg">set</span> <span class="color_unexpected">abc.xyz</span></td><td class="right_gray">'abc.xyz' is not a recognized argument for 'clink set'</td></tr>
<tr><td><span style="color:#c0c0c0">c:\dir></span><span style="color:#0087ff">findstr</span> <span style="color:#ffd787">/s needle haystack\*</span></td><td style="color:#d7d7d7;text-align:right"><em>if 'findstr' has no argmatcher, all words use 'color.input'</em></td></tr> <tr><td class="color_default">c:\dir><span class="color_executable">findstr</span> <span class="color_input">/s needle haystack\*</span></td><td class="right_gray">if 'findstr' has no argmatcher, all words use 'color.input'</td></tr>
<tr><td class="color_default">c:\dir><span class="color_executable">findstr</span> <span class="color_input">/s</span><span class="cursor">_</span><span class="color_suggestion">needle haystack\*</span></td><td class="right_gray">press RIGHT to accept an auto-suggestion</td></tr>
</table></code></pre> </table></code></pre>
<h3 id="more-advanced-stuff-2"><div class="wlink"><a href="#more-advanced-stuff-2"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>More Advanced Stuff</h3> <h3 id="more-advanced-stuff-2"><div class="wlink"><a href="#more-advanced-stuff-2"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>More Advanced Stuff</h3>
@ -4568,12 +4693,12 @@ function bracket_prompt:filter(prompt)
end end
</code></pre> </code></pre>
<p>The resulting prompt will look like this:</p> <p>The resulting prompt will look like this:</p>
<pre style="border-radius:initial;border:initial"><code class="plaintext" style="background-color:black"><span style="color:#00ff00">Wed 12:54</span> <span style="color:#ffff00">c:\dir</span> <span style="color:#008080">[master]</span> <pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"><span class="color_default"><span style="color:#00ff00">Tue 12:54</span> <span style="color:#ffff00">c:\dir</span> <span style="color:#008080">[master]</span>
<span style="color:#cccccc">&gt;&nbsp;_</span> &gt;&nbsp;<span class="cursor">_</span></span>
</code></pre> </code></pre>
<p>...except on Wednesdays, when it will look like this:</p> <p>...except on Wednesdays, when it will look like this:</p>
<pre style="border-radius:initial;border:initial"><code class="plaintext" style="background-color:black"><span style="color:#00ff00">Wed 12:54</span> <span style="color:#ffff00">c:\dir</span> <span style="color:#cccccc">HAPPY HUMP DAY!&nbsp;_</span> <pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"><span class="color_default"><span style="color:#00ff00">Wed 12:54</span> <span style="color:#ffff00">c:\dir</span> HAPPY HUMP DAY!&nbsp;<span class="cursor">_</span></span>
</code></pre> </code></pre>
<p/> <p/>
@ -4864,7 +4989,8 @@ end
<tr><td><a href="#keybindings">Customizing Key Bindings</a></td><td>How to customize key bindings.</td></tr> <tr><td><a href="#keybindings">Customizing Key Bindings</a></td><td>How to customize key bindings.</td></tr>
<tr><td><a href="#saved-command-history">Saved Command History</a></td><td>How the saved command history works.</td></tr> <tr><td><a href="#saved-command-history">Saved Command History</a></td><td>How the saved command history works.</td></tr>
<tr><td><a href="#using-history-expansion">Using History Expansion</a></td><td>How to use history expansion.</td></tr> <tr><td><a href="#using-history-expansion">Using History Expansion</a></td><td>How to use history expansion.</td></tr>
<tr><td><a href="#directory-shortcuts">Directory Shortcuts</a></td><td>Convenient shortcut for changing the current directory.</td></tr> <tr><td><a href="#directory-shortcuts">Directory Shortcuts</a></td><td>Convenient shortcuts for changing the current directory.</td></tr>
<tr><td><a href="#enhanced-doskey-expansion">Enhanced Doskey Expansion</a></td><td>How enhanced Doskey expansion works.</td></tr>
<tr><td><a href="#popular-scripts">Popular Scripts</a></td><td>Some popular scripts to enhance Clink.</td></tr> <tr><td><a href="#popular-scripts">Popular Scripts</a></td><td>Some popular scripts to enhance Clink.</td></tr>
<tr><td><a href="#terminal-support">Terminal Support</a></td><td>Information about how Clink's terminal support works.</td></tr> <tr><td><a href="#terminal-support">Terminal Support</a></td><td>Information about how Clink's terminal support works.</td></tr>
<tr><td><a href="#troubleshooting-tips">Troubleshooting Tips</a></td><td>How to troubleshoot and report problems.</td></tr> <tr><td><a href="#troubleshooting-tips">Troubleshooting Tips</a></td><td>How to troubleshoot and report problems.</td></tr>
@ -5518,12 +5644,7 @@ end
<p>But it might be more convenient to acquire a keyboard that has an <kbd>Alt</kbd> key.</p> <p>But it might be more convenient to acquire a keyboard that has an <kbd>Alt</kbd> key.</p>
<h2 id="saved-command-history"><div class="wlink"><a href="#saved-command-history"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Saved Command History</h2> <h2 id="saved-command-history"><div class="wlink"><a href="#saved-command-history"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Saved Command History</h2>
<p>Clink has a list of commands from the current session, and it can be saved and loaded across sessions.</p> <p>Clink has a list of commands from the current session, and it can be saved and loaded across sessions.</p>
<p>A line won&#39;t be added to history if either of the following are true:</p> <p>By prefixing the command you can control whether it&#39;s added to history and whether a doskey alias may be expanded.</p>
<ul>
<li>The first word in the line matches one of the words in the <a href="#history_dont_add_to_history_cmds"><code>history.dont_add_to_history_cmds</code></a> setting.</li>
<li>The line begins with a space character.</li>
</ul>
<p>To prevent doskey alias expansion while still adding the line to history, you can start the line with a semicolon.</p>
<table> <table>
<thead> <thead>
<tr> <tr>
@ -5533,18 +5654,22 @@ end
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><code>somecmd</code></td> <td><code>somecmd</code></td>
<td>Expands doskey alias and adds to history.</td> <td>Can expand a doskey alias and adds to history.</td>
</tr> </tr>
<tr> <tr>
<td><code>&nbsp;somecmd</code></td> <td><code>&nbsp;somecmd</code></td>
<td>Doesn&#39;t expand doskey alias and doesn&#39;t add to history.</td> <td>Starting with a space doesn&#39;t expand a doskey alias and doesn&#39;t add to history.</td>
</tr> </tr>
<tr> <tr>
<td><code>;somecmd</code></td> <td><code>;somecmd</code></td>
<td>Doesn&#39;t expand doskey alias but does add to history.</td> <td>Starting with a semicolon doesn&#39;t expand a doskey alias but does add to history.</td>
</tr> </tr>
</tbody></table> </tbody></table>
<p>There are several settings that control how history works. Run <code>clink set history*</code> to see them.</p> <p>There are several settings that control how history works. Run <code>clink set history*</code> to see them all.</p>
<p><strong>Note:</strong> If the first word in the line matches one of the words in the <a href="#history_dont_add_to_history_cmds"><code>history.dont_add_to_history_cmds</code></a> setting then the command is not added to history. By default, <code>history</code> and <code>exit</code> are not added to history.</p>
<h3 id="list-the-history"><div class="wlink"><a href="#list-the-history"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>List the history</h3>
<p>Press <kbd>F7</kbd> for a popup list of selectable history entries.</p>
<p>You can also list the saved history by running <code>clink history</code> or the <code>history</code> doskey alias that Clink automatically defines. Use <code>history --help</code> for usage info.</p>
<h3 id="the-master-history-file"><div class="wlink"><a href="#the-master-history-file"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>The master history file</h3> <h3 id="the-master-history-file"><div class="wlink"><a href="#the-master-history-file"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>The master history file</h3>
<p>When the <a href="#history_save"><code>history.save</code></a> setting is enabled, then the command history is loaded and saved as follows (or when the setting is disabled, then it isn&#39;t saved between sessions).</p> <p>When the <a href="#history_save"><code>history.save</code></a> setting is enabled, then the command history is loaded and saved as follows (or when the setting is disabled, then it isn&#39;t saved between sessions).</p>
<p>Every time a new input line starts, Clink reloads the master history list and prunes it not to exceed the <a href="#history_max_lines"><code>history.max_lines</code></a> setting.</p> <p>Every time a new input line starts, Clink reloads the master history list and prunes it not to exceed the <a href="#history_max_lines"><code>history.max_lines</code></a> setting.</p>
@ -5935,7 +6060,16 @@ or edit, the word or words selected from the history event.</p>
</ul> </ul>
<p>These shortcuts only work in the interactive command line; they do not work in batch scripts.</p> <p>These shortcuts only work in the interactive command line; they do not work in batch scripts.</p>
<p><a name="sample-scripts"></a></p> <p><a name="sample-scripts"></a></p>
<h2 id="popular-scripts"><div class="wlink"><a href="#sample-scripts"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Popular Scripts</h2> <h2 id="enhanced-doskey-expansion"><div class="wlink"><a href="#sample-scripts"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Enhanced Doskey Expansion</h2>
<p>Enhanced Doskey expansion is enabled by default. You can turn it off by running <code>clink set <a href="#doskey_enhanced">doskey.enhanced</a> off</code>.</p>
<p>When enabled, this adds two behaviors:</p>
<ul>
<li>Expansion of Doskey macros that follow <code>|</code> and <code>&amp;</code> command separators.</li>
<li>Respects quotes around words when expanding <code>$1</code>...<code>$9</code> tags in Doskey macros.</li>
</ul>
<p>You can suppress macro expansion for an individual command by prefixing the command with a space or semicolon (e.g. <code>&nbsp;foo</code> or <code>;foo</code>). If the command follows a <code>|</code> or <code>&amp;</code> command separator, you can suppress macro expansion by prefixing the command with two spaces or a semicolon (e.g. <code>foo|&nbsp; bar</code> or <code>foo|;bar</code>).</p>
<p><strong>Note:</strong> Some Doskey macros might be incompatible with the enhanced Doskey expansion feature, especially if they use special or complicated syntax. If you encounter problems, you might need to turn off enhanced Doskey expansion or adjust the problematic macros.</p>
<h2 id="popular-scripts"><div class="wlink"><a href="#popular-scripts"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Popular Scripts</h2>
<p>Here are some popular scripts that show off what can be done with Clink.</p> <p>Here are some popular scripts that show off what can be done with Clink.</p>
<h3 id="clink-completions"><div class="wlink"><a href="#clink-completions"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>clink-completions</h3> <h3 id="clink-completions"><div class="wlink"><a href="#clink-completions"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>clink-completions</h3>
<p>The <a href="https://github.com/vladimir-kotikov/clink-completions">clink-completions</a> collection of scripts has a bunch of argument matchers and completion generators for things like git, mercurial, npm, and more.</p> <p>The <a href="https://github.com/vladimir-kotikov/clink-completions">clink-completions</a> collection of scripts has a bunch of argument matchers and completion generators for things like git, mercurial, npm, and more.</p>
@ -6025,7 +6159,7 @@ set CLINK_TERM_VS=\e[?12l
:addarg("red", "green", "blue") -- 1st argument is a color :addarg("red", "green", "blue") -- 1st argument is a color
:addarg("circle", "square", "triangle") -- 2nd argument is a shape</code></pre><p class="desc">When providing a table of arguments, the table can contain some special entries: <p><table> <tr><th>Entry</th><th>More Info</th><th>Version</th></tr> <tr><td><code>delayinit=<span class="arg">function</span></code></td><td>See <a href="#addarg_delayinit">Delayed initialization for an argument position</a>.</td><td class="version">v1.3.10 and newer</td></tr> <tr><td><code>fromhistory=true</code></td><td>See <a href="#addarg_fromhistory">Generate Matches From History</a>.</td><td class="version">v1.3.9 and newer</td></tr> <tr><td><code>loopchars="<span class="arg">characters</span>"</code></td><td>See <a href="#addarg_loopchars">Delimited Arguments</a>.</td><td class="version">v1.3.37 and newer</td></tr> <tr><td><code>nosort=true</code></td><td>See <a href="#addarg_nosort">Disable Sorting Matches</a>.</td><td class="version">v1.3.3 and newer</td></tr> <tr><td><code>onarg=<span class="arg">function</span></code></td><td>See <a href="#responsive-argmatchers">Responding to Arguments in Argmatchers</a>.</td><td class="version">v1.3.13 and newer</td></tr> </table></p> <strong>Note:</strong> Arguments are positional in an argmatcher. Using <code>:addarg()</code> multiple times adds multiple argument positions, in the order they are specified.</p></div></div><hr/> :addarg("circle", "square", "triangle") -- 2nd argument is a shape</code></pre><p class="desc">When providing a table of arguments, the table can contain some special entries: <p><table> <tr><th>Entry</th><th>More Info</th><th>Version</th></tr> <tr><td><code>delayinit=<span class="arg">function</span></code></td><td>See <a href="#addarg_delayinit">Delayed initialization for an argument position</a>.</td><td class="version">v1.3.10 and newer</td></tr> <tr><td><code>fromhistory=true</code></td><td>See <a href="#addarg_fromhistory">Generate Matches From History</a>.</td><td class="version">v1.3.9 and newer</td></tr> <tr><td><code>loopchars="<span class="arg">characters</span>"</code></td><td>See <a href="#addarg_loopchars">Delimited Arguments</a>.</td><td class="version">v1.3.37 and newer</td></tr> <tr><td><code>nosort=true</code></td><td>See <a href="#addarg_nosort">Disable Sorting Matches</a>.</td><td class="version">v1.3.3 and newer</td></tr> <tr><td><code>onarg=<span class="arg">function</span></code></td><td>See <a href="#responsive-argmatchers">Responding to Arguments in Argmatchers</a>.</td><td class="version">v1.3.13 and newer</td></tr> </table></p> <strong>Note:</strong> Arguments are positional in an argmatcher. Using <code>:addarg()</code> multiple times adds multiple argument positions, in the order they are specified.</p></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#_argmatcher:addargunsorted"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="_argmatcher:addargunsorted">_argmatcher:addargunsorted</a></div> <div class="signature">( <span class="arg_name">choices...</span>:string|table ) : self<br/><div class="version">v1.3.3 and newer</div></div></div><div class="body"><p class="desc">This is the same as <a href="#_argmatcher:addarg">_argmatcher:addarg</a> except that this disables sorting the matches.</p></div></div><hr/> <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#_argmatcher:addargunsorted"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="_argmatcher:addargunsorted">_argmatcher:addargunsorted</a></div> <div class="signature">( <span class="arg_name">choices...</span>:string|table ) : self<br/><div class="version">v1.3.3 and newer</div></div></div><div class="body"><p class="desc">This is the same as <a href="#_argmatcher:addarg">_argmatcher:addarg</a> except that this disables sorting the matches.</p></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#_argmatcher:adddescriptions"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="_argmatcher:adddescriptions">_argmatcher:adddescriptions</a></div> <div class="signature">( [<span class="arg_name">descriptions...</span>:table] ) : self<br/><div class="version">v1.2.38 and newer</div></div></div><div class="body"><p class="desc">Adds descriptions for arg matches and/or flag matches. Descriptions are displayed for their associated args or flags whenever possible completions are listed, for example by the <code><a href="#rlcmd-complete">complete</a></code> or <code><a href="#rlcmd-clink-select-complete">clink-select-complete</a></code> or <code><a href="#rlcmd-possible-completions">possible-completions</a></code> commands.</p><p class="desc"> Any number of descriptions tables may be passed to the function, and each table must use one of the following schemes: <ul> <li>One or more string values that are args or flags, and a <code>description</code> field that is the associated description string. <li>Key/value pairs where each key is an arg or flag, and its value is either a description string or a table containing an optional arguments string and a description string. If an arguments string is provided, it is appended to the arg or flag string when listing possible completions. For example, <code>["--user"] = { " name", "Specify username"}</code> gets printed as:</p><p class="desc"> <pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"> <span style="color:#c0c0c0">--user</span> <span style="color:#808000">name</span>&nbsp;&nbsp;&nbsp;&nbsp;<span style="color:#00ffff">Specify username</span> </code></pre> </ul></p><p class="desc"></p><pre class="language-lua"><code>local foo = clink.argmatcher("foo") <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#_argmatcher:adddescriptions"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="_argmatcher:adddescriptions">_argmatcher:adddescriptions</a></div> <div class="signature">( [<span class="arg_name">descriptions...</span>:table] ) : self<br/><div class="version">v1.2.38 and newer</div></div></div><div class="body"><p class="desc">Adds descriptions for arg matches and/or flag matches. Descriptions are displayed for their associated args or flags whenever possible completions are listed, for example by the <code><a href="#rlcmd-complete">complete</a></code> or <code><a href="#rlcmd-clink-select-complete">clink-select-complete</a></code> or <code><a href="#rlcmd-possible-completions">possible-completions</a></code> commands.</p><p class="desc"> Any number of descriptions tables may be passed to the function, and each table must use one of the following schemes: <ul> <li>One or more string values that are args or flags, and a <code>description</code> field that is the associated description string. <li>Key/value pairs where each key is an arg or flag, and its value is either a description string or a table containing an optional argument info string and a description string. If an argument info string is provided, it is appended to the arg or flag string when listing possible completions. For example, <code>["--user"] = { " name", "Specify username"}</code> gets printed as:</p><p class="desc"> <pre style="border-radius:initial;border:initial;background-color:black"><code class="plaintext" style="background-color:black"> <span class="color_default">--user</span> <span class="color_arginfo">name</span>&nbsp;&nbsp;&nbsp;&nbsp;<span class="color_description">Specify username</span> </code></pre> </ul></p><p class="desc"></p><pre class="language-lua"><code>local foo = clink.argmatcher("foo")
foo:addflags("-h", "--help", "--user") foo:addflags("-h", "--help", "--user")
foo:addarg("info", "set") foo:addarg("info", "set")
-- Example using first scheme and one table per description: -- Example using first scheme and one table per description:
@ -6110,11 +6244,12 @@ clink.argmatcher('some_command')
</div><div class="group"><h5 class="group_name"><span class="wlink"><a href="#builder"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder">builder</a></h5><div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:addmatch"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:addmatch">builder:addmatch</a></div> <div class="signature">( <span class="arg_name">match</span>:string|table, [<span class="arg_name">type</span>:string] ) : boolean<br/><div class="version">v1.0.0 and newer</div></div></div><div class="body"><p class="desc">Adds a match.</p><p class="desc"> The <span class="arg">match</span> argument is the match string to add.</p><p class="desc"> The <span class="arg">type</span> argument is the optional match type, or "none" if omitted (see below for the possible match types).</p><p class="desc"> Alternatively, the <span class="arg">match</span> argument can be a table with the following scheme:</p><pre class="language-lua"><code>{ </div><div class="group"><h5 class="group_name"><span class="wlink"><a href="#builder"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder">builder</a></h5><div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:addmatch"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:addmatch">builder:addmatch</a></div> <div class="signature">( <span class="arg_name">match</span>:string|table, [<span class="arg_name">type</span>:string] ) : boolean<br/><div class="version">v1.0.0 and newer</div></div></div><div class="body"><p class="desc">Adds a match.</p><p class="desc"> The <span class="arg">match</span> argument is the match string to add.</p><p class="desc"> The <span class="arg">type</span> argument is the optional match type, or "none" if omitted (see below for the possible match types).</p><p class="desc"> Alternatively, the <span class="arg">match</span> argument can be a table with the following scheme:</p><pre class="language-lua"><code>{
&nbsp; match = "..." -- [string] The match text. &nbsp; match = "..." -- [string] The match text.
&nbsp; display = "..." -- [string] OPTIONAL; alternative text to display when listing possible completions. &nbsp; display = "..." -- [string] OPTIONAL; alternative text to display when listing possible completions.
&nbsp; arginfo = "..." -- [string] OPTIONAL; an argument info string (requires v1.5.4 or greater).
&nbsp; description = "..." -- [string] OPTIONAL; a description for the match. &nbsp; description = "..." -- [string] OPTIONAL; a description for the match.
&nbsp; type = "..." -- [string] OPTIONAL; the match type. &nbsp; type = "..." -- [string] OPTIONAL; the match type.
&nbsp; appendchar = "..." -- [string] OPTIONAL; character to append after the match. &nbsp; appendchar = "..." -- [string] OPTIONAL; character to append after the match.
&nbsp; suppressappend = t_or_f -- [boolean] OPTIONAL; whether to suppress appending a character after the match. &nbsp; suppressappend = t_or_f -- [boolean] OPTIONAL; whether to suppress appending a character after the match.
}</code></pre><p class="desc"><ul> <li>The <code>display</code> field is optional, and is displayed instead of the <code>match</code> field when listing possible completions. It can even include ANSI escape codes for colors, etc. (Requires v1.2.38 or greater.) <li>The <code>description</code> field is optional, and is displayed in addition to <code>match</code> or <code>display</code> when listing possible completions. (Requires v1.2.38 or greater.) <li>The <code>type</code> field is optional. If omitted, then the <span class="arg">type</span> argument is used for that element. <li>The <code>appendchar</code> field is optional, and overrides the normal behavior for only this match. (Requires v1.3.1 or greater.) <li>The <code>suppressappend</code> field is optional, and overrides the normal behavior for only this match. (Requires v1.3.1 or greater.) </ul></p><p class="desc"> The match type affects how the match is inserted, displayed, and colored. Some type modifiers may be combined with a match type.</p><p class="desc"> <table> <tr><th>Type</th><th>Description</th></tr> <tr><td>"word"</td><td>Shows the whole word even if it contains slashes.</td></tr> <tr><td>"arg"</td><td>Avoids appending a space if the match ends with a colon or equal sign.</td></tr> <tr><td>"cmd"</td><td>Displays the match using <a href="#color_cmd">color.cmd</a>.</td></tr> <tr><td>"alias"</td><td>Displays the match using <a href="#color_doskey">color.doskey</a>.</td></tr> <tr><td>"file"</td><td>Shows only the last path component, with appropriate file coloring.</td></tr> <tr><td>"dir"</td><td>Shows only the last path component and adds a trailing path separator, with appropriate directory coloring.</td></tr> <tr><td>"none"</td><td>For backward compatibility the match is treated like "file", unless it ends with a path separator in which case it's treated like "dir".</td></tr> </table></p><p class="desc"> <table> <tr><th>Modifier</th><th>Description</th></tr> <tr><td>"hidden"</td><td>This can be combined with "file" or "dir" to use <a href="#color_hidden">color.hidden</a> (e.g. "file,hidden").</td></tr> <tr><td>"readonly"</td><td>This can be combined with "file" or "dir" to use <a href="#color_readonly">color.readonly</a> (e.g. "file,readonly").</td></tr> <tr><td>"link"</td><td>This can be combined with "file" or "dir" to appropriate symlink coloring (e.g. "file,link").</td></tr> <tr><td>"orphaned"</td><td>This can be combined with "link" to use appropriate orphaned symlink coloring (e.g. "file,link,orphaned").</td></tr> </table></p><p class="desc"> See <a href="#completioncolors">Completion Colors</a> and <a href="#colorsettings">Color Settings</a> for more information about colors.</p><pre class="language-lua"><code>builder:addmatch("hello") -- type is "none" }</code></pre><p class="desc"><ul> <li>The <code>display</code> field is optional, and is displayed instead of the <code>match</code> field when listing possible completions. It can even include ANSI escape codes for colors, etc. (Requires v1.2.38 or greater.) <li>The <code>arginfo</code> field is optional, and is displayed next to the <code>match</code> field. See <a href="#_argmatcher:adddescriptions">_argmatcher:adddescriptions</a> for more about the argument info string. The <code>arginfo</code> field is ignored if the <code>display</code> field is present. (Requires v1.5.4 or greater.) <li>The <code>description</code> field is optional, and is displayed in addition to <code>match</code> or <code>display</code> when listing possible completions. (Requires v1.2.38 or greater.) <li>The <code>type</code> field is optional. If omitted, then the <span class="arg">type</span> argument is used for that element. <li>The <code>appendchar</code> field is optional, and overrides the normal behavior for only this match. (Requires v1.3.1 or greater.) <li>The <code>suppressappend</code> field is optional, and overrides the normal behavior for only this match. (Requires v1.3.1 or greater.) </ul></p><p class="desc"> The match type affects how the match is inserted, displayed, and colored. Some type modifiers may be combined with a match type.</p><p class="desc"> <table> <tr><th>Type</th><th>Description</th></tr> <tr><td>"word"</td><td>Shows the whole word even if it contains slashes.</td></tr> <tr><td>"arg"</td><td>Avoids appending a space if the match ends with a colon or equal sign.</td></tr> <tr><td>"cmd"</td><td>Displays the match using <a href="#color_cmd">color.cmd</a>.</td></tr> <tr><td>"alias"</td><td>Displays the match using <a href="#color_doskey">color.doskey</a>.</td></tr> <tr><td>"file"</td><td>Shows only the last path component, with appropriate file coloring.</td></tr> <tr><td>"dir"</td><td>Shows only the last path component and adds a trailing path separator, with appropriate directory coloring.</td></tr> <tr><td>"none"</td><td>For backward compatibility the match is treated like "file", unless it ends with a path separator in which case it's treated like "dir".</td></tr> </table></p><p class="desc"> <table> <tr><th>Modifier</th><th>Description</th></tr> <tr><td>"hidden"</td><td>This can be combined with "file" or "dir" to use <a href="#color_hidden">color.hidden</a> (e.g. "file,hidden").</td></tr> <tr><td>"readonly"</td><td>This can be combined with "file" or "dir" to use <a href="#color_readonly">color.readonly</a> (e.g. "file,readonly").</td></tr> <tr><td>"link"</td><td>This can be combined with "file" or "dir" to appropriate symlink coloring (e.g. "file,link").</td></tr> <tr><td>"orphaned"</td><td>This can be combined with "link" to use appropriate orphaned symlink coloring (e.g. "file,link,orphaned").</td></tr> </table></p><p class="desc"> See <a href="#completioncolors">Completion Colors</a> and <a href="#colorsettings">Color Settings</a> for more information about colors.</p><pre class="language-lua"><code>builder:addmatch("hello") -- type is "none"
builder:addmatch("some_word", "word") builder:addmatch("some_word", "word")
builder:addmatch("/flag", "arg") builder:addmatch("/flag", "arg")
builder:addmatch("abbrev", "alias") builder:addmatch("abbrev", "alias")
@ -6131,11 +6266,12 @@ builder:addmatches({
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:isempty"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:isempty">builder:isempty</a></div> <div class="signature">() : boolean<br/><div class="version">v1.3.9 and newer</div></div></div><div class="body"><p class="desc">Returns whether the match builder is empty. It is empty when no matches have been added yet.</p></div></div><hr/> <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:isempty"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:isempty">builder:isempty</a></div> <div class="signature">() : boolean<br/><div class="version">v1.3.9 and newer</div></div></div><div class="body"><p class="desc">Returns whether the match builder is empty. It is empty when no matches have been added yet.</p></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:setappendcharacter"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:setappendcharacter">builder:setappendcharacter</a></div> <div class="signature">( [<span class="arg_name">append</span>:string] ) : nil<br/><div class="version">v1.1.2 and newer</div></div></div><div class="body"><p class="desc">Sets character to append after matches. For example the <code>set</code> match generator uses this to append "=" when completing matches, so that completing <code>set USER</code> becomes <code>set USERDOMAIN=</code> (rather than <code>set USERDOMAIN&nbsp;</code>).</p></div></div><hr/> <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:setappendcharacter"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:setappendcharacter">builder:setappendcharacter</a></div> <div class="signature">( [<span class="arg_name">append</span>:string] ) : nil<br/><div class="version">v1.1.2 and newer</div></div></div><div class="body"><p class="desc">Sets character to append after matches. For example the <code>set</code> match generator uses this to append "=" when completing matches, so that completing <code>set USER</code> becomes <code>set USERDOMAIN=</code> (rather than <code>set USERDOMAIN&nbsp;</code>).</p></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:setforcequoting"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:setforcequoting">builder:setforcequoting</a></div> <div class="signature">() : nil<br/><div class="version">v1.4.19 and newer</div></div></div><div class="body"><p class="desc">Forces quoting rules to be applied to matches even if they aren't filenames.</p></div></div><hr/> <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:setforcequoting"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:setforcequoting">builder:setforcequoting</a></div> <div class="signature">() : nil<br/><div class="version">v1.4.19 and newer</div></div></div><div class="body"><p class="desc">Forces quoting rules to be applied to matches even if they aren't filenames.</p></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:setfullyqualify"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:setfullyqualify">builder:setfullyqualify</a></div> <div class="signature">( [<span class="arg_name">fullyqualify</span>:boolean] ) : nil<br/><div class="version">v1.5.3 and newer</div></div></div><div class="body"><p class="desc">Forces completions to be inserted as fully qualified paths.</p></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:setnosort"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:setnosort">builder:setnosort</a></div> <div class="signature">() : nil<br/><div class="version">v1.3.3 and newer</div></div></div><div class="body"><p class="desc">Turns off sorting the matches.</p></div></div><hr/> <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:setnosort"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:setnosort">builder:setnosort</a></div> <div class="signature">() : nil<br/><div class="version">v1.3.3 and newer</div></div></div><div class="body"><p class="desc">Turns off sorting the matches.</p></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:setsuppressappend"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:setsuppressappend">builder:setsuppressappend</a></div> <div class="signature">( [<span class="arg_name">state</span>:boolean] ) : nil<br/><div class="version">v1.1.2 and newer</div></div></div><div class="body"><p class="desc">Sets whether to suppress appending anything after the match except a possible closing quote. For example the env var match generator uses this.</p></div></div><hr/> <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:setsuppressappend"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:setsuppressappend">builder:setsuppressappend</a></div> <div class="signature">( [<span class="arg_name">state</span>:boolean] ) : nil<br/><div class="version">v1.1.2 and newer</div></div></div><div class="body"><p class="desc">Sets whether to suppress appending anything after the match except a possible closing quote. For example the env var match generator uses this.</p></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:setsuppressquoting"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:setsuppressquoting">builder:setsuppressquoting</a></div> <div class="signature">( [<span class="arg_name">state</span>:integer] ) : nil<br/><div class="version">v1.1.2 and newer</div></div></div><div class="body"><p class="desc">Sets whether to suppress quoting for the matches. Set to 0 for normal quoting, or 1 to suppress quoting, or 2 to suppress end quotes. For example the env var match generator sets this to 1 to overcome the quoting that would normally happen for "%" characters in filenames.</p></div></div><hr/> <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:setsuppressquoting"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:setsuppressquoting">builder:setsuppressquoting</a></div> <div class="signature">( [<span class="arg_name">state</span>:integer] ) : nil<br/><div class="version">v1.1.2 and newer</div></div></div><div class="body"><p class="desc">Sets whether to suppress quoting for the matches. Set to 0 for normal quoting, or 1 to suppress quoting, or 2 to suppress end quotes. For example the env var match generator sets this to 1 to overcome the quoting that would normally happen for "%" characters in filenames.</p></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:setvolatile"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:setvolatile">builder:setvolatile</a></div> <div class="signature">() : nil<br/><div class="version">v1.3.37 and newer</div></div></div><div class="body"><p class="desc">Forces the generated matches to be used only once.</p><p class="desc"> Normally Clink tries to reuse the most recently generated list of matches, if possible. It is an optimization, to avoid doing potentally expensive work multiple times in a row to generate the same list of matches when nothing has changed. Normally the optimization is beneficial, and typing more letters in a word can simply filter the existing list of matches.</p><p class="desc"> But sometimes an argument may have special syntax. For example, an email address argument might want to generate matches for names until the word contains a <code>@</code>, and then it might want to generate matches for domain names. The optimization interferes with situations where parsing the word produces a completely different list of possible matches.</p><p class="desc"> Making the generated matches volatile ensures matches are generated anew each time completion is invoked.</p></div></div><hr/> <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#builder:setvolatile"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="builder:setvolatile">builder:setvolatile</a></div> <div class="signature">() : nil<br/><div class="version">v1.3.37 and newer</div></div></div><div class="body"><p class="desc">Forces the generated matches to be used only once.</p><p class="desc"> Normally Clink tries to reuse the most recently generated list of matches, if possible. It is an optimization, to avoid doing potentally expensive work multiple times in a row to generate the same list of matches when nothing has changed. Normally the optimization is beneficial, and typing more letters in a word can simply filter the existing list of matches.</p><p class="desc"> But sometimes an argument may have special syntax. For example, an email address argument might want to generate matches for names until the word contains a <code>@</code>, and then it might want to generate matches for domain names. The optimization interferes with situations where parsing the word produces a completely different list of possible matches.</p><p class="desc"> Making the generated matches volatile ensures matches are generated anew each time completion is invoked.</p></div></div><hr/>
</div><div class="group"><h5 class="group_name"><span class="wlink"><a href="#clink"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="clink">clink</a></h5><div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#clink.argmatcher"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="clink.argmatcher">clink.argmatcher</a></div> <div class="signature">( [<span class="arg_name">priority</span>:integer], <span class="arg_name">commands...</span>:string ) : <a href="#_argmatcher">_argmatcher</a><br/><div class="version">v1.0.0 and newer</div></div></div><div class="body"><p class="desc">Creates and returns a new argument matcher parser object. Use <a href="#_argmatcher:addarg">:addarg()</a> and etc to add arguments, flags, other parsers, and more. See <a href="#argumentcompletion">Argument Completion</a> for more information.</p><p class="desc"> If one <span class="arg">command</span> is provided and there is already an argmatcher for it, then this returns the existing parser rather than creating a new parser. Using :addarg() starts at arg position 1, making it possible to merge new args and etc into the existing parser.</p><p class="desc"> In Clink v1.3.38 and higher, if a <span class="arg">command</span> is a fully qualified path, then it is only used when the typed command expands to the same fully qualified path. This makes it possible to create one argmatcher for <code>c:\general\program.exe</code> and another for <code>c:\special\program.exe</code>. For example, aliases may be used to make both programs runnable, or the system PATH might be changed temporarily while working in a particular context.</p><p class="desc"> <strong>Note:</strong> Merging <a href="#linked-parsers">linked argmatchers</a> only merges the first argument position. The merge is simple, but should be sufficient for common simple cases.</p></div></div><hr/> </div><div class="group"><h5 class="group_name"><span class="wlink"><a href="#clink"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="clink">clink</a></h5><div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#clink.argmatcher"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="clink.argmatcher">clink.argmatcher</a></div> <div class="signature">( [<span class="arg_name">priority</span>:integer], <span class="arg_name">commands...</span>:string ) : <a href="#_argmatcher">_argmatcher</a><br/><div class="version">v1.0.0 and newer</div></div></div><div class="body"><p class="desc">Creates and returns a new argument matcher parser object. Use <a href="#_argmatcher:addarg">:addarg()</a> and etc to add arguments, flags, other parsers, and more. See <a href="#argumentcompletion">Argument Completion</a> for more information.</p><p class="desc"> If one <span class="arg">command</span> is provided and there is already an argmatcher for it, then this returns the existing parser rather than creating a new parser. Using :addarg() starts at arg position 1, making it possible to merge new args and etc into the existing parser.</p><p class="desc"> In Clink v1.3.38 and higher, if a <span class="arg">command</span> is a fully qualified path, then it is only used when the typed command expands to the same fully qualified path. This makes it possible to create one argmatcher for <code>c:\general\program.exe</code> and another for <code>c:\special\program.exe</code>. For example, aliases may be used to make both programs runnable, or the system PATH might be changed temporarily while working in a particular context.</p><p class="desc"> <strong>Note:</strong> Merging <a href="#argmatcher_linking">linked argmatchers</a> only merges the first argument position. The merge is simple, but should be sufficient for common simple cases.</p></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#clink.classifier"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="clink.classifier">clink.classifier</a></div> <div class="signature">( [<span class="arg_name">priority</span>:integer] ) : table<br/><div class="version">v1.1.49 and newer</div></div></div><div class="body"><p class="desc">Creates and returns a new word classifier object. Define on the object a <code>:classify()</code> function which gets called in increasing <span class="arg">priority</span> order (low values to high values) when classifying words for coloring the input. See <a href="#classifywords">Coloring the Input Text</a> for more information.</p></div></div><hr/> <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#clink.classifier"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="clink.classifier">clink.classifier</a></div> <div class="signature">( [<span class="arg_name">priority</span>:integer] ) : table<br/><div class="version">v1.1.49 and newer</div></div></div><div class="body"><p class="desc">Creates and returns a new word classifier object. Define on the object a <code>:classify()</code> function which gets called in increasing <span class="arg">priority</span> order (low values to high values) when classifying words for coloring the input. See <a href="#classifywords">Coloring the Input Text</a> for more information.</p></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#clink.dirmatches"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="clink.dirmatches">clink.dirmatches</a></div> <div class="signature">( <span class="arg_name">word</span>:string ) : table<br/><div class="version">v1.1.18 and newer</div></div></div><div class="body"><p class="desc">You can use this function in an argmatcher to supply directory matches. This automatically handles Readline tilde completion.</p><pre class="language-lua"><code>-- Make "cd" generate directory matches (no files). <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#clink.dirmatches"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="clink.dirmatches">clink.dirmatches</a></div> <div class="signature">( <span class="arg_name">word</span>:string ) : table<br/><div class="version">v1.1.18 and newer</div></div></div><div class="body"><p class="desc">You can use this function in an argmatcher to supply directory matches. This automatically handles Readline tilde completion.</p><pre class="language-lua"><code>-- Make "cd" generate directory matches (no files).
clink.argmatcher("cd") clink.argmatcher("cd")
@ -6581,7 +6717,7 @@ local t = os.globmatch("docs/**/*.md", true, flags)</code></pre><p class="desc">
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#os.sleep"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="os.sleep">os.sleep</a></div> <div class="signature">( <span class="arg_name">seconds</span>:number ) : nil<br/><div class="version">v1.3.16 and newer</div></div></div><div class="body"><p class="desc">Sleeps for the indicated duration, in seconds, with millisecond granularity.</p><pre class="language-lua"><code>os.sleep(0.01) -- Sleep for 10 milliseconds.</code></pre></div></div><hr/> <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#os.sleep"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="os.sleep">os.sleep</a></div> <div class="signature">( <span class="arg_name">seconds</span>:number ) : nil<br/><div class="version">v1.3.16 and newer</div></div></div><div class="body"><p class="desc">Sleeps for the indicated duration, in seconds, with millisecond granularity.</p><pre class="language-lua"><code>os.sleep(0.01) -- Sleep for 10 milliseconds.</code></pre></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#os.touch"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="os.touch">os.touch</a></div> <div class="signature">( <span class="arg_name">path</span>:string, [<span class="arg_name">atime</span>:number], [<span class="arg_name">mtime</span>:number] ) : boolean<br/><div class="version">v1.2.31 and newer</div></div></div><div class="body"><p class="desc">Sets the access and modified times for <span class="arg">path</span>, and returns whether it was successful. If unsuccessful it returns false, an error message, and the error number.</p><p class="desc"> The second argument is <span class="arg">atime</span> and is a time to set as the file's access time. If omitted, the current time is used. If present, the value must use the same format as <code><a href="https://www.lua.org/manual/5.2/manual.html#pdf-os.time">os.time()</a></code>.</p><p class="desc"> The third argument is <span class="arg">mtime</span> and is a time to set as the file's modified time. If omitted, the <span class="arg">atime</span> value is used (or the current time). If present, the value must use the same format as <code>os.time()</code>. In order to pass <span class="arg">mtime</span> it is necessary to also pass <span class="arg">atime</span>.</p></div></div><hr/> <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#os.touch"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="os.touch">os.touch</a></div> <div class="signature">( <span class="arg_name">path</span>:string, [<span class="arg_name">atime</span>:number], [<span class="arg_name">mtime</span>:number] ) : boolean<br/><div class="version">v1.2.31 and newer</div></div></div><div class="body"><p class="desc">Sets the access and modified times for <span class="arg">path</span>, and returns whether it was successful. If unsuccessful it returns false, an error message, and the error number.</p><p class="desc"> The second argument is <span class="arg">atime</span> and is a time to set as the file's access time. If omitted, the current time is used. If present, the value must use the same format as <code><a href="https://www.lua.org/manual/5.2/manual.html#pdf-os.time">os.time()</a></code>.</p><p class="desc"> The third argument is <span class="arg">mtime</span> and is a time to set as the file's modified time. If omitted, the <span class="arg">atime</span> value is used (or the current time). If present, the value must use the same format as <code>os.time()</code>. In order to pass <span class="arg">mtime</span> it is necessary to also pass <span class="arg">atime</span>.</p></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#os.unlink"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="os.unlink">os.unlink</a></div> <div class="signature">( <span class="arg_name">path</span>:string ) : boolean<br/><div class="version">v1.0.0 and newer</div></div></div><div class="body"><p class="desc">Deletes the file <span class="arg">path</span> and returns whether it was successful. If unsuccessful it returns false, an error message, and the error number.</p></div></div><hr/> <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#os.unlink"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="os.unlink">os.unlink</a></div> <div class="signature">( <span class="arg_name">path</span>:string ) : boolean<br/><div class="version">v1.0.0 and newer</div></div></div><div class="body"><p class="desc">Deletes the file <span class="arg">path</span> and returns whether it was successful. If unsuccessful it returns false, an error message, and the error number.</p></div></div><hr/>
</div><div class="group"><h5 class="group_name"><span class="wlink"><a href="#path"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="path">path</a></h5><div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#path.fnmatch"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="path.fnmatch">path.fnmatch</a></div> <div class="signature">( <span class="arg_name">pattern</span>:string, <span class="arg_name">string</span>:string, [<span class="arg_name">flags</span>:string] ) : boolean<br/><div class="version">v1.4.24 and newer</div></div></div><div class="body"><p class="desc">This compares the two strings <span class="arg">pattern</span> and <span class="arg">string</span> and returns whether they are considered to match. This is like the Linux <code>fnmatch</code> function, with an additional optional mode that can allow matching <code>**</code> patterns <a href="https://git-scm.com/docs/gitignore#_pattern_format">the same as git does</a>.</p><p class="desc"> The optional <span class="arg">flags</span> string may contain any of the following characters to modify the behavior accordingly: <ul> <tr><th>Flag</th><th>Mnemonic</th><th>Description</th></tr> <tr><td>"<code>e</code>"</td><td>NoEscape</td><td>Treat backslash in <span class="arg">pattern</span> as a normal character, rather than as an escape character.</td></tr> <tr><td>"<code>p</code>"</td><td>PathName</td><td>Path separators in <span class="arg">string</span> are matched only by a slash <code>/</code> in <span class="arg">pattern</span> (unless the <code>*</code> flag is used; see below).</td></tr> <tr><td>"<code>.</code>"</td><td>Period</td><td>A leading period <code>.</code> in <span class="arg">string</span> is matched only by a period <code>.</code> in <span class="arg">pattern</span>. A leading period is one at the beginning of <span class="arg">string</span>, or immediately following a path separator when the <code>p</code> flag is used.</td></tr> <tr><td>"<code>l</code>"</td><td>LeadingDir</td><td>Consider <span class="arg">pattern</span> to be matched if it completely matches <span class="arg">string</span>, or if it matches <span class="arg">string</span> up to a path separator.</td></tr> <tr><td>"<code>c</code>"</td><td>NoCaseFold</td><td>Match with case sensitivity. By default it matches case-insensitively, because Windows is case-insensitive.</td></tr> <tr><td>"<code>*</code>"</td><td>WildStar</td><td>Treat double-asterisks in <span class="arg">pattern</span> as matching path separators as well, the same as how git does (implies the <code>p</code> flag).</td></tr> <tr><td>"<code>s</code>"</td><td>NoSlashFold</td><td>Treat slashes <code>/</code> in <span class="arg">pattern</span> as only matching slashes in <span class="arg">string</span>. By default slashes in <span class="arg">pattern</span> match both slash <code>/</code> and backslash <code>\</code> because Windows recognizes both as path separators.</td></tr> </ul></p><p class="desc"> The <span class="arg">pattern</span> supports wildcards (<code>?</code> and <code>*</code>), character classes (<code>[</code>...<code>]</code>), ranges (<code>[</code>.<code>-</code>.<code>]</code>), and complementation (<code>[!</code>...<code>]</code> and <code>[!</code>.<code>-</code>.<code>]</code>).</p><p class="desc"> The <span class="arg">pattern</span> also supports the following character classes: <ul> <li>"<code>[[:alnum:]]</code>": Matches any alphabetic character or digit a - z, or A - Z, or 0 - 9. <li>"<code>[[:alpha:]]</code>": Matches any alphabetic character a - z or A - Z. <li>"<code>[[:blank:]]</code>": Matches 0x20 (space) or 0x09 (tab). <li>"<code>[[:cntrl:]]</code>": Matches 0x00 - 0x1F or 0x7F. <li>"<code>[[:digit:]]</code>": Matches any of the digits 0 - 9. <li>"<code>[[:graph:]]</code>": Matches any character that matches <code>[[:print:]]</code> but does not match <code>[[:space:]]</code>. <li>"<code>[[:lower:]]</code>": Matches any lower case ASCII letter a - z. <li>"<code>[[:print:]]</code>": Matches any printable character (e.g. 0x20 - 0x7E). <li>"<code>[[:punct:]]</code>": Matches any character that matches <code>[[:print:]]</code> but does not match <code>[[:alnum:]]</code>, <code>[[:space:]]</code>, or <code>[[:alnum:]]</code>. <li>"<code>[[:space:]]</code>": Matches 0x20 (space) or 0x09 - 0x0D (tab, linefeed, carriage return, etc). <li>"<code>[[:xdigit:]]</code>": Matches any of the hexadecimal digits 0 - 9, A - F, or a - f. <li>"<code>[[:upper:]]</code>": Matches any upper case ASCII letter A - Z. </ul></p><p class="desc"> <strong>Note:</strong> At this time the character classes and case-insensitivity operate on one byte at a time, so they do not fully work as expected with non-ASCII characters.</p></div></div><hr/> </div><div class="group"><h5 class="group_name"><span class="wlink"><a href="#path"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="path">path</a></h5><div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#path.fnmatch"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="path.fnmatch">path.fnmatch</a></div> <div class="signature">( <span class="arg_name">pattern</span>:string, <span class="arg_name">string</span>:string, [<span class="arg_name">flags</span>:string] ) : boolean<br/><div class="version">v1.4.24 and newer</div></div></div><div class="body"><p class="desc">This compares the two strings <span class="arg">pattern</span> and <span class="arg">string</span> and returns whether they are considered to match. This is like the Linux <code>fnmatch</code> function, with an additional optional mode that can allow matching <code>**</code> patterns <a href="https://git-scm.com/docs/gitignore#_pattern_format">the same as git does</a>.</p><p class="desc"> The optional <span class="arg">flags</span> string may contain any of the following characters to modify the behavior accordingly: <table> <tr><th>Flag</th><th>Mnemonic</th><th>Description</th></tr> <tr><td>"<code>e</code>"</td><td>NoEscape</td><td>Treat backslash in <span class="arg">pattern</span> as a normal character, rather than as an escape character.</td></tr> <tr><td>"<code>p</code>"</td><td>PathName</td><td>Path separators in <span class="arg">string</span> are matched only by a slash <code>/</code> in <span class="arg">pattern</span> (unless the <code>*</code> flag is used; see below).</td></tr> <tr><td>"<code>.</code>"</td><td>Period</td><td>A leading period <code>.</code> in <span class="arg">string</span> is matched only by a period <code>.</code> in <span class="arg">pattern</span>. A leading period is one at the beginning of <span class="arg">string</span>, or immediately following a path separator when the <code>p</code> flag is used.</td></tr> <tr><td>"<code>l</code>"</td><td>LeadingDir</td><td>Consider <span class="arg">pattern</span> to be matched if it completely matches <span class="arg">string</span>, or if it matches <span class="arg">string</span> up to a path separator.</td></tr> <tr><td>"<code>c</code>"</td><td>NoCaseFold</td><td>Match with case sensitivity. By default it matches case-insensitively, because Windows is case-insensitive.</td></tr> <tr><td>"<code>*</code>"</td><td>WildStar</td><td>Treat double-asterisks in <span class="arg">pattern</span> as matching path separators as well, the same as how git does (implies the <code>p</code> flag).</td></tr> <tr><td>"<code>s</code>"</td><td>NoSlashFold</td><td>Treat slashes <code>/</code> in <span class="arg">pattern</span> as only matching slashes in <span class="arg">string</span>. By default slashes in <span class="arg">pattern</span> match both slash <code>/</code> and backslash <code>\</code> because Windows recognizes both as path separators.</td></tr> </table></p><p class="desc"> The <span class="arg">pattern</span> supports wildcards (<code>?</code> and <code>*</code>), character classes (<code>[</code>...<code>]</code>), ranges (<code>[</code>.<code>-</code>.<code>]</code>), and complementation (<code>[!</code>...<code>]</code> and <code>[!</code>.<code>-</code>.<code>]</code>).</p><p class="desc"> The <span class="arg">pattern</span> also supports the following character classes: <ul> <li>"<code>[[:alnum:]]</code>": Matches any alphabetic character or digit a - z, or A - Z, or 0 - 9. <li>"<code>[[:alpha:]]</code>": Matches any alphabetic character a - z or A - Z. <li>"<code>[[:blank:]]</code>": Matches 0x20 (space) or 0x09 (tab). <li>"<code>[[:cntrl:]]</code>": Matches 0x00 - 0x1F or 0x7F. <li>"<code>[[:digit:]]</code>": Matches any of the digits 0 - 9. <li>"<code>[[:graph:]]</code>": Matches any character that matches <code>[[:print:]]</code> but does not match <code>[[:space:]]</code>. <li>"<code>[[:lower:]]</code>": Matches any lower case ASCII letter a - z. <li>"<code>[[:print:]]</code>": Matches any printable character (e.g. 0x20 - 0x7E). <li>"<code>[[:punct:]]</code>": Matches any character that matches <code>[[:print:]]</code> but does not match <code>[[:alnum:]]</code>, <code>[[:space:]]</code>, or <code>[[:alnum:]]</code>. <li>"<code>[[:space:]]</code>": Matches 0x20 (space) or 0x09 - 0x0D (tab, linefeed, carriage return, etc). <li>"<code>[[:xdigit:]]</code>": Matches any of the hexadecimal digits 0 - 9, A - F, or a - f. <li>"<code>[[:upper:]]</code>": Matches any upper case ASCII letter A - Z. </ul></p><p class="desc"> <strong>Note:</strong> At this time the character classes and case-insensitivity operate on one byte at a time, so they do not fully work as expected with non-ASCII characters.</p></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#path.getbasename"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="path.getbasename">path.getbasename</a></div> <div class="signature">( <span class="arg_name">path</span>:string ) : string<br/><div class="version">v1.1.0 and newer</div></div></div><div class="body"><p class="desc"></p><pre class="language-lua"><code>path.getbasename("/foo/bar.ext") -- returns "bar" <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#path.getbasename"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="path.getbasename">path.getbasename</a></div> <div class="signature">( <span class="arg_name">path</span>:string ) : string<br/><div class="version">v1.1.0 and newer</div></div></div><div class="body"><p class="desc"></p><pre class="language-lua"><code>path.getbasename("/foo/bar.ext") -- returns "bar"
path.getbasename("") -- returns ""</code></pre></div></div><hr/> path.getbasename("") -- returns ""</code></pre></div></div><hr/>
<div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#path.getdirectory"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="path.getdirectory">path.getdirectory</a></div> <div class="signature">( <span class="arg_name">path</span>:string ) : nil or string<br/><div class="version">v1.1.0 and newer</div></div></div><div class="body"><p class="desc">This is similar to <a href="#path.toparent">path.toparent()</a> but can behave differently when the input path ends with a path separator. This is the recommended API for parsing a path into its component pieces, but is not recommended for walking up through parent directories.</p><pre class="language-lua"><code>path.getdirectory("foo") -- returns nil <div class="function"><div class="header"> <div class="name"><span class="wlink"><a href="#path.getdirectory"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></span><a name="path.getdirectory">path.getdirectory</a></div> <div class="signature">( <span class="arg_name">path</span>:string ) : nil or string<br/><div class="version">v1.1.0 and newer</div></div></div><div class="body"><p class="desc">This is similar to <a href="#path.toparent">path.toparent()</a> but can behave differently when the input path ends with a path separator. This is the recommended API for parsing a path into its component pieces, but is not recommended for walking up through parent directories.</p><pre class="language-lua"><code>path.getdirectory("foo") -- returns nil
@ -7018,6 +7154,33 @@ end</code></pre></div></div><hr/>
<div class="section" id="changes"> <div class="section" id="changes">
<h1 id="changes"><div class="wlink"><a href="#changes"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Changes</h1> <h1 id="changes"><div class="wlink"><a href="#changes"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Changes</h1>
<h3 id="releases-from-chrisant996clink-fork"><div class="wlink"><a href="#releases-from-chrisant996clink-fork"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Releases from <a href="https://github.com/chrisant996/clink">chrisant996/clink</a> fork</h3> <h3 id="releases-from-chrisant996clink-fork"><div class="wlink"><a href="#releases-from-chrisant996clink-fork"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>Releases from <a href="https://github.com/chrisant996/clink">chrisant996/clink</a> fork</h3>
<h4 id="v154"><div class="wlink"><a href="#v154"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>v1.5.4</h4>
<ul>
<li>Further contrast improvements for default colors to be readable in both Dark and Light terminal themes.</li>
<li>Added <code>arginfo</code> field in <code>builder:addmatches()</code> and in match display filtering.</li>
<li>Auto-suggestions are no longer shown while searching history; it was too distracting and confusing.</li>
<li>Fixed updating the input line display after using <code>clink-popup-history</code> or <code>win-popup-history</code> (regression introduced in v1.5.3).</li>
<li>Fixed <code>old-menu-complete</code> and <code>menu-complete</code> when there&#39;s only one match. The first time it should insert the match, and subsequent times should ding instead of cycling through the same match over and over and requiring an equal number of <code>undo</code> to undo.</li>
<li>Fixed match display filtering to support the <code>match.substring</code> setting.</li>
<li>Fixed match display filtering to support the <code>files.system</code> setting.</li>
<li>Fixed the cursor position if match display filtering happens the first time <code>clink-select-complete</code> is used in a session.</li>
<li>Fixed a case where two <code>undo</code> were required to fully undo what <code>menu-complete</code> inserted.</li>
<li>Fixed <kbd>Esc</kbd> during incremental history search mode so it cancels the search.</li>
<li>Fixed input line coloring after <code>non-incremental-reverse-search-history</code> or <code>non-incremental-forward-search-history</code> finds an exact match for the search text (since v1.1.5).</li>
<li>Internal changes and optimizations.</li>
</ul>
<h4 id="v153"><div class="wlink"><a href="#v153"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>v1.5.3</h4>
<ul>
<li>Added <code>builder:setfullyqualified()</code> to force completions to be inserted as fully qualified path names.</li>
<li>Completions for <code>clink set <span class="arg">setting_name</span> <span class="arg">input</span></code> use fully qualified path names for <span class="arg">input</span>. This helps avoid accidentally setting relative paths in global settings; since the current directory changes frequently, setting relative paths usually leads to unintended consequences.</li>
<li>Only load a script from a <code>completions\</code> directory if the associated command exists in the file system. Also, pass the fully qualified file name as input to the script (in Lua, use <code>...</code> to get script arguments, e.g. <code>local command = ...</code>).</li>
<li><code>clink info</code> now reports whether Clink is injected.</li>
<li>Improve efficiency of updating the input line display. This eliminates some redundant processing in the Readline library and in Clink.</li>
<li>Fixed input line parsing and coloring when the <code>doskey.enhanced</code> setting is off or when doskey macro expansion is suppressed.</li>
<li>Fixed <code>line_state:getwordinfo()</code> to accurately set the <code>.alias</code> field when the <code>doskey.enhanced</code> setting is off or when doskey macro expansion is suppressed.</li>
<li>Fixed coloring the command word in the command line when queued keys select and accept a command line from history instantly (it could accidentally continue without applying the appropriate coloring).</li>
<li>Fixed script error in <code>clink.filematches(nil)</code> and <code>clink.dirmatches(nil)</code>; they were meant to behave the same as passing an empty string.</li>
</ul>
<h4 id="v152"><div class="wlink"><a href="#v152"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>v1.5.2</h4> <h4 id="v152"><div class="wlink"><a href="#v152"><svg width=16 height=16><use href="#wicon"/></a><span class="wfix">.</span></div>v1.5.2</h4>
<ul> <ul>
<li>Adjusted the colors in &quot;Use enhanced defaults&quot; to have sufficient contrast to be readable in both Dark and Light terminal themes.</li> <li>Adjusted the colors in &quot;Use enhanced defaults&quot; to have sufficient contrast to be readable in both Dark and Light terminal themes.</li>

10
tools/ConEmu/ConEmu/clink/clink.lua
View File

@ -1,5 +1,5 @@
-- This file is intentionally blank. -- This file is intentionally blank.
-- --
-- The old clink.lua file is no longer used, and this blank file ensures if a -- The old clink.lua file is no longer used, and this blank file ensures if a
-- new clink version is copied over an old clink version, it won't accidentally -- new clink version is copied over an old clink version, it won't accidentally
-- use an obsolete leftover clink.lua file. -- use an obsolete leftover clink.lua file.

BIN
tools/ConEmu/ConEmu/clink/clink_arm64.exe
View File

Binary file not shown.

BIN
tools/ConEmu/ConEmu/clink/clink_dll_arm64.dll
View File

Binary file not shown.

BIN
tools/ConEmu/ConEmu/clink/clink_dll_x64.dll
View File

Binary file not shown.

BIN
tools/ConEmu/ConEmu/clink/clink_dll_x86.dll
View File

Binary file not shown.

BIN
tools/ConEmu/ConEmu/clink/clink_x64.exe
View File

Binary file not shown.

BIN
tools/ConEmu/ConEmu/clink/clink_x86.exe
View File

Binary file not shown.