(vc-svn-merge-news): Understand the new format with two
[emacs.git] / etc / viperCard.tex
bloba4d80fcf66871c53de240427f536136fef6e91bb
1 % ViperCard -- The Reference Card for Viper under GNU Emacs 21 and XEmacs 20
2 %**start of header
3 \newcount\columnsperpage
5 % This file can be printed with 1 or 2 columns per page (see below).
6 % Specify how many you want here. Nothing else needs to be changed.
8 \columnsperpage=2
10 % Copyright (C) 1995, 1996, 1997, 2001, 2002, 2003, 2004,
11 % 2005, 2006, 2007 Free Software Foundation, Inc.
13 % This file is part of GNU Emacs.
15 % This file is distributed in the hope that it will be useful,
16 % but WITHOUT ANY WARRANTY. No author or distributor
17 % accepts responsibility to anyone for the consequences of using it
18 % or for whether it serves any particular purpose or describes
19 % any piece of software unless they say so in writing. Refer to the
20 % GNU Emacs General Public License for full details.
22 % Permission is granted to copy, modify and redistribute this source
23 % file provided the copyright notice and permission notices are
24 % preserved on all copies.
26 % Permission is granted to process this file through TeX and print the
27 % results, provided the printed document carries copyright and
28 % permission notices identical to the ones below.
30 % This file is intended to be processed by plain TeX (TeX82).
32 % The final reference card has six columns, three on each side.
33 % This file can be used to produce it in any of three ways:
34 % 1 column per page
35 % produces six separate pages, each of which needs to be reduced to 80%.
36 % This gives the best resolution.
37 % 2 columns per page
38 % produces three already-reduced pages.
39 % You will still need to cut and paste.
40 % 3 columns per page
41 % produces two pages which must be printed sideways to make a
42 % ready-to-use 8.5 x 11 inch reference card.
43 % For this you need a dvi device driver that can print sideways.
44 % Which mode to use is controlled by setting \columnsperpage above.
46 % Author of Viper:
47 % Michael Kifer
48 % email: kifer@cs.sunysb.edu
50 % Author of VIP 4.3:
51 % Aamod Sane
52 % email: sane@cs.uiuc.edu
54 % Author of VIP 3.5:
55 % Masahiko Sato
56 % email: ms@sail.stanford.edu
58 % The original TeX code for formatting the reference card was written by:
59 % Stephen Gildea
60 % UUCP: mit-erl!gildea
61 % email: gildea@stop.mail-abuse.org
64 \def\versionnumber{3.0}
65 \def\year{2007}
66 \def\version{August 2006 v\versionnumber}
68 \def\shortcopyrightnotice{\vskip 1ex plus 2 fill
69 \centerline{\small \copyright\ \year\ Free Software Foundation, Inc.
70 Permissions on back. v\versionnumber}}
72 \def\copyrightnotice{
73 %\vskip 1ex plus 2 fill\begingroup\small
74 \vskip 1ex \begingroup\small
75 \centerline{Copyright \copyright\ \year\ Free Software Foundation, Inc.}
76 \centerline{by Michael Kifer, Viper \version}
77 \centerline{by Aamod Sane, VIP version 4.3}
78 \centerline{by Masahiko Sato, VIP version 3.5}
80 Permission is granted to make and distribute copies of
81 this card provided the copyright notice and this permission notice
82 are preserved on all copies.
84 For copies of the GNU Emacs manual, write to the Free Software
85 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
87 \endgroup}
89 % make \bye not \outer so that the \def\bye in the \else clause below
90 % can be scanned without complaint.
91 \def\bye{\par\vfill\supereject\end}
93 \newdimen\intercolumnskip
94 \newbox\columna
95 \newbox\columnb
97 \def\ncolumns{\the\columnsperpage}
99 \message{[\ncolumns\space
100 column\if 1\ncolumns\else s\fi\space per page]}
102 \def\scaledmag#1{ scaled \magstep #1}
104 % This multi-way format was designed by Stephen Gildea
105 % October 1986.
106 % Slightly modified by Masahiko Sato, September 1987.
107 \if 1\ncolumns
108 \hsize 4in
109 \vsize 10in
110 %\voffset -.7in
111 \voffset -.57in
112 \font\titlefont=\fontname\tenbf \scaledmag3
113 \font\headingfont=\fontname\tenbf \scaledmag2
114 \font\miniheadingfont=\fontname\tenbf \scaledmag1 % masahiko
115 \font\smallfont=\fontname\sevenrm
116 \font\smallsy=\fontname\sevensy
118 \footline{\hss\folio}
119 \def\makefootline{\baselineskip10pt\hsize6.5in\line{\the\footline}}
120 \else
121 %\hsize 3.2in
122 %\vsize 7.95in
123 \hsize 3.41in % masahiko
124 \vsize 8in % masahiko
125 \hoffset -.75in
126 \voffset -.745in
127 \font\titlefont=cmbx10 \scaledmag2
128 \font\headingfont=cmbx10 \scaledmag1
129 \font\miniheadingfont=cmbx10 % masahiko
130 \font\smallfont=cmr6
131 \font\smallsy=cmsy6
132 \font\eightrm=cmr8
133 \font\eightbf=cmbx8
134 \font\eightit=cmti8
135 \font\eightsl=cmsl8
136 \font\eighttt=cmtt8
137 \font\eightsy=cmsy8
138 \textfont0=\eightrm
139 \textfont2=\eightsy
140 \def\rm{\eightrm}
141 \def\bf{\eightbf}
142 \def\it{\eightit}
143 \def\sl{\eightsl} % masahiko
144 \def\tt{\eighttt}
145 \normalbaselineskip=.8\normalbaselineskip
146 \normallineskip=.8\normallineskip
147 \normallineskiplimit=.8\normallineskiplimit
148 \normalbaselines\rm %make definitions take effect
150 \if 2\ncolumns
151 \let\maxcolumn=b
152 \footline{\hss\rm\folio\hss}
153 \def\makefootline{\vskip 2in \hsize=6.86in\line{\the\footline}}
154 \else \if 3\ncolumns
155 \let\maxcolumn=c
156 \nopagenumbers
157 \else
158 \errhelp{You must set \columnsperpage equal to 1, 2, or 3.}
159 \errmessage{Illegal number of columns per page}
160 \fi\fi
162 %\intercolumnskip=.46in
163 \intercolumnskip=.19in % masahiko .19x4 + 3.41x3 = 10.99
164 \def\abc{a}
165 \output={%
166 % This next line is useful when designing the layout.
167 %\immediate\write16{Column \folio\abc\space starts with \firstmark}
168 \if \maxcolumn\abc \multicolumnformat \global\def\abc{a}
169 \else\if a\abc
170 \global\setbox\columna\columnbox \global\def\abc{b}
171 %% in case we never use \columnb (two-column mode)
172 \global\setbox\columnb\hbox to -\intercolumnskip{}
173 \else
174 \global\setbox\columnb\columnbox \global\def\abc{c}\fi\fi}
175 \def\multicolumnformat{\shipout\vbox{\makeheadline
176 \hbox{\box\columna\hskip\intercolumnskip
177 \box\columnb\hskip\intercolumnskip\columnbox}
178 \makefootline}\advancepageno}
179 \def\columnbox{\leftline{\pagebody}}
181 \def\bye{\par\vfill\supereject
182 \if a\abc \else\null\vfill\eject\fi
183 \if a\abc \else\null\vfill\eject\fi
184 \end}
187 % we won't be using math mode much, so redefine some of the characters
188 % we might want to talk about
189 \catcode`\^=12
190 \catcode`\_=12
192 \chardef\\=`\\
193 \chardef\{=`\{
194 \chardef\}=`\}
196 \hyphenation{mini-buf-fer}
198 \parindent 0pt
199 \parskip 1ex plus .5ex minus .5ex
201 \def\small{\smallfont\textfont2=\smallsy\baselineskip=.8\baselineskip}
203 \outer\def\newcolumn{\vfill\eject}
205 \outer\def\title#1{{\titlefont\centerline{#1}}\vskip 1ex plus .5ex}
207 \outer\def\section#1{\par\filbreak
208 \vskip 3ex plus 2ex minus 2ex {\headingfont #1}\mark{#1}%
209 \vskip 2ex plus 1ex minus 1.5ex}
211 % masahiko
212 \outer\def\subsection#1{\par\filbreak
213 \vskip 2ex plus 2ex minus 2ex {\miniheadingfont #1}\mark{#1}%
214 \vskip 1ex plus 1ex minus 1.5ex}
216 \newdimen\keyindent
218 \def\beginindentedkeys{\keyindent=1em}
219 \def\endindentedkeys{\keyindent=0em}
220 \endindentedkeys
222 \def\paralign{\vskip\parskip\halign}
224 \def\<#1>{$\langle${\rm #1}$\rangle$}
226 \def\kbd#1{{\tt#1}\null} %\null so not an abbrev even if period follows
228 \def\beginexample{\par\leavevmode\begingroup
229 \obeylines\obeyspaces\parskip0pt\tt}
230 {\obeyspaces\global\let =\ }
231 \def\endexample{\endgroup}
233 \def\key#1#2{\leavevmode\hbox to \hsize{\vtop
234 {\hsize=.75\hsize\rightskip=1em
235 \hskip\keyindent\relax#1}\kbd{#2}\hfil}}
237 \newbox\metaxbox
238 \setbox\metaxbox\hbox{\kbd{M-x }}
239 \newdimen\metaxwidth
240 \metaxwidth=\wd\metaxbox
242 \def\metax#1#2{\leavevmode\hbox to \hsize{\hbox to .75\hsize
243 {\hskip\keyindent\relax#1\hfil}%
244 \hskip -\metaxwidth minus 1fil
245 \kbd{#2}\hfil}}
247 \def\fivecol#1#2#3#4#5{\hskip\keyindent\relax#1\hfil&\kbd{#2}\quad
248 &\kbd{#3}\quad&\kbd{#4}\quad&\kbd{#5}\cr}
250 \def\fourcol#1#2#3#4{\hskip\keyindent\relax#1\hfil&\kbd{#2}\quad
251 &\kbd{#3}\quad&\kbd{#4}\quad\cr}
253 \def\threecol#1#2#3{\hskip\keyindent\relax#1\hfil&\kbd{#2}\quad
254 &\kbd{#3}\quad\cr}
256 \def\twocol#1#2{\hskip\keyindent\relax\kbd{#1}\hfil&\kbd{#2}\quad\cr}
258 \def\twocolkey#1#2#3#4{\hskip\keyindent\relax#1\hfil&\kbd{#2}\quad&\relax#3\hfil&\kbd{#4}\quad\cr}
260 %**end of header
262 \beginindentedkeys
264 \title{ViperCard: Viper Reference Pal}
266 \centerline{(Version 3.0 (Polyglot) for Emacs 21 and XEmacs 20)}
268 %\copyrightnotice
270 \section{Loading Viper}
272 Just type \kbd{M-x viper-mode} followed by \kbd{RET}
274 OR put
276 (setq viper-mode t)
277 (require 'viper)
279 in .emacs
281 \section{Viper States}
283 Viper has four states: {\it emacs state}, {\it vi state}, {\it insert state},
284 {\it replace state}.
285 Mode line tells you which state you are in.
286 In emacs state you can do all the normal GNU Emacs editing.
287 This card explains only vi state and insert state (replace state is similar
288 to insert state).
289 {\bf GNU Emacs Reference Card} explains emacs state.
290 You can switch states as follows.
292 \key{from emacs state to vi state}{C-z}
293 \key{from vi state to emacs state}{C-z}
294 \key{from vi state to emacs state for 1 command}{$\backslash$}
295 \metax{from vi state to insert state}{i, I, a, A, o, O}
296 \metax{from vi state to replace state}{c, C, R}
297 \key{from insert or replace state to vi state}{ESC}
298 \key{from insert state to vi state for 1 command}{C-z}
301 \section{Insert Mode}
302 You can do editing in insert state.
304 \metax{go back to vi state}{ESC}
305 \metax{delete previous character}{C-h, DEL}
306 \key{delete previous word}{C-w}
307 \key{delete line word}{C-u}
308 \key{indent shiftwidth forward}{C-t}
309 \key{indent shiftwidth backward}{C-d}
310 \key{delete line word}{C-u}
311 \key{quote following character}{C-v}
312 \key{emulate Meta key in emacs state}{C-$\backslash$}
313 \key{escape to Vi state for one command}{C-z}
315 \vskip 2mm
317 {\bf The rest of this card explains commands in {\bf vi state}.}
319 \section{Getting Information on Viper}
321 Execute info command by typing \kbd{M-x info} and select menu item
322 \kbd{viper}. Also:
324 \key{describe function attached to the key {\it x}}{$\backslash$ C-h k {\it x}}
326 \section{Leaving Emacs}
328 \metax{suspend Emacs}{:st {\rm or} :su}
329 \metax{exit Emacs permanently}{C-xC-c}
330 \metax{exit current file}{:wq {\rm or} :q}
332 \shortcopyrightnotice
334 \section{Error Recovery}
336 \metax{abort command}{C-c (user level = 1)}
337 \metax{abort command}{C-g (user level > 1)}
338 \key{redraw messed up screen}{C-l}
339 \metax{{\bf recover} after system crash}{:rec file}
340 \metax{restore a buffer }{:e!\ {\rm or} M-x revert-buffer}
343 \section{Counts}
345 Most commands in vi state accept a {\it count} which can be supplied as a
346 prefix to the commands. In most cases, if a count is given, the
347 command is executed that many times. E.g., \kbd{5 d d} deletes 5
348 lines.
350 \section{Registers}
352 There are 26 registers (\kbd{a} to \kbd{z}) that can store texts
353 and marks.
354 You can append a text at the end of a register (say \kbd{x}) by
355 specifying the register name in capital letter (say \kbd{X}).
356 There are also 9 read only registers (\kbd{1} to \kbd{9}) that store
357 up to 9 previous changes.
358 We will use {\it x\/} to denote a register.
359 \section{Entering Insert Mode}
361 \key{{\bf insert} at point}{i}
362 \key{{\bf append} after cursor}{a}
363 \key{{\bf insert} before first non-white}{I}
364 \key{{\bf append} at end of line}{A}
365 \key{{\bf open} line below}{o}
366 \key{{\bf open} line above}{O}
368 \section{Buffers and Windows}
370 \key{move cursor to {\bf next} window}{C-x o}
371 \key{delete current window}{C-x 0}
372 \key{delete other windows}{C-x 1}
373 \key{split current window into two windows}{C-x 2}
374 \key{{\bf switch} to a buffer in the current window}{C-x {\sl buffer}}
375 \metax{{\bf switch} to a buffer in another window}{:n, :b, {\rm or} C-x 4 {\sl buf}}
376 \key{{\bf kill} a buffer}{:q! {\rm or} C-x k}
377 \key{list existing {\bf buffers}}{:args {\rm or} C-x b}
379 \section{Files}
381 \metax{{\bf visit} file in the current window}{v {\sl file} {\rm or} :e {\sl file}}
382 \key{{\bf visit} file in another window}{V {\sl file}}
383 \key{{\bf visit} file in another frame}{C-v {\sl file}}
384 \key{{\bf save} buffer to the associated file}{:w {\rm or} C-xC-s}
385 \metax{{\bf write} buffer to a specified file}{:w {\sl file} {\rm or} C-xC-w}
386 \metax{{\bf insert} a specified file at point}{:r {\sl file} {\rm or} C-xi}
387 \key{{\bf get} information on the current {\bf file}}{C-c g {\rm or} :f}
388 \key{run the {\bf directory} editor}{:e RET {\rm or} C-xd}
390 %\shortcopyrightnotice
392 \section{Viewing the Buffer}
394 \key{scroll to next screen}{C-f}
395 \key{scroll to previous screen}{C-b}
396 \key{scroll {\bf down} half screen}{C-d}
397 \key{scroll {\bf up} half screen}{C-u}
398 \key{scroll down one line}{C-e}
399 \key{scroll up one line}{C-y}
401 \key{put current line on the {\bf home} line}{z H {\rm or} z RET}
402 \key{put current line on the {\bf middle} line}{z M {\rm or} z .}
403 \key{put current line on the {\bf last} line}{z L {\rm or} z -}
405 \section{Marking and Returning}
407 \key{{\bf mark} point in register {\it x}}{m {\it x}}
408 \key{set mark at buffer beginning}{m <}
409 \key{set mark at buffer end}{m >}
410 \key{set mark at point}{m .}
411 \key{jump to mark}{m ,}
412 \key{exchange point and mark}{` `}
413 \key{... and skip to first non-white on line}{' '}
414 \key{go to mark {\it x}}{` {\it x}}
415 \key{... and skip to first non-white on line}{' {\it x}}
416 \key{view contents of marker {\it x}}{[ {\it x}}
417 \key{view contents of register {\it x}}{] {\it x}}
419 \section{Macros}
421 Emacs style macros:
423 \key{start remembering keyboard macro}{C-x (}
424 \key{finish remembering keyboard macro}{C-x )}
425 \key{call last keyboard macro}{*}
427 \key{start remembering keyboard macro}{@ \#}
428 \key{finish macro and put into register {\it x}}{@ {\it x}}
429 \key{execute macro stored in register {\it x}}{@ {\it x}}
430 \key{repeat last @{\it x} command}{@ @}
432 \key{Pull last macro into register {\it x}}{@ ! {\it x}}
434 Vi-style macros (keys to be hit in quick succession):
436 \key{define Vi-style macro for Vi state}{:map}
437 \key{define Vi-style macro for Insert state}{:map!}
439 \key{toggle case-sensitive search}{//}
440 \key{toggle regular expression search}{///}
441 \key{toggle `\%' to ignore parentheses inside comments}{\%\%\%}
444 \section{Motion Commands}
446 \key{go backward one character}{h {\rm or} C-h}
447 \key{go forward one character}{l}
448 \metax{next line keeping the column}{j {\rm or} LF {\rm or} C-n}
449 \key{previous line keeping the column}{k}
450 \metax{next line at first non-white}{+ {\rm or} RET {\rm or} C-p}
451 \key{previous line at first non-white}{-}
453 \key{beginning of line}{0}
454 \key{first non-white on line}{^}
455 \key{end of line}{\$}
456 \key{go to {\it n}-th column on line}{{\it n} |}
458 \key{go to {\it n}-th line}{{\it n} G}
459 \key{go to last line}{G}
460 \key{find matching parenthesis for \kbd{()}, \kbd{\{\}} and \kbd{[]}}{\%}
462 \key{go to {\bf home} window line}{H}
463 \key{go to {\bf middle} window line}{M}
464 \key{go to {\bf last} window line}{L}
466 \subsection{Words, Sentences, Paragraphs, Headings}
468 \key{forward {\bf word}}{w {\rm or} W}
469 \key{{\bf backward} word}{b {\rm or} B}
470 \key{{\bf end} of word}{e {\rm or} E}
472 In the case of capital letter commands, a word is delimited by a
473 non-white character.
475 \key{forward sentence}{)}
476 \key{backward sentence}{(}
478 \key{forward paragraph}{\}}
479 \key{backward paragraph}{\{}
481 \key{forward heading}{]]}
482 \key{backward heading}{[[}
483 \key{end of heading}{[]}
485 \subsection{Find Characters on the Line}
487 \key{{\bf find} {\it c} forward on line}{f {\it c}}
488 \key{{\bf find} {\it c} backward on line}{F {\it c}}
489 \key{up {\bf to} {\it c} forward on line}{t {\it c}}
490 \key{up {\bf to} {\it c} backward on line}{T {\it c}}
491 \key{repeat previous \kbd{f}, \kbd{F}, \kbd{t} or \kbd{T}}{;}
492 \key{... in the opposite direction}{,}
494 %\newcolumn
495 %\title{Viper Quick Reference Card}
497 \section{Searching and Replacing}
499 \key{search forward for {\sl pat}}{/ {\sl pat}}
500 \key{search backward with previous {\sl pat}}{?\ RET}
501 \key{search forward with previous {\sl pat}}{/ RET}
502 \key{search backward for {\sl pat}}{?\ {\sl pat}}
503 \key{repeat previous search}{n}
504 \key{... in the opposite direction}{N}
506 \key{{\bf query} replace}{Q}
507 \key{{\bf replace} a character by another character {\it c}}{r {\it c}}
508 \key{{\bf overwrite} {\it n} lines}{{\it n} R}
510 \metax{{\bf buffer} search (if enabled)}{g {\it move command}}
512 \section{Modifying Commands}
514 Most commands that operate on text regions accept the motion commands,
515 to describe regions. They also accept the Emacs region specifications
516 {\bf r} and {\bf R}. {\bf r} describes the region between {\it point}
517 and {\it mark}, and {\bf R} describes whole lines in that region.
518 Motion commands are classified into {\it point commands} and
519 {\it line commands}. In the case of line commands, whole lines will
520 be affected by the command.
522 The point commands are as follows:
524 \hskip 5ex
525 \kbd{h l 0 ^ \$ w W b B e E ( ) / ?\ ` f F t T \% ; ,}
527 The line commands are as follows:
529 \hskip 5ex
530 \kbd{j k + - H M L \{ \} G '}
532 These region specifiers will be referred to as {\it m} below.
534 \subsection{Delete/Yank/Change Commands}
536 \paralign to \hsize{#\tabskip=10pt plus 1 fil&#\tabskip=0pt&#\tabskip=0pt&#\cr
537 \fourcol{}{{\bf delete}}{{\bf yank}}{{\bf change}}
538 \fourcol{region determined by {\it m}}{d {\it m}}{y {\it m}}{c {\it m}}
539 \fourcol{... into register {\it x}}{" {\it x\/} d {\it m}}{" {\it x\/} y {\it m}}{" {\it x\/} c {\it m}}
540 \fourcol{a line}{d d}{Y {\rm or} y y}{c c}
541 \fourcol{current {\bf region}}{d r}{y r}{c r}
542 \fourcol{expanded {\bf region}}{d R}{y R}{c R}
543 \fourcol{to end of line}{D}{y \$}{c \$}
544 \fourcol{a character after point}{x}{y l}{c l}
545 \fourcol{a character before point}{DEL}{y h}{c h}
548 \vskip 2ex
549 \key{Overwrite {\it n} lines}{{\it n} R}
551 \subsection{Put Back Commands}
553 Deleted/yanked/changed text can be put back by the following commands.
555 \key{{\bf Put} back at point/above line}{P}
556 \key{... from register {\it x}}{" {\it x\/} P}
557 \key{{\bf put} back after point/below line}{p}
558 \key{... from register {\it x}}{" {\it x\/} p}
560 \subsection{Repeating and Undoing Modifications}
562 \key{{\bf undo} last change}{u {\rm or} :und}
563 \key{repeat last change}{.\ {\rm (dot)}}
565 Undo is undoable by \kbd{u} and repeatable by \kbd{.}.
566 For example, \kbd{u...} will undo 4 previous changes.
567 A \kbd{.} after \kbd{5dd} is equivalent to \kbd{5dd},
568 while \kbd{3.} after \kbd{5dd} is equivalent to \kbd{3dd}.
570 \section{Miscellaneous Commands}
572 \endindentedkeys
574 \paralign to \hsize{#\tabskip=5pt plus 1 fil&#\tabskip=0pt&#\tabskip=0pt&#\tabskip=0pt&#\cr
575 \fivecol{}{{\bf shift left}}{{\bf shift right}}{{\bf filter shell command}}{{\bf indent}}
576 \fivecol{region}{< {\it m}}{> {\it m}}{!\ {\it m\/} {\sl shell-com}}{= {\it m}}
577 \fivecol{line}{< <}{> >}{!\ !\ {\sl shell-com}}{= =}
580 \key{{\bf join} lines}{J}
581 \key{toggle case (takes count)}{\~{}}
583 \key{view register {\it x}}{] {\it x}}
584 \key{view marker {\it x}}{] {\it x}}
586 \key{lowercase region}{\# c {\it m}}
587 \key{uppercase region}{\# C {\it m}}
588 \key{execute last keyboard macro on each line in the region}{\# g {\it m}}
590 \key{insert specified string for each line in the region}{\# q {\it m}}
591 \key{check spelling of the words in the region}{\# s {\it m}}
593 \key{repeat previous ex substitution}{\&}
594 \key{change to previous file}{C-^}
596 \key{Viper Meta key}{_}
598 \section{Customization}
600 By default, search is case sensitive.
601 You can change this by including the following line in your \kbd{\~{}/.vip} file.
603 \hskip 5ex
604 \kbd{(setq viper-case-fold-search t)}
606 The following is a subset of the variety of
607 options available for customizing Viper.
608 See the Viper manual for details on these and other options.
610 \beginindentedkeys
612 \paralign to \hsize{#\tabskip=10pt plus 1 fil&#\tabskip=0pt&#\cr
613 \twocol{{\bf variable}}{{\bf default value}}
614 \twocol{viper-search-wrap-around}{t}
615 \twocol{viper-case-fold-search}{nil}
616 \twocol{viper-re-search}{t}
617 \twocol{viper-re-replace}{t}
618 \twocol{viper-re-query-replace}{t}
619 \twocol{viper-auto-indent}{nil}
620 \twocol{viper-shift-width}{8}
621 \twocol{viper-tags-file-name}{"TAGS"}
622 \twocol{viper-no-multiple-ESC}{t}
623 \twocol{viper-ex-style-motion}{t}
624 \twocol{viper-always}{t}
625 \twocol{viper-custom-file-name}{"\~{}/.vip"}
626 \twocol{ex-find-file-shell}{"csh"}
627 \twocol{ex-cycle-other-window}{t}
628 \twocol{ex-cycle-through-non-buffers}{t}
629 \twocol{blink-matching-paren}{t}
630 \twocol{buffer-read-only}{{\it buffer dependent}}
633 To bind keys in Vi command state, put lines like these in your
634 \kbd{\~{}/.vip} file:
636 \beginexample
637 (define-key viper-vi-global-user-map "\\C-v" 'scroll-down)
638 (define-key viper-vi-global-user-map "\\C-cm" 'smail)
639 \endexample
642 \newcolumn
644 \title{Ex Commands in Viper}
646 In vi state, an Ex command is entered by typing:
648 \hskip 5ex
649 \kbd{:\ {\sl ex-command} RET}
651 \section{Ex Addresses}
653 \paralign to \hsize{#\tabskip=5pt plus 1 fil&#\tabskip=2pt&#\tabskip=5pt plus 1 fil&#\cr
654 \twocolkey{current line}{.}{next line with {\sl pat}}{/ {\sl pat} /}
655 \twocolkey{line {\it n}}{{\it n}}{previous line with {\sl pat}}{?\ {\sl pat} ?}
656 \twocolkey{last line}{\$}{{\it n\/} line before {\it a}}{{\it a} - {\it n}}
657 \twocolkey{next line}{+}{{\it a\/} through {\it b}}{{\it a\/} , {\it b}}
658 \twocolkey{previous line}{-}{line marked with {\it x}}{' {\it x}}
659 \twocolkey{entire buffer}{\%}{previous context}{' '}
662 Addresses can be specified in front of a command.
663 For example,
665 \hskip 5ex
666 \kbd{:.,.+10m\$}
668 moves 11 lines below current line to the end of buffer.
670 \section{Ex Commands}
672 Avoid Ex text manipulation commands except substitute.
673 There are better VI equivalents
674 for all of them. Also note that all Ex commands expand \% to
675 current file name. To include a \% in the command, escape it with a $\backslash$.
676 Similarly, \# is replaced by previous file. For Viper, this is the
677 first file in the {\sl :args} listing for that buffer. This defaults
678 to the previous file in the VI sense if you have one window.
679 Ex commands can be made to have history. See the manual for details.
681 \subsection{Ex Text Commands}
683 \endindentedkeys
685 \key{mark lines matching {\sl pat} and execute {\sl cmds} on these lines}{:g /{\sl pat}/ {\sl cmds}}
687 \key{mark lines {\it not\/} matching {\sl pat} and execute {\sl cmds} on these lines}{:v /{\sl pat}/ {\sl cmds}}
690 \key{{\bf move} specified lines after {\sl addr}}{:m {\sl addr}}
691 \key{{\bf copy} specified lines after {\sl addr}}{:co\rm\ (or \kbd{:t})\ \sl addr}
692 \key{{\bf delete} specified lines [into register {\it x\/}]}{:d {\rm [{\it x\/}]}}
693 \key{{\bf yank} specified lines [into register {\it x\/}]}{:y {\rm [{\it x\/}]}}
694 \key{{\bf put} back text [from register {\it x\/}]}{:pu {\rm [{\it x\/}]}}
696 \key{{\bf substitute} {\sl repl} for first string on line matching {\sl pat}}{:s /{\sl pat}/{\sl repl}/}
698 \key{repeat last substitution}{:\&}
699 \key{repeat previous substitute with previous search pattern as {\sl pat}}{:\~{}}
701 \subsection{Ex File and Shell Commands}
703 \key{{\bf edit} file}{:e {\sl file}}
704 \key{reedit messed up current file}{:e!}
705 \key{edit previous file}{:e\#}
706 \key{{\bf read} in a file}{:r {\sl file}}
707 \key{{\bf read} in the output of a shell command}{:r {\sl !command}}
708 \key{write out specified lines into {\sl file}}{:w {\sl file}}
709 \key{save all modified buffers, ask confirmation}{:W {\sl file}}
710 \key{save all modified buffers, no confirmation}{:WW {\sl file}}
711 \key{write out specified lines at the end of {\sl file}}{:w>> {\sl file}}
712 \key{{\bf write} to the input of a shell command}{:w {\sl !command}}
713 \key{write out and then quit}{:wq {\sl file}}
715 \key{run a sub{\bf shell} in a window}{:sh}
716 \key{execute shell command {\sl command}}{:!\ {\sl command}}
717 \key{execute previous shell command with {\it args} appended}{:!! {\sl args}}
719 \subsection{Ex Miscellaneous Commands}
721 \key{define a macro {\it x} that expands to {\sl cmd}}{:map {\it x} {\sl cmd}}
722 \key{remove macro expansion associated with {\it x}}{:unma {\it x}}
723 \key{define a macro {\it x} that expands to {\sl cmd} in insert state}{:map!\ {\it x} {\sl cmd}}
724 \key{remove macro expansion associated with {\it x} in insert state}{:unma!\ {\it x}}
726 \key{print line number}{:.=}
727 \key{print last line number}{:=}
728 \key{print {\bf version} number of Viper}{:ve}
730 \key{shift specified lines to the right}{:>}
731 \key{shift specified lines to the left}{:<}
733 \key{{\bf join} lines}{:j}
734 \key{mark specified line to register {\it x}}{:k {\it x}}
735 \key{{\bf set} a variable's value}{:se}
736 \key{find first definition of {\bf tag} {\sl tag}}{:ta {\sl tag}}
738 \key{Current directory}{:pwd}
741 \copyrightnotice
743 \bye
745 % Local variables:
746 % compile-command: "tex viperCard"
747 % End:
749 % arch-tag: e287b45c-4c5e-4bf9-ae28-ead4cd9f68e3