Mercurial > vim

annotate README.txt @ 11220:09300a732ca2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag v8.0.0496 for changeset e53609585b7668923f58ceba461be8993bf0dc22
author Christian Brabandt <cb@256bit.org>
date Tue, 21 Mar 2017 12:00:05 +0100
parents 9f48eab77d62
children 1174611ad715
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10198
9f48eab77d62 commit https://github.com/vim/vim/commit/bb76f24af2010943387ce696a7092175b4ecccf2
Christian Brabandt <cb@256bit.org>
parents: 8917
diff changeset
1 README.txt for version 8.0 of Vim: Vi IMproved.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
2
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
3
7177
c4d677c50b9b commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents: 6918
diff changeset
4 WHAT IS VIM?
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
5
8791
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
6 Vim is a greatly improved version of the good old UNIX editor Vi. Many new
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
7 features have been added: multi-level undo, syntax highlighting, command line
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
8 history, on-line help, spell checking, filename completion, block operations,
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
9 script language, etc. There is also a Graphical User Interface (GUI)
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
10 available. Still, Vi compatibility is maintained, those who have Vi "in the
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
11 fingers" will feel at home. See "runtime/doc/vi_diff.txt" for differences with
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
12 Vi.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
13
2564
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
14 This editor is very useful for editing programs and other plain text files.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
15 All commands are given with normal keyboard characters, so those who can type
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
16 with ten fingers can work very fast. Additionally, function keys can be
8791
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
17 mapped to commands by the user, and the mouse can be used.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
18
8791
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
19 Vim runs under MS-Windows (NT, 2000, XP, Vista, 7, 8, 10), Macintosh, VMS and
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
20 almost all flavours of UNIX. Porting to other systems should not be very
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
21 difficult. Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me, Amiga
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
22 DOS, Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
23
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
24
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
25 DISTRIBUTION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
26
7177
c4d677c50b9b commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents: 6918
diff changeset
27 You can often use your favorite package manager to install Vim. On Mac and
c4d677c50b9b commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents: 6918
diff changeset
28 Linux a small version of Vim is pre-installed, you still need to install Vim
c4d677c50b9b commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents: 6918
diff changeset
29 if you want more features.
c4d677c50b9b commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents: 6918
diff changeset
30
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
31 There are separate distributions for Unix, PC, Amiga and some other systems.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
32 This README.txt file comes with the runtime archive. It includes the
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
33 documentation, syntax files and other files that are used at runtime. To run
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
34 Vim you must get either one of the binary archives or a source archive.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
35 Which one you need depends on the system you want to run it on and whether you
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
36 want or must compile it yourself. Check "http://www.vim.org/download.php" for
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
37 an overview of currently available distributions.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
38
8917
d07e51166f08 commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents: 8791
diff changeset
39 Some popular places to get the latest Vim:
d07e51166f08 commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents: 8791
diff changeset
40 * Check out the git repository from github: https://github.com/vim/vim.
d07e51166f08 commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents: 8791
diff changeset
41 * Get the source code as an archive: https://github.com/vim/vim/releases.
d07e51166f08 commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents: 8791
diff changeset
42 * Get a Windows executable from the vim-win32-installer repository:
d07e51166f08 commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents: 8791
diff changeset
43 https://github.com/vim/vim-win32-installer/releases.
d07e51166f08 commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents: 8791
diff changeset
44
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
45
8791
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
46 COMPILING
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
47
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
48 If you obtained a binary distribution you don't need to compile Vim. If you
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
49 obtained a source distribution, all the stuff for compiling Vim is in the
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
50 "src" directory. See src/INSTALL for instructions.
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
51
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
52
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
53 INSTALLATION
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
54
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
55 See one of these files for system-specific instructions. Either in the
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
56 READMEdir directory (in the repository) or the top directory (if you unpack an
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
57 archive):
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
58
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
59 README_ami.txt Amiga
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
60 README_unix.txt Unix
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
61 README_dos.txt MS-DOS and MS-Windows
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
62 README_mac.txt Macintosh
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
63 README_vms.txt VMS
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
64
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
65 There are more README_*.txt files, depending on the distribution you used.
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
66
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
67
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
68 DOCUMENTATION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
69
8791
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
70 The Vim tutor is a one hour training course for beginners. Often it can be
2564
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
71 started as "vimtutor". See ":help tutor" for more information.
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
72
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
73 The best is to use ":help" in Vim. If you don't have an executable yet, read
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
74 "runtime/doc/help.txt". It contains pointers to the other documentation
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
75 files. The User Manual reads like a book and is recommended to learn to use
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
76 Vim. See ":help user-manual".
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
77
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
78
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
79 COPYING
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
80
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
81 Vim is Charityware. You can use and copy it as much as you like, but you are
2564
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
82 encouraged to make a donation to help orphans in Uganda. Please read the file
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
83 "runtime/doc/uganda.txt" for details (do ":help uganda" inside Vim).
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
84
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
85 Summary of the license: There are no restrictions on using or distributing an
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
86 unmodified copy of Vim. Parts of Vim may also be distributed, but the license
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
87 text must always be included. For modified versions a few restrictions apply.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
88 The license is GPL compatible, you may compile Vim with GPL libraries and
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
89 distribute it.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
90
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
91
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
92 SPONSORING
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
93
826
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
94 Fixing bugs and adding new features takes a lot of time and effort. To show
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
95 your appreciation for the work and motivate Bram and others to continue
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
96 working on Vim please send a donation.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
97
826
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
98 Since Bram is back to a paid job the money will now be used to help children
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
99 in Uganda. See runtime/doc/uganda.txt. But at the same time donations
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
100 increase Bram's motivation to keep working on Vim!
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
101
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
102 For the most recent information about sponsoring look on the Vim web site:
826
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
103
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
104 http://www.vim.org/sponsor/
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
105
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
106
8791
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
107 CONTRIBUTING
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
108
8791
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
109 If you would like to help making Vim better, see the CONTRIBUTING.md file.
2564
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
110
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
111
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
112 INFORMATION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
113
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
114 The latest news about Vim can be found on the Vim home page:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
115 http://www.vim.org/
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
116
6918
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6741
diff changeset
117 If you have problems, have a look at the Vim documentation or tips:
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6741
diff changeset
118 http://www.vim.org/docs.php
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6741
diff changeset
119 http://vim.wikia.com/wiki/Vim_Tips_Wiki
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
120
3941
5049eacbff0e updated for version 7.3.726
Bram Moolenaar <bram@vim.org>
parents: 3935
diff changeset
121 If you still have problems or any other questions, use one of the mailing
5049eacbff0e updated for version 7.3.726
Bram Moolenaar <bram@vim.org>
parents: 3935
diff changeset
122 lists to discuss them with Vim users and developers:
3935
ee138f29259e updated for version 7.3.723
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
123 http://www.vim.org/maillist.php
ee138f29259e updated for version 7.3.723
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
124
ee138f29259e updated for version 7.3.723
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
125 If nothing else works, report bugs directly:
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
126 Bram Moolenaar <Bram@vim.org>
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
127
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
128
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
129 MAIN AUTHOR
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
130
2502
e6420d275b6a Update README files. Remove references to extra and lang archives.
Bram Moolenaar <bram@vim.org>
parents: 2490
diff changeset
131 Send any other comments, patches, flowers and suggestions to:
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
132
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
133 Bram Moolenaar E-mail: Bram@vim.org