annotate README.txt @ 8440:4c6ad81d41fe

commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7 Author: Bram Moolenaar <Bram@vim.org> Date: Mon Mar 7 22:59:26 2016 +0100 Update runtime files.
author Christian Brabandt <cb@256bit.org>
date Mon, 07 Mar 2016 23:00:08 +0100
parents 388977454c14
children 43b5ff7837ea
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5294
359743c1f59a release version 7.4
Bram Moolenaar <bram@vim.org>
parents: 5247
diff changeset
1 README.txt for version 7.4 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
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
6 Vim is an almost compatible version of the UNIX editor Vi. Many new features
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
7 have been added: multi-level undo, syntax highlighting, command line history,
826
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
8 on-line help, spell checking, filename completion, block operations, etc.
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
9 There is also a Graphical User Interface (GUI) available. See
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
10 "runtime/doc/vi_diff.txt" for differences with Vi.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
11
2564
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
12 This editor is very useful for editing programs and other plain text files.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
13 All commands are given with normal keyboard characters, so those who can type
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
14 with ten fingers can work very fast. Additionally, function keys can be
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
15 defined by the user, and the mouse can be used.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
16
7437
388977454c14 commit https://github.com/vim/vim/commit/43f837dea588207c87c34794b19c024e9ff1db3e
Christian Brabandt <cb@256bit.org>
parents: 7177
diff changeset
17 Vim runs under MS-DOS, MS-Windows (NT, 2000, XP, Vista, 7, 8, 10), Macintosh,
388977454c14 commit https://github.com/vim/vim/commit/43f837dea588207c87c34794b19c024e9ff1db3e
Christian Brabandt <cb@256bit.org>
parents: 7177
diff changeset
18 VMS and almost all flavours of UNIX. Porting to other systems should not be
388977454c14 commit https://github.com/vim/vim/commit/43f837dea588207c87c34794b19c024e9ff1db3e
Christian Brabandt <cb@256bit.org>
parents: 7177
diff changeset
19 very difficult. Older versions of Vim run on MS-Windows 95/98/Me, Amiga DOS,
388977454c14 commit https://github.com/vim/vim/commit/43f837dea588207c87c34794b19c024e9ff1db3e
Christian Brabandt <cb@256bit.org>
parents: 7177
diff changeset
20 Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
21
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
22
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
23 DISTRIBUTION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
24
7177
c4d677c50b9b commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents: 6918
diff changeset
25 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
26 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
27 if you want more features.
c4d677c50b9b commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents: 6918
diff changeset
28
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
29 There are separate distributions for Unix, PC, Amiga and some other systems.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
30 This README.txt file comes with the runtime archive. It includes the
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
31 documentation, syntax files and other files that are used at runtime. To run
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
32 Vim you must get either one of the binary archives or a source archive.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
33 Which one you need depends on the system you want to run it on and whether you
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
34 want or must compile it yourself. Check "http://www.vim.org/download.php" for
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
35 an overview of currently available distributions.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
36
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
37
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
38 DOCUMENTATION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
39
2564
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
40 The vim tutor is a one hour training course for beginners. Mostly it can be
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
41 started as "vimtutor". See ":help tutor" for more information.
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
42
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
43 The best is to use ":help" in Vim. If you don't have an executable yet, read
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
44 "runtime/doc/help.txt". It contains pointers to the other documentation
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
45 files. The User Manual reads like a book and is recommended to learn to use
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
46 Vim. See ":help user-manual".
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
47
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
48
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
49 COPYING
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
50
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
51 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
52 encouraged to make a donation to help orphans in Uganda. Please read the file
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
53 "runtime/doc/uganda.txt" for details (do ":help uganda" inside Vim).
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
54
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
55 Summary of the license: There are no restrictions on using or distributing an
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
56 unmodified copy of Vim. Parts of Vim may also be distributed, but the license
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
57 text must always be included. For modified versions a few restrictions apply.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
58 The license is GPL compatible, you may compile Vim with GPL libraries and
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
59 distribute it.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
60
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
61
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
62 SPONSORING
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
63
826
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
64 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
65 your appreciation for the work and motivate Bram and others to continue
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
66 working on Vim please send a donation.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
67
826
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
68 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
69 in Uganda. See runtime/doc/uganda.txt. But at the same time donations
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
70 increase Bram's motivation to keep working on Vim!
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
71
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
72 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
73
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
74 http://www.vim.org/sponsor/
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
75
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
76
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
77 COMPILING
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
78
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
79 If you obtained a binary distribution you don't need to compile Vim. If you
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
80 obtained a source distribution, all the stuff for compiling Vim is in the
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
81 "src" directory. See src/INSTALL for instructions.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
82
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
83
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
84 INSTALLATION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
85
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
86 See one of these files for system-specific instructions:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
87 README_ami.txt Amiga
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
88 README_unix.txt Unix
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
89 README_dos.txt MS-DOS and MS-Windows
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
90 README_mac.txt Macintosh
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
91 README_vms.txt VMS
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
92
2564
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
93 There are more README_*.txt files, depending on the distribution you used.
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
94
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
95
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
96 INFORMATION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
97
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
98 The latest news about Vim can be found on the Vim home page:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
99 http://www.vim.org/
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
100
6918
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6741
diff changeset
101 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
102 http://www.vim.org/docs.php
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6741
diff changeset
103 http://vim.wikia.com/wiki/Vim_Tips_Wiki
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
104
3941
5049eacbff0e updated for version 7.3.726
Bram Moolenaar <bram@vim.org>
parents: 3935
diff changeset
105 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
106 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
107 http://www.vim.org/maillist.php
ee138f29259e updated for version 7.3.723
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
108
ee138f29259e updated for version 7.3.723
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
109 If nothing else works, report bugs directly:
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
110 Bram Moolenaar <Bram@vim.org>
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
111
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
112
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
113 MAIN AUTHOR
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
114
2502
e6420d275b6a Update README files. Remove references to extra and lang archives.
Bram Moolenaar <bram@vim.org>
parents: 2490
diff changeset
115 Send any other comments, patches, flowers and suggestions to:
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
116
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
117 Bram Moolenaar E-mail: Bram@vim.org