annotate README.txt @ 34:e170173ecb68 current-release

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