From 470e90261e389909b9f0196a41c07818590e33dd Mon Sep 17 00:00:00 2001 From: Bram Moolenaar Date: Sat, 14 Aug 2010 17:46:20 +0200 Subject: README and help file updates. --- Makefile | 3 ++- README.txt | 18 ++++++++++-------- README_bindos.txt | 18 +++++++++--------- README_dos.txt | 32 ++++++++++++++++---------------- README_os2.txt | 22 +++++++++++----------- README_src.txt | 4 ++-- README_srcdos.txt | 2 +- runtime/doc/os_amiga.txt | 4 +++- runtime/doc/os_beos.txt | 37 ++++--------------------------------- runtime/doc/todo.txt | 12 ++++++++++-- runtime/doc/version7.txt | 23 ++++++++++++++++------- 11 files changed, 84 insertions(+), 91 deletions(-) diff --git a/Makefile b/Makefile index 8e2ef22d..199d2f5b 100644 --- a/Makefile +++ b/Makefile @@ -141,7 +141,8 @@ DOSBIN_S = dosbin_s # - Set environment for Visual C++ 2008, e.g.: # "E:\Microsoft Visual Studio 9.0\VC\bin\vcvars32.bat". Or, when using the # Visual C++ Toolkit 2003: "msvcsetup.bat" (adjust the paths when necessary). -# For Windows 98/ME the 2003 version is required. +# For Windows 98/ME the 2003 version is required, but then it won't work on +# Windows 7 and 64 bit. # - "nmake -f Make_mvc.mak" # - "rm testdir/*.out", "nmake -f Make_mvc.mak test" and check the output. # - Rename the executables to "vimw32.exe", "xxdw32.exe". diff --git a/README.txt b/README.txt index 8986bd21..17753945 100644 --- a/README.txt +++ b/README.txt @@ -9,14 +9,14 @@ on-line help, spell checking, filename completion, block operations, etc. There is also a Graphical User Interface (GUI) available. See "runtime/doc/vi_diff.txt" for differences with Vi. -This editor is very useful for editing programs and other plain ASCII files. +This editor is very useful for editing programs and other plain text files. All commands are given with normal keyboard characters, so those who can type with ten fingers can work very fast. Additionally, function keys can be defined by the user, and the mouse can be used. -Vim currently runs under Amiga DOS, MS-DOS, MS-Windows (95, 98, Me, NT, 2000, -XP, Vista, 7), Atari MiNT, Macintosh, BeOS, VMS, RISC OS, OS/2 and almost all -flavours of UNIX. Porting to other systems should not be very difficult. +Vim runs under Amiga DOS, MS-DOS, MS-Windows (95, 98, Me, NT, 2000, XP, Vista, +7), Atari MiNT, Macintosh, BeOS, VMS, RISC OS, OS/2 and almost all flavours of +UNIX. Porting to other systems should not be very difficult. DISTRIBUTION @@ -32,19 +32,19 @@ an overview of currently available distributions. DOCUMENTATION +The vim tutor is a one hour training course for beginners. Mostly it can be +started as "vimtutor". See ":help tutor" for more information. + The best is to use ":help" in Vim. If you don't have an executable yet, read "runtime/doc/help.txt". It contains pointers to the other documentation files. The User Manual reads like a book and is recommended to learn to use Vim. See ":help user-manual". -The vim tutor is a one hour training course for beginners. Mostly it can be -started as "vimtutor". See ":help tutor" for more information. - COPYING Vim is Charityware. You can use and copy it as much as you like, but you are -encouraged to make a donation to orphans in Uganda. Please read the file +encouraged to make a donation to help orphans in Uganda. Please read the file "runtime/doc/uganda.txt" for details (do ":help uganda" inside Vim). Summary of the license: There are no restrictions on using or distributing an @@ -86,6 +86,8 @@ README_os2.txt OS/2 README_mac.txt Macintosh README_vms.txt VMS +There are more README_*.txt files, depending on the distribution you used. + INFORMATION diff --git a/README_bindos.txt b/README_bindos.txt index 4b15c077..82617268 100644 --- a/README_bindos.txt +++ b/README_bindos.txt @@ -2,18 +2,18 @@ README_bindos.txt for version 7.3g of Vim: Vi IMproved. See "README.txt" for general information about Vim. See "README_dos.txt" for installation instructions for MS-DOS and MS-Windows. -These files are in the runtime archive (vim72rt.zip). +These files are in the runtime archive (vim73rt.zip). There are several binary distributions of Vim for the PC. You would normally pick only one of them, but it's also possible to install several. These ones are available (the version number may differ): - vim72d16.zip 16 bit DOS version - vim72d32.zip 32 bit DOS version - vim72w32.zip Windows 95/98/NT/etc. console version - gvim72.zip Windows 95/98/NT/etc. GUI version - gvim72ole.zip Windows 95/98/NT/etc. GUI version with OLE - gvim72_s.zip Windows 3.1 GUI version + vim73d16.zip 16 bit DOS version + vim73d32.zip 32 bit DOS version + vim73w32.zip Windows 95/98/NT/etc. console version + gvim73.zip Windows 95/98/NT/etc. GUI version + gvim73ole.zip Windows 95/98/NT/etc. GUI version with OLE + gvim73_s.zip Windows 3.1 GUI version -You MUST also get the runtime archive (vim72rt.zip). -The sources are also available (vim72src.zip). +You MUST also get the runtime archive (vim73rt.zip). +The sources are also available (vim73src.zip). diff --git a/README_dos.txt b/README_dos.txt index c4b9deea..907195fe 100644 --- a/README_dos.txt +++ b/README_dos.txt @@ -47,13 +47,13 @@ These are the normal steps to install Vim from the .zip archives: Binary and runtime Vim archives are normally unpacked in the same location, on top of each other. -2. Unpack the zip archives. This will create a new directory "vim\vim72", +2. Unpack the zip archives. This will create a new directory "vim\vim73", in which all the distributed Vim files are placed. Since the directory name includes the version number, it is unlikely that you overwrite existing files. Examples: - pkunzip -d gvim72.zip - unzip vim72w32.zip + pkunzip -d gvim73.zip + unzip vim73w32.zip You need to unpack the runtime archive and at least one of the binary archives. When using more than one binary version, be careful not to @@ -69,7 +69,7 @@ These are the normal steps to install Vim from the .zip archives: archive and follow the instructions in the documentation. 3. Change to the new directory: - cd vim\vim72 + cd vim\vim73 Run the "install.exe" program. It will ask you a number of questions about how you would like to have your Vim setup. Among these are: - You can tell it to write a "_vimrc" file with your preferences in the @@ -80,8 +80,8 @@ These are the normal steps to install Vim from the .zip archives: console or in a shell. You can select one of the directories in your $PATH. If you skip this, you can add Vim to the search path manually: The simplest is to add a line to your autoexec.bat. Examples: - set path=%path%;C:\vim\vim72 - set path=%path%;D:\editors\vim\vim72 + set path=%path%;C:\vim\vim73 + set path=%path%;D:\editors\vim\vim73 - Create entries for Vim on the desktop and in the Start menu. That's it! @@ -93,8 +93,8 @@ Remarks: won't show a menubar. Then you need to set the $VIM environment variable to point to the top directory of your Vim files. Example: set VIM=C:\editors\vim - Vim version 7.2 will look for your vimrc file in $VIM, and for the runtime - files in $VIM/vim72. See ":help $VIM" for more information. + Vim version 7.3 will look for your vimrc file in $VIM, and for the runtime + files in $VIM/vim73. See ":help $VIM" for more information. - To avoid confusion between distributed files of different versions and your own modified vim scripts, it is recommended to use this directory layout: @@ -105,14 +105,14 @@ Remarks: C:\vim\vimfiles\ftplugin\*.vim Filetype plugins C:\vim\... Other files you made. Distributed files: - C:\vim\vim72\vim.exe The Vim version 7.2 executable. - C:\vim\vim72\doc\*.txt The version 7.2 documentation files. - C:\vim\vim72\bugreport.vim A Vim version 7.2 script. - C:\vim\vim72\... Other version 7.2 distributed files. + C:\vim\vim73\vim.exe The Vim version 7.3 executable. + C:\vim\vim73\doc\*.txt The version 7.3 documentation files. + C:\vim\vim73\bugreport.vim A Vim version 7.3 script. + C:\vim\vim73\... Other version 7.3 distributed files. In this case the $VIM environment variable would be set like this: set VIM=C:\vim - Then $VIMRUNTIME will automatically be set to "$VIM\vim72". Don't add - "vim72" to $VIM, that won't work. + Then $VIMRUNTIME will automatically be set to "$VIM\vim73". Don't add + "vim73" to $VIM, that won't work. - You can put your Vim executable anywhere else. If the executable is not with the other Vim files, you should set $VIM. The simplest is to add a line @@ -136,8 +136,8 @@ Remarks: Select Properties. 5. In the Program tab, change the "Cmdline" to add "/c" and the name of the Vim executable. Examples: - C:\command.com /c C:\vim\vim72\vim.exe - C:\command.com /c D:\editors\vim\vim72\vim.exe + C:\command.com /c C:\vim\vim73\vim.exe + C:\command.com /c D:\editors\vim\vim73\vim.exe 6. Select the font, window size, etc. that you like. If this isn't possible, select "Advanced" in the Program tab, and deselect "MS-DOS mode". diff --git a/README_os2.txt b/README_os2.txt index 1bc5b876..665ca858 100644 --- a/README_os2.txt +++ b/README_os2.txt @@ -5,28 +5,28 @@ See "README.txt" for general information about Vim. NOTE: You will need two archives: - vim72rt.zip contains the runtime files (same as for the PC version) - vim72os2.zip contains the OS/2 executables + vim73rt.zip contains the runtime files (same as for the PC version) + vim73os2.zip contains the OS/2 executables 1. Go to the directory where you want to put the Vim files. Examples: cd C:\ cd D:\editors -2. Unpack the zip archives. This will create a new directory "vim/vim72", +2. Unpack the zip archives. This will create a new directory "vim/vim73", in which all the distributed Vim files are placed. Since the directory name includes the version number, it is unlikely that you overwrite existing files. Examples: - pkunzip -d vim72os2.zip - unzip vim72os2.zip + pkunzip -d vim73os2.zip + unzip vim73os2.zip After you unpacked the files, you can still move the whole directory tree to another location. 3. Add the directory where vim.exe is to your path. The simplest is to add a line to your autoexec.bat. Examples: - set path=%path%;C:\vim\vim72 - set path=%path%;D:\editors\vim\vim72 + set path=%path%;C:\vim\vim73 + set path=%path%;D:\editors\vim\vim73 That's it! @@ -41,10 +41,10 @@ Extra remarks: C:\vim\_viminfo Dynamic info for 'viminfo'. C:\vim\... Other files you made. Distributed files: - C:\vim\vim72\vim.exe The Vim version 7.2 executable. - C:\vim\vim72\doc\*.txt The version 7.2 documentation files. - C:\vim\vim72\bugreport.vim A Vim version 7.2 script. - C:\vim\vim72\... Other version 7.2 distributed files. + C:\vim\vim73\vim.exe The Vim version 7.3 executable. + C:\vim\vim73\doc\*.txt The version 7.3 documentation files. + C:\vim\vim73\bugreport.vim A Vim version 7.3 script. + C:\vim\vim73\... Other version 7.3 distributed files. In this case the $VIM environment variable would be set like this: set VIM=C:\vim diff --git a/README_src.txt b/README_src.txt index 8ff2f06c..94d5ff99 100644 --- a/README_src.txt +++ b/README_src.txt @@ -2,9 +2,9 @@ README_src.txt for version 7.3g of Vim: Vi IMproved. The source archive contains the files needed to compile Vim on Unix systems. It is packed for Unix systems (NL line separator). It is also used for other -systems in combination with the extra archive (vim-7.2-extra.tar.gz, in the +systems in combination with the extra archive (vim-7.3-extra.tar.gz, in the "extra" directory of ftp.vim.org). For more information, see the README.txt file that comes with the runtime -archive (vim-7.2-rt.tar.gz). To be able to run Vim you MUST get the runtime +archive (vim-7.3-rt.tar.gz). To be able to run Vim you MUST get the runtime archive too! diff --git a/README_srcdos.txt b/README_srcdos.txt index 6f883797..9e68f88f 100644 --- a/README_srcdos.txt +++ b/README_srcdos.txt @@ -2,7 +2,7 @@ README_srcdos.txt for version 7.3g of Vim: Vi IMproved. See "README.txt" for general information about Vim. See "README_dos.txt" for installation instructions for MS-DOS and MS-Windows. -These files are in the runtime archive (vim72rt.zip). +These files are in the runtime archive (vim73rt.zip). The DOS source archive contains the files needed to compile Vim on MS-DOS or diff --git a/runtime/doc/os_amiga.txt b/runtime/doc/os_amiga.txt index de395e3a..62c13520 100644 --- a/runtime/doc/os_amiga.txt +++ b/runtime/doc/os_amiga.txt @@ -1,4 +1,4 @@ -*os_amiga.txt* For Vim version 7.3g. Last change: 2005 Mar 29 +*os_amiga.txt* For Vim version 7.3g. Last change: 2010 Aug 14 VIM REFERENCE MANUAL by Bram Moolenaar @@ -8,6 +8,8 @@ This file contains the particularities for the Amiga version of Vim. There is also a section specifically for |MorphOS| below. +NOTE: The Amiga code is still included, but has not been maintained or tested. + Installation on the Amiga: - Assign "VIM:" to the directory where the Vim "doc" directory is. Vim will look for the file "VIM:doc/help.txt" (for the help command). diff --git a/runtime/doc/os_beos.txt b/runtime/doc/os_beos.txt index 823938a3..a88183b6 100644 --- a/runtime/doc/os_beos.txt +++ b/runtime/doc/os_beos.txt @@ -1,4 +1,4 @@ -*os_beos.txt* For Vim version 7.3g. Last change: 2005 Mar 29 +*os_beos.txt* For Vim version 7.3g. Last change: 2010 Aug 14 VIM REFERENCE MANUAL by Bram Moolenaar @@ -131,38 +131,9 @@ You may also use the /boot/bin/xtou command to convert UTF-8 files from (xtou 5. The BeOS GUI *beos-gui* -Normally Vim starts with the GUI if you start it as gvim or vim -g. The BeOS -version tries to determine if it was started from the Tracker instead of the -Terminal, and if so, use the GUI anyway. However, the current detection scheme -is fooled if you use the command "vim -