Mercurial > vim

annotate README.txt @ 35115:d401437829ee default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag v9.1.0391 for changeset 219a779511feb93e76ff0f74718c609ebad6c7f6
author Christian Brabandt <cb@256bit.org>
date Fri, 03 May 2024 18:30:17 +0200
parents fe206762c077
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
34057
4635e43f2c6f patch 9.1.0000: Vim 9.1 release
Christian Brabandt <cb@256bit.org>
parents: 32774
diff changeset
1 README.txt for version 9.1 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,
34669
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
9 script language, etc. There is also a Graphical User Interface (GUI) available.
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
10 Still, Vi compatibility is maintained, those who have Vi "in the fingers" will
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
11 feel at home. See "runtime/doc/vi_diff.txt" for differences with Vi.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
12
2564
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
13 This editor is very useful for editing programs and other plain text files.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
14 All commands are given with normal keyboard characters, so those who can type
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
15 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
16 mapped to commands by the user, and the mouse can be used.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
17
30320
0763cb330a65 patch 9.0.0496: no good reason to keep supporting Windows-XP
Bram Moolenaar <Bram@vim.org>
parents: 29314
diff changeset
18 Vim runs under MS-Windows (7, 8, 10, 11), macOS, Haiku, VMS and almost all
19125
286aa7c0c9ab patch 8.2.0122: readme files still mention MS-DOS
Bram Moolenaar <Bram@vim.org>
parents: 18879
diff changeset
19 flavours of UNIX. Porting to other systems should not be very difficult.
30320
0763cb330a65 patch 9.0.0496: no good reason to keep supporting Windows-XP
Bram Moolenaar <Bram@vim.org>
parents: 29314
diff changeset
20 Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me/NT/2000/XP/Vista,
0763cb330a65 patch 9.0.0496: no good reason to keep supporting Windows-XP
Bram Moolenaar <Bram@vim.org>
parents: 29314
diff changeset
21 Amiga DOS, Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
22
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
23
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
24 DISTRIBUTION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
25
7177
c4d677c50b9b commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents: 6918
diff changeset
26 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
27 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
28 if you want more features.
c4d677c50b9b commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents: 6918
diff changeset
29
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
30 There are separate distributions for Unix, PC, Amiga and some other systems.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
31 This README.txt file comes with the runtime archive. It includes the
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
32 documentation, syntax files and other files that are used at runtime. To run
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
33 Vim you must get either one of the binary archives or a source archive.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
34 Which one you need depends on the system you want to run it on and whether you
25700
d4faa2c5211b Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 19125
diff changeset
35 want or must compile it yourself. Check "https://www.vim.org/download.php" for
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
36 an overview of currently available distributions.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
37
8917
d07e51166f08 commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents: 8791
diff changeset
38 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
39 * 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
40 * 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
41 * 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
42 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
43
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
44
8791
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
45 COMPILING
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
46
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
47 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
48 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
49 "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
50
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 INSTALLATION
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
53
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
54 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
55 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
56 archive):
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
57
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
58 README_ami.txt Amiga
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
59 README_unix.txt Unix
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
60 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
61 README_mac.txt Macintosh
34669
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
62 README_haiku.txt Haiku
8791
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
34669
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
65 There are other README_*.txt files, depending on the distribution you used.
8791
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
34669
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
74 "runtime/doc/help.txt". It contains pointers to the other documentation files.
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
75 The User Manual reads like a book and is recommended to learn to use Vim. See
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
76 ":help user-manual".
0
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
31579
7d68a90cbf5c Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 30320
diff changeset
87 text must always be included. For modified versions, a few restrictions apply.
0
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
34669
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
95 your appreciation for the work and motivate developers to continue working on
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
96 Vim please send a donation.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
97
34669
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
98 The money you donated will be mainly used to help children in Uganda. See
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
99 "runtime/doc/uganda.txt". But at the same time donations increase the
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
100 development team 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:
25700
d4faa2c5211b Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 19125
diff changeset
103 https://www.vim.org/sponsor/
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
104
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
105
8791
43b5ff7837ea commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents: 7437
diff changeset
106 CONTRIBUTING
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
107
31579
7d68a90cbf5c Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 30320
diff changeset
108 If you would like to help make Vim better, see the CONTRIBUTING.md file.
2564
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
109
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
110
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
111 INFORMATION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
112
34669
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
113 If you are on macOS, you can use MacVim: https://macvim.org
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
114
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
115 The latest news about Vim can be found on the Vim home page:
25700
d4faa2c5211b Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 19125
diff changeset
116 https://www.vim.org/
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
117
6918
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6741
diff changeset
118 If you have problems, have a look at the Vim documentation or tips:
25700
d4faa2c5211b Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 19125
diff changeset
119 https://www.vim.org/docs.php
d4faa2c5211b Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 19125
diff changeset
120 https://vim.fandom.com/wiki/Vim_Tips_Wiki
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
121
34669
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
122 If you still have problems or any other questions, use one of the mailing lists
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
123 to discuss them with Vim users and developers:
25700
d4faa2c5211b Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 19125
diff changeset
124 https://www.vim.org/maillist.php
3935
ee138f29259e updated for version 7.3.723
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
125
32770
4027cefc2aab Farewell to Bram and dedicate upcoming Vim 9.1 to him (#12749)
Christian Brabandt <cb@256bit.org>
parents: 31579
diff changeset
126 If nothing else works, report bugs directly to the vim-dev mailing list:
4027cefc2aab Farewell to Bram and dedicate upcoming Vim 9.1 to him (#12749)
Christian Brabandt <cb@256bit.org>
parents: 31579
diff changeset
127 <vim-dev@vim.org>
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
128
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
129
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
130 MAIN AUTHOR
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
131
34669
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
132 Most of Vim was created by Bram Moolenaar <Bram@vim.org>, ":help Bram-Moolenaar"
32774
1b2730ece70e runtime: Add a few more remarks about Bram and new runtime files
Christian Brabandt <cb@256bit.org>
parents: 32770
diff changeset
133
34669
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
134 Send any other comments, patches, flowers and suggestions to the vim-dev
fe206762c077 Update README.txt and README.md (#14313)
Christian Brabandt <cb@256bit.org>
parents: 34057
diff changeset
135 mailing list: <vim-dev@vim.org>