Index of Topics

- !  -

!

- < -

<

- > -

>

- A -

ABBREV
ADDMENUITEM
Advanced Usage
ALIAS
Altering Text
APPEND
ASSIGN
ATOMIC
autoindent
automessageclear
autosaveinterval

- B -

Basic Usage
beepflag
Boolean Settings
BORDER
BREAK
buttonheight
buttonwidth

- C -

CASCADE
Case Toggling
caseignore
CD
CHANGE
changelikevi
Changing Text
Characters
clock
clockx
clocky
cmode
columninfilestatus
The Command Line
Command Mode
Command Mode Key Summary
commandcursortype
Commands
COMMANDWINDOW
COMPILE
COMPRESS
CONTINUE
Control Flow Commands
Controlling Magic Characters
COPY
Copy Buffers
Copying Text
COUNTWINDOW
CTAGS
currentstatus
currentstatuscolumn
cursorblinkrate
Cutting and Pasting Text

- D -

DATE
DEFAULTWINDOW
DELETE
DELETEMENU
DELETEMENUITEM
Deleting Text
Deleting, Copying, and Pasting Text
DIMENSION
DIRWINDOW
drawtildes

- E -

ECHO
EDIT
Edit Menu
Edit Window Menu
Editor Commands
Editor Script Language
Editor Settings
EDITWINDOW
EGREP
eightbits
ELSE
ELSEIF
ENDIF
ENDLOOP
ENDMENU
endoflinechar
ENDWHILE
ENDWINDOW
Error Code Tokens
escapemessage
EVAL
Example - err.vi
Example - lnum.vi
Example - proc.vi
Example - qall.vi
Example - wrme.vi
EXECUTE
EXITALL
exitattr
EXPAND
EXPR
extendedmemory
EXTRAINFOWINDOW

- F -

FCLOSE
FGREP
File Matching Regular Expressions
File Menu
FILECWINDOW
fileendstring
FILES
FILEWINDOW
Filters
FLOATMENU
FOPEN
FREAD
FWRITE

- G -

gadgetstring
GENCONFIG
GET
Getting a File for Editing
GLOBAL
The Global Command
GOTO
grepdefault

- H -

hardtab
HELP
Help Menu
HILIGHT
historyfile
Hook Scripts

- I -

IF
The IF Block
ignorectrlz
ignoretagcase
inactivewindowcolor
INPUT
Inputting Text
INSERT
insertcursortype
Inserting Text
Intermediate Usage
Introduction to the Open Watcom Vi Editor
Invoking the Open Watcom Vi Editor

- J -

JOIN
Joining Text

- K -

KEYADD

- L -

LABEL
lefthandmouse
Line Address Examples
Line Addresses
Line Numbers
linenumbers
LINENUMBERWINDOW
linenumsonright
Lines
LIST
LOAD
LOOP
The LOOP Block
Lost File Recovery

- M -

magic
magicstring
MAP
MAPBASE
Mapping Keys
MARK
marklonglines
Marks
MATCH
Matching Examples
maxclhistory
maxemsk
maxfilterhistory
maxfindhistory
MAXIMIZE
maxlinelen
maxpush
maxswapk
maxtilecolors
maxwindowtilex
maxwindowtiley
maxxmsk
MENU
Menu Commands
MENUBARWINDOW
MENUITEM
menus
MENUWINDOW
MESSAGEWINDOW
MINIMIZE
Miscellaneous Keys
Modes
The Mouse
Mouse Control Booleans
Mouse Control Values
mousedclickspeed
mouserepeatdelay
mousespeed
MOVE
movecolor
Movement
MOVEWIN
Moving Around
Moving Around in a File
Moving Between Files

- N -

NEXT
NEXTWORD
Non-Boolean Settings

- O -

OPEN
The Open Watcom Vi Editor Environment
The Open Watcom Vi Editor Error Messages
Options Menu
overstrikecursortype

- P -

pagelinesexposed
pauseonspawnerr
POP
Position Menu
Pre-defined Global Variables
PREV
PUSH
PUT

- Q -

quiet
QUIF
QUIT
QUITALL
quitmovesforward

- R -

radix
READ
readentirefile
readonlycheck
realtabs
regsubmagic
Regular Expression BNF
Regular Expression Examples
Regular Expressions
repeatinfo
Repeating Edit Operations
Replacement Examples
Replacement Strings
Replacing Text
RESIZE
resizecolor
RETURN

- S -

samefilecheck
Sample Menus
Sample Window Settings
saveconfig
saveposition
Saving and Exiting a File
Saving and Exiting a File Revisited
The Screen
Script Commands
Script Examples
Script Expression BNF
Script Expressions
Script Variables
Searching
Searching Files For Text
Searching for Text
searchwrap
Selecting Text
SET
SETCOLOR
SETVALWINDOW
SETWINDOW
SHELL
shellprompt
Shifting Text
shiftwidth
showmatch
SIZE
Some Basic Commands
SOURCE
Special Keys
Special Keys In The Command Window
Special Keys In The Search String Window
spinning
spinx
spiny
stackk
Starting the Open Watcom Vi Editor
statusinfo
statussections
statusstring
STATUSWINDOW
SUBSTITUTE
The Substitute Command
Symbolic Keystrokes
Symbols and Meaning

- T -

tabamount
TAG
tagfilename
tagprompt
Terms and Notation
TEXT
Text Insertion Mode
Text Selection
TILE
tilecolor
tmpdir
toolbar

- U -

UNABBREV
UNALIAS
undo
UNDO (command)
Undo and Redo
Undoing Changes
UNMAP
UNTIL
usemouse
Using Edbind
Using Marks
Using the Menus
Using the Mouse

- V -

verbose
VERSION
VIEW
VISUAL

- W -

What is a Modal Editor?
WHILE
The WHILE Block
Window Control Booleans
Window Control Values
Window Menu
Window Properties
Window Types
windowgadgets
Windows and Menus
word
wordalt
wordwrap
WQ
wrapbackspace
wrapmargin
WRITE
writecrlf

- X -

XIT

- Y -

YANK

Introduction to the Open Watcom Vi Editor

• fully configurable
  • The size of every window can be set by the user
  • The color of every window can be set by the user
  • A window's border can be set by the user
  • The menu bar may be enabled/disabled
  • The menu items in each menu can be set by the user
  • Keys can be changed and augmented to suit any configuration
• unlimited undo and redo capability
• unlimited file size
• unlimited number of lines in a file
• edit up to 250 files at the same time
• multiple views on the same file
• full mouse support
• powerful script language
  • local and global variables
  • structured constructs (loop, while, if/elseif/else)
  • arbitrary conditional expressions
  • file I/O
• batch edit processing
• regular expression search and replacement
• text marks
• keystroke macros
• block delete, copy, change, case toggle, and shift operations

• DOS (real mode) (286 or higher)
• DOS (protected mode, 386 or higher processors)
• OS/2 1.x
• OS/2 2.x
• Windows NT
• QNX
• Windows 3.x GUI
• Windows NT GUI
• Linux (multiple CPU architectures)

Terms and Notation

The Mouse

click

Pressing a mouse button once.

double click

Pressing a mouse button twice in rapid succession.

dragging

Holding down a mouse button and then moving the mouse.

The Screen

• The top line of the screen is the menu bar which contains all of the menu choices, the current mode, and the current time.
• The large window below the menu bar is the edit window.  Since Vi is a multiple file editor, you may have more than one edit window.  Other edit windows are usually covered by the current edit window, unless you change the size and position of the edit windows.
• The lower left corner of the screen contains the status window.  This window typically shows the current row and column.
• The majority of the bottom of the screen contains the message window.  This window displays all errors and informational messages.

• In the top left corner of the edit window is the gadget character that opens up the menu for the window.
• In the lower right corner of the edit window is the resize gadget character.  When you click on this gadget character with your mouse and then drag the mouse, you can resize the edit window.
• On the right hand side of the edit window is the scroll bar.  The scroll bar has several components:
• The scroll up gadget character.  When you click on this with your mouse, the edit window scrolls up one line.
• The scroll down gadget character.  When you click on this with your mouse, the edit window scrolls down one line.
• The scroll thumb character.  The scroll thumb indicates the relative position of the current line in the file.  When you click on the scroll thumb with your mouse and drag it, you can move to a new position in the file.  If you click with your mouse on the scroll bar above the scroll thumb, you move one page up in the file.  If you click on the scroll bar below the scroll thumb, you move one page down in the file.

Basic Usage

Starting the Open Watcom Vi Editor

What is a Modal Editor?

Some Basic Commands

Moving Around

UP (up arrow key)

Cursor up through the text.

DOWN (down arrow key)

Cursor down through the text.

LEFT (left arrow key)

Cursor left through the text.

RIGHT (right arrow key)

Cursor right through the text.

HOME

Move to the start of the current line.

END

Move to the end of the current line.

PAGEUP

Move up one page in the text.

PAGEDOWN

Move down one page in the text.

CTRL_PAGEUP (Ctrl key + Page Up key)

Move to the first character on the first line in the file.

CTRL_PAGEDOWN (Ctrl key + Page Down key)

Move to the last character on the last line in the file.

Saving and Exiting a File

Inputting Text

UP (up arrow key)

Cursor up through the text.

DOWN (down arrow key)

Cursor down through the text.

LEFT (left arrow key)

Cursor left through the text.

RIGHT (right arrow key)

Cursor right through the text.

HOME

Move to the start of the current line.

END

Move to the end of the current line.

PAGEUP

Move up one page in the text.

PAGEDOWN

Move down one page in the text.

CTRL_PAGEUP (Ctrl key + Page Up key)

Move to the first character on the first line in the file.

CTRL_PAGEDOWN (Ctrl key + Page Down key)

Move to the last character on the last line in the file.

CTRL_DEL (Control-Delete)

Deletes the current line.

BS (Backspace key)

Deletes the character before the cursor, moving the cursor and the rest of the line to the left one character.

DEL (Delete key)

Delete the character under the cursor.  If you are at the end of the line, DEL has the same effect as pressing BS.

ENTER

Start a new line.

INS (Insert key)

Toggles between inserting and overstriking text.

a

Starts appending (inserting) text after the current character.

A

Starts appending (inserting) text after the last character on the current line.

i

Starts inserting text at the current cursor position.  This is the same as pressing the INS key.

I

Starts inserting text before the first non-white space character on the current line.

o

Adds a blank line after the current line, and starts you inserting text on the new line.

O

Adds a blank line before the current line, and starts you inserting text on the new line.

R

Starts overstriking text at the current cursor position.

INS

Start inserting text at the current cursor position.

1. Edit a new file (called "test", for example) as follows:
   
        
        vi test
   
   You will see the following screen:
   
   
   Figure 7. Editing the New File "test"
   
   Note the message window (the bottom two lines of the screen) contains the message
   
        
        "test" [new file] line 1 of 1  -- 100% --
   
   This message indicates that you are editing a new file called test, that you are on line 1 of a 1 line file, and that line 1 is 100% of the way into the file.
   
   You may see that message any time by pressing CTRL_G (hold down the Ctrl key and press the g key).
   
   Enter text insertion mode by pressing the INS key, and type the following lines:
   
        
        This is a test line.
        This is another test line.
   
   When you are done typing these lines, remember to press the ESC key to return to command mode.
   
   Press CTRL_G (hold down Ctrl and press the g key).  The message window (the bottom two lines of the screen) will show the message:
   
        
        "test" [modified] line 2 of 2  -- 100% --
   
   Now, press two capital z's in a row ('ZZ').  This will save the file and return to the operating system command prompt.
2. Edit the file you created in the previous example, by typing
   
        
        vi test
   
   You will see the following screen:
   
   
   Figure 8. Editing the File "test"
   
   Note the message window (the bottom two lines of the screen) contains the message
   
        
        "test" line 1 of 2  -- 50% --
   
   This message is different than when you edited "test" for the first time.  The "[new file]" indicator is gone, since you have edited an existing file.  This message indicates to you that you are now editing a file called test, that you are on line 1 of a 2 line file, and that line 1 is 50% of the way into the file.
   
   Now try to experiment with the different ways of entering insert mode.
   1. Try pressing the 'A'(capital 'a') key.  This will move your cursor to the end of the line, and will put you into insert mode.  Try adding some text to this line, and press the ESC key when you are done.
   2. Try pressing the 'I' key.  This will move your cursor to the start of the line, and will put you into insert mode.   Try adding some text to this line, and press the ESC key when you are done.
   3. Try pressing the 'R' key.  This will start you in overstrike mode.  Note that the you have a very large cursor and that the mode indicator says:
      
           
           Mode: overstrike
      
      Try typing some characters.  As you type, what was there already is replaced by what you type.  Press the ESC key when you are done.
   4. Try pressing the 'i' key.  This is the same as pressing the INS key.  Now type some text, then press the INS key.  Note that your cursor turned to full height from half height, and the mode indicator changed from:
      
           
           Mode: insert
      
      to
      
           
           Mode: overstrike
      
      Now, when you type, you will replace the existing characters.  Try pressing the INS key again.  This time, your cursor will turn from full height to half height, and the mode indicator will change from:
      
           
           Mode: overstrike
      
      to
      
           
           Mode: insert
      
      Remember to press the ESC key when you are done.
   5. Try pressing the 'a' key.  This will move the cursor over one character, and put you in insert mode.  Try cursoring around inside your text using the arrow keys.  Use the END key to move to the end of a line, and the HOME key to move to the start of a line.  Press the ESC key when you are done.
   
   You have now made a number of significant modifications to your file.  To discard the file without saving your changes, activate the individual file menu (at the top-left corner of the edit window) either by clicking on the gadget character with the mouse or by pressing ALT_G.  When the menu is up, try selecting the Close item.  You will get the message:
        
        File modified - use :q! to force
   
   The command ":q!" being referred to will be discussed later.  The file can be exited without saving by using the Close no save menu item.  Activate the individual file menu again, and select this item.   This will discard your changes to the file, and since you are not editing any other files, you are returned to the operating system command prompt.

Cutting and Pasting Text

Lines

Characters

1. Copy the first line by pressing the 'Y' (capital 'y') while the cursor is on the first line.
2. Now press the 'p' key to paste the line after the current line.  You should see the lines:
   
        
        This is a test line.
        This is a test line.
        This is another test line.
3. Now, go to the second line and yank 2 lines, by pressing the number '2' followed by the letters 'yy'.
4. Cursor up to the top line, and press the capital p ('P') key to paste the lines above the current line.  You will see:
   
        
        This is a test line.
        This is another test line.
        This is a test line.
        This is a test line.
        This is another test line.
5. Now, move to the top line in the file and delete the first 3 lines by press the number '3' followed by the letters 'dd'.   You will now have the following lines:
   
        
        This is a test line.
        This is another test line.
6. Delete the first line by pressing CTRL_DEL or by typing 'dd'.  You will be left with a single line:
   
        
        This is another test line.
7. Paste the line you deleted back in.  If you press the letter 'p' or SHIFT_INS, the line you deleted will appear after the first line:
   
        
        This is another test line.
        This is a test line.
8. Paste the line above the current line by pressing capital p ('P') or CTRL_INS.  The line should appear above the first line:
   
        
        This is a test line.
        This is another test line.
        This is a test line.
9. Delete all 3 lines of text.  Make sure your cursor is on the first line in the file, and type 3dd.  This will delete all three lines, and you will have an empty edit buffer.
10. Paste the lines back in by typing 'p'.  The three lines will be pasted in:
    
         
         This is a test line.
         This is another test line.
         This is a test line.
11. Go to the first line in the file, and to the first column (try pressing CTRL_PAGEUP).  Then press the 'x' key.  The first line should become:
    
         
         his is a test line.
    
    Your cursor should be on the letter 'h' in column 1.
12. Type the letter 'p'.  The 'T' that you deleted will appear after the 'h' in column 1:
    
         
         hTis is a test line.
13. Type capital p ('P').  The 'T' that you deleted will appear before the 'i' and after the 'T' you just pasted in.
    
         
         hTTis is a test line.
14. Cursor to the first column and type 6x.  This will delete the first word and the space:
    
         
         is a test line.
15. Move the cursor over to the 't' in 'test'.  Press capital x ('X'), and you will see:
    
         
         is atest line.
    
    The cursor will remain on the 't'.
16. Type 3X.  You will now see
    
         
         itest line.
    
    and the cursor will still be on the 't'.

Using the Menus

1. Cursoring up or down to the item and pressing the ENTER key.
2. Typing the hot key for the menu item.
3. Clicking on an item with the mouse.
4. Dragging the mouse and releasing the mouse button on an item.

Edit Window Menu

Maximize

Causes the window to become as large as possible.

Minimize

Causes the window to become as small as possible.

Open another view

Creates a separate window that is editing the same copy of the current file.  This is useful if you wish to be able to look at one part of a file while editing another part.

Save

Saves the current file.  You remain editing the current file.

Save and close

Saves the current file and closes the window.

Close no save

Closes the window, discarding the current file and any changes you may have made.

Close

Closes the window.  If the file has been modified, then the close will fail.

Window Menu

Tile windows

Tile all edit windows in a grid pattern, so that each window is displayed without overlapping any other.

Cascade windows

Causes all edit windows to cascade (overlap each other with the top border of each visible).

Reset windows

Resets all edit buffer windows to be full size (the same as maximizing each window individually).

Options Menu

Settings

This brings up a list of all settings for Vi.  For more information on settings, see the chapter Editor Settings.

File Menu

Open new file

Displays a list of all files and directories in the current directory, along with all drives that are available.  If you pick a file, you will edit that file.  If you pick a directory, Vi will display all the files in that directory.   If you pick a drive, Vi will display all files in the current directory on that drive.

Next file

Flip to the next file in the list of files that you are editing.

Read file

Displays a list of all files and directories in the current directory, along with all drives that are available.  If you pick a file, that file will be read into the current edit buffer, after the current line.  If you pick a directory, Vi will display all the files in that directory.  If you pick a drive, Vi will display all files in the current directory on that drive.

File list

When selected, a list of all files that you are editing is displayed.  Any modified files have an asterisk ('*') before their name.  By picking a file from this list, you move to that file.

Save current file

Vi will save the current file you are editing.  You will remain editing the current file.

Save current file and close

Vi will save the current file you are editing, and close the edit window.  If you are editing any other files, the next one in the list will become the current one.  If you are not editing any other files, then Vi will exit.

Enter command

Allows you to enter a command line command.  The command line is discussed in the next chapter Intermediate Usage.

System

Starts an operating system command shell.  You exit the command shell by typing 'exit'.

Exit

Exits all edit sessions, as long as no files have been modified.

Edit Menu

Delete region

Deletes the selected (highlighted) region.

Copy (yank) region

Makes a copy of the selected (highlighted) region.

Paste (put)

Pastes the last deleted or copied text into the current edit buffer.  The text is pasted after the current position in the file.

Insert text

Causes Vi to enter insert mode at the current cursor position.

Overstrike text

Causes Vi to enter overstrike mode at the current cursor position.

Undo

Undoes the last change that you made to the current edit buffer.  If you keep selecting this item, you will undo more and more of your changes.  If you select this item enough times, your file will be restored to the state when it was first opened or created.

Redo

Redoes the last undo that you did in the current edit buffer.  If you keep selecting this item, you will redo more and more of your undos.  If you select this item enough times, your file will return to the state when you made your last change.

Position Menu

Start of file

Moves to the start of the current edit buffer.

End of file

Moves to the end of the current edit buffer.

Line number

Prompts for a specific line number.  Once you enter the number, you are placed at that line.

Start of line

Moves to the start of the current line.

End of line

Moves to the end of the current line.

Search forwards

Prompts for some search text.  Once you type some text and press ENTER, Vi searches forwards through the current edit buffer for the text.  If the text is found, it is highlighted and the cursor is placed on the first character of the text.

Search backwards

Prompts for some search text.  Once you type some text and press ENTER, Vi searches backwards through the current edit buffer for the text.  If the text is found, it is highlighted and the cursor is placed on the first character of the text.

Last search

Repeats the last search that you typed, in the same direction as the initial search request.

Reverse last search

Repeats the last search that you typed, but the searches occurs in the opposite direction of the initial search request.

Help Menu

Command line

Gives help on all command line commands.

Keystrokes

Gives help on command mode and text insertion mode.

Regular expressions

Gives help on the search and replace abilities of Vi's regular expressions.

Scripts

Gives help on Vi's script language.

Starting up

Gives help on the various command line parameters for Vi.

Intermediate Usage

The Command Line

1. Select the Enter command item under the File menu.
2. Press the colon (':') key when in command mode.  Remember to press the ESC key to ensure that you are in command mode before pressing ':'.

Line Numbers

.  (dot)

Represents the current line number.

$ (dollar)

Represents the last line number.

'a (front quote)

Indicates the line with the mark 'a' set; marks 'a' through 'z' may be used.  Marks are discussed later in this chapter.

1. Start up Vi, and try selecting the File menu, and then selecting the Enter command item.  Notice how the window pops up.  Try typing and cursoring around.  When you are done, press the ESC key to cancel the command.
2. Make sure that you are in command mode, then press the colon (':') key.  Once again, the command window pops up.  Try typing and cursoring around.  When you are done, press the ESC key to cancel the command.
3. Add 10 lines to your file.  Then press the colon (':') key and enter the number 5.  You will go to line 5.  Try entering different numbers and see what happens.  If you enter a line number that does not exist, you will see the message:
   
        
        No such line
4. Now that you have a number of commands entered, try cursoring up and down in the command window.  You will see all the commands that you have typed.

Getting a File for Editing

1. Start up Vi without any files specified.  Then try entering the command line command EDIT without any parameters (remember to press the colon (':') key first).  You will see a screen similar to the following:
   
   
   Figure 18. File Selection display
   
   Try changing to other directories or drives with this list.  When you are done, press the ESC key to cancel the selection list.
2. Try entering the following command line command
   
        
        :e afile
   
   This will cause Vi to start editing a new file called "afile".
3. Try entering the command line command
   
        
        :e bfile cfile
   
   This will cause Vi to edit two new files, one named "bfile" and one named "cfile".
4. Enter the command line command
   
        
        :e afile
   
   This returns you to the first file ("afile") that you were already editing.
5. Press CTRL_C, and Vi will quit all the files that you have started editing.

Moving Between Files

1. Start up Vi in the following way:
   
        
        vi a b c
   
   This will cause you to edit three new files.  Now, press the F7 key.  The following will appear:
   
   
   Figure 19. Current File List
   
   Select the file b.  That file will become the current file being edited.
2. Type the command line command
   
        
        :files
   
   You will see the same result as you saw in the previous example.  Press the ESC key to cancel this display.
3. Press the F1 key several times.  You will rotate through the three files that you are editing.
4. Press the F2 key several times.  You will rotate through the three files that you are editing, but in the opposite order than when you were pressing the F1 key.
5. Use the command line commands NEXT and PREV to move through the files.  These commands behave the same as pressing F1 and F2.

Moving Around in a File

UP (up arrow key)

Cursor up through the text.

DOWN (down arrow key)

Cursor down through the text.

LEFT (left arrow key)

Cursor left through the text.

RIGHT (right arrow key)

Cursor right through the text.

HOME

Move to the start of the current line.

END

Move to the end of the current line.

PAGEUP

Move up one page in the text.

PAGEDOWN

Move down one page in the text.

CTRL_PAGEUP (Ctrl key + Page Up key)

Move to the first character on the first line in the file.

CTRL_PAGEDOWN (Ctrl key + Page Down key)

Move to the last character on the last line in the file.

$ (dollar sign)

Move to the end of the current line.

0 (zero)

Move to the start of the current line.

b

Move backwards to the previous word on the current line.  If preceded with a repeat count, you move back that many words.

h

Move right through the text.  If preceded with a repeat count, then you move right that many characters.

l

Move left through the text.  If preceded with a repeat count, then you move left that many characters.

w

Move forward to the next word on the current line.  If preceded with a repeat count, you move forward that many words.

B

Move backwards to the previous whitespace delimited word on the current line.  If preceded with a repeat count, you move back that many words.

W

Move forward to the next whitespace delimited word on the current line.  If preceded with a repeat count, you move forward that many words.

CTRL_B

Move back one page in the text.  If preceded with a repeat count, you will move back that many pages.

CTRL_D

Move down one half page in the text.  If preceded with a repeat count, then you move forward that many lines.  As well, any future CTRL_D or CTRL_U commands issued will move that many lines, instead of a half page.

CTRL_F

Move forward one page in the text.  If preceded with a repeat count, you will move forward that many pages.

CTRL_U

Move up one half page in the text.  If preceded with a repeat count, then you move backwards that many lines.  As well, any future CTRL_U or CTRL_D commands issued will move that many lines, instead of a half page.

j

Move down through the text.  If preceded with a repeat count, then you move down that many lines.

k

Move up through the text.  If preceded with a repeat count, then you move up that many lines.

G

Moves to the last line in the file.  If preceded with a repeat count, then you move to that line in the file.

H

Move to the top of the current edit window.  If preceded with a repeat count, you move that many lines from the top of the edit window.

L

Move to the bottom of the current edit window.  If preceded with a repeat count, you move that many lines from the bottom of the edit window.

M

Move to the middle of the current edit window.

1. Edit a new file, "atest".  Once you have edited this file, add the line:
   
        
        This is a test line.
   
   Once you have done this, copy this line by pressing 'Y'.  Press 'p' to paste in the copy.  Press 'p' 28 more times, so that you create a file with 30 lines in it (all just like the first line).
2. So that we can more easily see the results, type the following command line command:
   
        
        :%s/^/\# /
   
   This is a substitution command.  It will replace the start of each of your lines with the line number.  We will learn about the substitution command in the next chapter.  When you are done, you should see a screen similar to the following:
   
   
   Figure 20. "ATEST" File Contents
3. Press the 'G' key.  You will move to the last line of the file.
4. Type the following:
   
        
        15G
   
   This will move you to line 15.
5. Try using CTRL_F and CTRL_B.  Notice that they behave just like PAGEUP and PAGEDOWN.
6. Try using 'w' and 'b' to move forward and backwards through words in the file.
7. Try using 'j' and 'k' to cursor up and down in the file.
8. Try using 'l' and 'h' to cursor left and right in the file.
9. Press the 'H' key.  The cursor will move to the top line in the edit window.
10. Press the 'L' key.  The cursor will move to the bottom line in the edit window.
11. Try typing some numbers before pressing the 'H' and 'L' keys.  For example, typing
    
         
         3H
    
    will move your cursor to the 3rd line from the top of the edit window.
12. Press the 'M' key.  The cursor will move to the middle of edit window.
13. Press the '$' key.  The cursor will move to the end of the current line.
14. Press the '0' (zero) key.  The cursor will move to the start of the current line.
15. Press CTRL_D.  You will move down half a page
16. Type the number '2' and then press CTRL_D.  Notice that you only move down 2 lines.
17. Press CTRL_D.  You will move down 2 lines.
18. Press CTRL_U.  You will move up 2 lines.
19. Press 'ZZ' to save the file.  This file will be used in later exercises.

Saving and Exiting a File Revisited

1. QUIT ("!") or q ("!")
2. QUITALL
3. WRITE ("!") or w ("!")
4. WQ
5. XIT

1. Edit a file as follows:
   
        
        vi abc
   
   Add the lines:
   
        
        Line 1.
        Line 2.
        Line 3.
2. Enter the command line command QUIT (remember to press the colon (':') key to bring up the command window).  You will see the message:
   
        
        File modified - use :q! to force
   
   Press CTRL_G.  The message window will indicate the following:
   
        
        "abc" [modified] line 3 of 3  -- 100% --
   
   As you can see, the file has been modified, so you are not allowed to quit.
3. Enter the command line command WRITE.  You will see the message:
   
        
        "abc" 3 lines, 27 bytes
   
   This indicates that the file has been written.  Now press CTRL_G, and you will see:
   
        
        "abc" line 3 of 3  -- 100% --
   
   Notice that the file no longer is marked as modified once it is written.
4. Try the command line command QUIT again.  This time, you will be able to quit the file, since the file has been written, and is no longer marked as modified.
5. Re-edit the file "abc".  Enter command:
   
        
        :1,2 w def
   
   This will write out a new file called "def".  Now quit Vi.
6. Edit the file "def".  Notice that it contains the lines
   
        
        Line 1.
        Line 2.
   
   These are the first two lines of "abc", that you wrote to this file.  Try entering the command:
   
        
        :write abc
   
   You will see the message
   
        
        File exists - use w! to force
   
   Since "abc" already exists, you are not allowed to overwrite it, unless you specify the exclamation point, as follows:
   
        
        :write! abc
7. Re-edit the file "abc".  Delete the last line.  Press CTRL_G, and you will see that the file is modified.  Now, enter the command line command (remembering to press ':'):
   
        
        :q!
   
   You will exit the file, even though it has been modified.
8. Re-edit the file "abc", and delete the last line.  Enter the command line command XIT.   This will save the file and exit it, and because you are not editing any other files, you will exit Vi.  You could also use the command WQ to do the same thing.  Both of these commands do the same thing as pressing 'ZZ' while in command mode.
9. Start up Vi as follows:
   
        
        vi abc def
   
   This will edit two files, "abc" and "def".  Enter the command line command QUITALL and you will exit Vi.
10. Repeat the previous example, but add a line to one of the two files.  Now enter the command line command QUITALL.  In this case, you will be prompted with
    
         
         Files are modified, really exit?
    
    Reply with a 'y', and you will exit Vi, even though files are modified.

Using the Mouse

Selecting Text

SHIFT_UP (shifted cursor up key)

Starts or continues selection and moves up to the previous line.  The new line is selected.

SHIFT_DOWN (shifted cursor down key)

Starts or continues selection and moves down to the next line.  The new line is selected.

SHIFT_LEFT (shifted cursor left key)

Starts or continues selection and moves left to the next character.  The new character is selected.

SHIFT_RIGHT (shifted cursor right key)

Starts or continues selection and moves right to the previous character.  The new character is selected.

CTRL_R

Starts text selection, if no text is selected.  The current character is highlighted.  If a region is already selected, then this cancels the selected region.

ESC

Cancels the current selection.

1. Edit the file "atest" created in the Exercises section of Moving Around in a File.   Click the left mouse button when the mouse cursor is on the top line, and drag your mouse down until the first 10 lines are selected.  If you do not have a mouse, then press the shift key and cursor down until the first 10 lines are selected.
   
   Now, click the right mouse button somewhere inside the selected region.  If you do not have a mouse, press the underscore ('_') key.  A menu will appear.  The selected region and the menu will appear as follows:
   
   
   Figure 21. Selected Lines menu
   
   From this menu, you can either delete or yank (copy) the lines.  You may cancel the menu by pressing ESC (the region remains highlighted).  You can cancel the selected region by pressing ESC again.
   
   If you click your left mouse button somewhere outside the selected region, both the menu and the selected region will be cancelled.
2. Make sure the selected region is cancelled (press ESC until it is gone).  Now press the right mouse button on the word "This" in the first line of the file.  If you do not have a mouse, then position the cursor somewhere in the word "This" and press the underscore ('_') key.  You will see the following menu appear:
   
   
   Figure 22. Selected Columns menu
   
   You may do a number of things from the popup menu:

   Open

   Open (edit) the file indicated by the highlighted (selected) text.  The selected text is treated like a file name, and an edit session for that file is started.  The file will be given the name of the highlighted text.

   
   Change

   Change the selected word.

   
   Delete

   Delete the selected word.

   
   Yank

   Yank (copy) the selected word.

   
   Fgrep

   Search the current directory for any files containing the selected word.  See the command line command FGREP in the chapter Editor Commands for more information.

   
   Tag

   Search your tags file for the selected word.  See the command line command TAG in the chapter Editor Commands for more information.

3. Make sure the selected region is cancelled.  Then add the following line to the start of the file (use the command mode key capital o ('O') to open a line above the first line):
   
        
        #include <c:\h\test.h>
   
   Now, try right mouse clicking on parts of the file name.  Notice how only individual pieces of the file name are selected.  Now, try double clicking the left mouse button somewhere on the file name.  The menu from the previous example will appear, selecting the entire file name as shown below:
   
   
   Figure 23. Double Click Selection
4. Try using CTRL_R to start a selection and then move around in your file.  Use the ESC key to cancel your selection.
5. Try using the shifted cursor keys to select lines.  Use the ESC key to cancel your selection.

Joining Text

Using Marks

1. Edit the file "atest" created in the Exercises section of Moving Around in a File.   Cursor to the letter 'i' in the word 'is' on the first line, and type
   
        
        ma
   
   This will set the mark 'a' at that position.
2. Page down twice.  Now, type
   
        
        `a
   
   You will be moved to the 'i' in the word 'is' on the first line.
3. Page down twice.  Now, type
   
        
        'a
   
   You will be moved to the first column of the first line.
4. Go to the bottom of the file.  Now, enter the command line command MARK as follows (remember to press colon (':') to bring up the command window)
   
        
        :mark z
5. Go to the top of the file (using CTRL_PAGEUP), and enter the command line command
   
        
        :'z
   
   This will return you to the last line of the file
6. Now, type the following command line command
   
        
        :'a
   
   This will take you back to line 1, where you set the mark 'a'.

Searching for Text

1. Edit the file "atest" created in the Exercises section of Moving Around in a File.   Press the forward slash ('/') key, and enter the string "this".  The word "This" on the first line will be highlighted, and your cursor will be on the 'T' (notice that the search is case insensitive).
2. Now press, the 'n' key.  You will move to the word "This" on the second line.
3. Press 'n' two more times.  You will now be on the word "This" on the fourth line.
4. Press 'N'.  You will move to the word "This" on the third line.
5. Press the question mark ('?') key, and enter the string "1".  You will move to the '1' on the first line.
6. Press 'n'.  The search will wrap around to the end of the file, and search backwards until the '1' on line 21 is encountered.
7. Press 'n'.  You will move to the '1' on line 19.
8. Press 'N'.  You will move back to the '1' on line 21.

Deleting, Copying, and Pasting Text

1. A movement command.  See the section Movement for a full description of all movement commands.   If a movement command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the movement command.
2. A search command:
   • / (forward slash)
   • ?  (question mark)
   • n
   • N
   
   See the section Searching for a full description of the searching commands.  If a search command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the search command.
3. The current selected (highlighted) region.  In this case, <oper> is the r key.
4. The same character as the command character.  This causes the command to operate on the current line.

1. Edit the file "atest" created in the Exercises section of Moving Around in a File.   Press 'dd'.  This will delete the first line of the file.
2. Press 'dw'.  This will delete the first word of the line.
3. Press 'd$'.  This will delete to the end of the line.
4. Press 'dj'.  This will delete the current line and the next line.
5. Press '2dw'.  This will delete the first two words of the current line:
   
        
        04 This is a test line.
   
   leaving you with
   
        
        is a test line.
6. Press '2w'.  This will move you to the letter 't' in "test".  Press capital p ('P').  The 2 words you deleted will be inserted before the 't':
   
        
        is a 04 This test line.
7. Type the following command mode keys:
   
        
        "add
   
   You will see the message:
   
        
        1 lines deleted into buffer a
8. Press 'p'.  Note that you inserted the two words you deleted before into the current line.
9. Type:
   
        
        "ap
   
   This will insert the contents of buffer 'a' (line line you deleted) after the current line.
10. Type the following:
    
         
         2"byy
    
    This will copy the next two lines into buffer "b".  You will see the message
    
         
         2 lines yanked into buffer b
11. Type:
    
         
         "bP
    
    This will insert the two lines you yanked before the current line.
12. Type
    
         
         3"zyw
    
    This will yank three words into copy buffer 'z'.
13. Make sure you are in command mode and enter the command line command:
    
         
         :q!
    
    to exit without saving your changes.

Altering Text

1. A movement command.  See the section Movement for a full description of all movement commands.   If a movement command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the movement command.
2. A search command:
   • / (forward slash)
   • ?  (question mark)
   • n
   • N
   
   See the section Searching for a full description of the searching commands.  If a search command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the search command.
3. The current selected (highlighted) region.  In this case, <oper> is the r key.
4. The same character as the command character.  This causes the command to operate on the current line.

1. Edit the file "atest" created in the Exercises section of Moving Around in a File.   Type 'cw'.  This first word "01" will be highlighted.  Press ESC.  The word will return to normal, and nothing will happen.
2. Type 'cw' again.  This time, type the following:
   
        
        This is new text.
   
   and press the ESC key to exit text insertion mode.  Your original line:
   
        
        01 This is a test line.
   
   will now be:
   
        
        This is new text.
        This is a test line.
3. Type '2cc'.  The first two lines will be deleted, and you will enter text insertion mode.  Type the following:
   
        
        This is more new text.
4. Return to command mode by pressing the ESC key.  Cursor to the letter 'i' in the word "is" and type 'c$'.  This will highlight from the letter 'i' to the end of line.  Enter the text:
   
        
        This is more new text.
5. Make sure you are in command mode and enter the command line command:
   
        
        :q!
   
   to exit without saving your changes.

Undo and Redo

1. Edit the file "atest" created in the Exercises section of Moving Around in a File.   Delete the first line, delete the second line, then delete the third line (one at a time).  Then, press 'u' in command mode.  The third line will come back.
2. Press 'u' again.  The second line will come back.
3. Enter the command line command:
   
        
        :undo
   
   The first line will come back.
4. Enter the command line command
   
        
        :undo
   
   again.  This undo command cannot do anything, since you have already undo all the changes to your file.  You will see the message
   
        
        No more undos
   
   appear.
5. Press the capital u ('U') key in command mode.  The first line will now disappear, as you are undoing your undo.
6. Press 'U' again.  The second line will disappear.
7. Enter the command line command (remember to press ':'):
   
        
        undo!
   
   The third line will disappear.
8. Enter the command line command:
   
        
        undo!
   
   You will see the message:
   
        
        No more undos

Repeating Edit Operations

1. Edit the file "atest" from the Exercises section of Moving Around in a File.   Delete the first two lines by typing the command mode command:
   
        
        2dd
   
   Now press the dot ('.') key.  Two more lines will be deleted.
2. Move to the first column of the first line.  Type the command mode command:
   
        
        m.
   
   This will start you in memorize mode.  Now, type:
   
        
        dwjdwj.
   
   This deletes the word on the first line, goes down to the next line, deletes another word on the next line, and goes down one more line.  The final dot ('.') terminates memorize mode.
3. Now, press dot ('.').  This will delete the first word of the next two lines.
4. Make sure you are in command mode and enter the command line command:
   
        
        :q!
   
   to exit without saving your changes.

Advanced Usage

The Substitute Command

1. Edit the file "atest" created in the Exercises section of Moving Around in a File in the previous chapter Intermediate Usage.  Enter the command line command (remember to press colon (':') to bring up the command window):
   
        
        :1,$s/This/This This/
   
   All lines will have the word "This" replaced with "This This".
2. Enter the command line command:
   
        
        :1,$s/This/Change/
   
   Notice that only the first occurrence of the word "This" was replaced.
3. Type the letter 'u' in command mode to undo the change you just made.  Then enter the command line command:
   
        
        :1,$s/This/Change/g
   
   Now all of the occurrences of "This" were replaced.
4. Make sure you are in command mode and enter the command line command:
   
        
        :q!
   
   to exit without saving your changes.

The Global Command

1. Edit the file "atest" created in the Exercises section of Moving Around in a File in the previous chapter Intermediate Usage.  Enter the command line command (remember to press colon (':') to bring up the command window):
   
        
        :g/This/delete
   
   Each line that contains the word "This" on it will have the DELETE command executed on it.
2. Press the 'u' key to undo the previous global command, then enter the command line command:
   
        
        :g/1/delete
   
   All lines with the character '1' in them will be deleted.
3. Press the 'u' key to undo the previous global command, then enter the command line command:
   
        
        :g!/1/delete
   
   All lines without the character '1' in them will be deleted.
4. Make sure you are in command mode and enter the command line command:
   
        
        :q!
   
   to exit without saving your changes.

Searching Files For Text

Mapping Keys

\<"key">

Any special key may be inserted for "key".  The angle brackets are required.  There are a number of pre-defined keys symbols that are recognized.  These are described in the Appendix Symbolic Keystrokes.

\e

Short form for the escape key (rather than \<ESC>).

\n

Short form for the enter key (rather than \<ENTER>).

\h

If a command line command is used in the sequence, and it follows the colon (':'), the command is not added to the history.  For example:
     
     :\hdate\n

will display the current date and time, but the command will not enter the command history.

\x

If a command line command is used in the sequence, then this stops the command window from opening.  This prevents the "flashing" of the command window as it is opened then closed.  For example:
     
     \x:date\n

will display the current date and time, but the command window will not be displayed.

1. Edit the file "atest" created in the Exercises section of Moving Around in a File in the previous chapter Intermediate Usage.  Enter the following command line command:
   
        
        :map F5 dd
   
   Now, whenever you press F5, a line will be deleted.  Try pressing F5 a few times to verify this.
2. Enter the command line command
   
        
        :unmap F5
   
   and try pressing F5 again.  It will no longer delete lines.
3. Enter the command line command
   
        
        :map F6 :date\n
   
   Press F6.  The time and date will be displayed in the message window.  You will notice that the command window flashes as you push F6.
4. Enter the command line command
   
        
        :map F6 \x:date\n
   
   Press F6.  The time and date will be displayed in the message window.  You will notice that the command window no longer flashes.
5. Bring up the command window ( press ':') and press cursor up.  You will notice that the date commands are in your history.  Now, enter the command line command:
   
        
        :map F6 \x:\hdate\n
   
   Press F6 a few times.  Bring up the command window again and cursor up.  You will see that the date commands did not get added to the history.
6. Enter the command line command:
   
        
        :map! F6 \edwi
   
   Whenever you press F6 in text insertion mode, you will exit insert mode (the \e is like pressing the ESC key), delete the current word, and then re-enter insert mode.  Try entering text insertion mode and pressing F6.
7. Exit text insertion mode and press F6.  You will notice that the date is still displayed, since the text insertion mode and command mode mappings for F6 are different.
8. Make sure you are in command mode and enter the command line command:
   
        
        :q!
   
   to exit without saving your changes.

The Open Watcom Vi Editor Environment

ed.cfg

The configuration script (contains editor setup)

keys.dat

Symbolic key names used by the command line commands MAP, MAPBASE, UNMAP, EXECUTE and KEYADD.

error.dat

Symbolic names for errors that can occur.  These are used for testing return codes in editor scripts.

1. The editor executable itself (if the files are bound).
2. The current directory.
3. Directories in the EDPATH environment variable.
4. Directories in the PATH environment variable.

Using Edbind

1. The current directory.
2. The directories in the environment variable EDPATH.
3. The directories in the environment variable PATH

Invoking the Open Watcom Vi Editor

-?

Displays the possible options, and what they do.

--

Starts Vi in stdio mode.  In this mode, Vi reads from standard in to get the file to edit.  When the file is written, the lines are written to standard out.  This is useful for including Vi in a pipe.

-d

Use default configuration.  Vi will not invoke ed.cfg when it starts up.

-i

Ignore lost files.  Vi will not let you start if there are files to be recovered.  This option will cause Vi to get rid of its checkpoint file, so that it will no longer complain about files that have not been recovered.

-n

This option will cause Vi to read a file as it needs the data, instead of reading the file all at once.  It is useful if you wish to look at the first lines of a huge file.  This option overrides any setting of readentirefile in your configuration.

-q

Causes Vi to run in quiet mode (no screen usage).  This is useful for using Vi as a batch script processor.

-r

Recover lost files, if there are any.  If this option is specified, files specified on the command line are ignored.

-v

Causes file edited to be a "view only" file.

-z

Causes Vi not to terminate a file read when finding a ctrl-z in a file.  This option is the same as the ignorectrlz setting.

+<n>

Cause Vi set the edit buffer to line <n> in the file edited.

-k "keys"

Execute the string keys as if they were typed from the keyboard.  These keystrokes are processed once Vi is initialized and all files have been read in.

-s <scr>

Runs the startup script <scr> once Vi is initialized and all files have been read in.  Up to 10 startup scripts may be specified.

-p "parms"

Specify the parameters parms for each startup script.  Multiple parms may be specified as long as they are in double quotes.  The parameters are associated with the most recently specified startup script.

-t <tag>

Edits the file containing the tag <tag>.

-c <cfg>

Runs the configuration script <cfg>, instead of the default ed.cfg.

Lost File Recovery

Modes

Text Insertion Mode

a

Starts appending (inserting) text after the current character in the edit buffer.

A

Starts appending (inserting) text after the last character on the current line in the edit buffer.

C

Changes text from the current position to the end of the current line.  Deletes the text, and enters text insertion mode.

<n>c<oper>

Change command.  Deletes the text in the range specified by <oper>, and enters text insertion mode.

g

Starts inserting or overstriking text at the current cursor position, depending on how you were adding text the last time you were in text insertion mode.

i

Starts inserting text at the current cursor position.

I

Starts inserting text before the first non-white space character on the current line.

o

Opens a line after the current line, and enters text insertion mode.

O

Opens a line before the current line, and enters text insertion mode.

R

Starts overstriking text at the current character in the edit buffer.

<n>s

Substitute <n> characters.  The first <n> characters from the current cursor position are deleted, and text insertion mode is entered.

<n>S

Substitute lines of text.  <n> lines from the current line forward are deleted, and text insertion mode is entered.

INS

Start inserting text at the current cursor position.

Special Keys

Arrow Keys

UP

Cursor up through the text.

DOWN

Cursor down through the text.

LEFT

Cursor left through the text.

RIGHT

Cursor right through the text.

Text Selection Keys

SHIFT_UP (shifted cursor up key)

Starts or continues selection and moves up to the previous line.  The new line is selected.

SHIFT_DOWN (shifted cursor down key)

Starts or continues selection and moves down to the next line.  The new line is selected.

SHIFT_LEFT (shifted cursor left key)

Starts or continues selection and moves left to the next character.  The new character is selected.

SHIFT_RIGHT (shifted cursor right key)

Starts or continues selection and moves right to the previous character.  The new character is selected.

CTRL_R

Starts text selection, if no text is selected.  The current character is highlighted.  If a region is already selected, then this cancels the selected region.

ESC

Cancels the current selection.

CTRL_PAGEUP

Moves to the first non-white space character on the first line of the current edit buffer.

CTRL_PAGEDOWN

Moves to the last character on the last line of the current edit buffer.

SHIFT_DEL

Deletes the currently selected region into the active copy buffer.

SHIFT_INS

Pastes the active copy buffer into the text after the current position.

SHIFT_TAB

Move back to the previous tab stop, deleting the characters before the cursor.

CTRL_DEL (ctrl-delete)

Delete the current line into the active copy buffer.

CTRL_INS (ctrl-insert)

Pastes the active copy buffer into the text before the current position.

CTRL_D

Move backwards shiftwidth spaces, deleting the characters before the cursor.  A shiftwidth is a number that you may set, its default value is 4.

CTRL_T

Insert shiftwidth spaces.  If realtabs is set, then once tabamount spaces are inserted, the spaces are replaced with a tab character.

CTRL_V

The next key typed is inserted directly, without any interpretation.

CTRL_Q

The next key typed is inserted directly, without any interpretation.

BS

Backspace one on the current line, deleting the character before the cursor.

DEL

Delete the character under the cursor.  If you are at the end of the line, DEL has the same effect as pressing BS.

ENTER

Start a new line.

END

Move to the end of the current line.

HOME

Move to the start of the current line.

INS

Toggles between insert and overstrike mode.

PAGEUP

Move up one page in the text.

PAGEDOWN

Move up down one page in the text.

TAB

Move forward to the next tab stop.  If realtabs is set, a tab character is inserted into the file.  Otherwise, spaces are inserted.

Command Mode

Movement

<n>| (or bar)

Move to the column number specified by <n>.

Example(s):

|

Move to column 1 of the current line.

15|

Move to column 15 of the current line.

`<?> (back quote)

Moves to the mark position (line and column) specified by <?> See the section Marks for more information.
Also see the command line command MARK.

Example(s):

`a

Move to the line and column with mark a.

'<?> (front quote)

Move to the start of line with the mark <?>.  See the section Marks for more information.
Also see the command line command MARK.

Example(s):

'z

Move to the start of the line with mark z.

% (percent)

Moves to matching brace or other defined match string.  Defaults are "{","}" and "(",")".   For example, by pressing % while on the first opening brace ('(') on the line:
     
     if( ( i=foo( x ) ) ) return;

moves the cursor to the last closing brace (')') on the line.  It is possible to set arbitrary pairs of match strings using the command line command MATCH.

$ (dollar)

Moves the cursor to the last character on the current line.

^ (caret)

Moves the cursor to the first non-whitespace character on the current line.

; (semi-colon)

Repeats the last f, F, t or T movement commands.

, (comma)

Repeats the last f, F, t or T movement commands, but the search is done in the opposite direction.
If the last movement command was an F then an f movement command is executed.  If the last movement command was a t then a T movement command is executed.

Similarly, if the last movement command was an f then an F movement command is executed.   If the last movement command was a t then a T movement command is executed.

<n>- (dash)

Moves the cursor to the start of the previous line.  If a repeat count <n> is specified, then you are moved up <n> lines.

<n>+ (plus)

Moves the cursor to the start of the next line.  If a repeat count <n> is specified, then you are moved down <n> lines.

0

Moves the cursor the first character of the current line.

CTRL_PAGEUP

Moves to the first non-white space character on the first line of the current edit buffer.

CTRL_PAGEDOWN

Moves to the last character on the last line of the current edit buffer.

<n>DOWN

Move the cursor down one line.  <n> is specified, the cursor moves down <n> lines.

END

Moves the cursor to the last character on the current line.

<n>ENTER

Moves the cursor to the start of the next line.  If a repeat count <n> is specified, then the cursor is moved down <n> lines.

HOME

Moves the cursor the first character of the current line.

<n>LEFT

Move the cursor left one character.  If <n> is specified, the cursor moves left <n> characters.

<n>PAGEDOWN

Moves forwards one page.  If a repeat count <n> is specified, then you are moved ahead <n> pages.  The number of lines of context maintained is controlled by the pagelinesexposed setting.

<n>PAGEUP

Moves backwards one page.  If a repeat count <n> is specified, then you are moved back <n> pages.  The number of lines of context maintained is controlled by the pagelinesexposed setting.

<n>RIGHT

Move the cursor right one character.  If <n> is specified, the cursor moves right <n> characters.

<n>SHIFT_TAB

Moves the cursor left by tabamount characters.  A repeat count <n> multiplies this.

<n>TAB

Moves the cursor right by tabamount characters.  A repeat count <n> multiplies this.

<n>UP

Move the cursor up one line.  <n> is specified, the cursor moves up <n> lines.

<n>CTRL_B

Moves backwards one page.  If a repeat count <n> is specified, then you are moved back <n> pages.  The number of lines of context maintained is controlled by the pagelinesexposed setting.

<n>CTRL_D

Move down a certain number of lines.  The default is to move down half a page.  If the repeat count <n> is specified, then that becomes the number of lines moved from then on.  Also see the CTRL_U key.

<n>CTRL_E

Expose the line below the last line in the current edit window, leaving the cursor on the same line if possible.  If a repeat count <n> is specified, then that many lines are exposed.

<n>CTRL_F

Moves forwards one page.  If a repeat count <n> is specified, then you are moved ahead <n> pages.  The number of lines of context maintained is controlled by the pagelinesexposed setting.

<n>CTRL_N

Move the cursor to the next line.  If a repeat count <n> is specified, then you are moved down <n> lines.

<n>CTRL_P

Move the cursor to the previous line.  If a repeat count <n> is specified, then you are moved up <n> lines.

<n>CTRL_U

Move up a certain number of lines.  The default is to move up half a page.  If the repeat count <n> is specified, then that becomes the number of lines moved from then on.  Also see the CTRL_D key.

<n>CTRL_Y

Expose the line above the first line in the current edit window, leaving the cursor on the same line if possible.  If a repeat count <n> is specified, then that many lines are exposed.

<n>B

Moves the cursor backwards to the start of previous space delimited word on the current line.

Example(s):

B

If the cursor was on the right parenthesis (')') of

     
     x = foo(abc) + 3;

then the cursor moves to the f in foo.

2B

If the cursor was on the right parenthesis (')') of

     
     x = foo(abc) + 3;

then the cursor moves to the = sign.

<n>b

Moves the cursor backwards to the start of the previous word on the current line.  A word is defined using the word setting.  The default is that any characters in the set ( _, a-z, A-Z, 0-9 ) are considered part of a word, and all other characters (except for whitespace) are delimiters.  Groups of delimiters are considered to be a word as well.

Example(s):

b

If the cursor was on the right parenthesis (')') of

     
     x = foo(abc) + 3;

then the cursor moves to the letter a in abc.

2b

If the cursor was on the right parenthesis (')') of

     
     x = foo(abc) + 3;

then the cursor moves to left parenthesis (.

<n>E

Moves the cursor to the end of the next space delimited word on the current line.

Example(s):

E

If the cursor was on the letter f in

     
     x = foo(abc) + 3;

then the cursor moves to the right parenthesis ).

2E

If the cursor was on the letter f in

     
     x = foo(abc) + 3;

then the cursor moves to the + sign.

<n>e

Moves the cursor to the end of the next word on the current line.  A word is defined using the word setting.  The default is that any characters in the set ( _, a-z, A-Z, 0-9 ) are considered part of a word, and all other characters (except for whitespace) are delimiters.  Groups of delimiters are considered to be a word as well.

Example(s):

e

If the cursor was on the letter f in

     
     x = foo(abc) + 3;

then the cursor moves to the second letter o in foo.

2e

If the cursor was on the letter f in

     
     x = foo(abc) + 3;

then the cursor moves to the left parenthesis (.

<n>F<?>

Moves the cursor backwards from its current position to the character <?> on the current line.  If a repeat count <n> is specified, then the nth occurrence of the character <?> is moved to.

Example(s):

F+

If the cursor is on the semi-colon (';') in

     
     x = foo(abc) + 3;

The the cursor is moved to the + sign.

2Fo

If the cursor is on the semi-colon (';') in

     
     x = foo(abc) + 3;

The the cursor is moved to the first o in foo.

<n>f<?>

Moves the cursor forwards from its current position to the character <?> on the current line.  If a repeat count <n> is specified, then the nth occurrence of the character <?> is moved to.

Example(s):

f+

If the cursor is on the character x in

     
     x = foo(abc) + 3;

The the cursor is moved to the + sign.

2fo

If the cursor is on the character x in

     
     x = foo(abc) + 3;

The the cursor is moved to the second o in foo.

<n>G

Goes to the line specified by the repeat count <n>.  If no repeat count is specified, you move the the last line in the current edit buffer.

Example(s):

100G

Moves to line 100 in the current edit buffer.

G

Moves to the last line in the current edit buffer.

<n>h

Move the cursor left one character.  If <n> is specified, the cursor moves left <n> characters.

<n>H

Moves to the line at the top of the current file window.  If a repeat count is specified, then you are moved to that line relative to the top of the current file window.

Example(s):

2H

Moves to the second line from the top of the current file window.

H

Moves to the line at the top of the current file window.

<n>j

Move the cursor down one line.  <n> is specified, the cursor moves down <n> lines.

<n>k

Move the cursor up one line.  <n> is specified, the cursor moves up <n> lines.

<n>L

Moves to the line at the bottom of the current file window.  If a repeat count is specified, then you are moved to that line relative from the bottom of the current file window.

Example(s):

2L

Moves to the second line from the bottom of the current file window.

L

Moves to the line at the bottom of the current file window.

<n>l

Move the cursor right one character.  If <n> is specified, the cursor moves right <n> characters.

M

Moves the cursor to the line in the middle of the current file window.

<n>T<?>

Moves the cursor backwards from its current position to the character after the character <?> on the current line.  If a repeat count <n> is specified, then the the character after the nth occurrence of the character <?> is moved to.

Example(s):

T+

If the cursor is on the semi-colon (';') in

     
     x = foo(abc) + 3;

The the cursor is moved to the space after the + sign.

2To

If the cursor is on the semi-colon (';') in

     
     x = foo(abc) + 3;

The the cursor is moved to the second o in foo.

<n>t<?>

Moves the cursor forwards from its current position to the character before the character <?> on the current line.  If a repeat count <n> is specified, then the the character before the nth occurrence of the character <?> is moved to.

Example(s):

t+
If the cursor is on the character x in

     
     x = foo(abc) + 3;

The the cursor is moved to the space before + sign.

2to

If the cursor is on the character x in

     
     x = foo(abc) + 3;

The the cursor is moved to the first o in foo.

<n>W

Moves the cursor forward to the start of the next space delimited word on the current line.

Example(s):

W

If the cursor was on the letter f in

     
     x = foo(abc) + 3;

then the cursor moves to the + sign.

2W

If the cursor was on the letter f in

     
     x = foo(abc) + 3;

then the cursor moves to the number 3.

<n>w

Moves the cursor forward to the start of the next word on the current line.  A word is defined using the word setting.  The default is that any characters in the set ( _, a-z, A-Z, 0-9 ) are considered part of a word, and all other characters (except for whitespace) are delimiters.  Groups of delimiters are considered to be a word as well.

Example(s):

w

If the cursor was on the letter f in

     
     x = foo(abc) + 3;

then the cursor moves to the left parenthesis (.

2w

If the cursor was on the letter f in

     
     x = foo(abc) + 3;

then the cursor moves to the letter a in abc.

Undoing Changes

u

Undo last change.

U

Redo last undo.

Marks

m<?>

Allows the setting of mark <?>.
If <?> is an exclamation mark ('!') instead of a letter, it clears all marks on the current line.

If <?> is a dot ('.') instead of a letter, it puts Vi in memorize mode.  All characters typed are memorized until another dot ('.') is pressed.  The memorized keystrokes may be repeated by pressing a dot ('.').  See the dot ('.') command mode command later in this chapter.

If <?> is an equals sign ('=') instead of a letter, it puts Vi in alternate memorize mode.   All characters typed are memorized until another equals sign ('=') is pressed.  The memorized keystrokes may be repeated by pressing an equals sign ('=').  See the equals sign ('=') command mode command later in this chapter.

Also see the command line command MARK.

Example(s):

ma

Sets the mark a at the current cursor position

m.

Enter memorize mode

m!

Clear any marks set on the current line.

'<?> (front quote)

Move to the start of the line with the mark <?>.

Example(s):

'a

Moves to the first column of the line with mark a.

''

Moves to the first column of line of the last position before the last non-linear movement command was issued.

`<?> (back quote)

Move to the position in the edit buffer with the mark <?>.

Example(s):

`a

Moves to the column and line with mark a.

``

Moves to the last position before the last non-linear movement command was issued.

Copy Buffers

<"?><n>d<oper>

Deletes text in various ways.

<n>DEL

Deletes the character at the current cursor position.

D

Deletes text from the current cursor position to the end of the current line.

<n>x

Deletes the character at the current cursor position.

<n>X

Deletes the character before the current cursor position.

<"?><n>y<oper>

Yanks (copies) text in various ways.

<n>Y

Yanks (copies) the current line.

<"?>SHIFT_INS

Puts (pastes) the contents of the active copy buffer after the cursor position in the current edit buffer.
Also see the command line command PUT.

Example(s):

"aSHIFT_INS

Copy the data in the named buffer a after the current position in the file.

SHIFT_INS

Copy the data in the active copy buffer after the current position in the file.

<"?>p

Puts (pastes) the contents of the active copy buffer after the cursor position in the current edit buffer.
Also see the command line command PUT.

Example(s):

p

Copies the data in the active copy buffer after the current position in the file.

"5p

Copies the data in the numbered buffer 5 after the current position in the file.

<"?>P

Puts (pastes) the contents of the active copy buffer before the cursor position in the current edit buffer.
Also see the command line command PUT.

Example(s):

"aP

Copy the data in the named buffer a before the current position in the file.

P

Copy the data in the active copy buffer before the current position in the file.

Searching

/ (forward slash)

Enter a regular expression to search for from current position forwards.

?  (question mark)

Enter a regular expression to search for from current position backwards.

n

Repeat last search command, in the direction of the last search.

N

Repeat last search command, in the opposite direction of the last search.

Special Keys In The Search String Window

CTRL_V

Insert next keystroke directly; do not process as a special character.

CTRL_Q

Insert next keystroke directly; do not process as a special character.

CTRL_O

Insert the current input string after current line in the edit buffer.

ALT_O

Insert the current input string before current line in the edit buffer.

ALT_L

Adds the current line in the current edit buffer, from the current column to the end of the line, to the input string.

CTRL_E

Adds the current space delimited word in the current edit buffer to the input string.

CTRL_L

Adds the current line in the current edit buffer to the input string.

CTRL_R

Adds the currently selected column range in the current edit buffer to the input string.

CTRL_W

Adds the current word in the current edit buffer to the input string.

CTRL_INS

Restores last thing typed in the input window (one level undo).

UP

Scroll backwards through the history.

DOWN

Scroll forwards through the history.

ALT_TAB

Command completion.  Looks backwards through the history for first item starting with what is already entered.  Subsequent presses of ALT_TAB get the 2nd last matching item, and so on.

RIGHT

Move cursor right through input string.

LEFT

Move cursor left through input string.

CTRL_END

Delete to end of the input string.

END

Move to end of the input string.

HOME

Move to start of the input string.

INSERT

Toggle between insertion and overstrike of text.

BS

Backspace in the input string, deleting the previous character.

DELETE

Delete current character.

ENTER

Do the search.

ESC

Cancel the search request.

TAB

Try to complete the file name based on the current string.
The first match is completed, and a window with possible choices is displayed.  Subsequent presses of TAB will scroll forward through the list of possible matches, and pressing SHIFT_TAB will scroll backwards through the list of possible matches.   Cursor keys may also be used, and so may the mouse.

Figure 27. File Name Completion Window

Inserting Text

INS

Starts inserting text before the current character in the edit buffer.

a

Starts appending (inserting) text after the current character in the edit buffer.

A

Starts appending (inserting) text after the last character on the current line in the edit buffer.

g

Enters text insertion mode at the current cursor position.  This sets you up in overstrike or insert mode, depending on the mode you were in last time you were in text insertion mode.
This key is useful to KEYADD in a script, to return to the exact same type of text insertion mode the user was in before leaving text insertion mode.

i

Starts inserting text before the current character in the edit buffer.

I

Starts inserting text before the first non-white space character in the edit buffer.

o

Opens a line after the current line, and enters text insertion mode.

O

Opens a line before the current line, and enters text insertion mode.

Replacing Text

g

Enters text insertion mode at the current cursor position.  This sets you up in overstrike or insert mode, depending on the mode you were in last time you were in text insertion mode.
This key is useful to KEYADD in a script, to return to the exact same type of text insertion mode the user was in before leaving text insertion mode.

R

Starts overstriking text at the current character in the edit buffer.  Once you are overstriking text, you can toggle back and forth between overstrike and insert using the INS key.  You exit text insertion mode by pressing the ESC key.  See the previous section, Text Insertion Mode, for more information on manipulating text in text insertion mode.

<n>r<?>

Replaces the current character with the next character typed, <?>.  If a repeat count is specified, then the next <n> characters are replaced with the character <?>.

Example(s):

ra

Replaces the current character with the letter a.

10rZ

Replaces the next 10 characters with the letter Z.

Deleting Text

<"?>D

Deletes the characters from the current position to the end of line.

Example(s):

"aD

Deletes characters from current position to the end of line into the named buffer a.

<n><"?>X

Delete the character before the current cursor position.

Example(s):

X

Delete the previous character.

10X

Delete the 10 previous characters.

"z5X

Delete the 5 previous characters into the named buffer z.

<n><"?>x

Delete the character at the current cursor position.

Example(s):

x

Delete the current character.

3x

Delete the next 3 characters.

"217x

Delete the next 17 characters into the numbered buffer 2.

<n><"?>DEL

Delete the character at the current cursor position.  This behaves the same as the command mode command x.

Example(s):

DEL

Delete the current character.

12DEL

Delete the next 12 characters.

"a5DEL

Delete the next 5 characters into the named buffer a.

1. A movement command.  See the section Movement for a full description of all movement commands.   If a movement command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the movement command.
2. A search command:
   • / (forward slash)
   • ?  (question mark)
   • n
   • N
   
   See the section Searching for a full description of the searching commands.  If a search command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the search command.
3. The current selected (highlighted) region.  In this case, <oper> is the r key.
4. The same character as the command character.  This causes the command to operate on the current line.

<n><"?>d<oper>

Delete text from the current position in the file to the position specified by <oper>.  A copy of the text is placed into the specified copy buffer <"?>.  If no buffer is specified, then the text is placed into the active buffer.  A repeat count <n> may precede the command, this causes <n> units of the <oper> command to be deleted.
<oper> may be specified as d, which causes a single line to be deleted.

Also see the command line command DELETE.

Example(s):

dr

Deletes the current selected (highlighted) region in the edit buffer.  A copy is placed into the active copy buffer.

"zdd

Deletes the current line.  A copy is placed into the named copy buffer z.

95dd

Deletes 95 lines, starting at the current.  A copy of the lines is placed into the active copy buffer.

"cdfa

Deletes the characters from the current column up to and including the first a on the current line.  A copy of the text is placed in the named buffer c.

"5d'a

Deletes the lines from the current line to the line with mark m into the numbered buffer 5.

dG

Deletes all lines from the current line to the end of the current edit buffer.

Copying Text

<n>Y

Yank (copy) the current line.  If a repeat count <n> is specified, then <n> lines are copied.
This command is the same as typing yy.

1. A movement command.  See the section Movement for a full description of all movement commands.   If a movement command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the movement command.
2. A search command:
   • / (forward slash)
   • ?  (question mark)
   • n
   • N
   
   See the section Searching for a full description of the searching commands.  If a search command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the search command.
3. The current selected (highlighted) region.  In this case, <oper> is the r key.
4. The same character as the command character.  This causes the command to operate on the current line.

<n><"?>y<oper>

Yanks (copies) text from the current position in the file to the position specified by <oper>.  Text is placed into the specified copy buffer <"?>.  If no buffer is specified, then the text is placed into the active buffer.  A repeat count <n> may precede the command, this causes <n> units of the <oper> command to be copied.
<oper> may be specified as y, which causes a single line to be yanked.

Also see the command line command DELETE.

Example(s):

yy

Yanks (copies) the current line into the active copy buffer.

10yy

Copies 10 lines, starting at the current, into the active copy buffer.

y$

Copies the characters from the current column to the end of the current line into the active copy buffer.

"ay'm

Yanks the lines from the current line to the line with mark m into the named buffer a.

y/foo

Copies:

• the part of the current line from the current position to the end of the line
• all lines between the current line and the first line containing the string foo
• the part of the line containing foo from the start of the line to the first letter in the string foo

Changing Text

C

This command changes the characters on the current line from the current character to the end of the line.  The character range is highlighted, and once a character is typed, the highlighted text is deleted, and text insertion mode is entered.
This command is the same as typing c$.

<n>S

This command substitutes the current line with text.  The text on the current line is deleted, and text insertion mode is entered.  If a repeat count <n> is specified, then <n> lines are deleted.
This command is the same as typing cc.

<n>s

This command substitutes the current character with text.  If <n> is specified, then <n> characters are substituted.
This command is the same as typing cl, cRIGHT, or cSPACE.

1. A movement command.  See the section Movement for a full description of all movement commands.   If a movement command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the movement command.
2. A search command:
   • / (forward slash)
   • ?  (question mark)
   • n
   • N
   
   See the section Searching for a full description of the searching commands.  If a search command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the search command.
3. The current selected (highlighted) region.  In this case, <oper> is the r key.
4. The same character as the command character.  This causes the command to operate on the current line.

<n>c<oper>

Change text from the current position in the file to the position specified by <oper>.  A repeat count <n> may precede the command, this causes <n> units of the <oper> command to be changed.
<oper> may be specified as c, which causes a single line to be changed.

Example(s):

cr

Changes the current selected (highlighted) region in the edit buffer.

cc

Change the current line.  The current line is deleted, and text insertion mode is entered.

95cc

Changes 95 lines, starting at the current.  The lines are deleted, and text insertion mode is entered.

cw

Change the current word.  The current word is highlighted, and once a character other than ESC is typed, the word is deleted and text insertion mode is entered.

c$

Changes from the current column to the end of the current line.  The column range is highlighted, and once a character other than ESC is typed, the column range is deleted and text insertion mode is entered.

2cfa

Changes from the current column to the second letter a on the current line.  The column range is highlighted, and once a character other than ESC is typed, the column range is deleted and text insertion mode is entered.

Shifting Text

1. A movement command.  See the section Movement for a full description of all movement commands.   If a movement command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the movement command.
2. A search command:
   • / (forward slash)
   • ?  (question mark)
   • n
   • N
   
   See the section Searching for a full description of the searching commands.  If a search command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the search command.
3. The current selected (highlighted) region.  In this case, <oper> is the r key.
4. The same character as the command character.  This causes the command to operate on the current line.

<n>><oper> (right angle bracket)

This is the shift right command.  It shifts the specified lines to the right shiftwidth spaces, inserting necessary leading tabs if realtabs is specified.
A repeat count <n> may precede the command, this causes <n> units of the <oper> command to be shifted to the right.

<oper> may be specified as >, which causes a single line to be shifted to the right.

Also see the command line command >.

Example(s):

10>>

Shifts the current line and the next 9 lines to the right shiftwidth spaces.

>'a

Shifts all lines from the current line to the line with mark a to the right shiftwidth spaces.

>r

Shifts all lines in the selected (highlighted) region to the right shiftwidth spaces.

<n><<oper> (left angle bracket)

This is the shift left command.  It shifts the specified lines to the left shiftwidth spaces.
A repeat count <n> may precede the command, this causes <n> units of the <oper> command to be shifted to the left shiftwidth spaces.

<oper> may be specified as <, which causes a single line to be shifted to the left shiftwidth spaces.

Also see the command line command <.

Example(s):

<<

Shifts the current line to the left shiftwidth spaces.

<G

Shifts all lines from the current line to the last line in the edit buffer to the left shiftwidth spaces.

10<j

Shifts the current line and the next 10 lines to the left shiftwidth spaces.

Case Toggling

1. A movement command.  See the section Movement for a full description of all movement commands.   If a movement command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the movement command.
2. A search command:
   • / (forward slash)
   • ?  (question mark)
   • n
   • N
   
   See the section Searching for a full description of the searching commands.  If a search command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the search command.
3. The current selected (highlighted) region.  In this case, <oper> is the r key.
4. The same character as the command character.  This causes the command to operate on the current line.

<n>~<oper> (tilde)

This is the case toggle command.  This command only works if the togglecaselikevi setting is not turned on.  If togglecaselikevi is set, then pressing ~ only changes the case of the current character, and advances the cursor to the next character.
However, if togglecaselikevi is not set, then this command toggles the case of the characters over the range specified by <oper>

A repeat count <n> may precede the command, this causes <n> units of the <oper> command to be case toggled.

<oper> may be specified as ~, which causes a single line to be have its case toggled.

Example(s):

~r

Toggles the case of the currently selected (highlighted) range.

~$

Toggles the case of all characters from the current column of the current line to the last character of the current line.

~w

Toggles the case of the current word.

10~~

Toggles the case of the current line and the 9 lines following.

Filters

1. A movement command.  See the section Movement for a full description of all movement commands.   If a movement command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the movement command.
2. A search command:
   • / (forward slash)
   • ?  (question mark)
   • n
   • N
   
   See the section Searching for a full description of the searching commands.  If a search command is specified, then the range that the command will act on is from the current position to the position that would be achieved by using the search command.
3. The current selected (highlighted) region.  In this case, <oper> is the r key.
4. The same character as the command character.  This causes the command to operate on the current line.

<n>!<oper> (exclamation mark)

Filter text.  The line range specified by <oper> are run through a specified filter.  A repeat count <n> may precede the command, this causes <n> units of the <oper> command to be run through the filter.
<oper> may be specified as !, which causes a single line to be run through the filter.

The lines specified are run through a specified system command (filter).  Once the filter range has been specified, a window is displayed, prompting for a system command:


Figure 28. Filter System Command Prompt

The system command must take input from standard in and put its output to standard out.  The lines specified are replaced with the output of the the command.

There is a filter command history in the filter command prompt, the size of which is controlled with the maxfilterhistory setting.

Also see the command line command !.

Example(s):

!r

Runs the current selected (highlighted) region in the edit buffer through a specified filter.

!!

Runs the current line through a specified filter

!G

Runs all lines from the current line to the end of the edit buffer through a specified filter.

Text Selection

CTRL_R

Starts text selection, if no text is selected.  The current character is highlighted.
If region is already selected, then cancel the selected region.

<n>SHIFT_UP

Starts selection (if not already started) and moves up to the previous line.  The previous line and the current line are selected.  If a repeat count <n> is specified, then the cursor moves up <n> lines, and all the lines between the starting and ending position are selected.

<n>SHIFT_DOWN

Starts selection (if not already started) and moves down to the next line.  The next line and the current line are selected.   If a repeat count <n> is specified, then the cursor moves down <n> lines, and all the lines between the starting and ending position are selected.

<n>SHIFT_LEFT

Starts selection (if not already started) and move left to the previous character.  The current character and the previous character are selected.  If a repeat count <n> is specified, then the cursor moves left <n> characters, and all the characters between the starting and ending position are selected.

<n>SHIFT_RIGHT

Starts selection (if not already started) and move right to the next character.  The current character and the next character are selected.  If a repeat count <n> is specified, then the cursor moves right <n> characters, and all the characters between the starting and ending position are selected.

<"?>SHIFT_DEL

Deletes the currently selected region.  If the copy buffer <"?> is specified, the region is copied into that buffer, otherwise the data is copied into the active copy buffer.

_ (underscore)

Simulates the right mouse being clicked at the current cursor position.  If a region is not selected, then the current word will be selected.  The word is defined using the command line command word.

Miscellaneous Keys

CTRL_C

Exits the editor if no files have been modified.  If files have been modified, a prompt is displayed asking you to verify that you really want to discard the modified file(s).  If you do not respond with a 'y', then the command is cancelled.
Also see the command line command QUITALL.

CTRL_G

Display information about the current file in the edit window.  The information includes:

• the file name.
• a special indicator if the file is read-only.
• a special indicator if the file is view-only.
• a special indicator if the file has been modified.
• the current line number, and the last line number.
• The percentage of the way through the file.

Some sample results are:

     
     "test.c" [modified] line 5 of 100  -- 5% --
     "..\c\file.c" [read only] line 100 of 100  -- 100% --

     "\autoexec.bat" line 1 of 100  -- 1% --

CTRL_L

Redraws the current screen.

CTRL_V

Displays the current version of Vi in the message window.
Also see the command line command VERSION.

CTRL_X

Displays the hex value (and the decimal value) of the current character.  A sample of the output in the message window is:
     
     Char 'e': 0x65 (101)

CTRL_] (control right square bracket)

Go to the tag given by the current word.  The word is defined using the command line command word.
Also see the command line command TAG.
See the appendix CTAGS for more information.

ALT_W

Activates the current edit window's menu.  This menu is defined using the windowgadget MENU.   See the chapter Windows and Menus for more information on setting this menu.

ALT_X

Insert a character, at the current cursor position.  When ALT_X is pressed, a prompt is displayed:

Figure 30. Character Insertion Prompt

Enter either a decimal or a hex number.  That character will be inserted directly into the edit buffer.

:  (colon)

Allows entry of a command line.  See the chapter Editor Commands for full details on command line commands.

@<?> (at sign)

This command executes the copy buffer <?>.  Vi behaves as if the contents of the buffer were being typed at the keyboard.

<n>J

Joins the next line to the current line.  If a repeat count <n> is specified, the next <n> lines are joined to the current line.  (lines are concatenated one after another).
Also see the command line command JOIN.

Example(s):

J

Joins the next line to the current line.

3J

Joins the next 3 lines to the current line.

Q

Enters EX mode.  EX mode is a line-oriented mode of Vi.  To exit EX mode, use the VISUAL command.

Z<Z>

Used when you are finished with the current edit buffer.  If the current edit buffer has been modified, it is saved.

Example(s):

ZZ

Finished with current edit buffer.

<n>z<?>

Reorients the current screen position.  The current line moves as follows, depending on the value of <?>:

ENTER

Moves the current line to the top of the screen.

.  (dot)

Moves the current line to the center of the screen.

- (dash)

Moves the current line to the bottom of the screen.

If a repeat count <n> is specified, then <n> is made the current line.

Example(s):

z-

Move the current line to the bottom of the screen.

100zENTER

Makes line 100 the current line, and puts line 100 at the top of the screen.

25z.

Makes line 25 the current line, and puts line 25 at the center of the screen.

F1

Move forward through the file list to the next file.
Also see the command line command NEXT.

F2

Move backwards through the file list to the previous file.
Also see the command line command PREV.

F11

Push the current file and position.  If you press F12, you will be restored to this position.  These positions are stacked up, up to a maximum of maxpush.
Also see the command line command PUSH.

F12

Restore the last pushed file and position.
Also see the command line command POP.

.  (dot)

Repeat the last command mode command that changed text in the edit buffer.  It is also possible to memorize more than just one command for '.' by using memorize mode:

1. Type "m." (Vi enters memorize mode).
2. Enter keystrokes.
3. Type "."

Now, whenever you press dot ('.'), all the entered keystrokes will be executed.

= (equals sign)

Performs the last alternate memorized command sequence.  The alternate memorize mode is used as follows:

1. Type "m=" (Vi enters alternate memorize mode).
2. Enter keystrokes.
3. Type "="

Now, whenever you press the equals sign ('='), all the entered keystrokes will be executed as if you typed them again from the keyboard.

This memorized keystroke sequence will last until you memorize another, unlike using "m.".

ALT_M

Display current memory state.  Shows the total amount of memory, the amount of memory for use by Vi, and how much extended memory and/or disk space is available.

Editor Commands

Special Keys In The Command Window

CTRL_V

Insert next keystroke directly; do not process as a special character.

CTRL_Q

Insert next keystroke directly; do not process as a special character.

CTRL_O

Insert the current input string after current line in the edit buffer.

ALT_O

Insert the current input string before current line in the edit buffer.

ALT_L

Adds the current line in the current edit buffer, from the current column to the end of the line, to the input string.

CTRL_E

Adds the current space delimited word in the current edit buffer to the input string.

CTRL_L

Adds the current line in the current edit buffer to the input string.

CTRL_R

Adds the currently selected column range in the current edit buffer to the input string.

CTRL_W

Adds the current word in the current edit buffer to the input string.

CTRL_INS

Restores last thing typed in the input window (one level undo).

UP

Scroll backwards through the history.

DOWN

Scroll forwards through the history.

ALT_TAB

Command completion.  Looks backwards through the history for first item starting with what is already entered.  Subsequent presses of ALT_TAB get the 2nd last matching item, and so on.

RIGHT

Move cursor right through input string.

LEFT

Move cursor left through input string.

CTRL_END

Delete to end of the input string.

END

Move to end of the input string.

HOME

Move to start of the input string.

INSERT

Toggle between insertion and overstrike of text.

BS

Backspace in the input string, deleting the previous character.

DELETE

Delete current character.

ENTER

Process the command.

ESC

Cancel the command.

TAB

Try to complete the file name based on the current string.
The first match is completed, and a window with possible choices is displayed.  Subsequent presses of TAB will scroll forward through the list of possible matches, and pressing SHIFT_TAB will scroll backwards through the list of possible matches.   Cursor keys may also be used, and so may the mouse.

Figure 32. File Name Completion Window

Line Addresses

5+7

Indicates line 13

100-5

indicates line 95

99-11+6

indicates line 94

.  (dot)

Represents the current line number.

$ (dollar)

Represents the last line number.

% (percent)

Represents the address range 1,$ (the entire file)

# (pound)

Represents the current selected region

'a (front quote)

Indicates the line with the mark 'a' set; marks 'a' through 'z' may be used.

/regexp/

Indicates the first line following the current line that has the regular expression regexp.  If regexp is not specified, then the last regular expression search is used.

?regexp?

Indicates the first line previous to the current line that has the regular expression regexp.  If regexp is not specified, then the last regular expression search is used.

Line Address Examples

.-5

5 lines before the current line

1,5

lines 1 to 5.

.-10,.+10

10 lines before the current line to 10 lines past the current line

$-5

5 lines before the last line in the file

%

all lines

#

all lines in the currently selected region

'a,.

line with mark 'a' to current line.

/foo/

the first line after the current line containing 'foo'

'z+5,$-10

5 lines past line with mark 'z' to 10 lines before the end of the file.

/foo/+5,/bar/-1

5 lines past line next line containing 'foo' to 1 line before the line containing 'bar'.

Commands

>

Syntax:

<line_range> >

Description:

This command shifts the specified line range <line_range> to the right shiftwidth spaces, inserting necessary leading tabs if realtabs is specified.

Example(s):

1,.  >

Shifts from first line to current line to the right shiftwidth spaces.

See Also:

<

<

Syntax:

<line_range> <

Description:

This command shifts the specified line range <line_range> to the left shiftwidth spaces.

Example(s):

.,$ <

Shifts entire file shiftwidth spaces to the left.

See Also:

>

!

Syntax:

<line_range> !  <cmd>

Description:

If <line_range> is specified, then the lines are run through the specified system command <cmd> (the command must get its input from standard in and write its output to standard out) and replaces the lines with the output of the command.
If no range is specified, then the system command <cmd> is run.  If <cmd> is not specified, then an operating system shell is started.

The global variable %(Sysrc) contains the return code from the last system command, and %(Syserr) contains the errno value.

Example(s):

1,$ !  sort

Takes all lines in the current edit buffer and runs them through the sort command.  The lines are then replaced with the output of the sort command.

!  dir

Executes the system dir command.  After dir is finished executing, you are prompted to press a key before returning to the editor.

!

Temporarily leaves Vi and enters an operating system command shell.

See Also:

SHELL

ABBREV

Syntax:

ABbrev <short> <long>

Description:

Create an abbreviation of <short> for <long>.  Whenever <short> is typed as a word during text insertion mode, it is expanded to <long>.  UNABBREV is used to remove the abbreviation.

Example(s):

abbrev wh while(

Whenever wh is entered as a word, the word while( is substituted.

See Also:

UNABBREV

ALIAS

Syntax:

ALias <alias> <data>

Description:

Creates an command line alias of <alias> for <data>.  Whenever <alias> is typed on the command line, the full command <data> is substituted.  UNALIAS is used to remove the abbreviation.

Example(s):

alias ai set autoindent

Whenever ai is entered on the command line, the command set autoindent is executed.

See Also:

UNALIAS

APPEND

Syntax:

<line_num> Append

Description:

Appends source lines after line <line_num>.  Append is terminated when a line with nothing but a dot ('.') is entered.

Notes:

Only valid in EX mode.

See Also:

CHANGE, INSERT

CASCADE

Syntax:

CASCADE

Description:

Causes all edit buffer windows to cascade (overlap each other with top border of each visible).

See Also:

MAXIMIZE, MINIMIZE, MOVEWIN, RESIZE, SIZE, TILE

CD

Syntax:

CD <dir>

Description:

Changes current working directory to <dir>.  If <dir> is not specified, then the current directory is displayed in the message window.  <dir> may be specified with drive and path.

Example(s):

cd c:\tmp

Changes to the \tmp directory of the c drive

cd

Display the current working directory

CHANGE

Syntax:

<line_range> Change

Description:

Deletes the line range <line_range>, and replaces the range with inputted source lines.  The input of text is terminated when a line with nothing on it but a dot ('.') is entered.

Notes:

Only valid in EX mode.

See Also:

APPEND, INSERT

COMPILE

Syntax:

COMPile "-a" "-A" <script> <result>

Description:

Compiles the editor script <script>.
If -a is specified, all local variables are translated at compile time (rather than at run time) - this is useful for the configuration script.

If -A is specified, all variables (both local and global) are translated at compile time.

The file will be compiled into a file with the same name as the script and the extension ._vi, unless <result> is specified.

For information on editor scripts, see the chapter Editor Script Language.

Example(s):

comp -a ed.cfg

Compiles the default configuration script ed.cfg and expands all local variables to any values assigned to them in the script.  The compiled script file ed._vi is generated.

If any errors occur while compiling, a file with the the same name as the script and the extension .err is created.

comp test.vi test.out

Compiles the script test.vi and generates the compiled script file test.out.

See Also:

LOAD, SOURCE

COMPRESS

Syntax:

COMpress

Description:

Replaces spaces in the current edit buffer with tabs.  Single spaces are not replaced with a tab, and spaces inside a quoted string are not replaced with a tab.

COPY

Syntax:

<line_range> COpy <line_number>

Description:

Copies the specified range of lines <line_range> after the line <line_number>.

Example(s):

% copy $

Copies the entire file and places the lines after the last line in the file.

1,.  copy .

Copies all lines from the beginning of the file to the current line and places the lines after the current line.

DATE

Syntax:

DAte

Description:

Display the current time and date in the message window.

DELETE

Syntax:

<line_range> Delete <buffer>

Description:

Deletes the specified line range <line_range>.
If <buffer> is not specified, the text is deleted into the active copy buffer.

If <buffer> ('1'-'9', or 'a'-'z') is specified, the text is deleted into that copy buffer.

The PUT command may be used to place contents of a copy buffer into the file.

Example(s):

% d

Deletes all lines into the active copy buffer.

1,10 d a

Deletes lines 1 to 10 into the named copy buffer a.

See Also:

MOVE, PUT, YANK

ECHO

Syntax:

ECHO <line> <msg>

Description:

Echos the message <msg> on line <line> of the message window.
If <line> is specified as off, then nothing is echoed into the message window from then on.

If <line> is specified as on, messages will start to appear in the message window again.

<msg> may be surrounded by double quotes (") or a forward slash (/) if it contains any spaces.

Example(s):

echo 1 "hello world"

The words hello world will appear on line 1 of the message window.

echo off

Disables output to the message window.

echo on

Enables output to the message window.

echo 2 /Line 2 message/

The words Line 2 message will appear on line 2 of the message window.

EDIT

Syntax:

Edit "!" <files>

Description:

Edits the specified files <files>.  <files> may be a single file or a list of files.
Each file name may contain file regular expressions, see the section File Matching Regular Expressions in the chapter Regular Expressions for more information.

If "!" is specified, then the current file is discarded before editing the new file(s).

If a file is already being edited, then control is simply transferred to the window with that file.  If the file is already being edited and you specified a different path, then a new copy of the file is read from the disk and is edited, unless samefilecheck is set.  If samefilecheck is set, then control is transferred to the window with the original copy of the file.

If you wish to have have multiple views on the same file, the OPEN command is available.

If <files> is not specified, then a window containing a list of files in the current directory is opened.   From this listing, you may pick a file, another directory, or another drive (the available drives are at the end of the listing).  A directory is indicated by the leading backslash ('\').  If a directory is chosen in this window, then the list of files in that directory is displayed.  This list also contains all the drives available (which are enclosed in square brackets, e.g.  [c:]).  If you select a drive, the list of files in the current directory on that drive is displayed.

For files and directories, each line indicates the file name, the various attributes of the file ([d]irectory, [a]rchive, [h]idden, [s]ystem, [r]eadable, [w]riteable, e[x]ecutable), the file size in bytes, the date and time of the last file update.  Some sample lines are:

     
       test.c        -a--rw-    25586   08/16/92  08:14
       bar.c         -a--r--       639  02/27/92  13:25
      \tmpdir        d---rw-         0  08/16/92  19:05
       [c:]

Example(s):

edit test.c

Edits the file test.c.

edit!  test2.c

Discards the current file, and edits test2.c.

edit test.(c|h)

Edits the file test.c if it exists, and the file test.h if it exists.

edit ([a-c])*.c

Edits all files in the current directory that start with the letters a, b or c and have the extension .c.

edit *

Edits all files in the current directory.

edit

Gives a file selection display:


Figure 33. File Selection Display

See Also:

OPEN, READ, VIEW, VISUAL

EGREP

Syntax:

EGRep <regexp> <files>

Description:

Searches the file list <files> for the regular expression <regexp>.
<regexp> may be surrounded by double quotes (") or a forward slash (/) if it contains any spaces.

<files> may be a single file, a directory, or a list of files.  <files> may contain file regular expressions, see the section File Matching Regular Expressions in the chapter Regular Expressions for more information.

If <files> is not specified, it defaults to the setting of grepdefault.  If a directory is specified for <files>, then the files in that directory are searched, based on the setting of grepdefault.

When all matches are found, a selection window is presented with all the files that contained <regexp>.

If you are not using regular expressions, the FGREP command is much faster.  For more information on regular expressions, see the chapter Regular Expressions.

Example(s):

egrep ((if)|(while)) *.c

Searches all files in the current directory ending in the extension .c for the regular expression ((if)|(while)).

egrep [a-z]a+

Searches all files specified by grepdefault for the regular expression [a-z]a+.

egrep [a-z]a+ ..\c

Searches all files in the directory ..\c specified by grepdefault for the regular expression [a-z]a+.

See Also:

FGREP

EVAL

Syntax:

EVAL <expr>

Description:

Evalutes a given mathematical expression, and displays the result on line 1 of the message window.  For a full explanation of the rules for formulating the expression <expr>, see the chapter Editor Script Language.

Example(s):

eval 5+7*3

Evaluates 5+7*3 and displays the result (26) in the message window.

eval (5+7)*3

Evaluates (5+7)*3 and displays the result (36) in the message window.

eval ((12+3)*100)/50-3

Evaluates ((12+3)*100)/50-3 and displays the result (27) in the message window.

EXECUTE

Syntax:

EXECUTE <str>

Description:

Execute the string <str>.  This causes the editor to behave as if the string <str> was typed at the keyboard.
Special keys in the string are indicated as follows:

\<"key">

Any special key may be inserted for "key".  The angle brackets are required.  There are a number of pre-defined keys symbols that are recognized.  These are described in the Appendix Symbolic Keystrokes.

\e

Short form for the escape key (rather than \<ESC>).

\n

Short form for the enter key (rather than \<ENTER>).

\h

If a command line command is used in the sequence, and it follows the colon (':'), the command is not added to the history.  For example:
     
     :\hdate\n

will display the current date and time, but the command will not enter the command history.

\x

If a command line command is used in the sequence, then this stops the command window from opening.  This prevents the "flashing" of the command window as it is opened then closed.  For example:
     
     \x:date\n

will display the current date and time, but the command window will not be displayed.

Example(s):

execute dd

Acts as if dd were typed, and the current line gets deleted.

execute :eval 5*3\n

Acts as if :eval 5*3<ENTER> was typed, and the number 15 gets displayed in the message window.

See Also:

KEYADD, MAP, MAPBASE

EXITALL

Syntax:

EXITALL

Description:

Exits all files.  For each file that has been modified, you are prompted as to whether you want to save the file or not.

See Also:

QUITALL

EXPAND

Syntax:

EXPAND

Description:

Replaces all tabs in the current edit buffer with spaces.

FGREP

Syntax:

FGRep "-c" "-u" <string> <files>

Description:

Searches the file list <files> for the string <string>.
The search is by default case insensitive, unless -c is specified, which forces the search to be case sensitive.   Specifying -u causes the setting of caseignore to determine whether or not to be case sensitive in the search.

<string> may be surrounded by double quotes (") or a forward slash (/) if it contains any spaces.

<files> may be a single file or a list of files.  Each file name may contain file regular expressions, see the section File Matching Regular Expressions in the chapter Regular Expressions for more information.

If <files> is not specified, it defaults to the setting of grepdefault.

While searching for the item, Vi displays a window that shows all files being searched.  When all matches are found, a selection window is presented with all the files that contained <files>.

Example(s):

fgrep window *.c

Searches all files in the current directory ending in the extension .c for the string window.  This will produce out similar to the following:


Figure 34. Grep Result display

See Also:

EGREP

FILES

Syntax:

Files

Description:

Opens a window with the a list of all files current being edited.  Files that have been modified will have a '*' beside them.  A file may be selected from this list either with the keyboard or with the mouse.

Example(s):

files

Displays following screen


Figure 35. Current file list

FLOATMENU

Syntax:

FLOATMENU <id> <slen> <x1> <y1>

Description:

Activates the floating (popup) menu <id> (<id> may be 0, 1, 2 or 3).
The floating menus are defined using the command line command MENU (See the section Menu Commands).

<x1>, <y1> specify the coordinates of the upper left hand corner of the floating menu.  (0,0) specifies the upper left hand corner of the screen.

<slen> defines the length of a string that the menu is around the floating menu will try to appear around the string (<id> may be 0).  This is useful if you wish to pop up a menu around some selected characters on a line, for example.

If <slen> is non-zero, then the coordinates is assumed to be the lower right-hand side of the string that the menu is popping up around.

Example(s):

float 0 0 10 10

Bring up floating menu 0 at location (10,10) on the screen.  There is no string, so the menu position will simply cycle around (10,10) in an attempt to position itself.

float 0 6 50 20

Bring up floating menu 0 at location (50,20) on the screen.  This is assumed to be on the lower right hand side of a string of length 5 (i.e., it is assumed that the string is on line 19 and starts at column 45).  If the menu cannot fit by opening at (50,20), it will try to open at all other corners of the string.

See Also:

MENU, INPUT, GET

GENCONFIG

Syntax:

GENCONFIG <filename>

Description:

Writes the current editor configuration out to the file <filename>.  If <filename> is not specified, then the file name "ed.cfg" is assumed.

GLOBAL

Syntax:

<line_range> Global '"!"' /<regexp>/ <cmd>

Description:

For each line in the range <line_range> that matches the regular expression <regexp>, the editor command <cmd> is executed.  <cmd> may contain replacement expressions, see the chapter Regular Expressions for more information.
If "!" is specified, then the command <cmd> is executed on every line that does NOT match the regular expression <regexp>.

If <line_range> is not specified, then the global command operates on the entire line range of the current edit buffer.

Example(s):

g/printf/d

Deletes all lines in the current edit buffer that have the word printf.

g!/[a-c]123/ d

Deletes all lines in the current edit buffer that DO not match the regular expression [a-c]123.

g/(abc)*/ execute Iabc\e

For every line that matches the regular expression (abc)*, execute the keystrokes Iabc<ESC> (this will insert the characters abc at the start of the line).

See Also:

SUBSTITUTE

HELP

Syntax:

HELP <topic>

Description:

Starts a view-only edit buffer on help for a specified topic.  Possible topics are:

COMmandline

All command line commands.

KEYS

What different keystrokes do in command mode.

REGularexpressions

How to use regular expressions.

SETtings

Everything that can be modified with the SET command line command.

SCRipts

Vi script guide.

STARTing

How to start the editor:  switches, required files.

Example(s):

help com

Gives help on command line commands.

help

Gives list of help topics.

INSERT

Syntax:

<line_number> Insert

Description:

Inserts text after a the specified line number <line_number>.  Insert is terminated when a line with nothing but a '.' is entered.

Notes:

Only valid in EX mode.

See Also:

APPEND, CHANGE

JOIN

Syntax:

<line_range> Join

Description:

Joins the lines in the specified range <line_range> into a single line (lines are concatenated one after another).

Example(s):

.,.+2 join

Joins the current line and the next 2 lines into a single line.

KEYADD

Syntax:

KEYAdd <string>

Description:

Adds a set of keystrokes <string> to the key buffer just as if they were typed by the user.  The processing of these keystrokes is deferred until Vi finishes its current processing, and is ready to process keystrokes again.  This is different than the EXECUTE command, which processes the keystrokes immediately.
KEYADD is useful in a script, because it allows keystrokes to be executed after the script is exited.   This prevents re-entrance of a script that is being executed by a mapped key in input mode, for example.

Keys are processed in FIFO order.  Multiple KEYADD commands cause more keys to queue up for processing.

If you need to use one or more special keys (e.g.  ENTER, F1, etc) in <string>, they may specified as follows:

\<"key">

Any special key may be inserted for "key".  The angle brackets are required.  There are a number of pre-defined keys symbols that are recognized.  These are described in the Appendix Symbolic Keystrokes.

\e

Short form for the escape key (rather than \<ESC>).

\n

Short form for the enter key (rather than \<ENTER>).

\h

If a command line command is used in the sequence, and it follows the colon (':'), the command is not added to the history.  For example:
     
     :\hdate\n

will display the current date and time, but the command will not enter the command history.

\x

If a command line command is used in the sequence, then this stops the command window from opening.  This prevents the "flashing" of the command window as it is opened then closed.  For example:
     
     \x:date\n

will display the current date and time, but the command window will not be displayed.

Example(s):

keyadd dd

Acts as if dd were typed, and the current line gets deleted.

keyadd :eval 5*3\n

Acts as if :eval 5*3<ENTER> was typed, and the number 15 gets displayed in the message window.

See Also:

EXECUTE, MAP, MAPBASE

LIST

Syntax:

<line_range> List

Description:

Lists lines in the specified line range <line_range>.

Notes:

Only valid in EX mode.

LOAD

Syntax:

LOAD <script>

Description:

Loads a script into memory for the life of the edit session.  This allows for much faster access to the script, since the data structures for the script do not have to be built every time the script is invoked.  This is especially important for a hook script.
For information on editor scripts, see the chapter Editor Script Language.

Example(s):

load rdme._vi

Loads the script rdme._vi and makes it resident.

See Also:

COMPILE, SOURCE

MAP

Syntax:

MAP "!" <key> <string>

Description:

Tells the editor to run the string of keys <string> whenver the key <key> is pressed in command mode.
If "!" is specified, then the string of keys <string> is executed whenever <key> is pressed in text insertion mode.

When a mapped key is pressed, it acts is if the characters in <string> are being typed at the keyboard.   Recursion does not occur; if a key that is mapped is executed after it has been executed as a mapped key, then the default behaviour for that key is used, e.g.:

     
     map a 0a

will cause the editor to move to column 1, and then start appending after the character in column 1.

If you need to specify a special key (e.g.  ENTER, F1, etc) in <key>, you specify a symbolic name for that key.  There are a number of pre-defined keys symbols that are recognized when specifying which key is being mapped/unmapped.  These are described in the Appendix Symbolic Keystrokes.

If you need to use one or more special keys (e.g.  ENTER, F1, etc) in <string>, then you may enter:

\<"key">

Any special key may be inserted for "key".  The angle brackets are required.  There are a number of pre-defined keys symbols that are recognized.  These are described in the Appendix Symbolic Keystrokes.

\e

Short form for the escape key (rather than \<ESC>).

\n

Short form for the enter key (rather than \<ENTER>).

\h

If a command line command is used in the sequence, and it follows the colon (':'), the command is not added to the history.  For example:
     
     :\hdate\n

will display the current date and time, but the command will not enter the command history.

\x

If a command line command is used in the sequence, then this stops the command window from opening.  This prevents the "flashing" of the command window as it is opened then closed.  For example:
     
     \x:date\n

will display the current date and time, but the command window will not be displayed.

To remove a mapping, use the UNMAP command.

Example(s):

map K \x:next\n

Whenever K is pressed in command mode, the NEXT command is executed.  The command window will not be displayed, because of the \x.

map CTRL_T \x:\hda\n

Whenever CTRL_T is pressed in command mode, the current date is displayed.  The command window will not be displayed, because of the \x.  The command will not be added to the command history, because of the \h.

map CTRL_W \x:fgrep \<CTRL_W>\n

Whenever CTRL_W is pressed in command mode, an fgrep command, searching for the current word, is executed.   The \x keeps the command window from opening.  \<CTRL_W> simulates CTRL_W being pressed, so the current word is inserted into the command line.

map!  CTRL_W \edwi

Whenever CTRL_W is pressed in text insertion mode, text insertion mode is exited (\e simulates the ESC key being pressed), the current word is deleted, and text insertion mode is re-entered.  This has the effect of deleting the current word in text insertion mode and appearing to remain in text insertion mode.