You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/clink.md
+12-25Lines changed: 12 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,7 +69,7 @@ Name | Description
69
69
`exec.cwd` | When matching executables as the first word (`exec.enable`), include executables in the current directory. (This is implicit if the word being completed is a relative path).
70
70
`exec.dirs` | When matching executables as the first word (`exec.enable`), also include directories relative to the current working directory as matches.
71
71
`exec.enable` | Only match executables when completing the first word of a line.
72
-
`exec.path` | When matching executables as the first word (`exec.enable`), include executables found in the directories specified in the `PATH` environment variable.
72
+
`exec.path` | When matching executables as the first word (`exec.enable`), include executables found in the directories specified in the `%PATH%` environment variable.
73
73
`exec.space_prefix` | If the line begins with whitespace then Clink bypasses executable matching (`exec.path`) and will do normal files matching instead.
74
74
`files.hidden` | Includes or excludes files with the "hidden" attribute set when generating file lists.
75
75
`files.system` | Includes or excludes files with the "system" attribute set when generating file lists.
@@ -87,6 +87,8 @@ Name | Description
87
87
`terminal.emulate` | Clink can either emulate a virtual terminal and handle ANSI escape codes itself, or let the console host natively handle ANSI escape codes. `off` = let the console host process ANSI escape codes, `on` = emulate a virtual terminal, `auto` = only emulate if the console host doesn't say it supports ANSI escape codes.
88
88
`terminal.modify_other_keys` | When enabled, pressing Space or Tab with modifier keys sends extended XTerm key sequences so they can be bound separately.
89
89
90
+
<br>
91
+
90
92
> Notes:
91
93
> - The `esc_clears_line` setting has been replaced by a `clink-reset-line` command that can be bound to <kbd>Escape</kbd> (or any other key).
92
94
> - The `history_file_lines` setting doesn't exist at the moment. _**NYI:** Some mechanism for trimming history will be added eventually._
@@ -96,12 +98,12 @@ Name | Description
96
98
97
99
Settings and history are persisted to disk from session to session. The location of these files depends on which distribution of Clink was used. If you installed Clink using the .exe installer then Clink uses the current user's non-roaming application data directory. This user directory is usually found in one of the following locations;
98
100
99
-
-`c:\Documents and Settings\<username>\Local Settings\Application Data`*(XP)*
-Windows XP: `c:\Documents and Settings\<username>\Local Settings\Application Data`
102
+
-Windows Vista onwards: `c:\Users\<username>\AppData\Local`
101
103
102
104
The .zip distribution of Clink creates and uses a directory called `profile` which is located in the same directory where Clink's core files are found.
103
105
104
-
All of the above locations can be overridden using the `--profile <path>` command line option which is specified when injecting Clink into cmd.exe using `clink inject`.
106
+
All of the above locations can be overridden using the `--profile <path>` command line option which is specified when injecting Clink into cmd.exe using `clink inject`.
105
107
106
108
<br>
107
109
@@ -111,7 +113,7 @@ Readline itself can also be configured to add custom keybindings and macros by c
111
113
112
114
> **TODO:** Update the description of how/where inputrc files are loaded.
113
115
114
-
Clink will search in the directory as specified by the HOME environment variable for one or all of the following files; `clink_inputrc`, `_inputrc`, and `.inputrc`. If HOME is unset then Clink will use either of the standard Windows environment variables `%homedrive%\%homepath%` or `%userprofile%`.
116
+
Clink will search in the directory as specified by the `%HOME%` environment variable for one or all of the following files; `clink_inputrc`, `_inputrc`, and `.inputrc`. If `%HOME%` is unset then Clink will use either of the standard Windows environment variables `%HOMEDRIVE%\%HOMEPATH%` or `%USERPROFILE%`.
115
117
116
118
Other software that also uses Readline will also look for the `.inputrc` file (and possibly the `_inputrc` file too). To set macros and keybindings intended only for Clink one can use the Readline init file conditional construct like this; `$if clink [...] $endif`.
117
119
@@ -124,6 +126,8 @@ Name | Description
124
126
`completion-auto-query-items`|Automatically prompts before displaying completions if they won't fit on one screen page.
125
127
`history-point-at-end-of-anchored-search`|Puts the cursor at the end of the line when using `history-search-forward` or `history-search-backward`.
126
128
129
+
<br>
130
+
127
131
> **Compatibility Note:** The `clink_inputrc_base` file from v0.4.8 no longer exists.
The `sort_id` argument is used to sort the match generators such that generators with a lower sort ids are called first.
195
199
196
-
Here is an simple example script that checks if `text` begins with a `%` character and then uses the remained of `text` to match the names of environment variables.
200
+
Here is an simple example script that checks if `text` begins with a `%` character and then uses the remainder of `text` to match the names of environment variables.
0 commit comments