Mercurial > vim

comparison README.txt @ 0:770908d1cb47

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author vimboss
date Sun, 13 Jun 2004 12:29:53 +0000
parents
children 6beb2c667935
comparison
equal deleted inserted replaced
-1:000000000000 0:770908d1cb47
1 README.txt for version 7.0aa of Vim: Vi IMproved.
2
3
4 WHAT IS VIM
5
6 Vim is an almost compatible version of the UNIX editor Vi. Many new features
7 have been added: multi-level undo, syntax highlighting, command line history,
8 on-line help, filename completion, block operations, etc. There is also a
9 Graphical User Interface (GUI) available. See "runtime/doc/vi_diff.txt" for
10 differences with Vi.
11
12 This editor is very useful for editing programs and other plain ASCII files.
13 All commands are given with normal keyboard characters, so those who can type
14 with ten fingers can work very fast. Additionally, function keys can be
15 defined by the user, and the mouse can be used.
16
17 Vim currently runs under Amiga DOS, MS-DOS, MS-Windows 95/98/Me/NT/2000/XP,
18 Atari MiNT, Macintosh, BeOS, VMS, RISC OS, OS/2 and almost all flavours of
19 UNIX. Porting to other systems should not be very difficult.
20
21
22 DISTRIBUTION
23
24 There are separate distributions for Unix, PC, Amiga and some other systems.
25 This README.txt file comes with the runtime archive. It includes the
26 documentation, syntax files and other files that are used at runtime. To run
27 Vim you must get either one of the binary archives or a source archive.
28 Which one you need depends on the system you want to run it on and whether you
29 want or must compile it yourself. Check "http://www.vim.org/download.php" for
30 an overview of currently available distributions.
31
32
33 DOCUMENTATION
34
35 The 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
37 files. The User Manual reads like a book and is recommended to learn to use
38 Vim. See ":help user-manual".
39
40 The vim tutor is a one hour training course for beginners. Mostly it can be
41 started as "vimtutor". See ":help tutor" for more information.
42
43
44 COPYING
45
46 Vim is Charityware. You can use and copy it as much as you like, but you are
47 encouraged 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
50 Summary of the license: There are no restrictions on using or distributing an
51 unmodified copy of Vim. Parts of Vim may also be distributed, but the license
52 text must always be included. For modified versions a few restrictions apply.
53 The license is GPL compatible, you may compile Vim with GPL libraries and
54 distribute it.
55
56
57 SPONSORING
58
59 Fixing bugs and adding new features takes a lot of effort. For a few years
60 Bram has attempted to do this next to a full-time job. During that time the
61 todo list kept getting longer and longer.
62
63 In order for Bram to support Vim properly he needs your help. Through your
64 donations Bram will be able to have a part-time job and spend more time on
65 fixing bugs and adding new features.
66
67 For the most recent information about sponsoring look on the Vim web site:
68 http://www.vim.org/sponsor/
69
70
71 COMPILING
72
73 If you obtained a binary distribution you don't need to compile Vim. If you
74 obtained a source distribution, all the stuff for compiling Vim is in the
75 "src" directory. See src/INSTALL for instructions.
76
77
78 INSTALLATION
79
80 See one of these files for system-specific instructions:
81 README_ami.txt Amiga
82 README_unix.txt Unix
83 README_dos.txt MS-DOS and MS-Windows
84 README_os2.txt OS/2
85 README_mac.txt Macintosh
86 README_vms.txt VMS
87
88
89 INFORMATION
90
91 The latest news about Vim can be found on the Vim home page:
92 http://www.vim.org/
93
94 If you have problems, have a look at the Vim FAQ:
95 http://vimdoc.sf.net/vimfaq.html
96
97 Send bug reports to:
98 Bram Moolenaar <Bram@vim.org>
99
100 There are five mailing lists for Vim:
101 <vim@vim.org>
102 For discussions about using existing versions of Vim: Useful mappings,
103 questions, answers, where to get a specific version, etc.
104 <vim-dev@vim.org>
105 For discussions about changing Vim: New features, porting, beta-test
106 versions, etc.
107 <vim-announce@vim.org>
108 Announcements about new versions of Vim; also beta-test versions and
109 ports to different systems.
110 <vim-multibyte@vim.org>
111 For discussions about using and improving the multi-byte aspects of
112 Vim: XIM, Hangul, fontset, etc.
113 <vim-mac@vim.org>
114 For discussions about using and improving Vim on the Macintosh.
115
116 For more info and URLs of the archives see "http://www.vim.org/maillist.php".
117
118 NOTE:
119 - You can only send messages to these lists if you have subscribed!
120 - You need to send the messages from the same location as where you subscribed
121 from (to avoid spam mail).
122 - Maximum message size is 40000 characters.
123
124 If you want to join a maillist, send a message to
125 <vim-help@vim.org>
126 Make sure that your "From:" address is correct. Then the list server will
127 send you a help message.
128
129
130 MAIN AUTHOR
131
132 Send any other comments, patches, pizza and suggestions to:
133
134 Bram Moolenaar E-mail: Bram@vim.org
135 Clematisstraat 30
136 5925 BE Venlo Tel: +31 77 387 2340
137 The Netherlands Fax/voice-mail: +31 20 773 8272