tREADME - neatvi - [fork] simple vi-type editor with UTF-8 support
(HTM) git clone git://src.adamsgaard.dk/neatvi
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
---
tREADME (2954B)
---
1 NEATVI
2 ======
3
4 Neatvi is a vi/ex editor. It can edit bidirectional UTF-8 text.
5
6 Original version by Ali Gholami Rudi
7 https://github.com/aligrudi/neatvi
8
9 CONFIGURATION
10 -------------
11
12 Edit conf.h to adjust syntax highlighting rules and text direction
13 patterns. To define a new keymap, create a new array in kmap.h, like
14 kmap_fa, and add it to kmaps array in the same header (the first entry
15 of the new array specifies its name). The current keymap may be
16 changed with :cm ex command. When in input mode, ^e activates the
17 English kaymap and ^f switches to the alternate keymap (the last
18 keymap specified with :cm).
19
20 Sadly, VTE-based terminals such as GNOME's implement a
21 backward-incompatible extension of virtual terminal escape codes to
22 render bidirectional text by default. When using these terminal, the
23 value of LNPREF macro in conf.h needs to be edited.
24
25 COMMANDS
26 --------
27
28 Commands not available in ex(1):
29
30 :cm[ap][!] [kmap]
31 Without kmap, prints the current keymap name.
32 When kmap is specified, sets the alternate keymap to
33 kmap and, unless ! is given, switches to this keymap.
34 :ft [filetype]
35 Without filetype, prints the current file type.
36 When filetype is specified, sets the file type of the
37 current ex buffer.
38
39 New key mappings:
40 ^a in normal mode: searches for the word under the cursor.
41 ^p in insert mode: inserts the contents of the default yank buffer.
42 zL, zl, zr, and zR in normal mode: change the value of td option.
43 ^e and ^f in insert mode: switch to the English and alternate keymap.
44 ze and zf in normal mode: switch to the English and alternate keymap.
45 gu, gU, and g~ in normal mode: switch character case.
46 ^l in normal mode: updates terminal dimensions (after resizing it).
47
48 OPTIONS
49 -------
50
51 To improve neatvi's performance, shaping, character reordering, and
52 syntax highlighting can be disabled by defining the EXINIT environment
53 variable as "set noshape | set noorder | set nohl | set td=+2".
54
55 Options supported in neatvi:
56
57 td, textdirection
58 Current direction context. The following values are meaningful:
59 * +2: always left-to-right.
60 * +1: follow conf.h's dircontexts[]; left-to-right for others.
61 * -1: follow conf.h's dircontexts[]; right-to-left for others.
62 * -2: always right-to-left.
63 shape
64 If set (default), performs Arabic/Farsi letter shaping.
65 order
66 If set, reorder characters based on the rules defined
67 in conf.h.
68 hl, highlight
69 If set (default), text will be highlighted based on syntax
70 highlighting rules in conf.h.
71 hll, highlightline
72 If set, highlight current line.
73 lim, linelimit
74 Lines longer than this value are not reordered or highlighted.
75 ai, autoindent
76 As in vi(1).
77 aw, autowrite
78 As in vi(1).
79 ic, ignorecase
80 As in vi(1).
81
82 MARKS AND BUFFERS
83 -----------------
84
85 Special marks:
86 * the position of the previous change
87 [ the first line of the previous change
88 ] the last line of the previous change
89
90 Special yank buffers:
91 / the previous search keyword
92 : the previous ex command