Commit Graph

743 Commits

Author SHA1 Message Date
Maxime Coste
394a104405 Merge remote-tracking branch 'Screwtapello/doc-improvements' 2021-07-07 19:18:27 +10:00
Maxime Coste
272350c32c Merge remote-tracking branch 'somasis/mandoc' 2021-06-26 10:00:01 +10:00
Kylie McClain
f5e478e9de doc/kak.1: Convert to mdoc(7) semantic markup
This aids in making it more uniform in style with most manuals on *nix
systems in terms of formatting. Plus, the semantic markup will make it
easier to maintain and less reliant on writing for the renderer.
2021-06-15 21:04:22 -04:00
Maxime Coste
d78da60b45 Merge remote-tracking branch 'Screwtapello/document-completion-escaping' 2021-06-15 20:40:19 +10:00
Taupiqueur
ad1dc79789 Fix typos 2021-06-13 04:12:03 +02:00
Tim Allen
bdb668ba54 Document how to escape special characters in completions. 2021-06-11 00:27:13 +10:00
Tim Allen
b228232de7 Clarify which parts of Kakoune the extra_word_chars option affects.
Also, document the "empty option implies underscore" quirk.
2021-06-09 17:50:30 +10:00
Maxime Coste
3d6d61141c Merge remote-tracking branch 'somasis/doc-style' 2021-05-18 20:53:21 +10:00
Tim Allen
e958499400 Document that $kak_token_to_complete is zero-based, not 1-based.
Also, clean up some formatting: definition lists don't need a leading `-`, use
`$` for environment variables, consistent indentation, etc.
2021-05-17 20:25:05 +10:00
Kylie McClain
4ae2102cd8 regex.asciidoc: rephrasing, style, consistency
* Polish some grammar in places.
* Correct some capitalization nitpicks.
* Use "newline" rather than "line feed", which tends to be more common
  in Kakoune's documentation thusfar.

I rephrased some sections, as some of them read a little odd.
* Zero width assertions
    * Consistently use "subject's beginning" instead of "subject begin",
      it reads better.
    * Improve the flow of the word boundary descriptions.
* Modifiers
    * Improve phrasing to emphasize the linear nature of their usage and
      remove a double negative.
    * Use `.` instead of "dot", since that aids in searching through the
      page for things talking about the dot character.
* Compatibility
    * Use asciidoc syntax for the link to the ECMA-262 standard.
    * Use better punctuation on the point about escapes.
2021-05-16 09:16:14 -04:00
Kylie McClain
9bc5e76ad7 {commands,hooks}.asciidoc: Use consistent capitalization for Kakoune 2021-05-15 22:17:41 -04:00
Maxime Coste
7394307a3d Merge remote-tracking branch 'nojhan/feat_padding-options' 2021-04-28 08:11:15 +10:00
Maxime Coste
9b94c2b1d8 Merge remote-tracking branch 'lenormf/patch-10' 2021-04-25 20:16:22 +10:00
Tim Allen
dd28d6f560 doc: Ensure the hook -always switch is documented.
- Make sure switches are in commands.asciidoc.
- Make hooks.asciidoc link to commands.asciidoc.
- Minor wording fix-ups.
2021-04-19 12:46:47 +10:00
nojhan
daa63ba879 [feat] add ui_options: padding_char & padding_fill
In some cases, it may be difficult to easily spot the area out of the buffer
(bad color scheme, small font, superimposed windows).

This patch adds two ncurses ui_options to bypass this problem:
- `ncurses_padding_char`, to configure the padding character,
- `ncurses_padding_fill`, to indicate whether to fill the padding line
  (or to display a single character).

The default config is the legacy one (a single "~").
2021-04-05 20:21:48 +02:00
Kevin Conner
b207f9a435 Edit high-level design doc for ease of reading
- Some run-ons, comma splices, and parentheticals broken into
  more sentences
- Minor fixes like mismatched singular/plurals
- Some word choices tuned for nuances of meaning
2021-03-17 22:12:17 -04:00
Maxime Coste
fa3aa3c1a3 Add + key to duplicate selections and <a-+> to merge overlapping ones
This is an experiment and might get reverted if overlapping selections
prove too cumbersome.

Fixes #4041
2021-02-15 09:01:14 +11:00
Tim Allen
a5e9b69e61 doc: Document the -menu switch for define-command.
This switch was added in c972dfd2.
2021-01-10 23:24:32 +11:00
Tim Allen
e85538e670 doc: Sort define-command's switches to match its docstring. 2021-01-10 23:16:12 +11:00
Maxime Coste
966ad0443d Merge remote-tracking branch 'Cycatz/master' 2021-01-04 09:50:00 +11:00
Maxime Coste
fe12bb4512 Add a changelog entry for shell expansion trailing newline change 2021-01-04 09:48:52 +11:00
Dan Rosén
455cf4838e
Fix typos in changelog 2020-12-29 01:28:13 +01:00
Cycatz
466834fcc3 Fix typo: requiered -> required 2020-12-28 00:11:44 +08:00
Frank LENORMAND
ac2d7bd097
doc mapping: Document semicolon and percent 2020-12-15 17:13:02 +03:00
Maxime Coste
644660f65f Merge remote-tracking branch 'lenormf/patch-9' 2020-11-18 19:57:29 +11:00
Frank LENORMAND
5931655397
doc commands: Align mis-indented command flags 2020-11-17 16:09:56 +03:00
Frank LENORMAND
d673f61620
doc commands: Fix spelling mistake 2020-11-17 15:57:17 +03:00
Maxime Coste
d495369e75 Merge remote-tracking branch 'ManDay/master' into master 2020-11-11 07:25:54 +11:00
Maxime Coste
e6c598dec4 Merge branch 'remove-quote-in-expansion' of http://github.com/contrun/kakoune into master 2020-11-08 15:06:11 +11:00
SeerLite
aa22ea58cf doc options: Clarify how to empty lists/maps 2020-10-27 16:08:16 -03:00
Cedric Sodhi
221fc38bd9 Disabled backtick escaping
Fixes issue #2377 by removing the ability to escape backticks in backticks in compliance with asciidoc's behaviour. Adjusted hooks.asciidoc, keys.asciidoc, and command-parsing.asciidoc to match accordingly.
2020-10-27 12:36:33 +01:00
Maxime Coste
90043e7df0 Replace write -atomic with write -method <method>
`-atomic` becomes `-method replace` and `-method overwrite` is now
supported explicitely instead of only available through the
writemethod option.

Fixes #3827
2020-10-27 20:20:18 +11:00
YI
489773dbf4 remove extra double quotes in expansion documentation 2020-10-22 09:03:20 +08:00
Maxime Coste
65587d1eee Auto-insert best completion on space for menu completions
The menu flag signifies that only the completions are valid arguments,
hence it makes sense to auto insert the best one on space.

Because full match is always considered the best match in completion
ranking, this should always have a reasonable behaviour.

This makes it harder to enter a hidden command, but completion can
always be disabled via <c-o> or by quoting in those rare cases.
2020-10-19 21:43:03 +11:00
Maxime Coste
97e88b6087 Remove the rename-client's nc alias
Closes #3789
2020-10-19 20:30:33 +11:00
Maxime Coste
f549190a98 Add support for explicit completion in prompt mode 2020-10-19 19:36:58 +11:00
Delapouite
8989febe7a doc: mention comma key for entering user-mode 2020-10-04 13:34:57 +02:00
Maxime Coste
cec62e0a93 Merge remote-tracking branch 'samueldple/modify-wording-in-manual-description' into master 2020-09-30 19:45:15 +10:00
Tim Allen
9bc00b6853 doc: Document the form of next-key sub-modes in the ModeChange hook. 2020-09-21 17:28:18 +10:00
Maxime Coste
0e58d4702c Merge branch 'patch-1' of http://github.com/xiaq/kakoune into master 2020-09-17 19:35:56 +10:00
samueldple
59c6c071de
Fix grammar in manual entry 2020-09-12 11:05:14 +01:00
Maxime Coste
ec3d7c3104 Add support for removing from options
`set -remove ...` will remove from the current option value, substracting
from int, removing elements from vectors and maps.
2020-09-09 21:00:30 +10:00
Qi Xiao
1f5d566d15
Update commands.asciidoc
Fix typo: "automatically" should be "atomically"
2020-09-07 23:46:30 +01:00
Maxime Coste
97fd0c0510 Merge remote-tracking branch 'lenormf/repl-normalise' into master 2020-09-06 10:48:08 +10:00
Maxime Coste
e0d2602e6a Kakoune 2020.09.01 2020-09-01 20:37:20 +10:00
Frank LENORMAND
87f9be6723 rc repl: Normalise REPL commands
It's unclear what the `send-text` alias does at first glance,
so prefixing it with "repl-" both fixes that and helps make it
discoverable via the command prompt's fuzzy matcher.

The `repl` alias also seems too generic a name, the "-new" suffix
should hopefully give a hint that it creates a new window.
2020-09-01 13:34:52 +03:00
Maxime Coste
ca195ffd7b Merge branch 'docs' of http://github.com/migueldvb/kakoune 2020-08-23 14:01:01 +10:00
Maxime Coste
01daf7c2e7 Merge remote-tracking branch 'lenormf/fix-faq' 2020-08-20 19:24:35 +10:00
Maxime Coste
40aa687601 Do not fork in daemon mode
Leave that to the shell or external service management tools

Fixes #3618
2020-08-17 19:56:00 +10:00
Frank LENORMAND
2192e3845a doc faq: Document the frugal scripting language 2020-08-10 12:23:35 +03:00
Jason Felice
a52822d965 Override runtime by setting $KAKOUNE_RUNTIME 2020-08-04 11:48:34 -04:00
Maxime Coste
a82d61c14b Kakoune 2020.08.04 2020-08-04 19:13:08 +10:00
Maxime Coste
678390d9d8 Merge remote-tracking branch 'krobelus/doc-keynames' 2020-07-30 21:08:34 +10:00
Johannes Altmanninger
9d33b57e49 doc: mention aliases <lt> and <gt> in keys.asciidoc
This information can also be found in in :doc mapping but I think this
doesn't hurt.
2020-07-25 20:07:18 +02:00
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
Maxime Coste
d3374e7e5f Refactor mouse press/release handling to support 3 buttons
Change button to be an additional parameter instead of having separate
events for left/right buttons.

Fixes #3471
2020-06-28 19:48:55 +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
Maëlys Bras de fer
6fa26b8dd2
Fix usage of $KAKOUNE_CONFIG_DIR in doc 2020-06-01 15:46:24 +02:00
Maëlys Bras de fer
8a7023731f
Fix default value of $XDG_CONFIG_HOME in doc 2020-06-01 15:23:23 +02:00
Maxime Coste
590807b94c Merge remote-tracking branch 'lenormf/patch-6' 2020-05-30 09:23:36 +10: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
Frank LENORMAND
36c0c611be
doc writing_scripts: Document echo portability issues 2020-05-04 12:10:23 +00: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
ffa47f3e35 Merge remote-tracking branch 'lenormf/fix-2510' 2019-10-23 22:34:01 +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
Frank LENORMAND
21686f8d5e man: Factorize the documentation about autoloading
Fixes #2510
2019-10-20 12:44:56 +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
Maxime Coste
081595fa2f Support specifying the user configuration with KAKOUNE_CONFIG_DIR
Fixes #3072
Closes #3081
2019-10-10 20:26:27 +11:00
Maxime Coste
f2e5582f34 Merge remote-tracking branch 'eraserhd/pr/master/extra_word_chars-on-window' 2019-10-01 20:06:03 +10: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
ba0ce99717 Merge remote-tracking branch 'Delapouite/patch-2' 2019-09-26 20:31:45 +10:00
Bruno Heridet
033908f8ec
doc: add link to json-rpc 2.0 spec 2019-09-24 10:07:23 +02:00