Commit Graph

422 Commits

Author SHA1 Message Date
Johannes Altmanninger
48a53fecc3 doc: use angle brackets for page{up,down} like for other key names 2020-07-25 20:07:18 +02:00
Frank LENORMAND
e0193f23db doc faq: Fix the prose 2020-07-21 17:36:45 +03:00
Maxime Coste
3e17a6d185 Fix command example to use correct syntax
Change the example to something that requires going through the
shell.
2020-07-21 20:47:44 +10:00
Maxime Coste
ab25561da2 Merge remote-tracking branch 'occivink/doc-fix' 2020-07-21 19:54:20 +10:00
Frank LENORMAND
a84e3aeb85 doc faq: Document beam cursors being inconsistent 2020-07-21 09:08:35 +03:00
Maxime Coste
47ba36c66e Add a RegisterModified hook
This one has been a long time coming, I am still concerned this could
impact performance a lot. This hook does *not* trigger for capture
registers (0-9) or any other dynamic registers (that are not writable).

Fixes #859
2020-07-19 12:56:55 +10:00
Olivier Perret
03525779fb [doc] Escape asciidoc meta-character 2020-07-09 12:00:01 +02:00
Maxime Coste
f2cc7bc891 Add User hook support 2020-07-04 13:48:27 +10:00
Tim Allen
14573244d4 expansions.asciidoc: Add an example of file expansion.
Properly speaking, all expansions are of the form "%abc{}" where "abc"
is the expansion type. All expansion types are listed in the documentation, as
they should be. However, when searching through the documentation, a keyword
like "file" is likely to hit a lot of false-positives, so a smart user is likely
to search for the more-unique "%file" instead. Unfortunately, unlike every other
expansion-type, file-expansions did not include an example, so a search for
"%file" resulted in no hits, potentially leading people to believe it was
undocumented.

Now there's an example, so people searching for "%file" will find what they're
looking for.
2020-07-01 23:47:06 +10:00
Frank LENORMAND
accc619c0f doc faq: Document hook disabling with \i 2020-06-26 11:14:38 +03:00
Frank LENORMAND
442aae1cef doc faq: Fix the prose 2020-06-26 11:12:21 +03:00
Maxime Coste
e989bda964 Merge remote-tracking branch 'lenormf/fix-changelog' 2020-06-25 20:58:57 +10:00
Maxime Coste
f5127f8b22 Merge remote-tracking branch 'lenormf/key-percent' 2020-06-25 20:58:26 +10:00
Frank LENORMAND
1761c4e059 doc faq: Remove space leading question marks 2020-06-11 10:17:10 +03:00
Frank LENORMAND
b72493bbbb doc faq: Document -buffer * 2020-06-10 14:49:46 +03:00
Frank LENORMAND
61094a97e2 doc faq: Fix the prose 2020-06-10 12:38:54 +03:00
Frank LENORMAND
cb5e005378 doc faq: Mention (?S) 2020-06-10 12:37:43 +03:00
Frank LENORMAND
ad122aec4e doc faq: Mention "readline shortcuts" in prompts 2020-06-10 12:32:06 +03:00
Frank LENORMAND
55383afb4d doc faq: Mention the Language Server Protocol 2020-06-10 12:29:52 +03:00
Frank LENORMAND
0737375b61 doc faq: Rephrase invalid note about :format 2020-06-10 12:23:46 +03:00
Maxime Coste
f75d49e9ef Do not include non-primitive option value in *SetOption hook filter
Only include the value for int/str/bool options, for the rest just
write '<option name>=...'.

This should reduce the cost of some patterns such as repeatedly adding
a value inside a list option.

It seems very unlikely that the actual value would be matched by
a hook regex string for non primitive types.
2020-06-09 21:38:47 +10:00
Frank LENORMAND
d17e7adc92 doc faq: Document how to get debug information 2020-06-06 11:18:19 +03:00
Frank LENORMAND
79428da9b5 doc faq: Document locale issues 2020-06-06 10:44:10 +03:00
Frank LENORMAND
cf152832e5 doc faq: Split questions into subsections 2020-06-06 10:34:52 +03:00
Frank LENORMAND
24c5169400 src: Introduce a <percent> named key
Similarly to the <semicolon> key, make it easier to write
`:execute-keys` commands by replacing <percent> with `%`.

Highlighters can keep escaping the sign when regular expressions are
not quoted, but built-in scripts that use `%` as an editing primitive
have been modified to use the named key, for clarity.
2020-06-03 15:42:38 +03:00
Frank LENORMAND
fb05adb75c doc changelog: Update the changelog 2020-06-03 15:05:19 +03:00
Maxime Coste
61dc64808d Merge remote-tracking branch 'Delapouite/object-punctuation' 2020-05-30 09:23:06 +10:00
Johannes Altmanninger
e4f7d42396 doc: fix typos and clarify some parts 2020-05-28 18:37:26 +02:00
Johannes Altmanninger
3385c6a20e doc: state that replace-ranges' replacements are markup strings
The term "display line" is only used in source code.
2020-05-28 00:45:38 +02:00
Maxime Coste
b44c4f41a6 Document rgba faces and client stdin in the changelog 2020-05-16 10:10:28 +10:00
Aajn
ae17669859
Remove outdated information
Default build mode is release since c07f052.
2020-05-10 15:58:24 +02:00
Miguel de Val-Borro
85227019ff Fix some typos in docs 2020-05-09 12:18:16 -04:00
Delapouite
8748bdbc10 doc(keys): mention punctuation text-objects
The fact that punctuation characters can act as surrounding
delimiters is a useful behavior but not obvious.

This "hidden" text-object feature deserves to be described explicitely.
2020-05-06 23:02:29 +02:00
Maxime Coste
295a77b23a Merge branch 'docs' of https://github.com/migueldvb/kakoune 2020-05-03 13:48:59 +10:00
Miguel de Val-Borro
3efb3a3e43 Fix some typos in docs 2020-05-02 11:43:33 -04:00
Maxime Coste
ccecd5bd8e Add support for alpha channel in colors
This makes it easier to define faces that lighten/darken whatever
they apply on.
2020-05-02 12:57:36 +10:00
Maxime Coste
50dc0099c3 Add multi-line replace-range in changelog 2020-04-27 17:41:09 +10:00
Daniel Lewan
635353bbd6 fix link in registers docs 2020-04-12 14:26:14 +02:00
Maxime Coste
f7a2ecfacb Support empty ranges in replace-ranges highlighter 2020-04-06 11:23:47 +10:00
Maxime Coste
c585107ab5 Add -override support to add-highlighter
This allow replacing a highlighter in place, not loosing its current
position in its parent.

Fixes #3436
2020-03-30 21:04:01 +11:00
Maxime Coste
09375edf54 Merge remote-tracking branch 'occivink/arrange-buffers' 2020-03-15 12:18:04 +11:00
Maxime Coste
0a66eb9c47 Expand env vars as list of strings
This makes it possible to do :select `%val{selections_decs}` and to
correctly combine $kak_quoted with those.
2020-03-02 20:53:28 +11:00
Olivier Perret
0cfc398a1a Document 'arrange-buffers' command 2020-02-24 09:41:51 +01:00
Alex Leferry 2
796eb20730 Fix typo 2020-02-07 16:57:09 +01:00
Joachim Henke
4dd0b432ab the option 'ncurses_builtin_key_parser' has gone 2020-01-19 15:30:18 +01:00
Maxime Coste
9ca479ed40 Kakoune v2020.10.16 2020-01-16 20:52:20 +11:00
Jason Felice
44ba86245c Fix error in expansions doc 2020-01-04 19:48:38 -05:00
Maxime Coste
8b6ed26e8c Few style changes on history exposition code 2020-01-02 22:36:26 +11:00
Jason Felice
b03b51d27a Add 'history' and 'uncommitted_modifications' expansions 2020-01-01 19:47:29 -05:00
Maxime Coste
ac28f2b47b Merge remote-tracking branch 'Screwtapello/no-prompt-in-draft-context' 2019-12-20 08:46:41 +11:00
Tim Allen
b09653ccc5 highlighters.cc: Add a '-min-digits' flag to the number-lines highlighter.
Fixes #3260.
2019-12-15 13:36:25 +11:00
Tim Allen
69a3de46e1 hooks.asciidoc: Document how *Key hooks interact with mappings and exec. 2019-12-12 22:02:48 +11:00
Tim Allen
18c34408c5 doc: Mention that commands requiring a client context are unhelpful in a draft context.
Fixes #2618.
2019-12-12 19:36:35 +11:00
Maxime Coste
9ace7b584d Kakoune v2019.12.10 2019-12-10 21:36:03 +11:00
Maxime Coste
5ba4da99e3 Tweak mark documentation 2019-12-10 21:14:03 +11:00
Maxime Coste
170c4a9cf1 Merge remote-tracking branch 'Screwtapello/document-mark-registers' 2019-12-10 21:05:26 +11:00
Maxime Coste
15df0fc781 Add -scratch and -file switches to the rename-buffer command 2019-12-07 15:40:57 +11:00
Tim Allen
31162bdbb7 registers.asciidoc: Document the format of marks. 2019-12-06 20:01:30 +11:00
Tim Allen
3a23fdf15a registers.asciidoc: I don't think selections have captured groups. 2019-12-06 20:01:07 +11:00
Tim Allen
1fffd38b56 registers.asciidoc: Link from registers back to the keys that use them. 2019-12-06 18:41:27 +11:00
Maxime Coste
1ec14ea826 Merge remote-tracking branch 'dpercy/patch-1' 2019-12-05 21:10:43 +11:00
Maxime Coste
ee2985739b Merge remote-tracking branch 'lenormf/window-range' 2019-12-04 21:16:11 +11:00
David Percy
e8a7b06388 Typo: "escaped with a backspace" -> backslash 2019-12-03 19:44:08 +00:00
Maxime Coste
0b66aa8dda Document that fg face is optional 2019-12-03 21:17:33 +11:00
Maxime Coste
2904d13420 Add a {\} marker to disable markup processing 2019-11-28 20:23:52 +11:00
Maxime Coste
936bd923ea Fix typos 2019-11-22 21:51:32 +11:00
Maxime Coste
cb1b03c0db Add support for markup in info boxes
Fixes #2552
2019-11-22 21:50:51 +11:00
Maxime Coste
82e5346904 Add a -atomic switch to write and change clang.kak to take advantage 2019-11-21 23:38:32 +11:00
Maxime Coste
e964b68ab8 Add support for selecting and exporting selections in display columns
Fixes #2724
2019-11-12 21:56:45 +11:00
Maxime Coste
7a8f57f97b Add support for a -codepoint switch to the select command 2019-11-12 21:21:24 +11:00
Jason Felice
5fae16faef Implement %val{selections_char_desc}
Fixes #3194
2019-11-12 20:54:32 +11:00
Delapouite
db1d013422 doc: add WrapMarker in faces and changelog 2019-11-07 11:09:48 +01:00
Maxime Coste
d23544f6fd Merge remote-tracking branch 'Delapouite/doc-completers' 2019-11-07 20:17:33 +11:00
Maxime Coste
1c5a7d839c Merge remote-tracking branch 'lenormf/fix-scratch-doc' 2019-11-07 20:16:06 +11:00
Maxime Coste
4a954839fa Merge remote-tracking branch 'Delapouite/doc-semicolon' 2019-11-07 20:04:58 +11:00
Maxime Coste
3e7301ede7 Support \x and \u escapes in regex character classes
Change \u to use 6 digits to cover the full unicode range.

Fixes #3172
2019-11-06 20:48:48 +11:00
Delapouite
00e44903e7 doc: fix completers option description 2019-11-04 10:11:09 +01:00
Frank LENORMAND
dde3d57b1f doc commands: Document auto-generated scratch buffer names 2019-11-03 08:53:11 +01:00
Delapouite
551d7dfbac doc: mention newly introduced <semicolon> and <a-semicolon> keys
Ref: #3156
2019-10-28 22:18:55 +01:00
Maxime Coste
ec31d83972 Merge remote-tracking branch 'Delapouite/doc-hl-group' 2019-10-23 22:39:08 +11:00
Maxime Coste
a49ae162f4 Add a -verbatim switch to evaluate-commands for perfect forwarding
-verbatim will disable argument parsing in evaluate-commands, making
it possible to forward a single command to a different context without
triggering a reparsing of the arguments.

Fixes -try-client support in grep.kak

Closes #3153
2019-10-23 22:30:23 +11:00
Frank LENORMAND
4499286070 doc: Document the window_range expansion 2019-10-20 21:37:53 +02:00
Maxime Coste
e4fb70ebec Replace ModeChange hooks by ModePush and ModePop
Remove deprecated InsertBegin, InsertEnd, NormalBegin, NormalEnd
hooks.

Closes #2545
2019-10-16 20:45:53 +11:00
Delapouite
c21228a8bd doc: fix example about shared highlighter group 2019-10-15 21:28:35 +02:00
Jason Felice
f88cf7ffb4 rc, doc: set extra_word_chars on buffer, not window
For clojure.kak and haskell.kak, set extra_word_chars on the buffer
and not the window, so that the buffer's word db is updated correctly
for word completion.

Document this.

Also, minor refactor of clojure.kak.

Closes #3108
2019-09-26 09:55:02 -04:00
Maxime Coste
fc3a1b6973 Make arrow keys normal mode mappings instead of commands 2019-09-15 19:40:38 +10:00
tawsi-melek
69eec33491
Fixed some English typos 2019-08-04 00:45:19 +02:00
Joachim Henke
2cc92e8ff1 function keys need to be provided in upper case now 2019-07-07 18:44:14 +02:00
Joachim Henke
556d58a073 allow for mapping the Insert key 2019-07-07 18:38:46 +02:00
Joachim Henke
4c61f82fb2 fix a few typos 2019-07-06 17:37:30 +02:00
Maxime Coste
2ff9fd8d92 Kakoune v2019.07.01 2019-07-01 22:07:29 +10:00
Maxime Coste
8346050232 Document function key syntax change in changelog 2019-06-29 09:56:28 +10:00
codesoap
ca2741fe20 Rename ModuleLoad hook to ModuleLoaded
This clarifies, that the hook is run *after* the module is loaded.
2019-06-25 19:16:47 +02:00
Maxime Coste
a9e778fcc7 Add support for echo -quoting (raw|kakoune|shell) switch 2019-06-23 12:04:21 +10:00
Maxime Coste
95da8cbc8f Document $kak_quoted_... 2019-06-23 12:04:21 +10:00
Olivier Perret
35c8ca6977 [doc] Fix some typos 2019-05-12 22:56:38 +02:00
Tim Allen
a7807b962e Document the %val{error} expansion. 2019-05-02 19:55:41 +10:00
Maxime Coste
0cc89b2b9f Merge remote-tracking branch 'laelath/provides-requires' 2019-04-25 11:59:42 +01:00
Maxime Coste
4e24ba86cc Change faces alias to be a base that can be modified
Using <fg>,<bg>+<attr>@<base> will apply the given fg color,
bg color and attributes on top of base dynamically. Simply giving
<base> is a shorthand for default,default@<base>.

Inspired by the discussion in #2862
2019-04-23 23:15:23 +01:00
Delapouite
4ce37c1211 doc: move aliases explanation from README to commands.asciidoc 2019-04-19 23:13:23 +02:00
Maxime Coste
06d4ee578e Update changelog 2019-04-17 08:38:52 +02:00
Maxime Coste
78419bc76f Remove InsertCompletionSelect hook 2019-04-17 08:38:52 +02:00
Maxime Coste
9118a18d5d Change completions option docstring element to be an arbitrary command
We can have the previous behaviour by just passing the docstring to
`info -placement menu`.
2019-04-17 08:38:52 +02:00
Maxime Coste
02fc42a12a Rename info -placement to info -style and support modal style
Fixes #1375
Closes #1380
2019-04-17 08:38:52 +02:00
Maxime Coste
ace499ecb1 Pass selected completion text to InsertCompletionHide 2019-04-16 15:56:07 +02:00
Justin Frank
f49644e8ee Fix typo in documentation and clarify override behaviour 2019-04-15 12:53:45 -07:00
Maxime Coste
0bff4851d9 Support '-placement menu' switch in the info command
Expose insert completion menu documentation via the info command.
2019-04-15 17:22:48 +02:00
Maxime Coste
6b79c1e000 Support named captures in hooks
Fixes #2857
2019-04-15 23:56:49 +10:00
Justin Frank
891c6ca8e2 Fix typo in changelog 2019-04-08 17:08:35 -07:00
Justin Frank
93ced79f37 Updated the changelog, commands, and hooks docs to be clearer 2019-04-08 17:06:56 -07:00
Justin Frank
87bcf23f3e Added module system to changelog, commands, and hooks doc files 2019-04-08 17:06:56 -07:00
Maxime Coste
69663bdc81 Update changelog 2019-04-08 22:19:17 +10:00
Maxime Coste
c8839e7904 Add a ClientCreate and ClientClose hook
As discussed in #2830.
Closes #2500.
2019-04-08 21:59:32 +10:00
Maxime Coste
08f1a471fd Merge remote-tracking branch 'elasticdog/current-option-values' 2019-04-07 21:08:48 +10:00
Maxime Coste
deff8f2b8e Merge remote-tracking branch 'Frojdholm/fix-typo-highlighters' 2019-04-07 13:40:41 +10:00
Maxime Coste
d0df1ffe71 update version notes and changelog 2019-04-07 09:51:27 +10:00
Maxime Coste
41f19f8dc9 Add support for %file{...} expansions
This should make the use case exposed in #2836 implementable.
2019-04-07 09:43:40 +10:00
Maxime Coste
744778be30 Add a -to-file <filename> switch to the echo command
As discussed in #2836
2019-04-07 09:32:17 +10:00
Hampus Fröjdholm
1046e3d4d5 Fix typo highlighters docs 2019-04-04 04:48:27 +02:00
Bruno Heridet
b40eeae6e3 doc: add precision about -buffer switch on eval/exec
Relevant filter in the code:
```
        if (*bufnames == "*")
        {
            for (auto&& buffer : BufferManager::instance()
                               | transform(&std::unique_ptr<Buffer>::get)
                               | filter([](Buffer* buf) { return not (buf->flags() & Buffer::Flags::Debug); })
                               | gather<Vector<SafePtr<Buffer>>>()) // gather as we might be mutating the buffer list in the loop.
                context_wrap_for_buffer(*buffer);
        }

```
2019-03-26 19:34:23 +01:00
Maxime Coste
b531bab1ce Add support for -shell-script-* completion in :prompt
Fixes #2754
2019-03-24 19:28:46 +11:00
Tim Allen
066217ad4b doc: The faces doc should list all the supported color names. 2019-03-23 11:38:21 +11:00
Maxime Coste
cf0458e734 Add cursor_display_column expansion
Fixes #2788
2019-03-23 11:32:32 +11:00
Maxime Coste
830dd2b619 Update changelog to notify change in rc/ hierarchy 2019-03-21 22:03:11 +11:00
Aaron Bull Schaefer
ada4e01f97 Document how to view the current value for options 2019-03-18 08:27:08 -07:00
Maxime Coste
af38d9230c Merge remote-tracking branch 'Screwtapello/document-edit-flags' 2019-03-13 06:50:15 +11:00
Maxime Coste
7c5831780b Fix typo
Thanks to occivink
2019-03-05 21:07:49 +11:00
Maxime Coste
e65a7f1310 Merge branch 'patch-1' of https://github.com/bugabinga/kakoune 2019-03-05 20:51:04 +11:00
Maxime Coste
ffb1813759 Merge remote-tracking branch 'krobelus/write-all-note-modified' 2019-03-05 20:50:15 +11:00
Maxime Coste
2fa78d720f Merge remote-tracking branch 'eraserhd/tmux-mac-color-fix' 2019-03-05 20:49:19 +11:00
Maxime Coste
4843149b6a Make error description available as "%val{error}" during catch blocks
Fixes #2761
2019-03-05 20:46:23 +11:00
Jason Felice
f140b01b5b Notes on true color and Mac OS 2019-03-02 22:53:15 -05:00
Johannes Altmanninger
b849099472 Document that write-all only writes modified buffers 2019-02-25 10:59:45 +01:00
Oliver Jan Krylow
b36ece46c4
rename auto_complete -> autocomplete in docs 2019-02-24 10:45:38 +00:00
Jason Felice
7cf6eddc30 Add object mode expansions 2019-02-17 20:18:19 -05:00
Maxime Coste
e169a1893b Merge remote-tracking branch 'eraserhd/object-command-submode' 2019-02-17 11:22:02 +11:00
Tim Allen
d862556066 doc: Add more details about debug buffers.
From https://github.com/mawww/kakoune/issues/2739#issuecomment-464400235
2019-02-17 11:09:58 +11:00
Tim Allen
abbf843763 doc: Document the switches of :edit. 2019-02-15 20:07:56 +11:00
Jason Felice
000aa2282c Add object command 2019-02-14 09:32:04 -05:00
Maxime Coste
4dae2c875b Introduce a writemethod option to either overwrite or replace files
This permit to choose if files should be written by overwriting their
content (the default), or by writing to a separate temporary file
and rename it to the current file.

As discussed in #2036
2019-02-12 21:01:19 +11:00
Maxime Coste
d28dbd0918 Merge remote-tracking branch 'lePerdu/expansion-docs' 2019-02-03 10:09:53 +11:00
Jan-Jaap Korpershoek
0d8d32cf38 Change all instances of count to monospace 2019-02-01 18:19:50 +01:00
Jan-Jaap Korpershoek
4521099ebb Add explanation of count for s and S commands 2019-02-01 16:36:57 +01:00
lePerdu
665d90b9bb Document escaping %-strings and add more examples 2019-01-31 09:00:08 -05:00
lePerdu
a5f865a566 Add/fix cross-references for expansions 2019-01-31 08:48:35 -05:00
lePerdu
deda159536 Change "brace" back to "nestable punctuation" 2019-01-30 21:12:48 -05:00
lePerdu
db4bb6788d Make word splitting description more precise 2019-01-30 21:12:39 -05:00
lePerdu
a7320a01aa Specify only lists can expand to multiple args 2019-01-30 16:17:45 -05:00
lePerdu
5a4ba0b35f Update and clarify expansion/quoting docs 2019-01-30 15:46:40 -05:00
Tim Allen
4247cf6def doc: Document the buffer=/path/to/file scope syntax.
Also, make sure all commands that involve scopes link to the scopes
documentation, and refer to the "scope" parameter as `*scope*` for consistency.
2019-01-23 12:34:02 +11:00