| blob | 944e2312c76596bfec9c9c01180ce0f545515d58 |
1 .\" $NetBSD: vi.1,v 1.3 2008/10/29 17:50:49 christos Exp $
2 .\"
3 .\" Copyright (c) 1994
4 .\" The Regents of the University of California. All rights reserved.
5 .\" Copyright (c) 1994, 1995, 1996
6 .\" Keith Bostic. All rights reserved.
7 .\"
8 .\" This document may not be republished without written permission from
9 .\" Keith Bostic.
10 .\"
11 .\" See the LICENSE file for redistribution information.
12 .\"
13 .\" Id: vi.1,v 8.53 2001/01/28 13:20:06 skimo Exp (Berkeley) Date: 2001/01/28 13:20:06
14 .\"
15 .TH VI 1 "%Q%"
16 .UC
17 .SH NAME
18 ex, vi, view \- text editors
19 .SH SYNOPSIS
20 .B ex
21 [\c
22 .B -eFGRrSsv\c
23 ] [\c
24 .BI -c " cmd"\c
25 ] [\c
26 .BI -t " tag"\c
27 ] [\c
28 .BI -w " size"\c
29 ] [file ...]
30 .br
31 .B vi
32 [\c
33 .B -eFlRrSv\c
34 ] [\c
35 .BI -c " cmd"\c
36 ] [\c
37 .BI -t " tag"\c
38 ] [\c
39 .BI -w " size"\c
40 ] [file ...]
41 .br
42 .B view
43 [\c
44 .B -eFGRrSv\c
45 ] [\c
46 .BI -c " cmd"\c
47 ] [\c
48 .BI -t " tag"\c
49 ] [\c
50 .BI -w " size"\c
51 ] [file ...]
52 .SH LICENSE
53 The vi program is freely redistributable. You are welcome to copy,
54 modify and share it with others under the conditions listed in the
55 LICENSE file. If any company (not individual!) finds vi sufficiently
56 useful that you would have purchased it, or if any company wishes to
57 redistribute it, contributions to the authors would be appreciated.
58 .SH DESCRIPTION
59 .I \&Vi
60 is a screen oriented text editor.
61 .I \&Ex
62 is a line-oriented text editor.
63 .I \&Ex
64 and
65 .I \&vi
66 are different interfaces to the same program,
67 and it is possible to switch back and forth during an edit session.
68 .I View
69 is the equivalent of using the
70 .B \-R
71 (read-only) option of
72 .IR \&vi .
73 .PP
74 This manual page is the one provided with the
75 .I nex/nvi
76 versions of the
77 .I ex/vi
78 text editors.
79 .I Nex/nvi
80 are intended as bug-for-bug compatible replacements for the original
81 Fourth Berkeley Software Distribution (4BSD)
82 .I \&ex
83 and
84 .I \&vi
85 programs.
86 For the rest of this manual page,
87 .I nex/nvi
88 is used only when it's necessary to distinguish it from the historic
89 implementations of
90 .IR ex/vi .
91 .PP
92 This manual page is intended for users already familiar with
93 .IR ex/vi .
94 Anyone else should almost certainly read a good tutorial on the
95 editor before this manual page.
96 If you're in an unfamiliar environment, and you absolutely have to
97 get work done immediately, read the section after the options
98 description, entitled ``Fast Startup''.
99 It's probably enough to get you going.
100 .PP
101 The following options are available:
102 .TP
103 .B \-c
104 Execute
105 .B cmd
106 immediately after starting the edit session.
107 Particularly useful for initial positioning in the file, however
108 .B cmd
109 is not limited to positioning commands.
110 This is the POSIX 1003.2 interface for the historic ``+cmd'' syntax.
111 .I Nex/nvi
112 supports both the old and new syntax.
113 .TP
114 .B \-e
115 Start editing in ex mode, as if the command name were
116 .IR \&ex .
117 .TP
118 .B \-F
119 Don't copy the entire file when first starting to edit.
120 (The default is to make a copy in case someone else modifies
121 the file during your edit session.)
122 .TP
123 .B \-G
124 Start editing in gtags mode, as if the gtagsmode option was set.
125 .TP
126 .B \-l
127 Start editing with the lisp and showmatch options set.
128 .TP
129 .B \-R
130 Start editing in read-only mode, as if the command name was
131 .IR view ,
132 or the
133 .B readonly
134 option was set.
135 .TP
136 .B \-r
137 Recover the specified files, or, if no files are specified,
138 list the files that could be recovered.
139 If no recoverable files by the specified name exist,
140 the file is edited as if the
141 .B \-r
142 option had not been specified.
143 .TP
144 .B \-S
145 Run with the
146 .B secure
147 edit option set, disallowing all access to external programs.
148 .TP
149 .B \-s
150 Enter batch mode; applicable only to
151 .I \&ex
152 edit sessions.
153 Batch mode is useful when running
154 .I \&ex
155 scripts.
156 Prompts, informative messages and other user oriented message
157 are turned off,
158 and no startup files or environmental variables are read.
159 This is the POSIX 1003.2 interface for the historic ``\-'' argument.
160 .I \&Nex/nvi
161 supports both the old and new syntax.
162 .TP
163 .B \-t
164 Start editing at the specified tag.
165 (See
166 .IR ctags (1)).
167 .TP
168 .B \-w
169 Set the initial window size to the specified number of lines.
170 .TP
171 .B \-v
172 Start editing in vi mode, as if the command name was
173 .I \&vi
174 or
175 .IR view .
176 .PP
177 Command input for
178 .I ex/vi
179 is read from the standard input.
180 In the
181 .I \&vi
182 interface, it is an error if standard input is not a terminal.
183 In the
184 .I \&ex
185 interface, if standard input is not a terminal,
186 .I \&ex
187 will read commands from it regardless, however, the session will be a
188 batch mode session, exactly as if the
189 .B \-s
190 option had been specified.
191 .PP
192 .I Ex/vi
193 exits 0 on success, and greater than 0 if an error occurs.
194 .SH FAST STARTUP
195 This section will tell you the minimum amount that you need to
196 do simple editing tasks using
197 .IR \&vi .
198 If you've never used any screen editor before, you're likely to have
199 problems even with this simple introduction.
200 In that case you should find someone that already knows
201 .I \&vi
202 and have them walk you through this section.
203 .PP
204 .I \&Vi
205 is a screen editor.
206 This means that it takes up almost the entire screen, displaying part
207 of the file on each screen line, except for the last line of the screen.
208 The last line of the screen is used for you to give commands to
209 .IR \&vi ,
210 and for
211 .I \&vi
212 to give information to you.
213 .PP
214 The other fact that you need to understand is that
215 .I \&vi
216 is a modeful editor, i.e. you are either entering text or you
217 are executing commands, and you have to be in the right mode
218 to do one or the other.
219 You will be in command mode when you first start editing a file.
220 There are commands that switch you into input mode.
221 There is only one key that takes you out of input mode,
222 and that is the <escape> key.
223 (Key names are written using less-than and greater-than signs, e.g.
224 <escape> means the ``escape'' key, usually labeled ``esc'' on your
225 terminal's keyboard.)
226 If you're ever confused as to which mode you're in,
227 keep entering the <escape> key until
228 .I \&vi
229 beeps at you.
230 (Generally,
231 .I \&vi
232 will beep at you if you try and do something that's not allowed.
233 It will also display error messages.)
234 .PP
235 To start editing a file, enter the command ``vi file_name<carriage-return>''.
236 The command you should enter as soon as you start editing is
237 ``:set verbose showmode<carriage-return>''.
238 This will make the editor give you verbose error messages and display
239 the current mode at the bottom of the screen.
240 .PP
241 The commands to move around the file are:
242 .TP
243 .B h
244 Move the cursor left one character.
245 .TP
246 .B j
247 Move the cursor down one line.
248 .TP
249 .B k
250 Move the cursor up one line.
251 .TP
252 .B l
253 Move the cursor right one character.
254 .TP
255 .B <cursor-arrows>
256 The cursor arrow keys should work, too.
257 .TP
258 .B /text<carriage-return>
259 Search for the string ``text'' in the file,
260 and move the cursor to its first character.
261 .PP
262 The commands to enter new text are:
263 .TP
264 .B a
265 Append new text,
266 .I after
267 the cursor.
268 .TP
269 .B i
270 Insert new text,
271 .I before
272 the cursor.
273 .TP
274 .B o
275 Open a new line below the line the cursor is on, and start
276 entering text.
277 .TP
278 .B O
279 Open a new line above the line the cursor is on, and start
280 entering text.
281 .TP
282 .B <escape>
283 Once you've entered input mode using the one of the
284 .BR \&a ,
285 .BR \&i ,
286 .BR \&O
287 or
288 .B \&o
289 commands, use
290 .B <escape>
291 to quit entering text and return to command mode.
292 .PP
293 The commands to copy text are:
294 .TP
295 .B yy
296 Copy the line the cursor is on.
297 .TP
298 .B p
299 Append the copied line after the line the cursor is on.
300 .PP
301 The commands to delete text are:
302 .TP
303 .B dd
304 Delete the line the cursor is on.
305 .TP
306 .B x
307 Delete the character the cursor is on.
308 .PP
309 The commands to write the file are:
310 .TP
311 .B :w<carriage-return>
312 Write the file back to the file with the name that you originally used
313 as an argument on the
314 .I \&vi
315 command line.
316 .TP
317 .B ":w file_name<carriage-return>"
318 Write the file back to the file with the name ``file_name''.
319 .PP
320 The commands to quit editing and exit the editor are:
321 .TP
322 .B :q<carriage-return>
323 Quit editing and leave vi (if you've modified the file, but not
324 saved your changes,
325 .I \&vi
326 will refuse to quit).
327 .TP
328 .B :q!<carriage-return>
329 Quit, discarding any modifications that you may have made.
330 .PP
331 One final caution.
332 Unusual characters can take up more than one column on the screen,
333 and long lines can take up more than a single screen line.
334 The above commands work on ``physical'' characters and lines,
335 i.e. they affect the entire line no matter how many screen lines it
336 takes up and the entire character no matter how many screen columns
337 it takes up.
338 .SH VI COMMANDS
339 The following section describes the commands available in the command
340 mode of the
341 .I \&vi
342 editor.
343 In each entry below, the tag line is a usage synopsis for the command
344 character.
345 .PP
346 .TP
347 .B "[count] <control-A>"
348 Search forward
349 .I count
350 times for the current word.
351 .TP
352 .B "[count] <control-B>"
353 Page backwards
354 .I count
355 screens.
356 .TP
357 .B "[count] <control-D>"
358 Scroll forward
359 .I count
360 lines.
361 .TP
362 .B "[count] <control-E>"
363 Scroll forward
364 .I count
365 lines, leaving the current line and column as is, if possible.
366 .TP
367 .B "[count] <control-F>"
368 Page forward
369 .I count
370 screens.
371 .TP
372 .B "<control-G>"
373 Display the file information.
374 .TP
375 .B "<control-H>"
376 .TP
377 .B "[count] h"
378 Move the cursor back
379 .I count
380 characters in the current line.
381 .TP
382 .B "[count] <control-J>"
383 .TP
384 .B "[count] <control-N>"
385 .TP
386 .B "[count] j"
387 Move the cursor down
388 .I count
389 lines without changing the current column.
390 .TP
391 .B "<control-L>"
392 .TP
393 .B "<control-R>"
394 Repaint the screen.
395 .TP
396 .B "[count] <control-M>"
397 .TP
398 .B "[count] +"
399 Move the cursor down
400 .I count
401 lines to the first nonblank character of that line.
402 .TP
403 .B "[count] <control-P>"
404 .TP
405 .B "[count] k"
406 Move the cursor up
407 .I count
408 lines, without changing the current column.
409 .TP
410 .B "<control-T>"
411 Return to the most recent tag context.
412 .TP
413 .B "<control-U>"
414 Scroll backwards
415 .I count
416 lines.
417 .TP
418 .B "<control-W>"
419 Switch to the next lower screen in the window, or, to the first
420 screen if there are no lower screens in the window.
421 .TP
422 .B "<control-Y>"
423 Scroll backwards
424 .I count
425 lines, leaving the current line and column as is, if possible.
426 .TP
427 .B "<control-Z>"
428 Suspend the current editor session.
429 .TP
430 .B "<escape>"
431 Execute
432 .I \&ex
433 commands or cancel partial commands.
434 .TP
435 .B "<control-]>"
436 Push a tag reference onto the tag stack.
437 In gtagsmode, if at the first column of line,
438 locate function references otherwise function definitions.
439 .TP
440 .B "<control-^>"
441 Switch to the most recently edited file.
442 .TP
443 .B "[count] <space>"
444 .TP
445 .B "[count] l"
446 Move the cursor forward
447 .I count
448 characters without changing the current line.
449 .TP
450 .B "[count] ! motion shell-argument(s)"
451 Replace text with results from a shell command.
452 .TP
453 .B "[count] # #|+|-"
454 Increment or decrement the cursor number.
455 .TP
456 .B "[count] $"
457 Move the cursor to the end of a line.
458 .TP
459 .B "%"
460 Move to the matching character.
461 .TP
462 .B "&"
463 Repeat the previous substitution command on the current line.
464 .TP
465 .B "'<character>"
466 .TP
467 .B "`<character>"
468 Return to a context marked by the character
469 .IR <character> .
470 .TP
471 .B "[count] ("
472 Back up
473 .I count
474 sentences.
475 .TP
476 .B "[count] )"
477 Move forward
478 .I count
479 sentences.
480 .TP
481 .B "[count] ,"
482 Reverse find character
483 .I count
484 times.
485 .TP
486 .B "[count] -"
487 Move to first nonblank of the previous line,
488 .I count
489 times.
490 .TP
491 .B "[count] ."
492 Repeat the last
493 .I \&vi
494 command that modified text.
495 .TP
496 .B "/RE<carriage-return>"
497 .TP
498 .B "/RE/ [offset]<carriage-return>"
499 .TP
500 .B "?RE<carriage-return>"
501 .TP
502 .B "?RE? [offset]<carriage-return>"
503 .TP
504 .B "N"
505 .TP
506 .B "n"
507 Search forward or backward for a regular expression.
508 .TP
509 .B "0"
510 Move to the first character in the current line.
511 .TP
512 .B ":"
513 Execute an ex command.
514 .TP
515 .B "[count] ;"
516 Repeat the last character find
517 .I count
518 times.
519 .TP
520 .B "[count] < motion"
521 .TP
522 .B "[count] > motion"
523 Shift lines left or right.
524 .TP
525 .B "@ buffer"
526 Execute a named buffer.
527 .TP
528 .B "[count] A"
529 Enter input mode, appending the text after the end of the line.
530 .TP
531 .B "[count] B"
532 Move backwards
533 .I count
534 bigwords.
535 .TP
536 .B "[buffer] [count] C"
537 Change text from the current position to the end-of-line.
538 .TP
539 .B "[buffer] D"
540 Delete text from the current position to the end-of-line.
541 .TP
542 .B "[count] E"
543 Move forward
544 .I count
545 end-of-bigwords.
546 .TP
547 .B "[count] F <character>"
548 Search
549 .I count
550 times backward through the current line for
551 .IR <character> .
552 .TP
553 .B "[count] G"
554 Move to line
555 .IR count ,
556 or the last line of the file if
557 .I count
558 not specified.
559 .TP
560 .B "[count] H"
561 Move to the screen line
562 .I "count - 1"
563 lines below the top of the screen.
564 .TP
565 .B "[count] I"
566 Enter input mode, inserting the text at the beginning of the line.
567 .TP
568 .B "[count] J"
569 Join lines.
570 .TP
571 .B "[count] L"
572 Move to the screen line
573 .I "count - 1"
574 lines above the bottom of the screen.
575 .TP
576 .B " M"
577 Move to the screen line in the middle of the screen.
578 .TP
579 .B "[count] O"
580 Enter input mode, appending text in a new line above the current line.
581 .TP
582 .B "[buffer] P"
583 Insert text from a buffer.
584 .TP
585 .B "Q"
586 Exit
587 .I \&vi
588 (or visual) mode and switch to
589 .I \&ex
590 mode.
591 .TP
592 .B "[count] R"
593 Enter input mode, replacing the characters in the current line.
594 .TP
595 .B "[buffer] [count] S"
596 Substitute
597 .I count
598 lines.
599 .TP
600 .B "[count] T <character>"
601 Search backwards,
602 .I count
603 times,
604 through the current line for the character
605 .I after
606 the specified
607 .IR <character> .
608 .TP
609 .B "U"
610 Restore the current line to its state before the cursor last
611 moved to it.
612 .TP
613 .B "[count] W"
614 Move forward
615 .I count
616 bigwords.
617 .TP
618 .B "[buffer] [count] X"
619 Delete
620 .I count
621 characters before the cursor.
622 .TP
623 .B "[buffer] [count] Y"
624 Copy (or ``yank'')
625 .I count
626 lines into the specified buffer.
627 .TP
628 .B "ZZ"
629 Write the file and exit
630 .IR \&vi .
631 .TP
632 .B "[count] [["
633 Back up
634 .I count
635 section boundaries.
636 .TP
637 .B "[count] ]]"
638 Move forward
639 .I count
640 section boundaries.
641 .TP
642 .B "\&^"
643 Move to first nonblank character on the current line.
644 .TP
645 .B "[count] _"
646 Move down
647 .I "count - 1"
648 lines, to the first nonblank character.
649 .TP
650 .B "[count] a"
651 Enter input mode, appending the text after the cursor.
652 .TP
653 .B "[count] b"
654 Move backwards
655 .I count
656 words.
657 .TP
658 .B "[buffer] [count] c motion"
659 Change a region of text.
660 .TP
661 .B "[buffer] [count] d motion"
662 Delete a region of text.
663 .TP
664 .B "[count] e"
665 Move forward
666 .I count
667 end-of-words.
668 .TP
669 .B "[count] f<character>"
670 Search forward,
671 .I count
672 times, through the rest of the current line for
673 .IR <character> .
674 .TP
675 .B "[count] i"
676 Enter input mode, inserting the text before the cursor.
677 .TP
678 .B "m <character>"
679 Save the current context (line and column) as
680 .IR <character> .
681 .TP
682 .B "[count] o"
683 Enter input mode, appending text in a new line under the current line.
684 .TP
685 .B "[buffer] p"
686 Append text from a buffer.
687 .TP
688 .B "[count] r <character>"
689 Replace
690 .I count
691 characters.
692 .TP
693 .B "[buffer] [count] s"
694 Substitute
695 .I count
696 characters in the current line starting with the current character.
697 .TP
698 .B "[count] t <character>"
699 Search forward,
700 .I count
701 times, through the current line for the character immediately
702 .I before
703 .IR <character> .
704 .TP
705 .B "u"
706 Undo the last change made to the file.
707 .TP
708 .B "[count] w"
709 Move forward
710 .I count
711 words.
712 .TP
713 .B "[buffer] [count] x"
714 Delete
715 .I count
716 characters.
717 .TP
718 .B "[buffer] [count] y motion"
719 Copy (or ``yank'')
720 a text region specified by the
721 .I count
722 and motion into a buffer.
723 .TP
724 .B "[count1] z [count2] -|.|+|^|<carriage-return>"
725 Redraw, optionally repositioning and resizing the screen.
726 .TP
727 .B "[count] {"
728 Move backward
729 .I count
730 paragraphs.
731 .TP
732 .B "[count] |"
733 Move to a specific
734 .I column
735 position on the current line.
736 .TP
737 .B "[count] }"
738 Move forward
739 .I count
740 paragraphs.
741 .TP
742 .B "[count] ~"
743 Reverse the case of the next
744 .I count
745 character(s).
746 .TP
747 .B "[count] ~ motion"
748 Reverse the case of the characters in a text region specified by the
749 .I count
750 and
751 .IR motion .
752 .TP
753 .B "<interrupt>"
754 Interrupt the current operation.
755 .SH VI TEXT INPUT COMMANDS
756 The following section describes the commands available in the text
757 input mode of the
758 .I \&vi
759 editor.
760 .PP
761 .TP
762 .B "<nul>"
763 Replay the previous input.
764 .TP
765 .B "<control-D>"
766 Erase to the previous
767 .B shiftwidth
768 column boundary.
769 .TP
770 .B "^<control-D>"
771 Erase all of the autoindent characters, and reset the autoindent level.
772 .TP
773 .B "0<control-D>"
774 Erase all of the autoindent characters.
775 .TP
776 .B "<control-T>"
777 Insert sufficient
778 .I <tab>
779 and
780 .I <space>
781 characters to move forward to the next
782 .B shiftwidth
783 column boundary.
784 If
785 .B expandtab
786 is set, only insert
787 .I <space>
788 characters.
789 .TP
790 .B "<erase>
791 .TP
792 .B "<control-H>"
793 Erase the last character.
794 .TP
795 .B "<literal next>"
796 Quote the next character.
797 .TP
798 .B "<escape>
799 Resolve all text input into the file, and return to command mode.
800 .TP
801 .B "<line erase>"
802 Erase the current line.
803 .TP
804 .B "<control-W>"
805 .TP
806 .B "<word erase>"
807 Erase the last word.
808 The definition of word is dependent on the
809 .B altwerase
810 and
811 .B ttywerase
812 options.
813 .TP
814 .B "<control-X>[0-9A-Fa-f]+"
815 Insert a character with the specified hexadecimal value into the text.
816 .TP
817 .B "<interrupt>"
818 Interrupt text input mode, returning to command mode.
819 .SH EX COMMANDS
820 The following section describes the commands available in the
821 .I \&ex
822 editor.
823 In each entry below, the tag line is a usage synopsis for the command.
824 .PP
825 .TP
826 .B "<end-of-file>"
827 Scroll the screen.
828 .TP
829 .B "! argument(s)"
830 .TP
831 .B "[range]! argument(s)"
832 Execute a shell command, or filter lines through a shell command.
833 .TP
834 .B \&"
835 A comment.
836 .TP
837 .B "[range] nu[mber] [count] [flags]"
838 .TP
839 .B "[range] # [count] [flags]"
840 Display the selected lines, each preceded with its line number.
841 .TP
842 .B "@ buffer"
843 .TP
844 .B "* buffer"
845 Execute a buffer.
846 .TP
847 .B "[line] a[ppend][!]"
848 The input text is appended after the specified line.
849 .TP
850 .B "[range] c[hange][!] [count]"
851 The input text replaces the specified range.
852 .TP
853 .B "cs[cope] add | find | help | kill | reset"
854 Execute a Cscope command.
855 .TP
856 .B "[range] d[elete] [buffer] [count] [flags]"
857 Delete the lines from the file.
858 .TP
859 .B "di[splay] b[uffers] | c[onnections] | s[creens] | t[ags]"
860 Display buffers, Cscope connections, screens or tags.
861 .TP
862 .B "[Ee][dit][!] [+cmd] [file]"
863 .TP
864 .B "[Ee]x[!] [+cmd] [file]"
865 Edit a different file.
866 .TP
867 .B "exu[sage] [command]"
868 Display usage for an
869 .I \&ex
870 command.
871 .TP
872 .B "f[ile] [file]"
873 Display and optionally change the file name.
874 .TP
875 .B "[Ff]g [name]"
876 .I \&Vi
877 mode only.
878 Foreground the specified screen.
879 .TP
880 .B "[range] g[lobal] /pattern/ [commands]"
881 .TP
882 .B "[range] v /pattern/ [commands]"
883 Apply commands to lines matching (or not matching) a pattern.
884 .TP
885 .B "he[lp]"
886 Display a help message.
887 .TP
888 .B "[line] i[nsert][!]"
889 The input text is inserted before the specified line.
890 .TP
891 .B "[range] j[oin][!] [count] [flags]"
892 Join lines of text together.
893 .TP
894 .B "[range] l[ist] [count] [flags]"
895 Display the lines unambiguously.
896 .TP
897 .B "map[!] [lhs rhs]"
898 Define or display maps (for
899 .I \&vi
900 only).
901 .TP
902 .B "[line] ma[rk] <character>"
903 .TP
904 .B "[line] k <character>"
905 Mark the line with the mark
906 .IR <character> .
907 .TP
908 .B "[range] m[ove] line"
909 Move the specified lines after the target line.
910 .TP
911 .B "mk[exrc][!] file"
912 Write the abbreviations, editor options and maps to the specified
913 file.
914 .TP
915 .B "[Nn][ext][!] [file ...]"
916 Edit the next file from the argument list.
917 .TP
918 .B "[line] o[pen] /pattern/ [flags]"
919 Enter open mode.
920 .TP
921 .B "pre[serve]"
922 Save the file in a form that can later be recovered using the
923 .I \&ex
924 .B \-r
925 option.
926 .TP
927 .B "[Pp]rev[ious][!]"
928 Edit the previous file from the argument list.
929 .TP
930 .B "[range] p[rint] [count] [flags]"
931 Display the specified lines.
932 .TP
933 .B "[line] pu[t] [buffer]"
934 Append buffer contents to the current line.
935 .TP
936 .B "q[uit][!]"
937 End the editing session.
938 .TP
939 .B "[line] r[ead][!] [file]"
940 Read a file.
941 .TP
942 .B "rec[over] file"
943 Recover
944 .I file
945 if it was previously saved.
946 .TP
947 .B "res[ize] [+|-]size"
948 .I \&Vi
949 mode only.
950 Grow or shrink the current screen.
951 .TP
952 .B "rew[ind][!]"
953 Rewind the argument list.
954 .TP
955 .B "rta[g][!] tagstring"
956 Edit the file refering the specified tag. (Only in gtagsmode)
957 .TP
958 .B "se[t] [option[=[value]] ...] [nooption ...] [option? ...] [all]"
959 Display or set editor options.
960 .TP
961 .B "sh[ell]"
962 Run a shell program.
963 .TP
964 .B "so[urce] file"
965 Read and execute
966 .I \&ex
967 commands from a file.
968 .TP
969 .B "[range] s[ubstitute] [/pattern/replace/] [options] [count] [flags]"
970 .TP
971 .B "[range] & [options] [count] [flags]"
972 .TP
973 .B "[range] ~ [options] [count] [flags]"
974 Make substitutions.
975 .TP
976 .B "su[spend][!]"
977 .TP
978 .B "st[op][!]"
979 .TP
980 .B <suspend>
981 Suspend the edit session.
982 .TP
983 .B "[Tt]a[g][!] tagstring"
984 Edit the file containing the specified tag.
985 .TP
986 .B "tagn[ext][!]"
987 Edit the file containing the next context for the current tag.
988 .TP
989 .B "tagp[op][!] [file | number]"
990 Pop to the specified tag in the tags stack.
991 .TP
992 .B "tagp[rev][!]"
993 Edit the file containing the previous context for the current tag.
994 .TP
995 .B "unm[ap][!] lhs"
996 Unmap a mapped string.
997 .TP
998 .B "ve[rsion]"
999 Display the version of the
1000 .I \&ex/vi
1001 editor.
1002 .TP
1003 .B "[line] vi[sual] [type] [count] [flags]"
1004 .I \&Ex
1005 mode only.
1006 Enter
1007 .IR \&vi .
1008 .TP
1009 .B "[Vi]i[sual][!] [+cmd] [file]"
1010 .I \&Vi
1011 mode only.
1012 Edit a new file.
1013 .TP
1014 .B "viu[sage] [command]"
1015 Display usage for a
1016 .I \&vi
1017 command.
1018 .TP
1019 .B "[range] w[rite][!] [>>] [file]"
1020 .TP
1021 .B "[range] w[rite] [!] [file]"
1022 .TP
1023 .B "[range] wn[!] [>>] [file]"
1024 .TP
1025 .B "[range] wq[!] [>>] [file]"
1026 Write the file.
1027 .TP
1028 .B "[range] x[it][!] [file]"
1029 Write the file if it has been modified.
1030 .TP
1031 .B "[range] ya[nk] [buffer] [count]"
1032 Copy the specified lines to a buffer.
1033 .TP
1034 .B "[line] z [type] [count] [flags]"
1035 Adjust the window.
1036 .SH SET OPTIONS
1037 There are a large number of options that may be set (or unset) to
1038 change the editor's behavior.
1039 This section describes the options, their abbreviations and their
1040 default values.
1041 .PP
1042 In each entry below, the first part of the tag line is the full name
1043 of the option, followed by any equivalent abbreviations.
1044 The part in square brackets is the default value of the option.
1045 Most of the options are boolean, i.e. they are either on or off,
1046 and do not have an associated value.
1047 .PP
1048 Options apply to both
1049 .I \&ex
1050 and
1051 .I \&vi
1052 modes, unless otherwise specified.
1053 .PP
1054 .TP
1055 .B "altwerase [off]"
1056 .I \&Vi
1057 only.
1058 Select an alternate word erase algorithm.
1059 .TP
1060 .B "autoindent, ai [off]"
1061 Automatically indent new lines.
1062 .TP
1063 .B "autoprint, ap [off]"
1064 .I \&Ex
1065 only.
1066 Display the current line automatically.
1067 .TP
1068 .B "autowrite, aw [off]"
1069 Write modified files automatically when changing files.
1070 .\" I cannot get a double quote to print between the square brackets
1071 .\" to save my life. The ONLY way I've been able to get this to work
1072 .\" is with the .tr command.
1073 .tr Q"
1074 .ds ms backup [QQ]
1075 .TP
1076 .B "\*(ms"
1077 .tr QQ
1078 Backup files before they are overwritten.
1079 .TP
1080 .B "beautify, bf [off]"
1081 Discard control characters.
1082 .TP
1083 .B "cdpath [environment variable CDPATH, or current directory]"
1084 The directory paths used as path prefixes for the
1085 .B cd
1086 command.
1087 .TP
1088 .B "cedit [no default]"
1089 Set the character to edit the colon command-line history.
1090 .TP
1091 .B "columns, co [80]"
1092 Set the number of columns in the screen.
1093 .TP
1094 .B "comment [off]"
1095 .I \&Vi
1096 only.
1097 Skip leading comments in shell, C and C++ language files.
1098 .TP
1099 .B "directory, dir [environment variable TMPDIR, or /tmp]"
1100 The directory where temporary files are created.
1101 .TP
1102 .B "edcompatible, ed [off]"
1103 Remember the values of the ``c'' and ``g'' suffices to the
1104 .B substitute
1105 commands, instead of initializing them as unset for each new
1106 command.
1107 .TP
1108 .B "errorbells, eb [off]"
1109 .I \&Ex
1110 only.
1111 Announce error messages with a bell.
1112 .TP
1113 .B "expandtab, et [off]"
1114 Prevent the use of
1115 .I <tab>
1116 characters in leading whitespace when shifting text, autoindenting,
1117 indenting with
1118 .BR "<control-T>" ,
1119 or outdenting with
1120 .BR "<control-D>" .
1121 .TP
1122 .B "exrc, ex [off]"
1123 Read the startup files in the local directory.
1124 .TP
1125 .B "extended [off]"
1126 Regular expressions are extended (i.e.
1127 .IR egrep (1)\-\c
1128 style) expressions.
1129 .TP
1130 .B "filec [no default]"
1131 Set the character to perform file path completion on the colon
1132 command line.
1133 .TP
1134 .B "flash [on]"
1135 Flash the screen instead of beeping the keyboard on error.
1136 .TP
1137 .B "gtagsmode, gt [off]"
1138 Use GTAGS and GRTAGS instead of tags.
1139 .TP
1140 .B "hardtabs, ht [8]"
1141 Set the spacing between hardware tab settings.
1142 .TP
1143 .B "iclower [off]"
1144 Makes all Regular Expressions case-insensitive,
1145 as long as an upper-case letter does not appear in the search string.
1146 .TP
1147 .B "ignorecase, ic [off]"
1148 Ignore case differences in regular expressions.
1149 .TP
1150 .B "keytime [6]"
1151 The 10th's of a second
1152 .I ex/vi
1153 waits for a subsequent key to complete a key mapping.
1154 .TP
1155 .B "leftright [off]"
1156 .I \&Vi
1157 only.
1158 Do left-right scrolling.
1159 .TP
1160 .B "lines, li [24]"
1161 .I \&Vi
1162 only.
1163 Set the number of lines in the screen.
1164 .TP
1165 .B "lisp [off]"
1166 .I \&Vi
1167 only.
1168 Modify various search commands and options to work with Lisp.
1169 .I "This option is not yet implemented."
1170 .TP
1171 .B "list [off]"
1172 Display lines in an unambiguous fashion.
1173 .TP
1174 .B "lock [on]"
1175 Attempt to get an exclusive lock on any file being edited,
1176 read or written.
1177 .TP
1178 .B "magic [on]"
1179 Treat certain characters specially in regular expressions.
1180 .TP
1181 .B "matchchars [[]{}()<>]"
1182 Character pairs looked for by the % command.
1183 .TP
1184 .B "matchtime [7]"
1185 .I \&Vi
1186 only.
1187 The 10th's of a second
1188 .I ex/vi
1189 pauses on the matching character when the
1190 .B showmatch
1191 option is set.
1192 .TP
1193 .B "mesg [on]"
1194 Permit messages from other users.
1195 .TP
1196 .B "modelines, modeline [off]"
1197 Read the first and last few lines of each file for
1198 .I ex
1199 commands.
1200 .I "This option will never be implemented."
1201 .\" I cannot get a double quote to print between the square brackets
1202 .\" to save my life. The ONLY way I've been able to get this to work
1203 .\" is with the .tr command.
1204 .tr Q"
1205 .ds ms noprint [QQ]
1206 .TP
1207 .B "\*(ms"
1208 .tr QQ
1209 Characters that are never handled as printable characters.
1210 .TP
1211 .B "number, nu [off]"
1212 Precede each line displayed with its current line number.
1213 .TP
1214 .B "octal [off]"
1215 Display unknown characters as octal numbers, instead of the default
1216 hexadecimal.
1217 .TP
1218 .B "open [on]"
1219 .I \&Ex
1220 only.
1221 If this option is not set, the
1222 .B open
1223 and
1224 .B visual
1225 commands are disallowed.
1226 .TP
1227 .B "optimize, opt [on]"
1228 .I \&Vi
1229 only.
1230 Optimize text throughput to dumb terminals.
1231 .I "This option is not yet implemented."
1232 .TP
1233 .B "paragraphs, para [IPLPPPQPP LIpplpipbp]"
1234 .I \&Vi
1235 only.
1236 Define additional paragraph boundaries for the
1237 .B \&{
1238 and
1239 .B \&}
1240 commands.
1241 .TP
1242 .B "path []"
1243 Define additional directories to search for files being edited.
1244 .\" I cannot get a double quote to print between the square brackets
1245 .\" to save my life. The ONLY way I've been able to get this to work
1246 .\" is with the .tr command.
1247 .tr Q"
1248 .ds ms print [QQ]
1249 .TP
1250 .B "\*(ms"
1251 .tr QQ
1252 Characters that are always handled as printable characters.
1253 .TP
1254 .B "prompt [on]"
1255 .I \&Ex
1256 only.
1257 Display a command prompt.
1258 .TP
1259 .B "readonly, ro [off]"
1260 Mark the file and session as read-only.
1261 .TP
1262 .B "recdir [/var/tmp/vi.recover]"
1263 The directory where recovery files are stored.
1264 .TP
1265 .B "redraw, re [off]"
1266 .I \&Vi
1267 only.
1268 Simulate an intelligent terminal on a dumb one.
1269 .I "This option is not yet implemented."
1270 .TP
1271 .B "remap [on]"
1272 Remap keys until resolved.
1273 .TP
1274 .B "report [5]"
1275 Set the number of lines about which the editor reports changes
1276 or yanks.
1277 .TP
1278 .B "ruler [off]"
1279 .I \&Vi
1280 only.
1281 Display a row/column ruler on the colon command line.
1282 .TP
1283 .B "scroll, scr [window / 2]"
1284 Set the number of lines scrolled.
1285 .TP
1286 .B "searchincr [off]"
1287 Makes the
1288 .B \&/
1289 and
1290 .B \&?
1291 commands incremental.
1292 .TP
1293 .B "sections, sect [NHSHH HUnhsh]"
1294 .I \&Vi
1295 only.
1296 Define additional section boundaries for the
1297 .B \&[[
1298 and
1299 .B \&]]
1300 commands.
1301 .TP
1302 .B "secure [off]"
1303 Turns off all access to external programs.
1304 .TP
1305 .B "shell, sh [environment variable SHELL, or /bin/sh]"
1306 Select the shell used by the editor.
1307 .\" I cannot get a double quote to print between the square brackets
1308 .\" to save my life. The ONLY way I've been able to get this to work
1309 .\" is with the .tr command.
1310 .tr Q"
1311 .ds ms shellmeta [~{[*?$`'Q\e]
1312 .TP
1313 .B "\*(ms"
1314 .tr QQ
1315 Set the meta characters checked to determine if file name expansion
1316 is necessary.
1317 .TP
1318 .B "shiftwidth, sw [8]"
1319 Set the autoindent and shift command indentation width.
1320 .TP
1321 .B "showmatch, sm [off]"
1322 .I \&Vi
1323 only.
1324 Note matching ``{'' and ``('' for ``}'' and ``)'' characters.
1325 .TP
1326 .B "showmode, smd [off]"
1327 .I \&Vi
1328 only.
1329 Display the current editor mode and a ``modified'' flag.
1330 .TP
1331 .B "sidescroll [16]"
1332 .I \&Vi
1333 only.
1334 Set the amount a left-right scroll will shift.
1335 .TP
1336 .B "slowopen, slow [off]"
1337 Delay display updating during text input.
1338 .I "This option is not yet implemented."
1339 .TP
1340 .B "sourceany [off]"
1341 Read startup files not owned by the current user.
1342 .I "This option will never be implemented."
1343 .TP
1344 .B "tabstop, ts [8]"
1345 This option sets tab widths for the editor display.
1346 .TP
1347 .B "taglength, tl [0]"
1348 Set the number of significant characters in tag names.
1349 .TP
1350 .B "tags, tag [tags /var/db/libc.tags /sys/kern/tags]"
1351 Set the list of tags files.
1352 .TP
1353 .B "term, ttytype, tty [environment variable TERM]"
1354 Set the terminal type.
1355 .TP
1356 .B "terse [off]"
1357 This option has historically made editor messages less verbose.
1358 It has no effect in this implementation.
1359 .TP
1360 .B "tildeop [off]"
1361 Modify the
1362 .B \&~
1363 command to take an associated motion.
1364 .TP
1365 .B "timeout, to [on]"
1366 Time out on keys which may be mapped.
1367 .TP
1368 .B "ttywerase [off]"
1369 .I \&Vi
1370 only.
1371 Select an alternate erase algorithm.
1372 .TP
1373 .B "verbose [off]"
1374 .I \&Vi
1375 only.
1376 Display an error message for every error.
1377 .TP
1378 .B "w300 [no default]"
1379 .I \&Vi
1380 only.
1381 Set the window size if the baud rate is less than 1200 baud.
1382 .TP
1383 .B "w1200 [no default]"
1384 .I \&Vi
1385 only.
1386 Set the window size if the baud rate is equal to 1200 baud.
1387 .TP
1388 .B "w9600 [no default]"
1389 .I \&Vi
1390 only.
1391 Set the window size if the baud rate is greater than 1200 baud.
1392 .TP
1393 .B "warn [on]"
1394 .I \&Ex
1395 only.
1396 This option causes a warning message to the terminal if the file has
1397 been modified, since it was last written, before a
1398 .B \&!
1399 command.
1400 .TP
1401 .B "window, w, wi [environment variable LINES]"
1402 Set the window size for the screen.
1403 .TP
1404 .B "windowname [off]"
1405 Change the icon/window name to the current file name even if it can't
1406 be restored on editor exit.
1407 .TP
1408 .B "wraplen, wl [0]"
1409 .I \&Vi
1410 only.
1411 Break lines automatically, the specified number of columns from the
1412 left-hand margin.
1413 If both the
1414 .B wraplen
1415 and
1416 .B wrapmargin
1417 edit options are set, the
1418 .B wrapmargin
1419 value is used.
1420 .TP
1421 .B "wrapmargin, wm [0]"
1422 .I \&Vi
1423 only.
1424 Break lines automatically, the specified number of columns from the
1425 right-hand margin.
1426 If both the
1427 .B wraplen
1428 and
1429 .B wrapmargin
1430 edit options are set, the
1431 .B wrapmargin
1432 value is used.
1433 .TP
1434 .B "wrapscan, ws [on]"
1435 Set searches to wrap around the end or beginning of the file.
1436 .TP
1437 .B "writeany, wa [off]"
1438 Turn off file-overwriting checks.
1439 .SH "ENVIRONMENT VARIABLES
1440 .TP
1441 .I COLUMNS
1442 The number of columns on the screen.
1443 This value overrides any system or terminal specific values.
1444 If the
1445 .I COLUMNS
1446 environmental variable is not set when
1447 .I ex/vi
1448 runs, or the
1449 .B columns
1450 option is explicitly reset by the user,
1451 .I ex/vi
1452 enters the value into the environment.
1453 .TP
1454 .I EXINIT
1455 A list of
1456 .I \&ex
1457 startup commands, read if the variable
1458 .I NEXINIT
1459 is not set.
1460 .TP
1461 .I HOME
1462 The user's home directory, used as the initial directory path
1463 for the startup ``$\fIHOME\fP/.nexrc'' and ``$\fIHOME\fP/.exrc''
1464 files.
1465 This value is also used as the default directory for the
1466 .I \&vi
1467 .B \&cd
1468 command.
1469 .TP
1470 .I LINES
1471 The number of rows on the screen.
1472 This value overrides any system or terminal specific values.
1473 If the
1474 .I LINES
1475 environmental variable is not set when
1476 .I ex/vi
1477 runs, or the
1478 .B lines
1479 option is explicitly reset by the user,
1480 .I ex/vi
1481 enters the value into the environment.
1482 .TP
1483 .I NEXINIT
1484 A list of
1485 .I \&ex
1486 startup commands.
1487 .TP
1488 .I SHELL
1489 The user's shell of choice (see also the
1490 .B shell
1491 option).
1492 .TP
1493 .I TERM
1494 The user's terminal type.
1495 The default is the type ``unknown''.
1496 If the
1497 .I TERM
1498 environmental variable is not set when
1499 .I ex/vi
1500 runs, or the
1501 .B term
1502 option is explicitly reset by the user,
1503 .I ex/vi
1504 enters the value into the environment.
1505 .TP
1506 .I TMPDIR
1507 The location used to stored temporary files (see also the
1508 .B directory
1509 edit option).
1510 .SH ASYNCHRONOUS EVENTS
1511 .TP
1512 SIGALRM
1513 .I \&Vi/ex
1514 uses this signal for periodic backups of file modifications and to
1515 display ``busy'' messages when operations are likely to take a long time.
1516 .TP
1517 SIGHUP
1518 .TP
1519 SIGTERM
1520 If the current buffer has changed since it was last written in its
1521 entirety, the editor attempts to save the modified file so it can
1522 be later recovered.
1523 See the
1524 .I \&vi/ex
1525 Reference manual section entitled ``Recovery'' for more information.
1526 .TP
1527 SIGINT
1528 When an interrupt occurs,
1529 the current operation is halted,
1530 and the editor returns to the command level.
1531 If interrupted during text input,
1532 the text already input is resolved into the file as if the text
1533 input had been normally terminated.
1534 .TP
1535 SIGWINCH
1536 The screen is resized.
1537 See the
1538 .I \&vi/ex
1539 Reference manual section entitled ``Sizing the Screen'' for more information.
1540 .TP
1541 SIGCONT
1542 .TP
1543 SIGQUIT
1544 .TP
1545 SIGTSTP
1546 .I \&Vi/ex
1547 ignores these signals.
1548 .SH FILES
1549 .TP
1550 /bin/sh
1551 The default user shell.
1552 .TP
1553 /etc/vi.exrc
1554 System-wide vi startup file.
1555 .TP
1556 /tmp
1557 Temporary file directory.
1558 .TP
1559 /var/tmp/vi.recover
1560 The default recovery file directory.
1561 .TP
1562 $HOME/.nexrc
1563 1st choice for user's home directory startup file.
1564 .TP
1565 $HOME/.exrc
1566 2nd choice for user's home directory startup file.
1567 .TP
1568 \&.nexrc
1569 1st choice for local directory startup file.
1570 .TP
1571 \&.exrc
1572 2nd choice for local directory startup file.
1573 .SH SEE ALSO
1574 .IR ctags (1),
1575 .IR more (1),
1576 .IR curses (3),
1577 .IR dbopen (3)
1578 .sp
1579 The ``Vi Quick Reference'' card.
1580 .sp
1581 ``An Introduction to Display Editing with Vi'', found in the
1582 ``UNIX User's Manual Supplementary Documents''
1583 section of both the 4.3BSD and 4.4BSD manual sets.
1584 This document is the closest thing available to an introduction to the
1585 .I \&vi
1586 screen editor.
1587 .sp
1588 ``Ex Reference Manual (Version 3.7)'',
1589 found in the
1590 ``UNIX User's Manual Supplementary Documents''
1591 section of both the 4.3BSD and 4.4BSD manual sets.
1592 This document is the final reference for the
1593 .I \&ex
1594 editor, as distributed in most historic 4BSD and System V systems.
1595 .sp
1596 ``Edit: A tutorial'',
1597 found in the
1598 ``UNIX User's Manual Supplementary Documents''
1599 section of the 4.3BSD manual set.
1600 This document is an introduction to a simple version of the
1601 .I \&ex
1602 screen editor.
1603 .sp
1604 ``Ex/Vi Reference Manual'',
1605 found in the
1606 ``UNIX User's Manual Supplementary Documents''
1607 section of the 4.4BSD manual set.
1608 This document is the final reference for the
1609 .I \&nex/nvi
1610 text editors, as distributed in 4.4BSD and 4.4BSD-Lite.
1611 .PP
1612 .I Roff
1613 source for all of these documents is distributed with
1614 .I nex/nvi
1615 in the
1616 .I nvi/USD.doc
1617 directory of the
1618 .I nex/nvi
1619 source code.
1620 .sp
1621 The files ``autowrite'', ``input'', ``quoting'' and ``structures''
1622 found in the
1623 .I nvi/docs/internals
1624 directory of the
1625 .I nex/nvi
1626 source code.
1627 .SH HISTORY
1628 The
1629 .I nex/nvi
1630 replacements for the
1631 .I ex/vi
1632 editor first appeared in 4.4BSD.
1633 .SH STANDARDS
1634 .I \&Nex/nvi
1635 is close to IEEE Std1003.2 (``POSIX'').
1636 That document differs from historical
1637 .I ex/vi
1638 practice in several places; there are changes to be made on both sides.