ch31_02.htm

the unix power tools

HREF="ch05_02.htm"
TITLE="The Idea of a Terminal Database "
>5.2</A
>)</SPAN
>
defines those keys.
For example, to make function key F1 transpose words:</P
><P
CLASS="para"
><BLOCKQUOTE
CLASS="screen"
><PRE
CLASS="screen"
>map #1 dwelp</PRE
></BLOCKQUOTE
></P
><P
CLASS="para"
>A final note: map assignments are not really limited to unused keys.
You can map keys that are defined as other <EM
CLASS="emphasis"
>vi</EM
> commands,
but then the key's original meaning is inaccessible.
But this is probably okay if the key is tied to a command that you 
rarely use.
There's more information in article
<A
CLASS="xref"
HREF="ch31_14.htm"
TITLE="Don't Lose Important Functions with vi Maps: Use noremap"
>31.14</A
>
about the <EM
CLASS="emphasis"
>noremap</EM
> option.</P
></DIV
><DIV
CLASS="sect2"
><H3
CLASS="sect2"
><A
CLASS="title"
NAME="UPT-ART-2770-SECT-1.2"
>31.2.2 Text-Input Mode Maps </A
></H3
><P
CLASS="para"
>The <CODE
CLASS="literal"
>map!</CODE
> command works like <CODE
CLASS="literal"
>map</CODE
>,
but <CODE
CLASS="literal"
>map!</CODE
> works during text-input mode.
You actually set the <CODE
CLASS="literal"
>map!</CODE
> during command mode, in the same
way as a plain <CODE
CLASS="literal"
>map</CODE
>:
at a colon (<CODE
CLASS="literal"
>:</CODE
>) prompt, type <CODE
CLASS="literal"
>map!</CODE
> followed by a space and
the key(s) that activate the map; then type a space and the text that
the text-input mode map stands for.
These text-input mode maps are a lot like
<SPAN
CLASS="link"
>abbreviations (<A
CLASS="linkend"
HREF="ch30_31.htm"
TITLE="vi Word Abbreviation "
>30.31</A
>)</SPAN
>;
the difference is that <CODE
CLASS="literal"
>map!</CODE
> lets you switch from text-input mode to
command mode, execute commands, then go back to text-input mode.
To go to command mode during a <CODE
CLASS="literal"
>map!</CODE
>, you'll need to put an ESC key in the
value of the map by
<SPAN
CLASS="link"
>typing CTRL-v and then ESC (<A
CLASS="linkend"
HREF="ch31_06.htm"
TITLE="Protecting Keys from Interpretation by ex "
>31.6</A
>)</SPAN
>.
After your <CODE
CLASS="literal"
>map!</CODE
> does whatever in command mode, it can re-enter
text-input mode with the usual commands <CODE
CLASS="literal"
>a</CODE
>, <CODE
CLASS="literal"
>i</CODE
>, and so on.</P
><P
CLASS="para"
>Let's say you normally never type the caret (<CODE
CLASS="literal"
>^</CODE
>) key during
input mode.
When you're typing along, as you realize that what you're typing is
important, you want to press the caret key.
Then, <EM
CLASS="emphasis"
>vi</EM
> should open a line above and insert the phrase
&quot;THIS IS IMPORTANT:&quot;.
Finally, <EM
CLASS="emphasis"
>vi</EM
> should return you to text-input mode at the end of the line
where you pressed the caret key.
To do that, go to command mode and enter the following <CODE
CLASS="literal"
>map!</CODE
>
command.
The first <CODE
CLASS="literal"
>^</CODE
> comes from pressing the caret key.
Then you'll see two places with <CODE
CLASS="literal"
>^[</CODE
>; that's made by pressing
CTRL-v followed by the ESC key.
Finish the map by pressing RETURN:</P
><P
CLASS="para"
><BLOCKQUOTE
CLASS="screen"
><PRE
CLASS="screen"
>:map! ^ ^[OTHIS IS IMPORTANT:^[jA</PRE
></BLOCKQUOTE
></P
><P
CLASS="para"
>What does that do?
It executes the same <EM
CLASS="emphasis"
>vi</EM
> commands you'd use to add those three words
yourself, manually.
During text-input mode, typing a caret (<CODE
CLASS="literal"
>^</CODE
>) will:</P
><OL
CLASS="orderedlist"
><LI
CLASS="listitem"
><P
CLASS="para"
>Do ESC to go to command mode,</P
></LI
><LI
CLASS="listitem"
><P
CLASS="para"
>Use <CODE
CLASS="literal"
>O</CODE
> to open a new line above (in text-input mode),</P
></LI
><LI
CLASS="listitem"
><P
CLASS="para"
>Enter the text <CODE
CLASS="literal"
>THIS IS IMPORTANT:</CODE
></P
></LI
><LI
CLASS="listitem"
><P
CLASS="para"
>Do another ESC to go back to command mode,</P
></LI
><LI
CLASS="listitem"
><P
CLASS="para"
>Do <CODE
CLASS="literal"
>j</CODE
> to go down a line (to the line where you started), and</P
></LI
><LI
CLASS="listitem"
><P
CLASS="para"
>Do <CODE
CLASS="literal"
>A</CODE
> to put you at the end of the line, in text-input mode.</P
></LI
></OL
><P
CLASS="para"
>The trick is to use <CODE
CLASS="literal"
>map!</CODE
> only to redefine keys you'll
never use for anything else during text-input mode.
To temporarily disable a text-input mode map, press CTRL-v
before the key.
For example, to put a real caret into your file, type
<KBD
CLASS="keycap"
>[CTRL-v]</KBD
>
<KBD
CLASS="keycap"
>[<CODE
CLASS="literal"
>^</CODE
>]</KBD
>
To disable an input-mode map for the rest of your <EM
CLASS="emphasis"
>vi</EM
> session,
type <CODE
CLASS="literal"
>:unmap!</CODE
> followed by the character(s) that activate the
map.</P
><P
CLASS="para"
><A
CLASS="indexterm"
NAME="AUTOID-34976"
></A
>A more common example is mapping your keyboard's arrow or function keys
to do something during text-input mode.
These keys send a special series of characters.
Normally, without a <CODE
CLASS="literal"
>map!</CODE
> defined for these keys, the characters
they send will be put into your editor buffer&nbsp;- just as if you'd typed
the characters they make, yourself, one by one.
For instance, my left arrow key sends the characters <CODE
CLASS="literal"
>ESC</CODE
>, then
<CODE
CLASS="literal"
>[</CODE
> (left bracket), then <CODE
CLASS="literal"
>D</CODE
>.
Without an text-input mode <CODE
CLASS="literal"
>map!</CODE
> defined for that three-character
sequence, <EM
CLASS="emphasis"
>vi</EM
> will be hopelessly confused
[1]
if I press that arrow key.
Many UNIX developers have added text-input mode maps for arrow keys.
You can see them when you list all your text-input mode maps by typing
<CODE
CLASS="literal"
>:map!</CODE
> by itself, with nothing after:</P
><BLOCKQUOTE
CLASS="footnote"
><P
CLASS="para"
>[1] Actually, the <CODE
CLASS="literal"
>ESC</CODE
> will switch <EM
CLASS="emphasis"
>vi</EM
> back to command mode.
The first <CODE
CLASS="literal"
>[</CODE
> will make <EM
CLASS="emphasis"
>vi</EM
> think you're about to type
the section-motion command <CODE
CLASS="literal"
>[[</CODE
>, so the following <CODE
CLASS="literal"
>D</CODE
>
will make <EM
CLASS="emphasis"
>vi</EM
> beep.
Ugly, eh?</P
></BLOCKQUOTE
><P
CLASS="para"
><BLOCKQUOTE
CLASS="screen"
><PRE
CLASS="screen"
>up      ^[[A    ^[ka
down    ^[[B    ^[ja
left    ^[[D    ^[hi
right   ^[[C    ^[la
^       ^       ^[OTHIS IS IMPORTANT:^[jA</PRE
></BLOCKQUOTE
></P
><P
CLASS="para"
>Article
<A
CLASS="xref"
HREF="ch31_03.htm"
TITLE="What You Lose When You Use map! "
>31.3</A
>
lists some problems with <CODE
CLASS="literal"
>map!</CODE
>.</P
></DIV
><DIV
CLASS="sect1info"
><P
CLASS="SECT1INFO"
>- <SPAN
CLASS="authorinitials"
>JP</SPAN
>, <SPAN
CLASS="authorinitials"
>DG</SPAN
>, <SPAN
CLASS="authorinitials"
>LL</SPAN
></P
></DIV
></DIV
><DIV
CLASS="htmlnav"
><P
></P
><HR
ALIGN="LEFT"
WIDTH="515"
TITLE="footer"><TABLE
WIDTH="515"
BORDER="0"
CELLSPACING="0"
CELLPADDING="0"
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="172"
><A
CLASS="SECT1"
HREF="ch31_01.htm"
TITLE="31.1 Why Type More Than You Have To? "
><IMG
SRC="gifs/txtpreva.gif"
SRC="gifs/txtpreva.gif"
ALT="Previous: 31.1 Why Type More Than You Have To? "
BORDER="0"></A
></TD
><TD
ALIGN="CENTER"
VALIGN="TOP"
WIDTH="171"
><A
CLASS="book"
HREF="index.htm"
TITLE="UNIX Power Tools"
><IMG
SRC="gifs/txthome.gif"
SRC="gifs/txthome.gif"
ALT="UNIX Power Tools"
BORDER="0"></A
></TD
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="172"
><A
CLASS="SECT1"
HREF="ch31_03.htm"
TITLE="31.3 What You Lose When You Use map! "
><IMG
SRC="gifs/txtnexta.gif"
SRC="gifs/txtnexta.gif"
ALT="Next: 31.3 What You Lose When You Use map! "
BORDER="0"></A
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="172"
>31.1 Why Type More Than You Have To? </TD
><TD
ALIGN="CENTER"
VALIGN="TOP"
WIDTH="171"
><A
CLASS="index"
HREF="index/idx_0.htm"
TITLE="Book Index"
><IMG
SRC="gifs/index.gif"
SRC="gifs/index.gif"
ALT="Book Index"
BORDER="0"></A
></TD
><TD
ALIGN="RIGHT"
VALIGN="TOP"
WIDTH="172"
>31.3 What You Lose When You Use map! </TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="515"
TITLE="footer"><IMG
SRC="gifs/smnavbar.gif"
SRC="gifs/smnavbar.gif"
USEMAP="#map"
BORDER="0"
ALT="The UNIX CD Bookshelf Navigation"><MAP
NAME="map"
><AREA
SHAPE="RECT"
COORDS="0,0,73,21"
HREF="../index.htm"
ALT="The UNIX CD Bookshelf"><AREA
SHAPE="RECT"
COORDS="74,0,163,21"
HREF="index.htm"
ALT="UNIX Power Tools"><AREA
SHAPE="RECT"
COORDS="164,0,257,21"
HREF="../unixnut/index.htm"
ALT="UNIX in a Nutshell"><AREA
SHAPE="RECT"
COORDS="258,0,321,21"
HREF="../vi/index.htm"
ALT="Learning the vi Editor"><AREA
SHAPE="RECT"
COORDS="322,0,378,21"
HREF="../sedawk/index.htm"
ALT="sed &amp; awk"><AREA
SHAPE="RECT"
COORDS="379,0,438,21"
HREF="../ksh/index.htm"
ALT="Learning the Korn Shell"><AREA
SHAPE="RECT"
COORDS="439,0,514,21"
HREF="../lrnunix/index.htm"
ALT="Learning the UNIX Operating System"></MAP
></DIV
></BODY
></HTML
>