annotate README.txt @ 2577:073ff46fe397

Fold Vim 7.2 default branch back to trunk to avoid two heads. (Tony Mechelynck)
author Bram Moolenaar <bram@vim.org>
date Fri, 20 Aug 2010 11:11:57 +0200
parents ee53a39d5896 733f0dc510c3
children ee138f29259e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2572
ee53a39d5896 Last changes for the 7.3 release!
Bram Moolenaar <bram@vim.org>
parents: 2564
diff changeset
1 README.txt for version 7.3 of Vim: Vi IMproved.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
2
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
3
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
4 WHAT IS VIM
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
2564
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
17 Vim runs under Amiga DOS, MS-DOS, MS-Windows (95, 98, Me, NT, 2000, XP, Vista,
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
18 7), Atari MiNT, Macintosh, BeOS, VMS, RISC OS, OS/2 and almost all flavours of
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
19 UNIX. Porting to other systems should not be very difficult.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
20
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
21
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
22 DISTRIBUTION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
23
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
24 There are separate distributions for Unix, PC, Amiga and some other systems.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
25 This README.txt file comes with the runtime archive. It includes the
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
26 documentation, syntax files and other files that are used at runtime. To run
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
27 Vim you must get either one of the binary archives or a source archive.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
28 Which one you need depends on the system you want to run it on and whether you
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
29 want or must compile it yourself. Check "http://www.vim.org/download.php" for
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
30 an overview of currently available distributions.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
31
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
32
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
33 DOCUMENTATION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
34
2564
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
35 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
36 started as "vimtutor". See ":help tutor" for more information.
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
37
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
38 The best is to use ":help" in Vim. If you don't have an executable yet, read
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
39 "runtime/doc/help.txt". It contains pointers to the other documentation
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
40 files. The User Manual reads like a book and is recommended to learn to use
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
41 Vim. See ":help user-manual".
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
42
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
43
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
44 COPYING
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
45
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
46 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
47 encouraged to make a donation to help orphans in Uganda. Please read the file
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
48 "runtime/doc/uganda.txt" for details (do ":help uganda" inside Vim).
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
49
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
50 Summary of the license: There are no restrictions on using or distributing an
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
51 unmodified copy of Vim. Parts of Vim may also be distributed, but the license
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
52 text must always be included. For modified versions a few restrictions apply.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
53 The license is GPL compatible, you may compile Vim with GPL libraries and
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
54 distribute it.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
55
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
56
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
57 SPONSORING
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
58
826
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
59 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
60 your appreciation for the work and motivate Bram and others to continue
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
61 working on Vim please send a donation.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
62
826
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
63 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
64 in Uganda. See runtime/doc/uganda.txt. But at the same time donations
1cdd2661f34c updated for version 7.0d01
vimboss
parents: 825
diff changeset
65 increase Bram's motivation to keep working on Vim!
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
66
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
67 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
68
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
69 http://www.vim.org/sponsor/
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
70
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
71
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
72 COMPILING
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
73
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
74 If you obtained a binary distribution you don't need to compile Vim. If you
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
75 obtained a source distribution, all the stuff for compiling Vim is in the
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
76 "src" directory. See src/INSTALL for instructions.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
77
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
78
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
79 INSTALLATION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
80
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
81 See one of these files for system-specific instructions:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
82 README_ami.txt Amiga
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
83 README_unix.txt Unix
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
84 README_dos.txt MS-DOS and MS-Windows
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
85 README_os2.txt OS/2
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
86 README_mac.txt Macintosh
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
87 README_vms.txt VMS
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
88
2564
f85004953416 README and help file updates.
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
89 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
90
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
91
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
92 INFORMATION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
93
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
94 The latest news about Vim can be found on the Vim home page:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
95 http://www.vim.org/
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
96
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
97 If you have problems, have a look at the Vim FAQ:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
98 http://vimdoc.sf.net/vimfaq.html
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
99
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
100 Send bug reports to:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
101 Bram Moolenaar <Bram@vim.org>
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
102
2479
f8f81a88a047 Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2465
diff changeset
103 There are several mailing lists for Vim, see http://www.vim.org/maillist.php.
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
104
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
105
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
106 MAIN AUTHOR
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
107
2502
e6420d275b6a Update README files. Remove references to extra and lang archives.
Bram Moolenaar <bram@vim.org>
parents: 2490
diff changeset
108 Send any other comments, patches, flowers and suggestions to:
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
109
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
110 Bram Moolenaar E-mail: Bram@vim.org
1648
58cad056e608 updated for version 7.2a-00
vimboss
parents: 1244
diff changeset
111 Finsterruetihof 1
58cad056e608 updated for version 7.2a-00
vimboss
parents: 1244
diff changeset
112 8134 Adliswil
58cad056e608 updated for version 7.2a-00
vimboss
parents: 1244
diff changeset
113 Switzerland