From 221e19251ca62622803b81735eefc57179a53cbf Mon Sep 17 00:00:00 2001 From: Delapouite Date: Sat, 9 Sep 2017 13:47:45 +0200 Subject: [PATCH] =?UTF-8?q?docs:=C2=A0add=20command=20aliases=20Fix=20#155?= =?UTF-8?q?6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/manpages/commands.asciidoc | 53 ++++++++++++++++++++++++---------- 1 file changed, 37 insertions(+), 16 deletions(-) diff --git a/doc/manpages/commands.asciidoc b/doc/manpages/commands.asciidoc index 90bfd5fc..1a64f17f 100644 --- a/doc/manpages/commands.asciidoc +++ b/doc/manpages/commands.asciidoc @@ -10,51 +10,62 @@ Primitives Some commands take an exclamation mark (*!*), which can be used to force the execution of the command (i.e. to quit a modified buffer, the -command *q!* has to be used). +command *q!* has to be used). Aliases are mentionned below each commands. -*cd* []:: +*change-directory* []:: + *alias* cd + change the current directory to *directory*, or the home directory if unspecified *doc* :: + *alias* help + display documentation about a topic. The completion list displays the available topics -*e[dit][!]* [ []]:: +*edit[!]* [ []]:: + *alias* e + open buffer on file, go to given line and column. If file is already opened, just switch to this file. Use edit! to force reloading -*w[rite][!]* []:: +*write[!]* []:: + *alias* w + write buffer to or use its name if filename is not given. If the file is write-protected, its permissions are temporarily changed to allow saving the buffer and restored afterwards when the write! command is used. -*w[rite]a[ll]*:: +*write-all*:: + *alias* wa + write all buffers that are associated to a file -*q[uit][!]* []:: +*quit!* []:: + *alias* q + exit Kakoune, use quit! to force quitting even if there is some unsaved buffers remaining. If specified, the client exit status will be set to -*w[a]q[!]* []:: - write the current buffer (or all buffers when *waq* is used) and quit. - If specified, the client exit status will be set to +*write-all-quit* []:: + *alias* waq + + write all buffers and quit. If specified, the client exit status + will be set to -*kill*:: +*kill[!]*:: terminate the current session, all the clients as well as the server -*b[uffer]* :: +*buffer* :: + *alias* b + switch to buffer -*b[uffer]n[ext]*:: +*buffer-next*:: + *alias* bn + switch to the next buffer -*b[uffer]p[rev]*:: +*buffer-prev*:: + *alias* bp + switch to the previous buffer -*d[el]b[uf][!]* []:: +*delete-buffer[!]* []:: + *alias* db + delete the buffer *source* :: @@ -64,6 +75,7 @@ command *q!* has to be used). load named colorscheme *rename-client* :: + *alias* nc + set current client name *rename-buffer* :: @@ -85,10 +97,12 @@ command *q!* has to be used). does nothing, but arguments will be evaluated (e.g. shell expansion) *declare-option* [-hidden] []:: + *alias* decl + declare a new option, the -hidden hides the option in completion suggestions (c.f. the 'options' documentation page) *set-option* :: + *alias* set + change the value of an option (c.f. the 'options' documentation page), note that the name of a particular buffer can be specified when the target *scope* is 'buffer', e.g. set buffer=/path/to/buffer foo "bar"; @@ -96,6 +110,7 @@ command *q!* has to be used). point to the narrowest scope available in the current context *unset-option* :: + *alias* unset + unset the value of an option (c.f. the 'options' documentation page) *update-option* :: @@ -109,7 +124,8 @@ command *q!* has to be used). remove an alias if its current value is the same as the one passed as an optional parameter, remove it unconditionally otherwise -*face* :: +*set-face* :: + *alias* face + define a face (c.f. the 'faces' documentation page) *exec* [] ...:: @@ -121,6 +137,7 @@ command *q!* has to be used). (c.f. the 'execeval' documentation page) *define-command* [] :: + *alias* def + define a new command (c.f. the 'Declaring new commands' section below) *map* :: @@ -135,14 +152,17 @@ command *q!* has to be used). documentation page) *remove-hooks* :: + *alias* rmhooks + remove every hooks in *scope* that are part of the given *group* (c.f. the 'hooks' documentation page) *add-highlighter* [] ...:: + *alias* addhl + add a highlighter to the current window (c.f. the 'highlighters' documentation page) *remove-highlighter* :: + *alias* rmhl + remove the highlighter whose id is *highlighter_id* (c.f. the 'highlighters' documentation page) @@ -194,7 +214,8 @@ commands: execution, execute *on_error_commands* instead. If nothing is to be done on error, the catch part can be omitted -*reg* :: +*set-register* :: + *alias* reg + set register *name* to *content* *select* .,.:...::