Commit Graph

333 Commits

Author SHA1 Message Date
Maxime Coste
4fabba3d12 doc.kak: Render documentation internally instead of relying on man
doc.kak now behaves as a basic asciidoc renderer. Asciidoc is unfortunately
still a dependency to generate the manpage of the `kak` command.
2017-11-02 10:03:24 +08:00
Maxime Coste
6f2088cbc4 Wrap: Add -indent switch support that wraps preserving line indent 2017-11-02 01:28:28 +08:00
Maxime Coste
6bc408e9b9 Remove duplicated documentation from the README
Just point towards the relevant doc page.
2017-11-01 19:49:13 +08:00
Maxime Coste
ed65d86c72 Rename doc/manpages to doc/pages
That fact we use man for these is an implementation detail.
2017-11-01 19:05:37 +08:00
Maxime Coste
412c21bf70 Update highlighters documentation
Remove documentation from the README and point to the highlighters
doc.
2017-11-01 19:00:44 +08:00
Maxime Coste
09de0686ef Remove remaining references to boost from documentation/contrib files 2017-11-01 14:15:11 +08:00
Maxime Coste
2b295a265e Regex: Add a Compatibility section to the regex documentation
Refer more explicitely to ECMAScript and document the
incompatibilities with it.
2017-11-01 14:05:15 +08:00
Maxime Coste
3f627058b0 Regex: add support for \0, \cX, \xXX and \uXXXX escapes 2017-11-01 14:05:15 +08:00
Maxime Coste
b59ad2f09d Regex: change description of lookarounds limitations 2017-11-01 14:05:15 +08:00
Maxime Coste
3d0a0f1369 Regex: apply danr's suggested changes to the regex syntax documentation 2017-11-01 14:05:15 +08:00
Frank LENORMAND
3acb75c5c2 Regex: Fix a few mistakes in the documentation 2017-11-01 14:05:14 +08:00
Maxime Coste
8c529d3cff Regex: add a regex.asciidoc documentation page describing the syntax 2017-11-01 14:05:14 +08:00
Maxime Coste
7744b4c164 Merge remote-tracking branch 'lenormf/trampoline' 2017-10-25 10:57:58 +08:00
Delapouite
d5b6669a83 Add distinct w (curr buf) / W (all buf) word completion for <c-x> 2017-10-24 22:47:43 +02:00
Maxime Coste
145cf843dd Add a fail command to explicitely raise an error 2017-10-17 10:25:16 +08:00
Frank LENORMAND
2f04317e7b contrib: Add a descriptive reference of editing primitives 2017-10-13 16:39:35 +03:00
Delapouite
d1e59d4673 Docs: fix wrong hardcoded 100ms value for autocompletion 2017-10-10 12:05:10 +02:00
Maxime Coste
b93fd8cbca Merge remote-tracking branch 'Delapouite/collapse-jumps' 2017-10-07 21:52:09 +08:00
Maxime Coste
ca17fbbeb9 Merge remote-tracking branch 'Delapouite/docs-scroll' 2017-10-07 21:51:37 +08:00
Delapouite
d30919dc0e Docs: add missing vm and update custom text-object : → c 2017-10-06 17:49:13 +02:00
Maxime Coste
cbb6e9ea0f Merge remote-tracking branch 'Delapouite/client_list' 2017-10-06 13:53:55 +08:00
Maxime Coste
8900d06646 Merge remote-tracking branch 'Delapouite/complete-line' 2017-10-06 13:50:42 +08:00
Delapouite
d03858280a Add client_list var 2017-10-05 16:41:36 +02:00
Delapouite
0e62518d89 Docs: add missing normal keys <c-[bfud]> 2017-10-04 12:47:56 +02:00
Delapouite
a63cf00b05 Add debug mappings 2017-10-03 23:00:08 +02:00
Delapouite
95e788786f Docs: add missing -collapse-jumps and fix -itersel 2017-10-03 14:22:15 +02:00
Delapouite
6bfc99bf08 Add 'line' in completers option as a way to force explicit <c-x>f 2017-10-02 18:45:11 +02:00
Delapouite
18d6b77a08 Docs: add missing -command-completion and -shell-candidates switches 2017-09-28 15:16:46 +02:00
Tim Allen
42196b83cf Document what keys are mappable. 2017-09-18 12:59:41 +10:00
Maxime Coste
fe50e85203 Merge remote-tracking branch 'lenormf/fix-doc' 2017-09-18 10:07:40 +09:00
Maxime Coste
b0d0014455 Merge remote-tracking branch 'Delapouite/options-default' 2017-09-18 10:02:07 +09:00
Maxime Coste
af61401e3a Merge remote-tracking branch 'lenormf/fix-faq' 2017-09-15 17:27:36 +09:00
Delapouite
7e1da905de docs: add options default values
Fix: #1557
2017-09-12 09:53:06 +02:00
Maxime Coste
772f85b883 Expose the character under the cursor as $kak_cursor_char_value
Fixes #142
2017-09-12 12:45:39 +08:00
Maxime Coste
efa66d7486 Merge remote-tracking branch 'Delapouite/alias' 2017-09-12 11:33:01 +08:00
Frank LENORMAND
4519e4f96b doc faq: Document how to fix the "insert mode escape lag" 2017-09-11 21:59:21 +03:00
Delapouite
221e19251c docs: add command aliases
Fix #1556
2017-09-11 16:23:24 +02:00
Delapouite
53090c0dd3 Add debug faces 2017-09-11 15:49:33 +02:00
Francesco Magliocca
d4fa94c356 Rename env variable kak_curr_history_id to kak_history_id 2017-09-04 16:41:27 +02:00
Francesco Magliocca
a903824ca6 Add documentation for curr_history_id 2017-09-03 20:48:28 +02:00
Frank LENORMAND
2780467329 doc: Document the column and line highlighters
The regular expression given as example for the `regex` highlighter
was also simplified.
2017-08-31 19:40:57 +03:00
Maxime Coste
17a29ab3da Merge remote-tracking branch 'lenormf/fix-doc-debug' 2017-08-28 19:09:46 +07:00
Maxime Coste
e80b36b495 Expose client pid as $kak_client_pid
As requested in #1414
2017-08-28 13:12:45 +07:00
Frank LENORMAND
cc5edd099d doc: Add missing flags to the debug option 2017-08-27 20:30:26 +03:00
Ned Pummeroy
430b7882eb Fix wording in docs for goto commands (h,l,i) 2017-08-27 15:21:13 +10:00
Maxime Coste
d6064e3f93 Merge remote-tracking branch 'lenormf/faq' 2017-08-26 10:46:12 +07:00
Frank LENORMAND
4e36bc7bf8 doc faq: Document the expansion of shell scopes 2017-08-25 11:52:25 +03:00
Maxime Coste
f7bed9eb18 Support specifying an exit status on quit commands
The current client exit status can be specified as an optional
parameter, is nothing is given the exit status will be 0.

Fixes #1230
2017-08-23 13:33:13 +07:00
Francesco Magliocca
1ca01e5d17 Add missing '&' to last example 2017-08-15 21:26:07 +02:00
Maxime Coste
9c4448ac41 Remove echo -color support, superseeded by echo -markup
`echo -color Error "blah"` is the same as `echo -markup '{Error}blah'`
Fixes #1512
2017-07-19 17:18:52 +02:00
Maxime Coste
bed8d9c48e Merge remote-tracking branch 'Delapouite/extra_word' 2017-07-18 17:30:33 +02:00
Delapouite
c30aac0080 Docs: update completions_extra_word_chars → extra_word_chars 2017-07-12 19:18:24 +02:00
Maxime Coste
81b5de6fd8 Add <a-c> and <a-d> for changing/deleting without yanking
As asked for in #1175
2017-07-11 22:25:15 +09:00
Maxime Coste
ebc1e054fc Merge remote-tracking branch 'Delapouite/last-command-reg' 2017-07-11 09:11:10 +09:00
Maxime Coste
b575067317 Add <a-o> and <a-O> to add lines below/above selections
Fixes #1480
2017-07-11 09:03:45 +09:00
Delapouite
0d2b303f62 Docs: add missing colon register (last entered command) 2017-07-10 22:05:21 +02:00
Delapouite
f917402f89 Docs: add missing <a-R> key and fix info message 2017-07-09 12:00:28 +02:00
Delapouite
8ed29dbd7a Docs: add missing PromptIdle hook mentions 2017-07-05 13:45:45 +02:00
Delapouite
21e8da7c37 Docs: add more details about hooks 2017-06-26 18:50:22 +02:00
Frank LENORMAND
f57a4e589e doc: Explain why a modifies the selection and i doesn't 2017-06-22 12:44:47 +03:00
Frank LENORMAND
9e53e00552 doc: Mention the proper environment variable for pagers 2017-06-22 12:44:39 +03:00
Frank LENORMAND
7a9bda9eb8 doc: Unify the documentation for menu keys 2017-06-15 15:14:05 +03:00
Maxime Coste
eadf8930fb Add -width <max_width> support in the wrap highlighter
Will always wrap at the minimum between max_width and actual window
width.

Fixes #1424
2017-06-08 07:05:44 +01:00
Delapouite
09daaa8b3a Expose kak_buf_line_count 2017-06-06 14:29:06 +02:00
Delapouite
eb8ab7a081 docs: add missing angle brackets around keys in README and manpages 2017-05-31 19:22:01 +02:00
Maxime Coste
1d74e1edaf Merge remote-tracking branch 'lenormf/doc-faq-update' 2017-05-29 10:26:57 +01:00
Maxime Coste
bc92633ddd Put the doc/manpages/ pages in the 'k' section 2017-05-27 07:35:13 +01:00
Frank LENORMAND
4360c71bfb doc: Update the F.A.Q. 2017-05-26 18:16:23 +03:00
Maxime Coste
43e8edd3a3 Document the update-option command 2017-05-25 19:54:08 +01:00
Maxime Coste
df4eadd2f5 Merge remote-tracking branch 'danr/Add-modified-value-if-buffer-has-modifications-not-saved' 2017-05-21 06:43:19 +01:00
Maxime Coste
862e4659e0 Merge branch 'master' of git://github.com/ManDay/kakoune 2017-05-21 06:41:26 +01:00
Cedric Sodhi
048697d881 Changed wording of completers description 2017-05-20 19:27:02 +02:00
Maxime Coste
b440d9f537 Change <a-z>/<a-Z> to combine selections instead of appending 2017-05-20 10:31:49 +01:00
Maxime Coste
5753be55c1 Merge remote-tracking branch 'danr/doc-esc-key' 2017-05-19 21:43:58 +01:00
Maxime Coste
8c62b670fd Merge remote-tracking branch 'danr/Document-that-markup-is-possible-in-completion-menu-entries' 2017-05-19 21:43:17 +01:00
Maxime Coste
91342a9d94 Merge remote-tracking branch 'lenormf/doc-E' 2017-05-19 21:33:25 +01:00
Dan Rosén
625e7f8249 Add modified value if buffer has modifications not saved
Closes #1386
2017-05-18 17:39:30 +02:00
Maxime Coste
dfaafcd49a Rename range-faces to range-specs
range-faces are now used to replace-range highlighters, where the string
part is not interpretted as a face but as a display line, so the name was
not relevant anymore.
2017-05-17 19:40:52 +01:00
Dan Rosén
016a601a9e Document escape key and update Q doc according to normal.cc 2017-05-17 14:22:27 +02:00
Dan Rosén
2ec360a178 Document that markup is possible in completion menu entries.
Closes #1373
2017-05-17 10:31:46 +02:00
Frank LENORMAND
6ccfd2f016 doc: Document the -E flag 2017-05-15 22:11:51 +03:00
Maxime Coste
a9deb7fbc8 Merge remote-tracking branch 'occivink/wrap-doc' 2017-05-12 09:51:30 +01:00
Olivier Perret
7f541e5879 misc whitespace fix in docs 2017-05-11 20:45:32 +02:00
Olivier Perret
ec636ce04b update line-flags and flag_lines doc to reflect current status 2017-05-11 20:45:28 +02:00
Olivier Perret
120bf94ed9 fix new face documentation 2017-05-11 19:38:27 +02:00
Maxime Coste
ff15f6bbaf Document the wrap highlighter 2017-05-07 16:26:14 +01:00
Maxime Coste
23e38a254f Introduce a LineNumberWrapped face 2017-05-07 16:26:14 +01:00
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