Commit Graph

246 Commits

Author SHA1 Message Date
Frank LENORMAND
495217edf9 doc: Document guidelines about writing kak scripts 2017-05-06 18:45:21 +03:00
Frank LENORMAND
0b8937a459 doc: document the X key 2017-04-25 11:39:50 +03:00
Frank LENORMAND
41822f630c doc: Fix some issues in spelling, grammar and punctuation 2017-04-21 13:59:38 +03:00
Frank LENORMAND
51ab59cd36 src: Implement a write! command
This commit allows "forced" writes to a write-protected file, by
attempting to temporarily grant the current user write permissions on
it. After the buffer has been written, the previous permissions are
restored if the file existed, or set to 0644 otherwise.
2017-04-20 17:13:42 +03:00
Maxime Coste
0d8b850bc3 Merge remote-tracking branch 'lenormf/doc-mapping' 2017-04-19 14:46:48 +01:00
Frank LENORMAND
fd874dabae doc: Write a dedicated "mapping" page
Closes #1189
2017-04-18 16:59:52 +03:00
Maxime Coste
376449f28a Add documentation for the set_cursor ui call in json_ui.asciidoc 2017-04-12 10:46:27 +01:00
Frank LENORMAND
16068321c1 src: Support the -help flag
This commit allows a help message to be printed when a `-help` flag is
passed to the editor, which will subsequently quit after a summary and a
description of all the flags available have been displayed.

The GNU convention (passing a single `--help` argument to the program)
is also supported, although undocumented.

The man page also now documents the `+:` argument, although unrelated to
the original changeset.
2017-04-10 22:23:30 +03:00
Maxime Coste
055ed5ff7e Expose hook params regex captures in hook_param_capture_N 2017-03-30 11:31:07 +01:00
Maxime Coste
2cfe3cae36 Add an InsertDelete hook 2017-03-30 10:38:56 +01:00
Dan Rosén
5a403a9611 Increase modelinefmt configuration power 2017-03-11 21:43:51 +01:00
Frank LENORMAND
59b65bb9fb ncurses: Add a Dilbert assistant
Drawn by myself.
2017-03-08 20:03:29 +03:00
Maxime Coste
58bde719e1 Document the -docstring switch of the :map command 2017-03-05 22:47:16 +00:00
Maxime Coste
2adbbb4129 Document backslash disabling hooks
Fixes #1223
2017-02-19 13:18:00 +00:00
Maxime Coste
edc2a88643 Rename BufNew and BufOpen hooks to BufNewFile and BufOpenFile
Fixes #1225
2017-02-19 13:08:06 +00:00
Maxime Coste
f6ce3f7edc Merge remote-tracking branch 'danr/fix-rot-doc' 2017-02-13 20:27:54 +00:00
Maxime Coste
2edb7d62ef Add support for -on-change and -on-abort to prompt
Fixes #1209
2017-02-12 12:51:58 +00:00
Dan Rosén
177fdfd5ce Update outdated example in <a-"> keys doc 2017-02-11 08:56:27 +01:00
Maxime Coste
6163134f30 Merge remote-tracking branch 'lenormf/show-whitespaces-flags' 2017-02-09 23:33:08 +00:00
Maxime Coste
ce2b85ddac Add -match-capture support for regions higlighter
Closes #837
2017-02-06 23:00:13 +00:00
Frank LENORMAND
5d86b58a38 Allow modifying the characters used when highlighting whitespace
This commit adds the following flags to the `show_whitespaces`
highlighter, with a one character long parameter:

 * `-lf`: character replacing line feeds
 * `-spc`: character replacing spaces
 * `-nbsp`: character replacing non breakable spaces
 * `-tab`: character replacing a tabulation
 * `-tabpad`: character used as padding after a tabulation to satisfy
              the `tabstop` option
2017-02-04 10:21:13 +03:00
Eike Plack
34e36e6bfb Fix doc ui options and manpage
* the ncurses_buffer_padding implementation was not merged
  see #593
2017-02-02 18:26:05 +01:00
Maxime Coste
bc0dfa9e8f Use <a-'> for backward rotate selection and move rotate content to <a-"> 2017-02-01 22:53:42 +00:00
Maxime Coste
2475ffa612 Merge remote-tracking branch 'ekie/tiny_tweaks' 2017-01-25 00:38:59 +00:00
Maxime Coste
d922ae9a93 Add a quick section on key syntax in keys.asciidoc 2017-01-25 00:14:11 +00:00
Maxime Coste
834ccff941 Rename "shortcuts" manpage to "keys"
Fixes #1150
2017-01-25 00:01:37 +00:00
Maxime Coste
ebcfba12f6 Add a RawKey hook for raw user input hooking
Fixes #1132
2017-01-24 23:57:36 +00:00
Maxime Coste
7ba24c043a Add gi to go to first non-blank character on line
Fixes #407
2017-01-22 23:53:08 +00:00
Eike Plack
8ff2d0ba41 Document +line[:column] 2017-01-19 22:56:27 +01:00
Eike Plack
3e67b20245 Fix misleading wording 2017-01-19 00:47:51 +01:00
Koen
394b962524 Add missing shell expansion variable documentation
Add  a documentation entry for kak_cursor_byte_offset
2017-01-11 12:36:17 +02:00
Maxime Coste
343df600cb Merge remote-tracking branch 'alexherbo2/command-names' 2017-01-10 13:44:11 +00:00
Maxime Coste
9dfd17a5bc Add the 'modal' info style documenation in json ui doc 2017-01-07 01:26:52 +00:00
Enrico Lumetti
a64ef12d2b Clarify parameters in json-rpc 2017-01-06 22:25:47 +01:00
Maxime Coste
f9f11aa762 Make the currently sourced file path available through $kak_source
The :source command sets an 'source' value to the real path of the
file getting sourced while its commands are executed.

Fixes #1112
2017-01-06 19:46:47 +00:00
Maxime Coste
44ecf99c93 Add show_whitespaces in the highlighters documentation page 2017-01-05 13:15:12 +00:00
Maxime Coste
306243e8d9 Remove the runtime command 2017-01-05 11:13:57 +00:00
Alex Leferry 2
671b50bb52 update command names 2017-01-04 13:04:27 +01:00
Maxime Coste
952bf8988f Update session doc and remove references to removed socket value 2017-01-02 11:11:13 +00:00
Maxime Coste
190a04d6c8 Add a ncurses_change_colors option that can disable color palette change
Closes #1057
2016-12-30 07:01:13 +00:00
Matt Schick
0a2428c448 Fixed a typo in the documentation - "test" -> "text" 2016-12-17 08:43:45 -08:00
Maxime Coste
119f73d23f Merge remote-tracking branch 'jakwings/doc' 2016-12-16 19:54:43 +00:00
J.W
e97a7f9af3 Update documentation about builtin faces 2016-12-16 12:29:43 +08:00
Matt Schick
9fb6650140 Correct typos 'red' -> 'read' 2016-12-15 17:36:11 -08:00
Maxime Coste
2969c376a1 Document the <a-.> normal command
Fixes #986
2016-12-14 20:45:15 +00:00
Maxime Coste
53267a926b Merge remote-tracking branch 'Phlogistique/doc-doc' 2016-12-14 00:06:37 +00:00
Noé Rubinstein
be917f7b32 README, doc: mention :doc 2016-12-13 19:11:45 +01:00
Maxime Coste
68d7309ddc Fix asciidoc error in design.asciidoc 2016-12-08 09:50:26 +00:00
Maxime Coste
948c591e8d Small wording change in design.asciidoc 2016-12-08 09:48:08 +00:00
Maxime Coste
3ad554167d Fix typo in commands.asciidoc 2016-12-01 20:14:31 +00:00
Maxime Coste
a4738ace5f :prompt and :onkey (renamed :on-key) now use values instead of registers
:prompt provides the entered text in the `text` value, :on-key provides
the entered key in the `key` value.

Closes #938
2016-11-27 20:57:04 +00:00
Maxime Coste
dcd733e5fa Do a first phase of command renaming 2016-11-14 00:27:14 +00:00
Maxime Coste
8490caa0d7 Add support for <a-Z> appending current selections to the given register 2016-11-09 13:57:05 +00:00
Frank LENORMAND
23ff7b6ca5 Update and compliment the kak man page 2016-10-29 10:55:10 +03:00
Frank LENORMAND
0f8981a9df Document missing options related to mouse support 2016-10-29 10:55:06 +03:00
Maxime Coste
be8b8a740d Merge remote-tracking branch 'lenormf/fix-doc-count' 2016-10-26 23:23:55 +01:00
Maxime Coste
7c6c6871ce BufferRange option syntax support <line>.<column>+<len> and is inclusive
Fixes #864
2016-10-26 22:58:12 +01:00
Frank LENORMAND
11733bc5a8 Document count parameters for commands
Closes #895
2016-10-26 13:34:09 +03:00
Maxime Coste
dc18963875 Make o/O open multiple lines when a count is given
Fixes #873
2016-10-24 20:45:12 +01:00
Maxime Coste
dbae81fa5c Merge remote-tracking branch 'lenormf/doc-scopes' 2016-10-23 23:24:13 +01:00
Frank LENORMAND
f4236fbb8b Document the current scope and some hooks behaviour 2016-10-18 15:36:43 +03:00
Maxime Coste
41a497d4fc Merge remote-tracking branch 'lenormf/faq' 2016-10-13 23:11:53 +01:00
Frank LENORMAND
8b133e32d6 Add a dedicated documentation page about scopes
Information related to scopes have also been modified in other documentation
pages.
2016-10-13 11:55:09 +03:00
Frank LENORMAND
70fd03679b Add a warning about setting $TERM manually, fix some typos 2016-10-12 09:36:42 +03:00
Frank LENORMAND
b0d8e1a230 Answer the pager question in the FAQ document 2016-10-11 14:40:20 +03:00
Frank LENORMAND
f7e2bfd76f Document the optional parameter of the cd command 2016-10-11 10:39:20 +03:00
Maxime Coste
0d2bb4756b Fix register alternate name doc and dash -> hash for '#' 2016-10-10 23:19:57 +01:00
Maxime Coste
314108e539 Document register alternate names and add some missing ones
Fixes #853
2016-10-09 23:27:52 +01:00
Frank LENORMAND
9848e1f4ba Fix a few mistakes, allow a2x to compile the page 2016-09-23 13:56:07 +03:00
Frank LENORMAND
59bb543bb5 Add more questions, complete some answers 2016-09-23 13:50:50 +03:00
Frank LENORMAND
3d80ce5f8e Add a basic FAQ 2016-09-23 13:50:50 +03:00
Maxime Coste
532e3758fe Add InsertCompletionShow/InsertCompletionHide hooks 2016-09-21 13:43:06 +01:00
Maxime Coste
396b71ecc2 Add an unmap command to remove key mappings 2016-09-19 09:10:41 +01:00
Maxime Coste
c152fbe3b6 Make idle timeout and filesystem check timeout configurable 2016-09-18 13:47:22 +01:00
Frank LENORMAND
a0e72a57a2 Document the <a-m> shortcut to merge selections 2016-08-29 11:48:40 +03:00
Maxime Coste
0c444c3f4b Fix documentation of completions and range-faces options
Fixes #771
2016-08-27 11:05:37 +01:00
Maxime Coste
ba7df73b15 Merge remote-tracking branch 'doppioandante/json-doc' 2016-08-27 10:33:03 +01:00
Enrico Lumetti
ddff67da39 Name JSON resize parameters explicitely 2016-08-25 02:14:50 +02:00
Maxime Coste
3f0415c765 Introduce the 'completion_extra_word_chars' option
This string option is used to get all the additional characters
that should be considered as "word" character for the purpose of
insert mode completion.

Fixes #758
2016-08-24 23:47:09 +01:00
Maxime Coste
e0c1f33427 Improve documentation for completions options 2016-08-17 19:52:53 +01:00
Martin Chaine
b9144f151a Update completion documentation 2016-08-17 18:24:59 +02:00
Maxime Coste
213888da74 Document namesession command 2016-07-28 00:17:55 +01:00
Frank LENORMAND
6ab238bfa8 Add dummy documentation of the alternative undo bindings 2016-07-26 09:26:13 +03:00
Maxime Coste
003cb8dfea Merge remote-tracking branch 'lenormf/readonly-mode' 2016-07-24 21:21:49 +01:00
Frank LENORMAND
7558994149 Document the readonly variable and -ro command line option 2016-07-23 10:03:25 +03:00
Maxime Coste
bbab4001de Document ranges highlighters
They were not, as pointed out in #736
2016-07-19 10:20:42 +01:00
Maxime Coste
7f345db3cc Document that json rpc requests will be written new-line separated
Fixes #717
2016-07-04 19:49:14 +01:00
Maxime Coste
6e0279856f Document InsertChar hook 2016-06-20 19:30:28 +01:00
Maxime Coste
7f2b3f0132 Document WinResize in hooks man page 2016-05-13 09:33:11 +01:00
Maxime Coste
199ccb4021 Add a -password switch to :prompt to allow for more secure password entering
Fixes #660
2016-04-19 09:51:09 +01:00
Maxime Coste
925b8d6e4f Add missing text objects in shortcuts.asciidoc 2016-04-13 09:51:51 +01:00
Maxime Coste
815924e4da Merge remote-tracking branch 'lenormf/buffer-padding' 2016-04-11 13:44:10 +01:00
Maxime Coste
9b98aa61a8 Fix json_ui doc on the option to use 2016-04-09 09:05:19 +01:00
Delapouite
f7e3ec03c2 Fix various typos in docs/ 2016-04-08 18:00:24 +02:00
Maxime Coste
d1732673ce Document the null register 2016-03-31 09:21:09 +01:00
Frank LENORMAND
8ae7116237 Document storing of submatches in a selection's regex 2016-03-16 14:29:43 +02:00
Frank LENORMAND
f32fe6c4cd Document missing commands, fix rendering issues 2016-03-12 11:30:10 +02:00
Maxime Coste
26e81976d3 Add a quick explanation of the json ui 2016-03-07 21:44:50 +00:00
Maxime Coste
52525a156f Remove complete_prefix option and behaviour
Now that we use subsequence based completion almost everywhere,
completing the common prefix does not make sense anymore.
2016-03-07 20:17:41 +00:00
Maxime Coste
7ec90f3afd Merge remote-tracking branch 'benoit-intrw/regex_doc' 2016-03-06 15:20:13 +00:00
Benoît Laurent
edce759d88 Use a link to Boost.Regex that always point to latest release 2016-02-22 22:17:02 +01:00
Frank LENORMAND
c90dafcbfb Document the | register, as well as default registers saved by exec/eval 2016-02-18 14:57:23 +02:00
Frank LENORMAND
72cfa65448 Document the BufferPadding face 2016-02-17 15:55:19 +02:00
Maxime Coste
1937b7745a Rewrap and tweak manpages 2016-02-10 21:03:49 +00:00
Maxime Coste
3030775414 Cleanup doc manpages generation 2016-02-06 00:01:42 +00:00
Frank LENORMAND
4280831e7a Prevent a2x from changing the generated man page name to 'kakoune' 2016-02-04 14:54:53 +02:00
Frank LENORMAND
eb62327a4c Rename the man page to kak 2016-02-04 12:58:59 +02:00
Frank LENORMAND
77beeaf9b9 Rewrote the documentation pages in asciidoc format 2016-02-03 19:15:35 +02:00
Frank LENORMAND
6951f3f2d9 Wrap long lines 2016-02-03 17:04:20 +02:00
Frank LENORMAND
b6e930a57d Migrate the raw troff kakoune man page to the asciidoc format 2016-02-03 14:51:32 +02:00
Frank LENORMAND
caa87608d4 Document the t and f bindings 2016-02-03 11:39:58 +02:00
Frank LENORMAND
33008f9ea7 Add a doc command, as well as several themed documentation pages 2016-02-02 21:15:12 +02:00
Frank LENORMAND
043f742ec3 Add a basic man page 2016-02-02 21:13:25 +02:00
Eike Plack
d8f034fbad Update Coding Style 2015-11-04 02:32:59 +01:00
Maxime Coste
e0a16734f6 Update keymap 2015-11-02 19:51:59 +00:00
Maxime Coste
4380683cad Fix a few out of date informations in interfacing.asciidoc 2015-11-01 11:11:44 +00:00
Maxime Coste
24de3ed822 Move selection saving/restoring to z/Z
Fixes #284
2015-07-11 11:36:23 +01:00
Dan Rosén
3881b4d3d0 Add a missing article in design document 2015-06-24 09:06:32 +02:00
Maxime Coste
75dd74ff43 Use <a-R> as replace paste all yanked selections
Move rotate to ' and rotate contents to <a-'>
Fix segfault when pasting all and nothing was yanked yet
2015-06-21 19:36:13 +01:00
Maxime Coste
ecfb715145 Update interfacing.asciidoc 2015-05-07 13:42:58 +01:00
Maxime Coste
71e586a976 Add some screenshots to README 2015-05-07 00:34:50 +01:00
Maxime Coste
ed1c47482d Fix interfacing.asciidoc wrong redirections 2015-04-02 19:17:55 +01:00
ponce
c761c34439 Add logo proposal.
Logo indent

Light now consistently comes from top-left direction.

Merge V branches
2015-03-22 14:09:32 +01:00
Maxime Coste
37a1403295 update keymap 2015-02-21 10:45:31 +00:00
Maxime Coste
a68ce2bf51 small improvement of autoedit.asciidoc 2015-02-03 13:56:55 +00:00
Maxime Coste
54e5d479bd Update doc 2014-12-13 13:17:05 +00:00
Maxime Coste
2c6110dedf Update keymap 2014-11-30 17:19:48 +00:00
Maxime Coste
ebaae7766a Add a coding style document
Fixes #58
2014-10-07 09:34:40 +01:00
Maxime Coste
858132e771 update keymap 2014-09-23 13:44:16 +01:00
Maxime Coste
352228c3b0 update keymap 2014-06-22 12:07:51 +01:00
Maxime Coste
24f6471431 Add '$' for keeping selections that passes a shell command
'$' pipes each selections through a given shell command, and
only keeps the one that have an exit code of 0

Fixes #36
2014-05-05 18:09:03 +01:00
Maxime Coste
8060eef66e Fix typo in design.asciidoc 2014-04-26 00:36:35 +01:00
Maxime Coste
aec858a819 Update design.asciidoc
Add self documenting as a goal, and precisions relative to pragmatism
and orthogonality.
2014-04-25 18:43:55 +01:00
Maxime Coste
4ba99f7d6f Update documentation 2014-03-02 02:08:17 +00:00
Maxime Coste
02760394ba update keymap 2014-03-02 01:06:27 +00:00
Maxime Coste
aacdd821cc update keymap 2014-01-08 19:23:31 +00:00
Maxime Coste
ea14c79c15 Document autoediting in doc/autoedit.asciidoc 2014-01-03 19:00:19 +00:00
Maxime Coste
fb65a09e35 update keymap 2013-11-04 21:59:28 +00:00
Maxime Coste
feff965ac6 Remove setg/setb/setw and use set <scope>
(with scope a prefix of global,buffer or window)
2013-10-30 09:38:40 +00:00
Maxime Coste
6093c43e40 update README, TODO and keymap 2013-10-26 00:51:19 +01:00
Maxime Coste
e11b7aad38 Add design.asciidoc explaining Kakoune design 2013-10-11 09:58:36 +01:00
Maxime Coste
60f03ae4e8 Fixes in interfacing.asciidoc 2013-10-11 09:58:36 +01:00
Maxime Coste
27c422b603 update keymap for case change 2013-07-24 23:21:06 +02:00
Maxime Coste
021627133a update interfacing.asciidoc 2013-07-24 23:18:52 +02:00
Maxime Coste
0be8566dd7 Add interfacing.asciidoc describing how to interact with external programs 2013-05-29 18:57:46 +02:00
Maxime Coste
3295140b31 add doc/keymap 2013-05-15 14:27:14 +02:00