blob: 6eece41973c3fe10ab99ba73485a871ed5e6b976 [file] [log] [blame]
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001README.txt for version 7.2a of Vim: Vi IMproved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
Bram Moolenaar071d4272004-06-13 20:20:40 +00003
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00004WHAT IS VIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00005
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00006Vim is an almost compatible version of the UNIX editor Vi. Many new features
7have been added: multi-level undo, syntax highlighting, command line history,
8on-line help, spell checking, filename completion, block operations, etc.
9There is also a Graphical User Interface (GUI) available. See
10"runtime/doc/vi_diff.txt" for differences with Vi.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000012This editor is very useful for editing programs and other plain ASCII files.
13All commands are given with normal keyboard characters, so those who can type
14with ten fingers can work very fast. Additionally, function keys can be
15defined by the user, and the mouse can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +000016
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000017Vim currently runs under Amiga DOS, MS-DOS, MS-Windows 95/98/Me/NT/2000/XP,
18Atari MiNT, Macintosh, BeOS, VMS, RISC OS, OS/2 and almost all flavours of
19UNIX. Porting to other systems should not be very difficult.
Bram Moolenaar071d4272004-06-13 20:20:40 +000020
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000021
22DISTRIBUTION
23
24There are separate distributions for Unix, PC, Amiga and some other systems.
25This README.txt file comes with the runtime archive. It includes the
26documentation, syntax files and other files that are used at runtime. To run
27Vim you must get either one of the binary archives or a source archive.
28Which one you need depends on the system you want to run it on and whether you
29want or must compile it yourself. Check "http://www.vim.org/download.php" for
30an overview of currently available distributions.
31
32
33DOCUMENTATION
34
35The best is to use ":help" in Vim. If you don't have an executable yet, read
36"runtime/doc/help.txt". It contains pointers to the other documentation
37files. The User Manual reads like a book and is recommended to learn to use
38Vim. See ":help user-manual".
39
40The vim tutor is a one hour training course for beginners. Mostly it can be
41started as "vimtutor". See ":help tutor" for more information.
42
43
44COPYING
45
46Vim is Charityware. You can use and copy it as much as you like, but you are
47encouraged to make a donation to orphans in Uganda. Please read the file
48"runtime/doc/uganda.txt" for details (do ":help uganda" inside Vim).
49
50Summary of the license: There are no restrictions on using or distributing an
51unmodified copy of Vim. Parts of Vim may also be distributed, but the license
52text must always be included. For modified versions a few restrictions apply.
53The license is GPL compatible, you may compile Vim with GPL libraries and
54distribute it.
55
56
57SPONSORING
58
59Fixing bugs and adding new features takes a lot of time and effort. To show
60your appreciation for the work and motivate Bram and others to continue
61working on Vim please send a donation.
62
63Since Bram is back to a paid job the money will now be used to help children
64in Uganda. See runtime/doc/uganda.txt. But at the same time donations
65increase Bram's motivation to keep working on Vim!
66
67For the most recent information about sponsoring look on the Vim web site:
68
69 http://www.vim.org/sponsor/
70
71
72COMPILING
73
74If you obtained a binary distribution you don't need to compile Vim. If you
75obtained a source distribution, all the stuff for compiling Vim is in the
76"src" directory. See src/INSTALL for instructions.
77
78
79INSTALLATION
80
81See one of these files for system-specific instructions:
82README_ami.txt Amiga
83README_unix.txt Unix
84README_dos.txt MS-DOS and MS-Windows
85README_os2.txt OS/2
86README_mac.txt Macintosh
87README_vms.txt VMS
88
89
90INFORMATION
91
92The latest news about Vim can be found on the Vim home page:
93 http://www.vim.org/
94
95If you have problems, have a look at the Vim FAQ:
96 http://vimdoc.sf.net/vimfaq.html
97
98Send bug reports to:
99 Bram Moolenaar <Bram@vim.org>
100
101There are five mailing lists for Vim:
102<vim@vim.org>
103 For discussions about using existing versions of Vim: Useful mappings,
104 questions, answers, where to get a specific version, etc.
105<vim-dev@vim.org>
106 For discussions about changing Vim: New features, porting, beta-test
107 versions, etc.
108<vim-announce@vim.org>
109 Announcements about new versions of Vim; also beta-test versions and
110 ports to different systems.
111<vim-multibyte@vim.org>
112 For discussions about using and improving the multi-byte aspects of
113 Vim: XIM, Hangul, fontset, etc.
114<vim-mac@vim.org>
115 For discussions about using and improving Vim on the Macintosh.
116
117For more info and URLs of the archives see "http://www.vim.org/maillist.php".
118
119NOTE:
120- You can only send messages to these lists if you have subscribed!
121- You need to send the messages from the same location as where you subscribed
122 from (to avoid spam mail).
123- Maximum message size is 40000 characters.
124
125If you want to join a maillist, send a message to
126 <vim-help@vim.org>
127Make sure that your "From:" address is correct. Then the list server will
128send you a help message.
129
130
131MAIN AUTHOR
132
133Send any other comments, patches, pizza and suggestions to:
134
135 Bram Moolenaar E-mail: Bram@vim.org
136 Finsterruetihof 1
137 8134 Adliswil
138 Switzerland