1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
Vis a vim-like text editor
==========================
[](https://travis-ci.org/martanne/vis)
[](https://ci.appveyor.com/project/martanne/vis/branch/master)
[](https://scan.coverity.com/projects/3939)
[](https://codecov.io/gh/martanne/vis)
[](irc://irc.freenode.net/vis-editor)
Vis aims to be a modern, legacy free, simple yet efficient editor
combining the strengths of both vi(m) and sam.
It extends vi's modal editing with built-in support for multiple
cursors/selections and combines it with [sam's](http://sam.cat-v.org/)
[structural regular expression](http://doc.cat-v.org/bell_labs/structural_regexps/)
based [command language](http://doc.cat-v.org/bell_labs/sam_lang_tutorial/).
As an universal editor it has decent Unicode support and should cope with arbitrary files
including: large, binary or single-line ones.
Efficient syntax highlighting is provided using
[Parsing Expression Grammars](https://en.wikipedia.org/wiki/Parsing_expression_grammar)
which can be conveniently expressed using [Lua](http://www.lua.org/)
in the form of [LPeg](http://www.inf.puc-rio.br/~roberto/lpeg/).
The editor core is written in a reasonable amount of clean (your mileage
may vary), modern and legacy free C code, enabling it to run in resource
constrained environments. The implementation should be easy to hack on
and encourage experimentation. There also exists a Lua API for in process
extensions.
Vis strives to be *simple* and focuses on its core task: efficient text
management. Clipboard and digraph handling as well as a fuzzy file open
dialog are all provided by independent utilities. There exist plans to use
a client/server architecture, delegating window management to your windowing
system or favorite terminal multiplexer.
The intention is *not* to be bug for bug compatible with vi(m), instead
we aim to provide more powerful editing features based on an elegant design
and clean implementation.
[](https://asciinema.org/a/41361)
Build instructions
------------------
In order to build vis you will need a
[C99](http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf)
compiler, a [POSIX.1-2008](http://pubs.opengroup.org/onlinepubs/9699919799/)
compatible environment as well as:
* [libtermkey](http://www.leonerd.org.uk/code/libtermkey/)
* [curses](https://en.wikipedia.org/wiki/Curses_(programming_library)) (recommended)
* [Lua](http://www.lua.org/) >= 5.2 (optional)
* [LPeg](http://www.inf.puc-rio.br/~roberto/lpeg/) >= 0.12
(optional runtime dependency required for syntax highlighting)
* [TRE](http://laurikari.net/tre/) (optional for more memory efficient regex search)
Assuming these dependencies are met, execute:
$ ./configure && make && sudo make install
By default the `configure` script will try to auto detect support for
Lua. See `configure --help` for a list of supported options. You can
also manually tweak the generated `config.mk` file.
Or simply use one of the [distribution provided packages]
(https://github.com/martanne/vis/wiki/Distribution-Packages).
Documentation
-------------
End user documentation can be found in the [`vis(1)` manual page]
(http://martanne.github.io/vis/man/vis.1.html) and the [Wiki]
(https://github.com/martanne/vis/wiki). Read the [FAQ]
(https://github.com/martanne/vis/wiki/FAQ) for common questions.
Learn about some differences compared to [`sam(1)`]
(https://github.com/martanne/vis/wiki/Differences-from-Sam) and
[`vim(1)`](https://github.com/martanne/vis/wiki/Differences-from-Vi(m)),
respectively.
[Lua API Documentation](http://martanne.github.io/vis/doc/) is also
available.
Non Goals
---------
Some features which will *not* be implemented:
- tabs / multiple workspaces / advanced window management
- file and directory browser
- support for file archives (tar, zip, ...)
- support for network protocols (ftp, http, ssh ...)
- encryption
- compression
- GUIs (neither x11, motif, gtk, win32 ...) although the codebase
should make it easy to add them
- VimL
- right-to-left text
- ex mode, we have more elegant structural regexp
- diff mode
- vimgrep
- internal spell checker
- lots of compile time configurable features / `#ifdef` mess
How to help?
------------
There are plenty of ways to contribute: writing core editor features using
C or extension in Lua, improving documentation or tests, packaging for
your favorite distribution, ...
Checkout the [Developer Overview](https://github.com/martanne/vis/wiki/Developer-Overview)
to get started and do not hesitate to ask question in the `#vis-editor`
IRC channel on freenode.
|
