Commit Graph

71 Commits

Author SHA1 Message Date
Coleman McFarland
11f98dc0f1
Add brief modules explanation
In lieu of adding a whole docs page for modules, a brief introduction can
be added above the provide-module and require-module command docs.
2022-02-13 15:15:07 -05:00
Maxime Coste
40e3614cf4 Prevent overwriting existing file in :write <explicit filename>
Add a -force (equivalent to w!) switch that enables overwriting.
2021-07-20 22:30:41 +10:00
Maxime Coste
394a104405 Merge remote-tracking branch 'Screwtapello/doc-improvements' 2021-07-07 19:18:27 +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
9bc5e76ad7 {commands,hooks}.asciidoc: Use consistent capitalization for Kakoune 2021-05-15 22:17:41 -04: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
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
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
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
Maxime Coste
97e88b6087 Remove the rename-client's nc alias
Closes #3789
2020-10-19 20:30:33 +11:00
Qi Xiao
1f5d566d15
Update commands.asciidoc
Fix typo: "automatically" should be "atomically"
2020-09-07 23:46:30 +01:00
Maxime Coste
ca195ffd7b Merge branch 'docs' of http://github.com/migueldvb/kakoune 2020-08-23 14:01:01 +10: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
f2cc7bc891 Add User hook support 2020-07-04 13:48:27 +10:00
Johannes Altmanninger
e4f7d42396 doc: fix typos and clarify some parts 2020-05-28 18:37:26 +02:00
Miguel de Val-Borro
85227019ff Fix some typos in docs 2020-05-09 12:18:16 -04: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
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
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
15df0fc781 Add -scratch and -file switches to the rename-buffer command 2019-12-07 15:40:57 +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
Maxime Coste
1c5a7d839c Merge remote-tracking branch 'lenormf/fix-scratch-doc' 2019-11-07 20:16:06 +11: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
a9e778fcc7 Add support for echo -quoting (raw|kakoune|shell) switch 2019-06-23 12:04:21 +10:00
Maxime Coste
0cc89b2b9f Merge remote-tracking branch 'laelath/provides-requires' 2019-04-25 11:59:42 +01:00
Delapouite
4ce37c1211 doc: move aliases explanation from README to commands.asciidoc 2019-04-19 23:13:23 +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
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
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
744778be30 Add a -to-file <filename> switch to the echo command
As discussed in #2836
2019-04-07 09:32:17 +10:00
Maxime Coste
b531bab1ce Add support for -shell-script-* completion in :prompt
Fixes #2754
2019-03-24 19:28:46 +11:00
Maxime Coste
7c5831780b Fix typo
Thanks to occivink
2019-03-05 21:07:49 +11:00
Maxime Coste
ffb1813759 Merge remote-tracking branch 'krobelus/write-all-note-modified' 2019-03-05 20:50:15 +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
Johannes Altmanninger
b849099472 Document that write-all only writes modified buffers 2019-02-25 10:59:45 +01:00
Tim Allen
abbf843763 doc: Document the switches of :edit. 2019-02-15 20:07:56 +11: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
Delapouite
4c68abab11 doc: fix misc typos for source and region highlighter 2018-11-10 12:12:03 +01:00
Justin Frank
ab6bc41358 Added shell command completion support to define-command and prompt
This commit also introduces a regression in that I decided that the best way to
avoid overly long and confusing names was to rename the current shell-*
switches to script-*, and have the shell command completion be
shell-completion.

renamed script-{completion,candidates} to shell-script-*

Updated docs with new switch names

Added -shell-completion switch to x11-repl and kitty-repl
2018-10-03 09:46:31 -07:00