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