xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Maxime Coste 2013-12-31 19:40:09 +00:00
parent d9b7eaef2b
commit 57329a6f41
1 changed files with 31 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.asciidoc
View File

@ -12,10 +12,32 @@ keys are directly inserted into the current buffer. In normal mode, keys
are used to manipulate the current selection and to enter insertion mode. are used to manipulate the current selection and to enter insertion mode.
There is no concept of cursor in kakoune, only selections, a single character There is no concept of cursor in kakoune, only selections, a single character
selection can be seen as a cursor but there is no difference internally. selection can be seen as a cursor but there is no difference internally. A
selection is an oriented, inclusive range of characters.
see http://vimeo.com/82711574 see http://vimeo.com/82711574
Features
--------
* Multiple selection as a central way of interacting
* Powerful selection manipulation primitives
- Select all regex matches in current selections
- Keep selections containing/not containing a
match for a given regex
- Split current selections with a regex
- Text objects (paragraph, sentence, nestable blocks)
* Powerful text manipulation primitives
- Align selections
- Rotate selection contents
- Case manipulation
- Indentation
- Piping each selection to external filter
* Simple interaction with external programs
* Macros
* Hooks
* Syntax Highlighting
Building Building
-------- --------
@ -29,6 +51,9 @@ Kakoune dependencies are:
To build, just type *make* in the src directory To build, just type *make* in the src directory
Kakoune can be built on Linux, MacOS, and Cygwin. Due to Kakoune relying heavily
on being in an Unix like environment, no native Windows version is planned.
To setup a basic configuration on your account, type *make userconfig* in the To setup a basic configuration on your account, type *make userconfig* in the
src directory, this will setup an initial $XDG_CONFIG_HOME/kak directory. See src directory, this will setup an initial $XDG_CONFIG_HOME/kak directory. See
the _Kakrc_ section for more information. the _Kakrc_ section for more information.
@ -696,8 +721,8 @@ Some of kakoune state is available through environment variables:
* +kak_hook_param+: filtering text passed to the currently executing hook * +kak_hook_param+: filtering text passed to the currently executing hook
Note that in order to make only needed information available, Kakoune needs Note that in order to make only needed information available, Kakoune needs
to find the environement variable reference in the shell script executed. to find the environment variable reference in the shell script executed.
Hence +%sh{ ./script.sh }+ with +script.sh+ referencing an environement will Hence +%sh{ ./script.sh }+ with +script.sh+ referencing an environment will
not work. not work.
for example you can print informations on the current file in the status for example you can print informations on the current file in the status
@ -732,7 +757,7 @@ new commands can be defined using the +:def+ command.
def can also takes some flags: def can also takes some flags:
* +-env-params+: pass parameters given to commands in the environement as * +-env-params+: pass parameters given to commands in the environment as
kak_paramN with N the parameter number kak_paramN with N the parameter number
* +-shell-params+: pass parameters given to commands as positional parameters * +-shell-params+: pass parameters given to commands as positional parameters
to any shell expansions used in the command. to any shell expansions used in the command.