README: use EXINIT to disable reordering
[neatvi.git] / README
blob81fd101cb11589c5395595bc2e29e2fcee19fb46
1 NEATVI
2 ======
4 Neatvi is a vi/ex editor.  It can edit bidirectional UTF-8 text.
6 Edit conf.h to adjust syntax highlighting rules and text direction
7 patterns.  To define a new keymap, create a new array in kmap.h, like
8 kmap_fa, and add it to kmaps array in the same header (the first entry
9 of the new array specifies its name).  The current keymap may be
10 changed using :cm ex command.  When in input mode, ^e changes to the
11 English kaymap and ^f changes to the alternate keymap (the last keymap
12 specified with :cm).
14 Commands not available in ex(1):
16 :cm[ap][!] [kmap]
17   Without kmap, print the current keymap name.
18   When kmap is specified, set the alternate keymap to
19   kmap and, unless ! is given, switch to this keymap.
20 :ft [filetype]
21   Without filetype, print the current file type.
22   When filetype is specified, set the file type of the
23   current ex buffer.
25 Options supported by neatvi:
27 td, textdirection
28   Current direction context.  The following values are meaningful:
29   * +2: always left-to-right.
30   * +1: follow conf.h's dircontexts[]; left-to-right for others.
31   * -1: follow conf.h's dircontexts[]; right-to-left for others.
32   * -2: always right-to-left.
33 shape
34   If set (default), performs Arabic/Farsi letter shaping.
35 order
36   If set, reorder characters based on the rules defined
37   in conf.h.
38 hl, highlight
39   If set (default), text will be highlighted based on syntax
40   highlighting rules in conf.h.
41 ai, autoindent
42   As in vi(1).
43 aw, autowrite
44   As in vi(1).
45 ic, ignorecase
46   As in vi(1).
48 Shaping, character reordering, and syntax highlighting can
49 be disabled by defining the EXINIT environment variable as:
50   "set noshape | set noorder | set nohl | set td=+2"