Maxime Coste
9118a18d5d
Change completions option docstring element to be an arbitrary command
...
We can have the previous behaviour by just passing the docstring to
`info -placement menu`.
2019-04-17 08:38:52 +02:00
Aaron Bull Schaefer
ada4e01f97
Document how to view the current value for options
2019-03-18 08:27:08 -07:00
Oliver Jan Krylow
b36ece46c4
rename auto_complete -> autocomplete in docs
2019-02-24 10:45:38 +00:00
Maxime Coste
4dae2c875b
Introduce a writemethod option to either overwrite or replace files
...
This permit to choose if files should be written by overwriting their
content (the default), or by writing to a separate temporary file
and rename it to the current file.
As discussed in #2036
2019-02-12 21:01:19 +11:00
Maxime Coste
64f1c31401
Refactor parsing of keys and introduce a builtin key parser mode
...
By setting the ncurses_builtin_key_parser ui_option to true, we
can disable ncurses parsing of key strokes to get less portable
parsing but support for more complex modifiers.
2018-12-09 21:35:22 +11:00
Tim Allen
26e5768207
Be specific about the units of ranges and cursor positions.
2018-10-09 14:31:02 +11:00
Tim Allen
e493eba46d
expansions.asciidoc: Rewrite to make Kakoune syntax the primary reference.
...
Also, moved the "Markup strings" section to faces.asciidoc, since it wasn't
anything to do with expansions, and updated various hyperlinks to point at the
new location.
2018-09-25 18:31:29 +10:00
Maxime Coste
df655422d1
Merge remote-tracking branch 'Screwtapello/support-user-map-options'
2018-08-30 20:10:00 +10:00
Maxime Coste
d99cd3981c
Merge remote-tracking branch 'henrebotha/fix-1'
2018-08-27 08:14:28 +10:00
Frank LENORMAND
5a066c139e
doc options: Make default list values space separated
2018-08-25 15:03:42 +03:00
Henré Botha
aa6d9b8cd5
Fix run-on sentence in options doc
2018-08-22 14:58:11 +02:00
Tim Allen
ede9155fc7
Document which option-types can be used with declare-options.
2018-08-21 18:24:33 +10:00
Tim Allen
49ef9968c0
Support user-defined "str-to-str-map" options.
2018-08-21 18:24:14 +10:00
Delapouite
231e140d37
docs: add -always and -once switch on hooks page
2018-08-16 19:06:57 +02:00
Maxime Coste
bde726d034
Change autoshowcompl to auto_complete with insert|prompt possible values
2018-07-15 11:10:32 +10:00
Maxime Coste
eab98c88bd
Refactor handling of startup info to make it configurable
...
A new `status_info_version` option allows user to disable info
message regarding changes that happened at that version or
earlier.
2018-07-05 07:54:28 +10:00
Maxime Coste
4e2e971033
Update commands.asciidoc, options.asciidoc and expansions.asciidoc pages
2018-07-05 07:54:28 +10:00
Maxime Coste
99fea9c0f9
Fix typo
...
Thanks @lenormf
2018-04-12 21:28:15 +10:00
Maxime Coste
5fa19f4d7f
NCursesUI: Add support for shifted function keys
...
Shifted function keys are not well standardized around terminals,
Shift F(N) usually returns F(X) + N, with X=12 on xterm, X=10 on
rxvt-unicode... Default to X=12 and make it configuable through
the ncurses_shift_function_key ui_option.
This fixes what #1898 tried to.
2018-04-11 20:39:57 +10:00
Delapouite
2d775921bc
Docs: describe the -add switch of set-option
2018-04-05 11:35:03 +02:00
Delapouite
ecd6cebdab
Docs: add %/ token to default path option
2018-03-23 10:24:18 +01:00
Delapouite
abc2d28570
Docs: extend explanations about line_flags, ranges and replace-ranges
2018-03-06 12:15:55 +01:00
Maxime Coste
1f02a1f7e2
Doc pages: Use passive form, never address the reader as 'you'
...
Except for the FAQ, it could be fixed, but it does not have to be
as formal as the rest of the docs.
2017-11-12 22:44:04 +08:00
Maxime Coste
b63f16e7a2
doc.kak: Support anchors and internal links
...
Underline links, support jumping to a specific anchor either in
the current page or another one, use those new features in some
pages.
2017-11-08 16:32:49 +08:00
Delapouite
3b250fe824
Docs: use asciidoc links between pages
2017-11-06 10:08:59 +01:00
Maxime Coste
7f51e51fcb
Introduce matching_pairs option that controls the pairs used by m
2017-11-04 15:53:53 +08:00
Maxime Coste
20fe8e0112
options.asciidoc: use _italic_ for default values
2017-11-02 17:42:44 +08:00
Maxime Coste
3c2159f06c
options.asciidoc: Document other option commands, remove tabs
2017-11-02 17:36:10 +08:00
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
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
