annotate README.txt @ 0:770908d1cb47

Initial revision
author vimboss
date Sun, 13 Jun 2004 12:29:53 +0000
parents
children 6beb2c667935
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
1 README.txt for version 7.0aa of Vim: Vi IMproved.
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,
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
8 on-line help, filename completion, block operations, etc. There is also a
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
9 Graphical User Interface (GUI) available. See "runtime/doc/vi_diff.txt" for
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
10 differences with Vi.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
11
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
12 This editor is very useful for editing programs and other plain ASCII files.
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
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
17 Vim currently runs under Amiga DOS, MS-DOS, MS-Windows 95/98/Me/NT/2000/XP,
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
18 Atari MiNT, Macintosh, BeOS, VMS, RISC OS, OS/2 and almost all flavours of
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
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
35 The best is to use ":help" in Vim. If you don't have an executable yet, read
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
36 "runtime/doc/help.txt". It contains pointers to the other documentation
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
37 files. The User Manual reads like a book and is recommended to learn to use
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
38 Vim. See ":help user-manual".
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
39
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
40 The vim tutor is a one hour training course for beginners. Mostly it can be
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
41 started as "vimtutor". See ":help tutor" for more information.
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
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
47 encouraged to make a donation to orphans in Uganda. Please read the file
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
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
59 Fixing bugs and adding new features takes a lot of effort. For a few years
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
60 Bram has attempted to do this next to a full-time job. During that time the
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
61 todo list kept getting longer and longer.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
62
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
63 In order for Bram to support Vim properly he needs your help. Through your
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
64 donations Bram will be able to have a part-time job and spend more time on
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
65 fixing bugs and adding new features.
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:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
68 http://www.vim.org/sponsor/
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
69
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
70
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
71 COMPILING
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
72
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
73 If you obtained a binary distribution you don't need to compile Vim. If you
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
74 obtained a source distribution, all the stuff for compiling Vim is in the
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
75 "src" directory. See src/INSTALL for instructions.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
76
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
77
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
78 INSTALLATION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
79
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
80 See one of these files for system-specific instructions:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
81 README_ami.txt Amiga
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
82 README_unix.txt Unix
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
83 README_dos.txt MS-DOS and MS-Windows
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
84 README_os2.txt OS/2
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
85 README_mac.txt Macintosh
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
86 README_vms.txt VMS
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
87
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
88
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
89 INFORMATION
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
90
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
91 The latest news about Vim can be found on the Vim home page:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
92 http://www.vim.org/
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
93
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
94 If you have problems, have a look at the Vim FAQ:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
95 http://vimdoc.sf.net/vimfaq.html
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
96
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
97 Send bug reports to:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
98 Bram Moolenaar <Bram@vim.org>
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
99
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
100 There are five mailing lists for Vim:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
101 <vim@vim.org>
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
102 For discussions about using existing versions of Vim: Useful mappings,
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
103 questions, answers, where to get a specific version, etc.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
104 <vim-dev@vim.org>
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
105 For discussions about changing Vim: New features, porting, beta-test
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
106 versions, etc.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
107 <vim-announce@vim.org>
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
108 Announcements about new versions of Vim; also beta-test versions and
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
109 ports to different systems.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
110 <vim-multibyte@vim.org>
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
111 For discussions about using and improving the multi-byte aspects of
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
112 Vim: XIM, Hangul, fontset, etc.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
113 <vim-mac@vim.org>
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
114 For discussions about using and improving Vim on the Macintosh.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
115
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
116 For more info and URLs of the archives see "http://www.vim.org/maillist.php".
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
117
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
118 NOTE:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
119 - You can only send messages to these lists if you have subscribed!
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
120 - You need to send the messages from the same location as where you subscribed
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
121 from (to avoid spam mail).
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
122 - Maximum message size is 40000 characters.
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
123
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
124 If you want to join a maillist, send a message to
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
125 <vim-help@vim.org>
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
126 Make sure that your "From:" address is correct. Then the list server will
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
127 send you a help message.
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
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
132 Send any other comments, patches, pizza and suggestions to:
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
133
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
134 Bram Moolenaar E-mail: Bram@vim.org
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
135 Clematisstraat 30
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
136 5925 BE Venlo Tel: +31 77 387 2340
770908d1cb47 Initial revision
vimboss
parents:
diff changeset
137 The Netherlands Fax/voice-mail: +31 20 773 8272