set.opt.roff

早期freebsd实现

.\" Copyright (c) 1994
.\"     The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)set.opt.roff	8.8 (Berkeley) 4/9/94
.\"
There are a large number of options that may be set (or unset) to
change the editor's behavior.
This section describes the options, their abbreviations and their
default values.
.Pp
In each entry below, the first part of the tag line is the full name
of the option, followed by any equivalent abbreviations.
#ifdef REFERENCE
(Regardless of the abbreviations, it is only necessary to use the
minimum number of characters necessary to distinguish an abbreviation
from all other commands for it to be accepted, in
.Nm nex/nvi .
Historically, only the full name and the official abbreviations
were accepted by
.Nm ex/vi .
Using full names in your startup files and environmental variables will
probably make them more portable.)
#endif
The part in square brackets is the default value of the option.
Most of the options are boolean, i.e. they are either on or off,
and do not have an associated value.
.Pp
Options apply to both
.Nm \&ex
and
.Nm \&vi
modes, unless otherwise specified.
#ifdef REFERENCE
.Pp
For information on modifying the options or to display the options and
their current values, see the
.Dq set
command in the Ex Commands section.
#endif
.Bl -tag -width "XXXX" -compact
.It Li "altwerase [off]"
.Nm \&Vi
only.
#ifdef MANUAL
Select an alternate word erase algorithm.
#endif
#ifdef REFERENCE
Change how
.Nm \&vi
does word erase during text input.
When this option is set, text is broken up into three classes:
alphabetic, numeric and underscore characters, other non-blank
characters, and blank characters.
Changing from one class to another marks the end of a word.
In addition, the class of the first character erased is ignored
(which is exactly what you want when erasing pathname components).
#endif
.It Li "autoindent, ai [off]"
#ifdef MANUAL
Automatically indent new lines.
#endif
#ifdef REFERENCE
If this option is set, whenever you create a new line (using the
.Nm \&vi
.Sy \&A ,
.Sy \&a ,
.Sy \&C ,
.Sy \&c ,
.Sy \&I ,
.Sy \&i ,
.Sy \&O ,
.Sy \&o ,
.Sy \&R ,
.Sy \&r ,
.Sy \&S ,
and
.Sy \&s
commands, or the
.Nm \&ex
.Sy append ,
.Sy change ,
and
.Sy insert
commands) the new line is automatically indented to align the cursor with
the first non-blank character of the line from which you created it.
Lines are indented using tab characters to the extent possible (based on
the value of the
.Sy tabstop
option) and then using space characters as necessary.
For commands inserting text into the middle of a line, any blank characters
to the right of the cursor are discarded, and the first non-blank character
to the right of the cursor is aligned as described above.
.Pp
The indent characters are themselves somewhat special.
If you do not enter more characters on the new line before moving moving to
another line, or entering <escape>, the indent character will be deleted and
the line will be empty.
For example, if you enter <carriage-return> twice in succession, the line
created by the first <carriage-return> will not have any characters in it,
regardless of the indentation of the previous or subsequent line.
.Pp
Indent characters also require that you enter additional erase characters
to delete them.
For example, if you have an indented line, containing only blanks, the first
<word-erase> character you enter will erase up to end of the indent characters,
and the second will erase back to the beginning of the line.
(Historically, only the
.Sy \&^D
key would erase the indent characters.
Both the
.Sy \&^D
key and the usual erase keys work in
.Nm nvi .)
In addition, if the cursor is positioned at the end of the indent
characters, the keys
.Dq 0^D
will erase all of the indent characters for the current line,
resetting the indentation level to 0.
Similarly, the keys
.Dq ^^D
(i.e. a carat followed by a <control-D>) will erase all of the indent
characters for the current line, leaving the indentation level for
future created lines unaffected.
.Pp
Finally, if
.Sy autoindent
is set, the
.Sy \&S
and
.Sy \&cc
commands change from the first non-blank of the line to the end of the
line, instead of from the beginning of the line to the end of the line.
#endif
.It Li "autoprint, ap [off]"
.Nm \&Ex
only.
#ifdef MANUAL
Display the current line automatically.
.
#endif
#ifdef REFERENCE
.Nm \&Ex
only.
Cause the current line to be automatically displayed after the
.Nm \&ex
commands
.Sy \&< ,
.Sy \&> ,
.Sy copy ,
.Sy delete ,
.Sy join ,
.Sy move ,
.Sy put ,
.Sy \&t ,
.Sy Undo ,
and
.Sy undo .
This automatic display is suppressed during
.Sy global
and
.Sy vglobal
commands, and for any command where optional flags are used to explicitly
display the line.
#endif
.It Li "autowrite, aw [off]"
#ifdef MANUAL
Write modified files automatically when changing files.
#endif
#ifdef REFERENCE
If this option is set, the
.Nm \&vi
.Sy \&!
.Sy \&^^
.Sy \&^]
and
.Sy \&^Z
commands, and the
.Nm \&ex
.Sy edit ,
.Sy next ,
.Sy rewind ,
.Sy stop ,
.Sy suspend ,
.Sy tag ,
.Sy tagpop ,
and
.Sy tagtop
commands automatically write the current file back to the current file name
if it has been modified since it was last written.
If the write fails, the command fails and goes no further.
.Pp
Appending the optional force flag
.Dq \&!
to the
.Nm \&ex
commands
.Sy next ,
.Sy rewind ,
.Sy stop ,
.Sy suspend ,
.Sy tag ,
.Sy tagpop ,
and
.Sy tagtop
stops the automatic write from being attempted.
.Pp
(Historically, the
.Sy next
command ignored the optional force flag.)
Note, the
.Nm \&ex
commands
.Sy edit ,
.Sy quit ,
.Sy shell ,
and
.Sy xit
are
.Em not
affected by the
.Sy autowrite
option.
#endif
.It Li "beautify, bf [off]"
#ifdef MANUAL
Discard control characters.
#endif
#ifdef REFERENCE
If this option is set, all control characters that are not currently being
specially interpreted, other than <tab>, <newline>, and <form-feed>, are
discarded from commands read in by
.Nm \&ex
from command files, and from input text entered to
.Nm \&vi
(either into the file or to the colon command line).
Text files read by
.Nm ex/vi
are
.Em not
affected by the
.Sy beautify
option.
#endif
.It Li "cdpath [environment variable CDPATH, or ``.'']"
#ifdef MANUAL
The directory paths used as path prefixes for the
.Sy cd
command.
#endif
#ifdef REFERENCE
This option is used to specify a colon separated list of directories
which are used as path prefixes for any relative path names used as
arguments for the
.Sy cd
command.
The value of this option defaults to the value of the environmental
variable
.Ev CDPATH
if it is set, otherwise to the current directory.
For compatibility with the POSIX 1003.2 shell, the
.Sy cd
command does
.Em not
check the current directory as a path prefix for relative path names
unless it is explicitly specified.
It may be so specified by entering an empty string or a
.Dq \&.
into the
.Ev CDPATH 
variable or the option value.
#endif
.It Li "columns, co [80]"
#ifdef MANUAL
Set the number of columns in the screen.
#endif
#ifdef REFERENCE
The number of columns in the screen.
Setting this option causes
.Nm ex/vi
to set (or reset) the environmental variable
.Ev COLUMNS .
See the SCREEN SIZING section for more information.
#endif
.It Li "comment [off]"
.Nm \&Vi
only.
#ifdef MANUAL
Skip leading comments in files.
#endif
#ifdef REFERENCE
If the first non-empty line of the file begins with the string
.Dq \&/\&* ,
this option causes
.Nm \&vi
to skip to the end of that C comment (probably a terribly boring
legal notice) before displaying the file.
#endif
.It Li "directory, dir [environment variable TMPDIR, or /tmp]"
#ifdef MANUAL
The directory where temporary files are created.
#endif
#ifdef REFERENCE
The directory where temporary files are created.
The environmental variable
.Ev TMPDIR
is used as the default value if it exists, otherwise
.Pa /tmp
is used.
#endif
.It Li "edcompatible, ed [off]"
Remember the values of the
.Dq \&c
and
.Dq \&g
suffices to the
.Sy substitute
commands, instead of initializing them as unset for each new
command.
#ifdef REFERENCE
Specifying pattern and replacement strings to the
.Sy substitute
command unsets the
.Dq \&c
and
.Dq \&g
suffices as well.
#endif
.It Li "errorbells, eb [off]"
.Nm \&Ex
only.
#ifdef MANUAL
Announce error messages with a bell.
#endif
#ifdef REFERENCE
.Nm \&Ex
error messages are normally presented in inverse video.
If that is not possible for the terminal, setting this option causes
error messages to be announced by ringing the terminal bell.
#endif
.It Li "exrc, ex [off]"
#ifdef MANUAL
Never read startup files in the local directory.
#endif
#ifdef REFERENCE
If this option is turned off in the system or $HOME startup files,
the local startup files are never read (unless they are the same
as the system or $HOME startup files).
Turning it on has no effect, i.e. the normal checks for local startup
files are performed, regardless.
See the STARTUP INFORMATION section for more information.
#endif
.It Li "extended [off]"
#ifdef MANUAL
Regular expressions are extended (i.e.
.Xr egrep 1
style) expressions.
#endif
#ifdef REFERENCE
This option causes all regular expressions to be treated as POSIX
1003.2 extended regular expressions (which are similar to historic
.Xr egrep 1
style expressions).
#endif
.It Li "flash [on]"
#ifdef MANUAL
Flash the screen instead of beeping the keyboard on error.
#endif
#ifdef REFERENCE
This option causes the screen to flash instead of beeping the keyboard,
on error, if the terminal has the capability.
#endif
.It Li "hardtabs, ht [8]"
#ifdef MANUAL
Set the spacing between hardware tab settings.
#endif
#ifdef REFERENCE
This option defines the spacing between hardware tab settings, i.e.
the tab expansion done by the operating system and/or the terminal
itself.
As
.Nm nex/nvi
never writes tabs to the terminal, unlike historic versions of
.Nm ex/vi ,
this option does not currently have any affect.
#endif
.It Li "ignorecase, ic [off]"
#ifdef MANUAL
Ignore case differences in regular expressions.
#endif
#ifdef REFERENCE
This option causes regular expressions, both in
.Nm \&ex
commands and in searches,
to be evaluated in a case-insensitive manner.
#endif
.It Li "keytime [6]"
The 10th's of a second
.Nm ex/vi
waits for a subsequent key to complete a key mapping.
.It Li "leftright [off]"
.Nm \&Vi
only.
#ifdef MANUAL
Do left-right scrolling.
#endif
#ifdef REFERENCE
This option causes the screen to be scrolled left-right to view
lines longer than the screen, instead of the traditional
.Nm \&vi
screen interface which folds long lines at the right-hand margin
of the terminal.
#endif
.It Li "lines, li [24]"
.Nm \&Vi
only.
#ifdef MANUAL
Set the number of lines in the screen.
#endif
#ifdef REFERENCE
The number of lines in the screen.
Setting this option causes
.Nm ex/vi
to set (or reset) the environmental variable
.Ev LINES .
See the Screen Sizing section for more information.
#endif
.It Li "lisp [off]"
.Nm \&Vi
only.
#ifdef MANUAL
Modify various search commands and options to work with Lisp.
#endif
#ifdef REFERENCE
This option changes the behavior of the
.Nm \&vi
.Sy \&( ,
.Sy \&) ,
.Sy \&{ ,
.Sy \&} ,
.Sy \&[[
and
.Sy \&]]
commands to match the Lisp language.
Also, the
.Sy autoindent
option's behavior is changed to be appropriate for Lisp.
#endif
.br
.Em "This option is not yet implemented."
.It Li "list [off]"
#ifdef MANUAL
Display lines in an unambiguous fashion.
#endif
#ifdef REFERENCE
This option causes lines to be displayed in an unambiguous fashion.
Specifically, tabs are displayed as control characters, i.e.
.Dq \&^I ,
and the ends of lines are marked with a
.Dq \&$
character.
#endif
.It Li "magic [on]"
#ifdef MANUAL
Treat certain characters specially in regular expressions.
#endif
#ifdef REFERENCE
This option is on by default.
Turning the
.Sy magic
option off causes all regular expression characters except for
.Dq \&^
and
.Dq \&$ ,
to be treated as ordinary characters.
To re-enable characters individually, when the
.Sy magic
option is off,
precede them with an
.Dq \&\e .
See the REGULAR EXPRESSIONS AND REPLACEMENT STRINGS section for
more information.
#endif
.It Li "matchtime [7]"
.Nm \&Vi
only.
The 10th's of a second
.Nm ex/vi
pauses on the matching character when the
.Sy showmatch
option is set.
.It Li "mesg [on]"
#ifdef MANUAL
Permit messages from other users.
#endif
#ifdef REFERENCE
This option allows other users to contact you using the
.Xr talk 1
and
.Xr write 1
utilities, while you are editing.
.Nm Ex/vi
does not turn message on, i.e. if messages were turned off when the