GitHub/vim
1
0
Fork 0
mirror of https://github.com/vim/vim synced 2025-07-16 09:12:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

README and help file updates.

Browse Source
This commit is contained in:
Bram Moolenaar
2010-08-14 17:46:20 +02:00
parent bb3d5dc320
commit 755bd26c59
11 changed files with 84 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Makefile
View File

@ -141,7 +141,8 @@ DOSBIN_S = dosbin_s
# - Set environment for Visual C++ 2008, e.g.: # - Set environment for Visual C++ 2008, e.g.:
# "E:\Microsoft Visual Studio 9.0\VC\bin\vcvars32.bat". Or, when using the # "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). # 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" # - "nmake -f Make_mvc.mak"
# - "rm testdir/*.out", "nmake -f Make_mvc.mak test" and check the output. # - "rm testdir/*.out", "nmake -f Make_mvc.mak test" and check the output.
# - Rename the executables to "vimw32.exe", "xxdw32.exe". # - Rename the executables to "vimw32.exe", "xxdw32.exe".

18
README.txt
View File

@ -9,14 +9,14 @@ on-line help, spell checking, filename completion, block operations, etc.
There is also a Graphical User Interface (GUI) available. See There is also a Graphical User Interface (GUI) available. See
"runtime/doc/vi_diff.txt" for differences with Vi. "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 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 with ten fingers can work very fast. Additionally, function keys can be
defined by the user, and the mouse can be used. 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, Vim runs under Amiga DOS, MS-DOS, MS-Windows (95, 98, Me, NT, 2000, XP, Vista,
XP, Vista, 7), Atari MiNT, Macintosh, BeOS, VMS, RISC OS, OS/2 and almost all 7), Atari MiNT, Macintosh, BeOS, VMS, RISC OS, OS/2 and almost all flavours of
flavours of UNIX. Porting to other systems should not be very difficult. UNIX. Porting to other systems should not be very difficult.
DISTRIBUTION DISTRIBUTION
@ -32,19 +32,19 @@ an overview of currently available distributions.
DOCUMENTATION 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 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 "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 files. The User Manual reads like a book and is recommended to learn to use
Vim. See ":help user-manual". 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 COPYING
Vim is Charityware. You can use and copy it as much as you like, but you are 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). "runtime/doc/uganda.txt" for details (do ":help uganda" inside Vim).
Summary of the license: There are no restrictions on using or distributing an 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_mac.txt Macintosh
README_vms.txt VMS README_vms.txt VMS
There are more README_*.txt files, depending on the distribution you used.
INFORMATION INFORMATION

18
README_bindos.txt
View File

@ -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.txt" for general information about Vim.
See "README_dos.txt" for installation instructions for MS-DOS and MS-Windows. 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 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. pick only one of them, but it's also possible to install several.
These ones are available (the version number may differ): These ones are available (the version number may differ):
vim72d16.zip 16 bit DOS version vim73d16.zip 16 bit DOS version
vim72d32.zip 32 bit DOS version vim73d32.zip 32 bit DOS version
vim72w32.zip Windows 95/98/NT/etc. console version vim73w32.zip Windows 95/98/NT/etc. console version
gvim72.zip Windows 95/98/NT/etc. GUI version gvim73.zip Windows 95/98/NT/etc. GUI version
gvim72ole.zip Windows 95/98/NT/etc. GUI version with OLE gvim73ole.zip Windows 95/98/NT/etc. GUI version with OLE
gvim72_s.zip Windows 3.1 GUI version gvim73_s.zip Windows 3.1 GUI version
You MUST also get the runtime archive (vim72rt.zip). You MUST also get the runtime archive (vim73rt.zip).
The sources are also available (vim72src.zip). The sources are also available (vim73src.zip).

32
README_dos.txt
View File

@ -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, Binary and runtime Vim archives are normally unpacked in the same location,
on top of each other. 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 in which all the distributed Vim files are placed. Since the directory
name includes the version number, it is unlikely that you overwrite name includes the version number, it is unlikely that you overwrite
existing files. existing files.
Examples: Examples:
pkunzip -d gvim72.zip pkunzip -d gvim73.zip
unzip vim72w32.zip unzip vim73w32.zip
You need to unpack the runtime archive and at least one of the binary 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 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. archive and follow the instructions in the documentation.
3. Change to the new directory: 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 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: 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 - 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 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: $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: The simplest is to add a line to your autoexec.bat. Examples:
set path=%path%;C:\vim\vim72 set path=%path%;C:\vim\vim73
set path=%path%;D:\editors\vim\vim72 set path=%path%;D:\editors\vim\vim73
- Create entries for Vim on the desktop and in the Start menu. - Create entries for Vim on the desktop and in the Start menu.
That's it! That's it!
@ -93,8 +93,8 @@ Remarks:
won't show a menubar. Then you need to set the $VIM environment variable to 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: point to the top directory of your Vim files. Example:
set VIM=C:\editors\vim set VIM=C:\editors\vim
Vim version 7.2 will look for your vimrc file in $VIM, and for the runtime Vim version 7.3 will look for your vimrc file in $VIM, and for the runtime
files in $VIM/vim72. See ":help $VIM" for more information. files in $VIM/vim73. See ":help $VIM" for more information.
- To avoid confusion between distributed files of different versions and your - To avoid confusion between distributed files of different versions and your
own modified vim scripts, it is recommended to use this directory layout: 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\vimfiles\ftplugin\*.vim Filetype plugins
C:\vim\... Other files you made. C:\vim\... Other files you made.
Distributed files: Distributed files:
C:\vim\vim72\vim.exe The Vim version 7.2 executable. C:\vim\vim73\vim.exe The Vim version 7.3 executable.
C:\vim\vim72\doc\*.txt The version 7.2 documentation files. C:\vim\vim73\doc\*.txt The version 7.3 documentation files.
C:\vim\vim72\bugreport.vim A Vim version 7.2 script. C:\vim\vim73\bugreport.vim A Vim version 7.3 script.
C:\vim\vim72\... Other version 7.2 distributed files. C:\vim\vim73\... Other version 7.3 distributed files.
In this case the $VIM environment variable would be set like this: In this case the $VIM environment variable would be set like this:
set VIM=C:\vim set VIM=C:\vim
Then $VIMRUNTIME will automatically be set to "$VIM\vim72". Don't add Then $VIMRUNTIME will automatically be set to "$VIM\vim73". Don't add
"vim72" to $VIM, that won't work. "vim73" to $VIM, that won't work.
- You can put your Vim executable anywhere else. If the executable is not - 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 with the other Vim files, you should set $VIM. The simplest is to add a line
@ -136,8 +136,8 @@ Remarks:
Select Properties. Select Properties.
5. In the Program tab, change the "Cmdline" to add "/c" and the name of the 5. In the Program tab, change the "Cmdline" to add "/c" and the name of the
Vim executable. Examples: Vim executable. Examples:
C:\command.com /c C:\vim\vim72\vim.exe C:\command.com /c C:\vim\vim73\vim.exe
C:\command.com /c D:\editors\vim\vim72\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 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 possible, select "Advanced" in the Program tab, and deselect "MS-DOS
mode". mode".

22
README_os2.txt
View File

@ -5,28 +5,28 @@ See "README.txt" for general information about Vim.
NOTE: You will need two archives: NOTE: You will need two archives:
vim72rt.zip contains the runtime files (same as for the PC version) vim73rt.zip contains the runtime files (same as for the PC version)
vim72os2.zip contains the OS/2 executables vim73os2.zip contains the OS/2 executables
1. Go to the directory where you want to put the Vim files. Examples: 1. Go to the directory where you want to put the Vim files. Examples:
cd C:\ cd C:\
cd D:\editors 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 in which all the distributed Vim files are placed. Since the directory
name includes the version number, it is unlikely that you overwrite name includes the version number, it is unlikely that you overwrite
existing files. existing files.
Examples: Examples:
pkunzip -d vim72os2.zip pkunzip -d vim73os2.zip
unzip vim72os2.zip unzip vim73os2.zip
After you unpacked the files, you can still move the whole directory tree After you unpacked the files, you can still move the whole directory tree
to another location. to another location.
3. Add the directory where vim.exe is to your path. The simplest is to add a 3. Add the directory where vim.exe is to your path. The simplest is to add a
line to your autoexec.bat. Examples: line to your autoexec.bat. Examples:
set path=%path%;C:\vim\vim72 set path=%path%;C:\vim\vim73
set path=%path%;D:\editors\vim\vim72 set path=%path%;D:\editors\vim\vim73
That's it! That's it!
@ -41,10 +41,10 @@ Extra remarks:
C:\vim\_viminfo Dynamic info for 'viminfo'. C:\vim\_viminfo Dynamic info for 'viminfo'.
C:\vim\... Other files you made. C:\vim\... Other files you made.
Distributed files: Distributed files:
C:\vim\vim72\vim.exe The Vim version 7.2 executable. C:\vim\vim73\vim.exe The Vim version 7.3 executable.
C:\vim\vim72\doc\*.txt The version 7.2 documentation files. C:\vim\vim73\doc\*.txt The version 7.3 documentation files.
C:\vim\vim72\bugreport.vim A Vim version 7.2 script. C:\vim\vim73\bugreport.vim A Vim version 7.3 script.
C:\vim\vim72\... Other version 7.2 distributed files. C:\vim\vim73\... Other version 7.3 distributed files.
In this case the $VIM environment variable would be set like this: In this case the $VIM environment variable would be set like this:
set VIM=C:\vim set VIM=C:\vim

4
README_src.txt
View File

@ -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. 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 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). "extra" directory of ftp.vim.org).
For more information, see the README.txt file that comes with the runtime 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! archive too!

2
README_srcdos.txt
View File

@ -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.txt" for general information about Vim.
See "README_dos.txt" for installation instructions for MS-DOS and MS-Windows. 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 The DOS source archive contains the files needed to compile Vim on MS-DOS or

4
runtime/doc/os_amiga.txt
View File

@ -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 VIM REFERENCE MANUAL by Bram Moolenaar
@ -8,6 +8,8 @@
This file contains the particularities for the Amiga version of Vim. This file contains the particularities for the Amiga version of Vim.
There is also a section specifically for |MorphOS| below. 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: Installation on the Amiga:
- Assign "VIM:" to the directory where the Vim "doc" directory is. Vim will - 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). look for the file "VIM:doc/help.txt" (for the help command).

37
runtime/doc/os_beos.txt
View File

@ -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 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* 5. The BeOS GUI *beos-gui*
Normally Vim starts with the GUI if you start it as gvim or vim -g. The BeOS The BeOS GUI is no longer included. It was not maintained for a while and
version tries to determine if it was started from the Tracker instead of the most likely didn't work. If you want to work on this: get the Vim 6.x version
Terminal, and if so, use the GUI anyway. However, the current detection scheme and merge it back in.
is fooled if you use the command "vim - </dev/null" or "vim filename &". The
latter can be called a feature but probably only works because there is no
BSD-style job control.
Stuff that does not work yet:
- Running external commands from the GUI does not work 100% (again due to lack
of support for select()). There was a choice between seeing the command's
output, or being able to interrupt it. I chose for seeing the output. Even
now the command sometimes crashes mysteriously, apparently in Be's
malloc_internal() called from the putenv() function, after fork()ing. (data
access exception occurred, ec01b0ec: 90e80000 *stw r7, 0x0000 (r8)). (:!ls
works usually, :r !ls usually doesn't). This has been reported as bug
# 971215-083826.
- The window title.
- Starting the GUI from the Terminal version with :gui always acts as if
:gui -f were used. There is no way to fix this that I can see.
- There are some small display glitches here and there that I hope to clean up
later. Most of them occur when the window is partially obscured. Some of
them seem to be bugs in BeOS, because the Terminal has similar glitches.
- Mouse up events are not generated when outside the window. This is a bug in
BeOS. You can notice this when selecting text and moving the cursor outside
the window, then letting go of the mouse button. Another way is when you
drag the scrollbar and do the same thing. Because Vim still thinks you are
still playing with the scrollbar it won't change it itself. I provided a
workaround which kicks in when the window is activated or deactivated (so it
works best with focus- follows-mouse (/boot/bin/ffm) turned on).
- The cursor does not flash (very low priority; I'm not sure I even like it
when it flashes)
6. The $VIM directory *beos-vimdir* 6. The $VIM directory *beos-vimdir*

12
runtime/doc/todo.txt
View File

@ -35,6 +35,10 @@ Before release 7.3:
Problem with \NL in Ex script. (Ray Frish, 2010 Aug 10) Problem with \NL in Ex script. (Ray Frish, 2010 Aug 10)
Using longest completion (with "longest" in 'wildmode' or using CTRL-L) after
:find will not work, because of shortening the results. Don't shorten when
looking for the longest common part of the matches.
Bug: E685 error for func_unref(). (ZyX, 2010 Aug 5) Bug: E685 error for func_unref(). (ZyX, 2010 Aug 5)
CTRL-] on help tag |/[\n]| doesn't jump to the right place. (Tony Mechelynck, CTRL-] on help tag |/[\n]| doesn't jump to the right place. (Tony Mechelynck,
@ -52,7 +56,7 @@ Editing a file with a ^M with 'ff' set to "mac", opening a help file, then the
Problem producing tags file when hebrew.frx is present. It has a BOM. Problem producing tags file when hebrew.frx is present. It has a BOM.
Results in E670. (Tony Mechelynck, 2010 May 2) Results in E670. (Tony Mechelynck, 2010 May 2)
setpos() does not resture cursor position after :normal. (Tyru, 2010 Aug 11) setpos() does not restore cursor position after :normal. (Tyru, 2010 Aug 11)
Test 73 fails on MS-Windows when compiled with DJGPP and run twice. How to Test 73 fails on MS-Windows when compiled with DJGPP and run twice. How to
delete the Xfind directory? Add an rmdir() function, just like we have delete the Xfind directory? Add an rmdir() function, just like we have
@ -113,7 +117,11 @@ path.
like it has ":keepjumps" before it. like it has ":keepjumps" before it.
Coverity: ask someone to create new user: Dominique. Coverity: ask someone to create new user: Dominique.
look into reported defects: http://scan.coverity.com/rung2.html Check if there are new reported defects: http://scan.coverity.com/rung2.html
When setting 'undofile' while the file is already loaded, but unchanged, try
to read the undo file. Requires computing a checksum of the text. (Andy
Wokula)
Bug with 'incsearch' going to wrong line. (Wolfram Kresse, 2009 Aug 17) Bug with 'incsearch' going to wrong line. (Wolfram Kresse, 2009 Aug 17)
Only with "vim -u NONE". Only with "vim -u NONE".

23
runtime/doc/version7.txt
View File

@ -1,4 +1,4 @@
*version7.txt* For Vim version 7.3g. Last change: 2010 Aug 13 *version7.txt* For Vim version 7.3g. Last change: 2010 Aug 14
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -7210,7 +7210,7 @@ Python3 interface *new-python3*
----------------- -----------------
Added the Python3 interface. It exists next to Python 2.x, both can be used Added the Python3 interface. It exists next to Python 2.x, both can be used
at the same time. |python3| (Roland Puntaier) at the same time. See |python3| (Roland Puntaier)
Changed *changed-7.3* Changed *changed-7.3*
@ -7351,13 +7351,16 @@ task 42 edit (John Florian)
New filetype plugins: ~ New filetype plugins: ~
Cucumber (Tim Pope) Cucumber (Tim Pope)
Liquid (Tim Pope) Liquid (Tim Pope)
Logcheck (Debian)
Markdown (Tim Pope) Markdown (Tim Pope)
Perl 6 (Andy Lester)
Quickfix window (Lech Lorens)
Tcl (Robert L Hicks) Tcl (Robert L Hicks)
New indent plugins: ~ New indent plugins: ~
CUDA (Bram Moolenaar)
ChaiScript (Jason Turner) ChaiScript (Jason Turner)
Cucumber (Tim Pope) Cucumber (Tim Pope)
CUDA (Bram Moolenaar)
LifeLines (Patrick Texier) LifeLines (Patrick Texier)
Liquid (Tim Pope) Liquid (Tim Pope)
Mail (Bram Moolenaar) Mail (Bram Moolenaar)
@ -7365,12 +7368,15 @@ Perl 6 (Andy Lester)
Other new runtime files: ~ Other new runtime files: ~
Breton spell file (Dominique Pelle) Breton spell file (Dominique Pelle)
Dvorak keymap (Ashish Shukla)
Korean translations. (SungHyun Nam)
Python 3 completion (Aaron Griffin)
Serbian menu translations (Aleksandar Jelenak)
Tetum spell files
Tutor Bairish (Sepp Hell) Tutor Bairish (Sepp Hell)
Tutor in Esperanto. (Dominique Pellé) Tutor in Esperanto. (Dominique Pellé)
Korean translations. (SungHyun Nam)
Dvorak keymap (Ashish Shukla) Removed the Mupad runtime files, they were not maintained.
Serbian menu translations (Aleksandar Jelenak)
Tetum spell files.
Fixed *fixed-7.3* Fixed *fixed-7.3*
@ -10132,5 +10138,8 @@ Avoid warnings from the clang compiler. (Dominique Pelle)
Fix: Include wchar.h in charset.c for towupper(). Fix: Include wchar.h in charset.c for towupper().
Fixed: Using ":read file" in an empty buffer when 'compatible' is set caused
an error.
vim:tw=78:ts=8:ft=help:norl: vim:tw=78:ts=8:ft=help:norl: