Skip to content

Commit 755bd26

Browse files
brammoolbrammool
committed
README and help file updates.
1 parent bb3d5dc commit 755bd26

11 files changed

Lines changed: 84 additions & 91 deletions

‎Makefile‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,8 @@ DOSBIN_S = dosbin_s
141141
# - Set environment for Visual C++ 2008, e.g.:
142142
# "E:\Microsoft Visual Studio 9.0\VC\bin\vcvars32.bat". Or, when using the
143143
# Visual C++ Toolkit 2003: "msvcsetup.bat" (adjust the paths when necessary).
144-
# For Windows 98/ME the 2003 version is required.
144+
# For Windows 98/ME the 2003 version is required, but then it won't work on
145+
# Windows 7 and 64 bit.
145146
# - "nmake -f Make_mvc.mak"
146147
# - "rm testdir/*.out", "nmake -f Make_mvc.mak test" and check the output.
147148
# - Rename the executables to "vimw32.exe", "xxdw32.exe".

‎README.txt‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ on-line help, spell checking, filename completion, block operations, etc.
99
There is also a Graphical User Interface (GUI) available. See
1010
"runtime/doc/vi_diff.txt" for differences with Vi.
1111

12-
This editor is very useful for editing programs and other plain ASCII files.
12+
This editor is very useful for editing programs and other plain text files.
1313
All commands are given with normal keyboard characters, so those who can type
1414
with ten fingers can work very fast. Additionally, function keys can be
1515
defined by the user, and the mouse can be used.
1616

17-
Vim currently runs under Amiga DOS, MS-DOS, MS-Windows (95, 98, Me, NT, 2000,
18-
XP, Vista, 7), Atari MiNT, Macintosh, BeOS, VMS, RISC OS, OS/2 and almost all
19-
flavours of UNIX. Porting to other systems should not be very difficult.
17+
Vim runs under Amiga DOS, MS-DOS, MS-Windows (95, 98, Me, NT, 2000, XP, Vista,
18+
7), 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.
2020

2121

2222
DISTRIBUTION
@@ -32,19 +32,19 @@ an overview of currently available distributions.
3232

3333
DOCUMENTATION
3434

35+
The vim tutor is a one hour training course for beginners. Mostly it can be
36+
started as "vimtutor". See ":help tutor" for more information.
37+
3538
The best is to use ":help" in Vim. If you don't have an executable yet, read
3639
"runtime/doc/help.txt". It contains pointers to the other documentation
3740
files. The User Manual reads like a book and is recommended to learn to use
3841
Vim. See ":help user-manual".
3942

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-
4343

4444
COPYING
4545

4646
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
47+
encouraged to make a donation to help orphans in Uganda. Please read the file
4848
"runtime/doc/uganda.txt" for details (do ":help uganda" inside Vim).
4949

5050
Summary of the license: There are no restrictions on using or distributing an
@@ -86,6 +86,8 @@ README_os2.txt OS/2
8686
README_mac.txt Macintosh
8787
README_vms.txt VMS
8888

89+
There are more README_*.txt files, depending on the distribution you used.
90+
8991

9092
INFORMATION
9193

‎README_bindos.txt‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@ README_bindos.txt for version 7.3g of Vim: Vi IMproved.
22

33
See "README.txt" for general information about Vim.
44
See "README_dos.txt" for installation instructions for MS-DOS and MS-Windows.
5-
These files are in the runtime archive (vim72rt.zip).
5+
These files are in the runtime archive (vim73rt.zip).
66

77

88
There are several binary distributions of Vim for the PC. You would normally
99
pick only one of them, but it's also possible to install several.
1010
These ones are available (the version number may differ):
11-
vim72d16.zip 16 bit DOS version
12-
vim72d32.zip 32 bit DOS version
13-
vim72w32.zip Windows 95/98/NT/etc. console version
14-
gvim72.zip Windows 95/98/NT/etc. GUI version
15-
gvim72ole.zip Windows 95/98/NT/etc. GUI version with OLE
16-
gvim72_s.zip Windows 3.1 GUI version
11+
vim73d16.zip 16 bit DOS version
12+
vim73d32.zip 32 bit DOS version
13+
vim73w32.zip Windows 95/98/NT/etc. console version
14+
gvim73.zip Windows 95/98/NT/etc. GUI version
15+
gvim73ole.zip Windows 95/98/NT/etc. GUI version with OLE
16+
gvim73_s.zip Windows 3.1 GUI version
1717

18-
You MUST also get the runtime archive (vim72rt.zip).
19-
The sources are also available (vim72src.zip).
18+
You MUST also get the runtime archive (vim73rt.zip).
19+
The sources are also available (vim73src.zip).

‎README_dos.txt‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ These are the normal steps to install Vim from the .zip archives:
4747
Binary and runtime Vim archives are normally unpacked in the same location,
4848
on top of each other.
4949

50-
2. Unpack the zip archives. This will create a new directory "vim\vim72",
50+
2. Unpack the zip archives. This will create a new directory "vim\vim73",
5151
in which all the distributed Vim files are placed. Since the directory
5252
name includes the version number, it is unlikely that you overwrite
5353
existing files.
5454
Examples:
55-
pkunzip -d gvim72.zip
56-
unzip vim72w32.zip
55+
pkunzip -d gvim73.zip
56+
unzip vim73w32.zip
5757

5858
You need to unpack the runtime archive and at least one of the binary
5959
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:
6969
archive and follow the instructions in the documentation.
7070

7171
3. Change to the new directory:
72-
cd vim\vim72
72+
cd vim\vim73
7373
Run the "install.exe" program. It will ask you a number of questions about
7474
how you would like to have your Vim setup. Among these are:
7575
- 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:
8080
console or in a shell. You can select one of the directories in your
8181
$PATH. If you skip this, you can add Vim to the search path manually:
8282
The simplest is to add a line to your autoexec.bat. Examples:
83-
set path=%path%;C:\vim\vim72
84-
set path=%path%;D:\editors\vim\vim72
83+
set path=%path%;C:\vim\vim73
84+
set path=%path%;D:\editors\vim\vim73
8585
- Create entries for Vim on the desktop and in the Start menu.
8686

8787
That's it!
@@ -93,8 +93,8 @@ Remarks:
9393
won't show a menubar. Then you need to set the $VIM environment variable to
9494
point to the top directory of your Vim files. Example:
9595
set VIM=C:\editors\vim
96-
Vim version 7.2 will look for your vimrc file in $VIM, and for the runtime
97-
files in $VIM/vim72. See ":help $VIM" for more information.
96+
Vim version 7.3 will look for your vimrc file in $VIM, and for the runtime
97+
files in $VIM/vim73. See ":help $VIM" for more information.
9898

9999
- To avoid confusion between distributed files of different versions and your
100100
own modified vim scripts, it is recommended to use this directory layout:
@@ -105,14 +105,14 @@ Remarks:
105105
C:\vim\vimfiles\ftplugin\*.vim Filetype plugins
106106
C:\vim\... Other files you made.
107107
Distributed files:
108-
C:\vim\vim72\vim.exe The Vim version 7.2 executable.
109-
C:\vim\vim72\doc\*.txt The version 7.2 documentation files.
110-
C:\vim\vim72\bugreport.vim A Vim version 7.2 script.
111-
C:\vim\vim72\... Other version 7.2 distributed files.
108+
C:\vim\vim73\vim.exe The Vim version 7.3 executable.
109+
C:\vim\vim73\doc\*.txt The version 7.3 documentation files.
110+
C:\vim\vim73\bugreport.vim A Vim version 7.3 script.
111+
C:\vim\vim73\... Other version 7.3 distributed files.
112112
In this case the $VIM environment variable would be set like this:
113113
set VIM=C:\vim
114-
Then $VIMRUNTIME will automatically be set to "$VIM\vim72". Don't add
115-
"vim72" to $VIM, that won't work.
114+
Then $VIMRUNTIME will automatically be set to "$VIM\vim73". Don't add
115+
"vim73" to $VIM, that won't work.
116116

117117
- You can put your Vim executable anywhere else. If the executable is not
118118
with the other Vim files, you should set $VIM. The simplest is to add a line
@@ -136,8 +136,8 @@ Remarks:
136136
Select Properties.
137137
5. In the Program tab, change the "Cmdline" to add "/c" and the name of the
138138
Vim executable. Examples:
139-
C:\command.com /c C:\vim\vim72\vim.exe
140-
C:\command.com /c D:\editors\vim\vim72\vim.exe
139+
C:\command.com /c C:\vim\vim73\vim.exe
140+
C:\command.com /c D:\editors\vim\vim73\vim.exe
141141
6. Select the font, window size, etc. that you like. If this isn't
142142
possible, select "Advanced" in the Program tab, and deselect "MS-DOS
143143
mode".

‎README_os2.txt‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,28 @@ See "README.txt" for general information about Vim.
55

66

77
NOTE: You will need two archives:
8-
vim72rt.zip contains the runtime files (same as for the PC version)
9-
vim72os2.zip contains the OS/2 executables
8+
vim73rt.zip contains the runtime files (same as for the PC version)
9+
vim73os2.zip contains the OS/2 executables
1010

1111
1. Go to the directory where you want to put the Vim files. Examples:
1212
cd C:\
1313
cd D:\editors
1414

15-
2. Unpack the zip archives. This will create a new directory "vim/vim72",
15+
2. Unpack the zip archives. This will create a new directory "vim/vim73",
1616
in which all the distributed Vim files are placed. Since the directory
1717
name includes the version number, it is unlikely that you overwrite
1818
existing files.
1919
Examples:
20-
pkunzip -d vim72os2.zip
21-
unzip vim72os2.zip
20+
pkunzip -d vim73os2.zip
21+
unzip vim73os2.zip
2222

2323
After you unpacked the files, you can still move the whole directory tree
2424
to another location.
2525

2626
3. Add the directory where vim.exe is to your path. The simplest is to add a
2727
line to your autoexec.bat. Examples:
28-
set path=%path%;C:\vim\vim72
29-
set path=%path%;D:\editors\vim\vim72
28+
set path=%path%;C:\vim\vim73
29+
set path=%path%;D:\editors\vim\vim73
3030

3131
That's it!
3232

@@ -41,10 +41,10 @@ Extra remarks:
4141
C:\vim\_viminfo Dynamic info for 'viminfo'.
4242
C:\vim\... Other files you made.
4343
Distributed files:
44-
C:\vim\vim72\vim.exe The Vim version 7.2 executable.
45-
C:\vim\vim72\doc\*.txt The version 7.2 documentation files.
46-
C:\vim\vim72\bugreport.vim A Vim version 7.2 script.
47-
C:\vim\vim72\... Other version 7.2 distributed files.
44+
C:\vim\vim73\vim.exe The Vim version 7.3 executable.
45+
C:\vim\vim73\doc\*.txt The version 7.3 documentation files.
46+
C:\vim\vim73\bugreport.vim A Vim version 7.3 script.
47+
C:\vim\vim73\... Other version 7.3 distributed files.
4848
In this case the $VIM environment variable would be set like this:
4949
set VIM=C:\vim
5050

‎README_src.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ README_src.txt for version 7.3g of Vim: Vi IMproved.
22

33
The source archive contains the files needed to compile Vim on Unix systems.
44
It is packed for Unix systems (NL line separator). It is also used for other
5-
systems in combination with the extra archive (vim-7.2-extra.tar.gz, in the
5+
systems in combination with the extra archive (vim-7.3-extra.tar.gz, in the
66
"extra" directory of ftp.vim.org).
77

88
For more information, see the README.txt file that comes with the runtime
9-
archive (vim-7.2-rt.tar.gz). To be able to run Vim you MUST get the runtime
9+
archive (vim-7.3-rt.tar.gz). To be able to run Vim you MUST get the runtime
1010
archive too!

‎README_srcdos.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ README_srcdos.txt for version 7.3g of Vim: Vi IMproved.
22

33
See "README.txt" for general information about Vim.
44
See "README_dos.txt" for installation instructions for MS-DOS and MS-Windows.
5-
These files are in the runtime archive (vim72rt.zip).
5+
These files are in the runtime archive (vim73rt.zip).
66

77

88
The DOS source archive contains the files needed to compile Vim on MS-DOS or

‎runtime/doc/os_amiga.txt‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*os_amiga.txt* For Vim version 7.3g. Last change: 2005 Mar 29
1+
*os_amiga.txt* For Vim version 7.3g. Last change: 2010 Aug 14
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -8,6 +8,8 @@
88
This file contains the particularities for the Amiga version of Vim.
99
There is also a section specifically for |MorphOS| below.
1010

11+
NOTE: The Amiga code is still included, but has not been maintained or tested.
12+
1113
Installation on the Amiga:
1214
- Assign "VIM:" to the directory where the Vim "doc" directory is. Vim will
1315
look for the file "VIM:doc/help.txt" (for the help command).

‎runtime/doc/os_beos.txt‎

Lines changed: 4 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*os_beos.txt* For Vim version 7.3g. Last change: 2005 Mar 29
1+
*os_beos.txt* For Vim version 7.3g. Last change: 2010 Aug 14
22

33

44
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
131131

132132
5. The BeOS GUI *beos-gui*
133133

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

167138

168139
6. The $VIM directory *beos-vimdir*

‎runtime/doc/todo.txt‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ Before release 7.3:
3535

3636
Problem with \NL in Ex script. (Ray Frish, 2010 Aug 10)
3737

38+
Using longest completion (with "longest" in 'wildmode' or using CTRL-L) after
39+
:find will not work, because of shortening the results. Don't shorten when
40+
looking for the longest common part of the matches.
41+
3842
Bug: E685 error for func_unref(). (ZyX, 2010 Aug 5)
3943

4044
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
5256
Problem producing tags file when hebrew.frx is present. It has a BOM.
5357
Results in E670. (Tony Mechelynck, 2010 May 2)
5458

55-
setpos() does not resture cursor position after :normal. (Tyru, 2010 Aug 11)
59+
setpos() does not restore cursor position after :normal. (Tyru, 2010 Aug 11)
5660

5761
Test 73 fails on MS-Windows when compiled with DJGPP and run twice. How to
5862
delete the Xfind directory? Add an rmdir() function, just like we have
@@ -113,7 +117,11 @@ path.
113117
like it has ":keepjumps" before it.
114118

115119
Coverity: ask someone to create new user: Dominique.
116-
look into reported defects: http://scan.coverity.com/rung2.html
120+
Check if there are new reported defects: http://scan.coverity.com/rung2.html
121+
122+
When setting 'undofile' while the file is already loaded, but unchanged, try
123+
to read the undo file. Requires computing a checksum of the text. (Andy
124+
Wokula)
117125

118126
Bug with 'incsearch' going to wrong line. (Wolfram Kresse, 2009 Aug 17)
119127
Only with "vim -u NONE".

0 commit comments

Comments
 (0)