| blob | e37343c97c33ad7cdd2b92e25e63beaa63e3c54b |
1 .\" $NetBSD: set.opt.roff,v 1.1 2008/09/02 09:25:39 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 .\" See the LICENSE file for redistribution information.
9 .\"
10 .\" @(#)set.opt.roff 8.66 (Berkeley) 10/10/96
11 .\"
12 .SH 1 "Set Options"
13 .pp
14 There are a large number of options that may be set (or unset) to
15 change the editor's behavior.
16 This section describes the options, their abbreviations and their
17 default values.
18 .pp
19 In each entry below, the first part of the tag line is the full name
20 of the option, followed by any equivalent abbreviations.
21 (Regardless of the abbreviations, it is only necessary to use the
22 minimum number of characters necessary to distinguish an abbreviation
23 from all other commands for it to be accepted, in
24 .EV nex nvi .
25 Historically, only the full name and the official abbreviations
26 were accepted by
27 .EV ex vi .
28 Using full names in your startup files and environmental variables will
29 probably make them more portable.)
30 The part in square brackets is the default value of the option.
31 Most of the options are boolean, i.e. they are either on or off,
32 and do not have an associated value.
33 .pp
34 Options apply to both
35 .CO ex
36 and
37 .CO vi
38 modes, unless otherwise specified.
39 .pp
40 With a few exceptions,
41 all options are settable per screen, i.e. the
42 .OP tags
43 option can be set differently in each screen.
44 The exceptions are the
45 .OP columns ,
46 .OP lines ,
47 .OP secure
48 and
49 .OP term
50 options.
51 Changing these options modifies the respective information for all screens.
52 .pp
53 For information on modifying the options or to display the options and
54 their current values, see the
55 .QQ set
56 command in the section entitled
57 .QB "Ex Commands" .
58 .KY altwerase
59 .IP "altwerase [off]"
60 .CO Vi
61 only.
62 Change how
63 .CO vi
64 does word erase during text input.
65 When this option is set, text is broken up into three classes:
66 alphabetic, numeric and underscore characters, other nonblank
67 characters, and blank characters.
68 Changing from one class to another marks the end of a word.
69 In addition, the class of the first character erased is ignored
70 (which is exactly what you want when erasing pathname components).
71 .KY autoindent
72 .IP "autoindent, ai [off]"
73 If this option is set, whenever you create a new line (using the
74 .CO vi
75 .CO A ,
76 .CO a ,
77 .CO C ,
78 .CO c ,
79 .CO I ,
80 .CO i ,
81 .CO O ,
82 .CO o ,
83 .CO R ,
84 .CO r ,
85 .CO S ,
86 and
87 .CO s
88 commands, or the
89 .CO ex
90 .CO append ,
91 .CO change ,
92 and
93 .CO insert
94 commands) the new line is automatically indented to align the cursor with
95 the first nonblank character of the line from which you created it.
96 Lines are indented using tab characters to the extent possible (based on
97 the value of the
98 .OP tabstop
99 option) and then using space characters as necessary.
100 For commands inserting text into the middle of a line, any blank characters
101 to the right of the cursor are discarded, and the first nonblank character
102 to the right of the cursor is aligned as described above.
103 .sp
104 The indent characters are themselves somewhat special.
105 If you do not enter more characters on the new line before moving to
106 another line, or entering
107 .LI <escape> ,
108 the indent character will be deleted and the line will be empty.
109 For example, if you enter
110 .LI <carriage-return>
111 twice in succession,
112 the line created by the first
113 .LI <carriage-return>
114 will not have any characters in it,
115 regardless of the indentation of the previous or subsequent line.
116 .sp
117 Indent characters also require that you enter additional erase characters
118 to delete them.
119 For example,
120 if you have an indented line, containing only blanks, the first
121 .LI <word-erase>
122 character you enter will erase up to end of the indent characters,
123 and the second will erase back to the beginning of the line.
124 (Historically, only the
125 .LI <control-D>
126 key would erase the indent characters.
127 Both the
128 .LI <control-D>
129 key and the usual erase keys work in
130 .CO nvi .)
131 In addition, if the cursor is positioned at the end of the indent
132 characters, the keys
133 .QT 0<control-D>
134 will erase all of the indent characters for the current line,
135 resetting the indentation level to 0.
136 Similarly, the keys
137 .QT ^<control-D>
138 will erase all of the indent characters for the current line,
139 leaving the indentation level for future created lines unaffected.
140 .sp
141 Finally, if the
142 .OP autoindent
143 option is set, the
144 .CO S
145 and
146 .CO cc
147 commands change from the first nonblank of the line to the end of the
148 line, instead of from the beginning of the line to the end of the line.
149 .KY autoprint
150 .IP "autoprint, ap [off]"
151 .CO Ex
152 only.
153 Cause the current line to be automatically displayed after the
154 .CO ex
155 commands
156 .CO < ,
157 .CO > ,
158 .CO copy ,
159 .CO delete ,
160 .CO join ,
161 .CO move ,
162 .CO put ,
163 .CO t ,
164 .CO Undo ,
165 and
166 .CO undo .
167 This automatic display is suppressed during
168 .CO global
169 and
170 .CO v
171 commands, and for any command where optional flags are used to explicitly
172 display the line.
173 .KY autowrite
174 .IP "autowrite, aw [off]"
175 If this option is set, the
176 .CO vi
177 .CO ! ,
178 .CO ^^ ,
179 .CO ^]
180 and
181 .CO <control-Z>
182 commands, and the
183 .CO ex
184 .CO edit ,
185 .CO next ,
186 .CO rewind ,
187 .CO stop ,
188 .CO suspend ,
189 .CO tag ,
190 .CO tagpop ,
191 and
192 .CO tagtop
193 commands automatically write the current file back to the current file name
194 if it has been modified since it was last written.
195 If the write fails, the command fails and goes no further.
196 .sp
197 Appending the optional force flag character
198 .QT !
199 to the
200 .CO ex
201 commands
202 .CO next ,
203 .CO rewind ,
204 .CO stop ,
205 .CO suspend ,
206 .CO tag ,
207 .CO tagpop ,
208 and
209 .CO tagtop
210 stops the automatic write from being attempted.
211 .sp
212 (Historically, the
213 .CO next
214 command ignored the optional force flag.)
215 Note, the
216 .CO ex
217 commands
218 .CO edit ,
219 .CO quit ,
220 .CO shell ,
221 and
222 .CO xit
223 are
224 .i not
225 affected by the
226 .OP autowrite
227 option.
228 .sp
229 The
230 .OP autowrite
231 option is ignored if the file is considered read-only for any reason.
232 .\" I cannot get a double quote to print between the square brackets
233 .\" to save my life. The ONLY way I've been able to get this to work
234 .\" is with the .tr command.
235 .tr Q"
236 .ds ms backup [QQ]
237 .KY backup
238 .IP "\*(ms"
239 .tr QQ
240 If this option is set, it specifies a pathname used as a backup file,
241 and, whenever a file is written, the file's current contents are copied
242 to it.
243 The pathname is
244 .QT \&# ,
245 .QT \&%
246 and
247 .QT \&!
248 expanded.
249 .sp
250 If the first character of the pathname is
251 .QT \&N ,
252 a version number is appended to the pathname (and the
253 .QT \&N
254 character is then discarded).
255 Version numbers are always incremented, and each backup file will have
256 a version number one greater than the highest version number currently
257 found in the directory.
258 .sp
259 Backup files must be regular files, owned by the real user ID of the
260 user running the editor, and not accessible by any other user.
261 .KY beautify
262 .IP "beautify, bf [off]"
263 If this option is set, all control characters that are not currently being
264 specially interpreted, other than
265 .LI <tab> ,
266 .LI <newline> ,
267 and
268 .LI <form-feed> ,
269 are
270 discarded from commands read in by
271 .CO ex
272 from command files, and from input text entered to
273 .CO vi
274 (either into the file or to the colon command line).
275 Text files read by
276 .EV ex vi
277 are
278 .i not
279 affected by the
280 .OP beautify
281 option.
282 .KY cdpath
283 .IP "cdpath [environment variable CDPATH, or current directory]"
284 This option is used to specify a colon separated list of directories
285 which are used as path prefixes for any relative path names used as
286 arguments for the
287 .CO cd
288 command.
289 The value of this option defaults to the value of the environmental
290 variable
291 .LI CDPATH
292 if it is set, otherwise to the current directory.
293 For compatibility with the POSIX 1003.2 shell, the
294 .CO cd
295 command does
296 .i not
297 check the current directory as a path prefix for relative path names
298 unless it is explicitly specified.
299 It may be so specified by entering an empty string or a
300 .QT \&.
301 character into the
302 .LI CDPATH
303 variable or the option value.
304 .KY cedit
305 .IP "cedit [no default]"
306 This option adds the ability to edit the colon command-line history.
307 This option is set to a string.
308 Whenever the first character of that string is entered on the colon
309 command line,
310 you will enter a normal editing window on the collected commands that
311 you've entered on the
312 .CO vi
313 colon command-line.
314 You may then modify and/or execute the commands.
315 All normal text editing is available,
316 except that you cannot use
317 .CO <control-W>
318 to switch to an alternate screen.
319 Entering a
320 .CO <carriage-return>
321 will execute the current line of the screen window as an ex command in
322 the context of the screen from which you created the colon command-line
323 screen,
324 and you will then return to that screen.
325 .sp
326 Because of
327 .CO vi \&'s
328 parsing rules, it can be difficult to set the colon command-line edit
329 character to the
330 .LI <escape>
331 character.
332 To set it to
333 .LI <escape> ,
334 use
335 .QT "set cedit=<literal-next><escape>" .
336 .sp
337 If the
338 .OP cedit
339 edit option is set to the same character as the
340 .OP filec
341 edit option,
342 .CO vi
343 will perform colon command-line editing if the character is entered as
344 the first character of the line,
345 otherwise,
346 .CO vi
347 will perform file name expansion.
348 .KY columns
349 .IP "columns, co [80]"
350 The number of columns in the screen.
351 Setting this option causes
352 .EV ex vi
353 to set (or reset) the environmental variable
354 .LI COLUMNS .
355 See the section entitled
356 .QB "Sizing the Screen"
357 more information.
358 .KY comment
359 .IP "comment [off]"
360 .CO Vi
361 only.
362 If the first non-empty line of the file begins with the string
363 .QT # ,
364 .QT /\&*
365 or
366 .QT // ,
367 this option causes
368 .CO vi
369 to skip to the end of that shell, C or C++ comment (probably a
370 terribly boring legal notice) before displaying the file.
371 .KY directory
372 .IP "directory, dir [environment variable TMPDIR, or /tmp]"
373 The directory where temporary files are created.
374 The environmental variable
375 .LI TMPDIR
376 is used as the default value if it exists, otherwise
377 .LI /tmp
378 is used.
379 .KY edcompatible
380 .IP "edcompatible, ed [off]"
381 Remember the values of the
382 .QQ c
383 and
384 .QQ g
385 suffixes to the
386 .CO substitute
387 commands, instead of initializing them as unset for each new
388 command.
389 Specifying pattern and replacement strings to the
390 .CO substitute
391 command unsets the
392 .QQ c
393 and
394 .QQ g
395 suffixes as well.
396 .KY escapetime
397 .IP "escapetime [1]"
398 The 10th's of a second
399 .EV ex vi
400 waits for a subsequent key to complete an
401 .LI <escape>
402 key mapping.
403 .KY errorbells
404 .IP "errorbells, eb [off]"
405 .CO Ex
406 only.
407 .CO Ex
408 error messages are normally presented in inverse video.
409 If that is not possible for the terminal, setting this option causes
410 error messages to be announced by ringing the terminal bell.
411 .KY exrc
412 .IP "exrc, ex [off]"
413 If this option is turned on in the EXINIT environment variables,
414 or the system or $HOME startup files,
415 the local startup files are read,
416 unless they are the same as the system or $HOME startup files or
417 fail to pass the standard permission checks.
418 See the section entitled
419 .QB "Startup Information"
420 for more information.
421 .KY extended
422 .IP "extended [off]"
423 This option causes all regular expressions to be treated as POSIX
424 1003.2 Extended Regular Expressions (which are similar to historic
425 .XR egrep 1
426 style expressions).
427 .KY filec
428 .IP "filec [no default]"
429 This option adds the ability to do shell expansion when entering input
430 on the colon command line.
431 This option is set to a string.
432 Whenever the first character of that string is entered on the colon
433 command line,
434 the <blank> delimited string immediately before the cursor is expanded
435 as if it were followed by a
436 .LI \&*
437 character, and file name expansion for the
438 .CO ex
439 edit command was done.
440 If no match is found, the screen is flashed and text input resumed.
441 If a single match results, that match replaces the expanded text.
442 In addition, if the single match is for a directory, a
443 .LI \&/
444 character is appended and file completion is repeated.
445 If more than a single match results,
446 any unique prefix shared by the matches replaces the expanded text,
447 the matches are displayed,
448 and text input resumed.
449 .sp
450 Because of
451 .CO vi \&'s
452 parsing rules, it can be difficult to set the path completion character
453 to two command values,
454 .LI <escape>
455 and
456 .LI <tab> .
457 To set it to
458 .LI <escape> ,
459 use
460 .QT "set filec=<literal-next><escape>" .
461 To set it to
462 .LI <tab> ,
463 use
464 .QT "set filec=\e<tab>" .
465 .sp
466 If the
467 .OP cedit
468 edit option is set to the same character as the
469 .OP filec
470 edit option,
471 .CO vi
472 will perform colon command-line editing if the character is entered as
473 the first character of the line,
474 otherwise,
475 .CO vi
476 will perform file name expansion.
477 .KY flash
478 .IP "flash [on]"
479 This option causes the screen to flash instead of beeping the keyboard,
480 on error, if the terminal has the capability.
481 .KY hardtabs
482 .IP "hardtabs, ht [8]"
483 This option defines the spacing between hardware tab settings, i.e.
484 the tab expansion done by the operating system and/or the terminal
485 itself.
486 As
487 .EV nex nvi
488 never writes
489 .LI <tab>
490 characters to the terminal, unlike historic versions of
491 .EV ex vi ,
492 this option does not currently have any affect.
493 .KY iclower
494 .IP "iclower [off]"
495 The
496 .OP iclower
497 edit option makes all Regular Expressions case-insensitive,
498 as long as an upper-case letter does not appear in the search string.
499 .KY ignorecase
500 .IP "ignorecase, ic [off]"
501 This option causes regular expressions, both in
502 .CO ex
503 commands and in searches,
504 to be evaluated in a case-insensitive manner.
505 .KY keytime
506 .IP "keytime [6]"
507 The 10th's of a second
508 .EV ex vi
509 waits for a subsequent key to complete a key mapping.
510 .KY leftright
511 .IP "leftright [off]"
512 .CO Vi
513 only.
514 This option causes the screen to be scrolled left-right to view
515 lines longer than the screen, instead of the traditional
516 .CO vi
517 screen interface which folds long lines at the right-hand margin
518 of the terminal.
519 .KY lines
520 .IP "lines, li [24]"
521 .CO Vi
522 only.
523 The number of lines in the screen.
524 Setting this option causes
525 .EV ex vi
526 to set (or reset) the environmental variable
527 .LI LINES .
528 See the section entitled
529 .QB "Sizing the Screen"
530 for more information.
531 .KY lisp
532 .IP "lisp [off]"
533 .CO Vi
534 only.
535 This option changes the behavior of the
536 .CO vi
537 .CO ( ,
538 .CO ) ,
539 .CO { ,
540 .CO } ,
541 .CO [[
542 and
543 .CO ]]
544 commands to match the Lisp language.
545 Also, the
546 .OP autoindent
547 option's behavior is changed to be appropriate for Lisp.
548 .sp
549 .i "This option is not yet implemented."
550 .KY list
551 .IP "list [off]"
552 This option causes lines to be displayed in an unambiguous fashion.
553 Specifically, tabs are displayed as control characters, i.e.
554 .QT ^I ,
555 and the ends of lines are marked with a
556 .QT $
557 character.
558 .KY lock
559 .IP "lock [on]"
560 This option causes the editor to attempt to get an exclusive lock on
561 any file being edited, read or written.
562 Reading or writing a file that cannot be locked produces a warning
563 message, but no other effect.
564 Editing a file that cannot be locked results in a read only edit session,
565 as if the
566 .OP readonly
567 edit option were set.
568 .KY magic
569 .IP "magic [on]"
570 This option is on by default.
571 Turning the
572 .OP magic
573 option off causes all regular expression characters except for
574 .QT ^
575 and
576 .QT $ ,
577 to be treated as ordinary characters.
578 To re-enable characters individually, when the
579 .OP magic
580 option is off,
581 precede them with a backslash
582 .QT \e
583 character.
584 See the section entitled
585 .QB "Regular Expressions and Replacement Strings"
586 for more information.
587 .KY matchchars
588 .IP "matchchars [[]{}()<>]"
589 .CO Vi
590 only.
591 This option defines the character pairs used by the
592 .CO %
593 command.
594 .KY matchtime
595 .IP "matchtime [7]"
596 .CO Vi
597 only.
598 The 10th's of a second
599 .CO vi
600 pauses on the matching character when the
601 .OP showmatch
602 option is set.
603 .KY mesg
604 .IP "mesg [on]"
605 This option allows other users to contact you using the
606 .XR talk 1
607 and
608 .XR write 1
609 utilities, while you are editing.
610 .EV Ex vi
611 does not turn message on, i.e. if messages were turned off when the
612 editor was invoked, they will stay turned off.
613 This option only permits you to disallow messages for the edit session.
614 See the
615 .XR mesg 1
616 utility for more information.
617 .KY msgcat
618 .IP "msgcat [./]"
619 This option selects a message catalog to be used to display error and
620 informational messages in a specified language.
621 If the value of this option ends with a '/', it is treated as the name
622 of a directory that contains a message catalog
623 .QT "vi_XXXX" ,
624 where
625 .QT XXXX
626 is the value of the
627 .LI LANG
628 environmental variable, if it's set, or the value of the
629 .LI LC_MESSAGES
630 environmental variable if it's not.
631 If neither of those environmental variables are set,
632 or if the option doesn't end in a '/',
633 the option is treated as the full path name of the message catalog to use.
634 .sp
635 If any messages are missing from the catalog,
636 the backup text (English) is used instead.
637 .sp
638 See the distribution file
639 .LI catalog/README
640 for additional information on building and installing message catalogs.
641 .KY modelines
642 .IP "modelines, modeline [off]"
643 If the
644 .OP modelines
645 option is set,
646 .EV ex vi
647 has historically scanned the first and last five lines of each file as
648 it is read for editing, looking for any
649 .CO ex
650 commands that have been placed in those lines.
651 After the startup information has been processed, and before the user
652 starts editing the file, any commands embedded in the file are executed.
653 .sp
654 Commands were recognized by the letters
655 .QQ e
656 or
657 .QQ v
658 followed by
659 .QQ x
660 or
661 .QQ i ,
662 at the beginning of a line or following a tab or space character,
663 and followed by a
664 .QQ : ,
665 an
666 .CO ex
667 command, and another
668 .QQ : .
669 .sp
670 This option is a security problem of immense proportions,
671 and should not be used under any circumstances.
672 .sp
673 .i "This option will never be implemented."
674 .\" I cannot get a double quote to print between the square brackets
675 .\" to save my life. The ONLY way I've been able to get this to work
676 .\" is with the .tr command.
677 .tr Q"
678 .ds ms noprint [QQ]
679 .KY noprint
680 .IP "\*(ms"
681 .tr QQ
682 Characters that are never handled as printable characters.
683 By default, the C library function
684 .XR isprint 3
685 is used to determine if a character is printable or not.
686 This edit option overrides that decision.
687 .KY number
688 .IP "number, nu [off]"
689 Precede each line displayed with its current line number.
690 .KY octal
691 .IP "octal [off]"
692 Display unknown characters as octal numbers
693 .PQ "\e###" ,
694 instead of the default
695 hexadecimal
696 .PQ "\ex##" .
697 .KY open
698 .IP "open [on]"
699 .CO Ex
700 only.
701 If this option is not set, the
702 .CO open
703 and
704 .CO visual
705 commands are disallowed.
706 .KY optimize
707 .IP "optimize, opt [on]"
708 .CO Vi
709 only.
710 Throughput of text is expedited by setting the terminal not to do automatic
711 carriage returns when printing more than one (logical) line of output,
712 greatly speeding output on terminals without addressable cursors when text
713 with leading white space is printed.
714 .sp
715 .i "This option is not yet implemented."
716 .KY paragraphs
717 .IP "paragraphs, para [IPLPPPQPP LIpplpipbp]"
718 .CO Vi
719 only.
720 Define additional paragraph boundaries for the
721 .CO {
722 and
723 .CO }
724 commands.
725 The value of this option must be a character string consisting
726 of zero or more character pairs.
727 .sp
728 In the text to be edited, the character string
729 .LI "<newline>.<char-pair>" ,
730 (where
731 .LI <char-pair>
732 is one of the character pairs in the option's value)
733 defines a paragraph boundary.
734 For example, if the option were set to
735 .LI "LaA<space>##" ,
736 then all of the following additional paragraph boundaries would be
737 recognized:
738 .sp
739 .(l
740 <newline>.La
741 <newline>.A<space>
742 <newline>.##
743 .)l
744 .KY path
745 .IP "path []"
746 The path option can be used to specify a <colon>-separated list of
747 paths, similar to the
748 .LI PATH
749 environment variable in the shells.
750 If this option is set,
751 the name of the file to be edited is not an absolute pathname,
752 the first component of the filename is not
753 .QT \&.
754 or
755 .QT \&.. ,
756 and the file to be edited doesn't exist in the current directory,
757 the elements of the
758 .OP path
759 option are sequentially searched for a file of the specified name.
760 If such a file is found, it is edited.
761 .\" I cannot get a double quote to print between the square brackets
762 .\" to save my life. The ONLY way I've been able to get this to work
763 .\" is with the .tr command.
764 .tr Q"
765 .ds ms print [QQ]
766 .KY print
767 .IP "\*(ms"
768 .tr QQ
769 Characters that are always handled as printable characters.
770 By default, the C library function
771 .XR isprint 3
772 is used to determine if a character is printable or not.
773 This edit option overrides that decision.
774 .KY prompt
775 .IP "prompt [on]"
776 .CO Ex
777 only.
778 This option causes
779 .CO ex
780 to prompt for command input with a
781 .QT :
782 character; when it is not set, no prompt is displayed.
783 .KY readonly
784 .IP "readonly, ro [off]"
785 This option causes a force flag to be required to attempt to write the file.
786 Setting this option is equivalent to using the
787 .b \-R
788 command line option,
789 or executing the
790 .CO vi
791 program using the name
792 .CO view .
793 .sp
794 The
795 .OP readonly
796 edit option is not usually persistent, like other edit options.
797 If the
798 .b \-R
799 command line option is set,
800 .CO vi
801 is executed as
802 .CO view ,
803 or the
804 .OP readonly
805 edit option is explicitly set,
806 all files edited in the screen will be marked readonly,
807 and the force flag will be required to write them.
808 However, if none of these conditions are true,
809 or the
810 .OP readonly
811 edit option is explicitly unset,
812 then the
813 .OP readonly
814 edit option will toggle based on the write permissions of the file currently
815 being edited as of when it is loaded into the edit buffer.
816 In other words, the
817 .OP readonly
818 edit option will be set if the current file lacks write permissions,
819 and will not be set if the user has write permissions for the file.
820 .KY recdir
821 .IP "recdir [/var/tmp/vi.recover]"
822 The directory where recovery files are stored.
823 .sp
824 If you change the value of
825 .OP recdir ,
826 be careful to choose a directory whose contents are not regularly
827 deleted.
828 Bad choices include directories in memory based filesystems,
829 or
830 .LI /tmp ,
831 on most systems,
832 as their contents are removed when the machine is rebooted.
833 .sp
834 Public directories like
835 .LI /usr/tmp
836 and
837 .LI /var/tmp
838 are usually safe, although some sites periodically prune old files
839 from them.
840 There is no requirement that you use a public directory,
841 e.g. a sub-directory of your home directory will work fine.
842 .sp
843 Finally, if you change the value of
844 .OP recdir ,
845 you must modify the recovery script to operate in your chosen recovery
846 area.
847 .sp
848 See the section entitled
849 .QB "Recovery"
850 for further information.
851 .KY redraw
852 .IP "redraw, re [off]"
853 .CO Vi
854 only.
855 The editor simulates (using great amounts of output), an intelligent
856 terminal on a dumb terminal (e.g. during insertions in
857 .CO vi
858 the characters to the right of the cursor are refreshed as each input
859 character is typed).
860 .sp
861 .i "This option is not yet implemented."
862 .KY remap
863 .IP "remap [on]"
864 If this option is set,
865 it is possible to define macros in terms of other macros.
866 Otherwise, each key is only remapped up to one time.
867 For example, if
868 .QT A
869 is mapped to
870 .QT B ,
871 and
872 .QT B
873 is mapped to
874 .QT C ,
875 The keystroke
876 .QT A
877 will be mapped to
878 .QT C
879 if the
880 .OP remap
881 option is set, and to
882 .QT B
883 if it is not set.
884 .KY report
885 .IP "report [5]"
886 Set the threshold of the number of lines that need to be changed or
887 yanked before a message will be displayed to the user.
888 For everything but the yank command, the value is the largest value
889 about which the editor is silent, i.e. by default, 6 lines must be
890 deleted before the user is notified.
891 However, if the number of lines yanked is greater than
892 .i "or equal to"
893 the set value, it is reported to the user.
894 .KY ruler
895 .IP "ruler [off]"
896 .CO Vi
897 only.
898 Display a row/column ruler on the colon command line.
899 .KY scroll
900 .IP "scroll, scr [(environment variable LINES - 1) / 2]"
901 Set the number of lines scrolled by the
902 .CO ex
903 .CO <control-D>
904 and
905 .CO <end-of-file>
906 commands.
907 .sp
908 Historically, the
909 .CO ex
910 .CO z
911 command, when specified without a count, used two times the size of the
912 scroll value; the POSIX 1003.2 standard specified the window size, which
913 is a better choice.
914 .KY searchincr
915 .IP "searchincr [off]"
916 The
917 .OP searchincr
918 edit option makes the search commands
919 .CO \&/
920 and
921 .CO \&?
922 incremental, i.e. the screen is updated and the cursor moves to the matching
923 text as the search pattern is entered.
924 If the search pattern is not found,
925 the screen is beeped and the cursor remains on the colon-command line.
926 Erasing characters from the search pattern backs the cursor up to the
927 previous matching text.
928 .KY sections
929 .IP "sections, sect [NHSHH HUnhsh]"
930 .CO Vi
931 only.
932 Define additional section boundaries for the
933 .CO [[
934 and
935 .CO ]]
936 commands.
937 The
938 .OP sections
939 option should be set to a character string consisting of zero or
940 more character pairs.
941 In the text to be edited, the character string
942 .LI "<newline>.<char-pair>" ,
943 (where
944 .LI <char-pair>
945 is one of the character pairs in the option's value),
946 defines a section boundary in the same manner that
947 .OP paragraphs
948 option boundaries are defined.
949 .KY secure
950 .IP "secure [off]"
951 The
952 .OP secure
953 edit option turns off all access to external programs.
954 This means that the versions of the
955 .CO read
956 and
957 .CO write
958 commands that filter text through other programs,
959 the
960 .CO vi
961 .CO \&!
962 and
963 .CO <control-Z>
964 commands,
965 the
966 .CO ex
967 .CO \&! ,
968 .CO script ,
969 .CO shell ,
970 .CO stop
971 and
972 .CO suspend
973 commands and file name expansion will not be permitted.
974 Once set,
975 the
976 .OP secure
977 edit option may not be unset.
978 .KY shell
979 .IP "shell, sh [environment variable SHELL, or /bin/sh]"
980 Select the shell used by the editor.
981 The specified path is the pathname of the shell invoked by the
982 .CO vi
983 .CO !
984 shell escape command and by the
985 .CO ex
986 .CO shell
987 command.
988 This program is also used to resolve any shell meta-characters in
989 .CO ex
990 commands.
991 .\" I cannot get a double quote to print between the square brackets
992 .\" to save my life. The ONLY way I've been able to get this to work
993 .\" is with the .tr command.
994 .tr Q"
995 .ds ms shellmeta [~{[*?$`'Q\e]
996 .KY shellmeta
997 .IP "\*(ms"
998 .tr QQ
999 The set of characters that
1000 .CO ex
1001 checks for when doing file name expansion.
1002 If any of the specified characters are found in the file name arguments
1003 to the
1004 .CO ex
1005 commands,
1006 the arguments are expanded using the program defined by the
1007 .OP shell
1008 option.
1009 The default set of characters is a union of meta characters
1010 from the Version 7 and the Berkeley C shell.
1011 .KY shiftwidth
1012 .IP "shiftwidth, sw [8]"
1013 Set the autoindent and shift command indentation width.
1014 This width is used by the
1015 .OP autoindent
1016 option and by the
1017 .CO < ,
1018 .CO > ,
1019 and
1020 .CO shift
1021 commands.
1022 .KY showmatch
1023 .IP "showmatch, sm [off]"
1024 .CO Vi
1025 only.
1026 This option causes
1027 .CO vi ,
1028 when a
1029 .QT }
1030 or
1031 .QT )
1032 is entered, to briefly move the cursor the matching
1033 .QT {
1034 or
1035 .QT ( .
1036 See the
1037 .OP matchtime
1038 option for more information.
1039 .KY showmode
1040 .IP "showmode, smd [off]"
1041 .CO Vi
1042 only.
1043 This option causes
1044 .CO vi
1045 to display a string identifying the current editor mode on the colon
1046 command line.
1047 The string is preceded by an asterisk (``*'') if the file has been
1048 modified since it was last completely written,
1049 .KY sidescroll
1050 .IP "sidescroll [16]"
1051 .CO Vi
1052 only.
1053 Sets the number of columns that are shifted to the left or right,
1054 when
1055 .CO vi
1056 is doing left-right scrolling and the left or right margin is
1057 crossed.
1058 See the
1059 .OP leftright
1060 option for more information.
1061 .KY slowopen
1062 .IP "slowopen, slow [off]"
1063 This option affects the display algorithm used by
1064 .CO vi ,
1065 holding off display updating during input of new text to improve
1066 throughput when the terminal in use is slow and unintelligent.
1067 .sp
1068 .i "This option is not yet implemented."
1069 .KY sourceany
1070 .IP "sourceany [off]"
1071 If this option is turned on,
1072 .CO vi
1073 historically read startup files that were owned by someone other than
1074 the editor user.
1075 See the section entitled
1076 .QB "Startup Information"
1077 for more information.
1078 This option is a security problem of immense proportions,
1079 and should not be used under any circumstances.
1080 .sp
1081 .i "This option will never be implemented."
1082 .KY tabstop
1083 .IP "tabstop, ts [8]"
1084 This option sets tab widths for the editor display.
1085 .KY taglength
1086 .IP "taglength, tl [0]"
1087 This option sets the maximum number of characters that are considered
1088 significant in a tag name.
1089 Setting the value to 0 makes all of the characters in the tag name
1090 significant.
1091 .KY tags
1092 .IP "tags, tag [tags /var/db/libc.tags /sys/kern/tags]"
1093 Sets the list of tags files, in search order,
1094 which are used when the editor searches for a tag.
1095 .KY term
1096 .IP "term, ttytype, tty [environment variable TERM]"
1097 Set the terminal type.
1098 Setting this option causes
1099 .EV ex vi
1100 to set (or reset) the environmental variable
1101 .LI TERM .
1102 .KY terse
1103 .IP "terse [off]"
1104 This option has historically made editor messages less verbose.
1105 It has no effect in this implementation.
1106 See the
1107 .OP verbose
1108 option for more information.
1109 .KY tildeop
1110 .IP "tildeop [off]"
1111 Modify the
1112 .CO ~
1113 command to take an associated motion.
1114 .KY timeout
1115 .IP "timeout, to [on]"
1116 If this option is set,
1117 .EV ex vi
1118 waits for a specific period for a subsequent key to complete a key
1119 mapping (see the
1120 .OP keytime
1121 option).
1122 If the option is not set, the editor waits until enough keys are
1123 entered to resolve the ambiguity, regardless of how long it takes.
1124 .KY ttywerase
1125 .IP "ttywerase [off]"
1126 .CO Vi
1127 only.
1128 This option changes how
1129 .CO vi
1130 does word erase during text input.
1131 If this option is set, text is broken up into two classes,
1132 blank characters and nonblank characters.
1133 Changing from one class to another marks the end of a word.
1134 .KY verbose
1135 .IP "verbose [off]"
1136 .CO Vi
1137 only.
1138 .CO Vi
1139 historically bells the terminal for many obvious mistakes, e.g. trying
1140 to move past the left-hand margin, or past the end of the file.
1141 If this option is set, an error message is displayed for all errors.
1142 .KY w300
1143 .IP "w300 [no default]"
1144 .CO Vi
1145 only.
1146 Set the window size if the baud rate is less than 1200 baud.
1147 See the
1148 .OP window
1149 option for more information.
1150 .KY w1200
1151 .IP "w1200 [no default]"
1152 .CO Vi
1153 only.
1154 Set the window size if the baud rate is equal to 1200 baud.
1155 See the
1156 .OP window
1157 option for more information.
1158 .KY w9600
1159 .IP "w9600 [no default]"
1160 .CO Vi
1161 only.
1162 Set the window size if the baud rate is greater than 1200 baud.
1163 See the
1164 .OP window
1165 option for more information.
1166 .KY warn
1167 .IP "warn [on]"
1168 .CO Ex
1169 only.
1170 This option causes a warning message to the terminal if the file has
1171 been modified, since it was last written, before a
1172 .CO !
1173 command.
1174 .KY window
1175 .IP "window, w, wi [environment variable LINES - 1]"
1176 This option determines the default number of lines in a screenful,
1177 as displayed by the
1178 .CO z
1179 command.
1180 It also determines the number of lines scrolled by the
1181 .CO vi
1182 commands
1183 .CO <control-B>
1184 and
1185 .CO <control-F> ,
1186 and the default number of lines scrolled by the
1187 .CO vi
1188 commands
1189 .CO <control-D>
1190 and
1191 .CO <control-U> .
1192 The value of window can be unrelated to the real screen size,
1193 although it starts out as the number of lines on the screen.
1194 See the section entitled
1195 .QB "Sizing the Screen"
1196 for more information.
1197 Setting the value of the
1198 .OP window
1199 option is the same as using the
1200 .b \-w
1201 command line option.
1202 .sp
1203 If the value of the
1204 .OP window
1205 option (as set by the
1206 .OP window ,
1207 .OP w300 ,
1208 .OP w1200
1209 or
1210 .OP w9600
1211 options) is smaller than the actual size of the screen,
1212 large screen movements will result in displaying only that smaller
1213 number of lines on the screen.
1214 (Further movements in that same area will result in the screen being
1215 filled.)
1216 This can provide a performance improvement when viewing different
1217 places in one or more files over a slow link.
1218 .sp
1219 Resetting the window size does not reset the default number of lines
1220 scrolled by the
1221 .CO <control-D>
1222 and
1223 .CO <control-U>
1224 commands.
1225 .KY windowname
1226 .IP "windowname [off]"
1227 .CO Vi
1228 changes the name of the editor's icon/window to the current file name
1229 when it's possible and not destructive, i.e.,
1230 when the editor can restore it to its original value on exit or when
1231 the icon/window will be discarded as the editor exits.
1232 If the
1233 .OP windowname
1234 edit option is set,
1235 .CO vi
1236 will change the icon/window name even when it's destructive and the
1237 icon/window name will remain after the editor exits.
1238 (This is the case for
1239 .XR xterm 1 ).
1240 .KY wraplen
1241 .IP "wraplen, wl [0]"
1242 This option is identical to the
1243 .OP wrapmargin
1244 option, with the exception that it specifies the number of columns
1245 from the
1246 .i left
1247 margin before the line splits, not the right margin.
1248 .sp
1249 If both
1250 .OP wraplen
1251 and
1252 .OP wrapmargin
1253 are set, the
1254 .OP wrapmargin
1255 value is used.
1256 .KY wrapmargin
1257 .IP "wrapmargin, wm [0]"
1258 .CO Vi
1259 only.
1260 If the value of the
1261 .OP wrapmargin
1262 option is non-zero,
1263 .CO vi
1264 will split lines so that they end at least that number of columns
1265 before the right-hand margin of the screen.
1266 (Note, the value of
1267 .OP wrapmargin
1268 is
1269 .i not
1270 a text length.
1271 In a screen that is 80 columns wide, the command
1272 .QT ":set wrapmargin=8"
1273 attempts to keep the lines less than or equal to 72 columns wide.)
1274 .sp
1275 Lines are split at the previous whitespace character closest to the
1276 number.
1277 Any trailing whitespace characters before that character are deleted.
1278 If the line is split because of an inserted
1279 .LI <space>
1280 or
1281 .LI <tab>
1282 character, and you then enter another
1283 .LI <space>
1284 character, it is discarded.
1285 .sp
1286 If wrapmargin is set to 0,
1287 or if there is no blank character upon which to split the line,
1288 the line is not broken.
1289 .sp
1290 If both
1291 .OP wraplen
1292 and
1293 .OP wrapmargin
1294 are set, the
1295 .OP wrapmargin
1296 value is used.
1297 .KY wrapscan
1298 .IP "wrapscan, ws [on]"
1299 This option causes searches to wrap around the end or the beginning
1300 of the file, and back to the starting point.
1301 Otherwise, the end or beginning of the file terminates the search.
1302 .KY writeany
1303 .IP "writeany, wa [off]"
1304 If this option is set, file-overwriting checks that would usually be
1305 made before the
1306 .CO write
1307 and
1308 .CO xit
1309 commands, or before an automatic write (see the
1310 .OP autowrite
1311 option), are not made.
1312 This allows a write to any file, provided the file permissions allow it.