Skip to content

Commit

Permalink
Fix docs about match.wild and clink.default_bindings.
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisant996 committed Dec 13, 2024
1 parent f311980 commit d9907d6
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/clink.md
Original file line number Diff line number Diff line change
Expand Up @@ -468,7 +468,7 @@ Name | Default [*](#alternatedefault) | Description
<a name="clink_autoupdate"></a>`clink.autoupdate` | `check` | Clink can periodically check for updates for the Clink program files (see [Automatic Updates](#automatic-updates)).
<a name="clink_colorize_input"></a>`clink.colorize_input` | True | Enables context sensitive coloring for the input text (see [Coloring the Input Text](#classifywords)).
<a name="clink_customprompt"></a>`clink.customprompt` | | *.clinkprompt files contain customizations for the prompt. Setting this to the name of a .clinkprompt file causes it to be loaded and used for displaying the prompt (see [Customizing the Prompt](#customisingtheprompt)).
<a name="default_bindings"><a name="clink_default_bindings"></a></a>`clink.default_bindings` | `bash` [*](#alternatedefault) | Clink uses bash key bindings when this is set to `bash` (the default). When this is set to `windows` Clink overrides some of the bash defaults with familiar Windows key bindings for <kbd>Tab</kbd>, <kbd>Ctrl</kbd>-<kbd>A</kbd>, <kbd>Ctrl</kbd>-<kbd>F</kbd>, <kbd>Ctrl</kbd>-<kbd>M</kbd>, and <kbd>Right</kbd>.
<a name="default_bindings"><a name="clink_default_bindings"></a></a>`clink.default_bindings` | `bash` [*](#alternatedefault) | When this is `bash` (the default), Clink uses bash key bindings and does not match leading dots unless typed (completion does not match `.foo` when `f` is typed).<br/>When this is `windows`, Clink overrides some of the bash defaults with familiar Windows key bindings for <kbd>Tab</kbd>, <kbd>Ctrl</kbd>-<kbd>A</kbd>, <kbd>Ctrl</kbd>-<kbd>F</kbd>, <kbd>Ctrl</kbd>-<kbd>M</kbd>, and <kbd>Right</kbd>, and also Clink mimics the CMD completion behavior where completion matches `.foo` when just `f` is typed (that can also be controlled with the [match-hidden-files](#configmatchhiddenfiles) configuration variable in the [.inputrc](#init-file) file).
<a name="clink_logo"></a>`clink.logo` | `full` | Controls what startup logo to show when Clink is injected. `full` = show full copyright logo, `short` = show abbreviated version info, `none` = omit the logo.
<a name="clink_max_input_rows"></a>`clink.max_input_rows` | `0` | Limits how many rows the input line can use, up to the terminal height. When this is `0` (the default), the terminal height is the limit.
<a name="clink_paste_crlf"></a>`clink.paste_crlf` | `crlf` | What to do with CR and LF characters on paste. Setting this to `delete` deletes them, `space` replaces them with spaces, `ampersand` replaces them with ampersands, and `crlf` pastes them as-is (executing commands that end with a newline).
Expand Down Expand Up @@ -561,7 +561,7 @@ Name | Default [*](#alternatedefault) | Description
<a name="match_sort_dirs"></a>`match.sort_dirs` | `with` | How to sort matching directory names. `before` = before files, `with` = with files, `after` = after files.
<a name="match_substring"></a>`match.substring` | False [*](#alternatedefault) | When set, if no completions are found with a prefix search, then a substring search is used.
<a name="match_translate_slashes"></a>`match.translate_slashes` | `auto` | File and directory completions can be translated to use consistent slashes. The default is `auto` which translates all slashes in the completed word to match the first kind of slash in the word (or the system path separator if the word didn't have any slashes before being completed). Use `slash` for forward slashes, `backslash` for backslashes, or `system` for the appropriate path separator for the OS host (backslashes on Windows). Use `off` to turn off translating slashes.
<a name="match_wild"></a>`match.wild` | True | Matches `?` and `*` wildcards and leading `.` when using any of the completion commands. Turn this off to behave how bash does, and not match wildcards or leading dots (but [`glob-complete-word`](#rlcmd-glob-complete-word) always matches wildcards).
<a name="match_wild"></a>`match.wild` | True | Matches `?` and `*` wildcards when using any of the completion commands. Turn this off to behave how bash does, and not match wildcards (but [`glob-complete-word`](#rlcmd-glob-complete-word) always matches wildcards).
<a name="prompt_async"></a>`prompt.async` | True | Enables [asynchronous prompt refresh](#asyncpromptfiltering). Turn this off if prompt filter refreshes are annoying or cause problems.
<a name="prompt_spacing"></a>`prompt.spacing` | `normal` | The default is `normal` which never removes or adds blank lines. Set to `compact` to remove blank lines before the prompt, or set to `sparse` to remove blank lines and then add one blank line.
<a name="prompt-transient"></a>`prompt.transient` | `off` | Controls when past prompts are collapsed ([transient prompts](#transientprompts)). `off` = never collapse past prompts, `always` = always collapse past prompts, `same_dir` = only collapse past prompts when the current working directory hasn't changed since the last prompt.
Expand Down

0 comments on commit d9907d6

Please sign in to comment.