Bram Moolenaar | 3577c6f | 2008-06-24 21:16:56 +0000 | [diff] [blame] | 1 | README.txt for version 7.2a of Vim: Vi IMproved. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3 | |
Bram Moolenaar | 3577c6f | 2008-06-24 21:16:56 +0000 | [diff] [blame] | 4 | WHAT IS VIM |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5 | |
Bram Moolenaar | 3577c6f | 2008-06-24 21:16:56 +0000 | [diff] [blame] | 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, spell checking, filename completion, block operations, etc. |
| 9 | There is also a Graphical User Interface (GUI) available. See |
| 10 | "runtime/doc/vi_diff.txt" for differences with Vi. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 11 | |
Bram Moolenaar | 3577c6f | 2008-06-24 21:16:56 +0000 | [diff] [blame] | 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. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 16 | |
Bram Moolenaar | 3577c6f | 2008-06-24 21:16:56 +0000 | [diff] [blame] | 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. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 20 | |
Bram Moolenaar | 3577c6f | 2008-06-24 21:16:56 +0000 | [diff] [blame] | 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 time and effort. To show |
| 60 | your appreciation for the work and motivate Bram and others to continue |
| 61 | working on Vim please send a donation. |
| 62 | |
| 63 | Since Bram is back to a paid job the money will now be used to help children |
| 64 | in Uganda. See runtime/doc/uganda.txt. But at the same time donations |
| 65 | increase Bram's motivation to keep working on Vim! |
| 66 | |
| 67 | For the most recent information about sponsoring look on the Vim web site: |
| 68 | |
| 69 | http://www.vim.org/sponsor/ |
| 70 | |
| 71 | |
| 72 | COMPILING |
| 73 | |
| 74 | If you obtained a binary distribution you don't need to compile Vim. If you |
| 75 | obtained a source distribution, all the stuff for compiling Vim is in the |
| 76 | "src" directory. See src/INSTALL for instructions. |
| 77 | |
| 78 | |
| 79 | INSTALLATION |
| 80 | |
| 81 | See one of these files for system-specific instructions: |
| 82 | README_ami.txt Amiga |
| 83 | README_unix.txt Unix |
| 84 | README_dos.txt MS-DOS and MS-Windows |
| 85 | README_os2.txt OS/2 |
| 86 | README_mac.txt Macintosh |
| 87 | README_vms.txt VMS |
| 88 | |
| 89 | |
| 90 | INFORMATION |
| 91 | |
| 92 | The latest news about Vim can be found on the Vim home page: |
| 93 | http://www.vim.org/ |
| 94 | |
| 95 | If you have problems, have a look at the Vim FAQ: |
| 96 | http://vimdoc.sf.net/vimfaq.html |
| 97 | |
| 98 | Send bug reports to: |
| 99 | Bram Moolenaar <Bram@vim.org> |
| 100 | |
| 101 | There 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 | |
| 117 | For more info and URLs of the archives see "http://www.vim.org/maillist.php". |
| 118 | |
| 119 | NOTE: |
| 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 | |
| 125 | If you want to join a maillist, send a message to |
| 126 | <vim-help@vim.org> |
| 127 | Make sure that your "From:" address is correct. Then the list server will |
| 128 | send you a help message. |
| 129 | |
| 130 | |
| 131 | MAIN AUTHOR |
| 132 | |
| 133 | Send 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 |