8000 minix/man/man1x/elvis.1x at R3.2.0 · devinblood/minix · GitHub
[go: up one dir, main page]

Skip to content

Latest commit

 

History

History
1272 lines (1155 loc) · 36.5 KB

elvis.1x

File metadata and controls

1272 lines (1155 loc) · 36.5 KB
.B :set
charattr
.ti -0.25i
.B :se
ca
.br
\fIElvis\fR can display \*(OQbackslash-f\*(CQ style character attributes on the
screen as you edit. The following example shows the recognized
attributes:
normal \fBboldface\fR \fIitalics\fR
NOTE: you must compile \fIelvis\fR without the \(enDSET_NOCHARATTR flag for
this to work.
.in -0.25i
.SS "Omissions"
.PP
A few \fIvi\fR features are missing.
The replace mode is a hack. It does not save the text that it overwrites.
.PP
Long lines are displayed differently\(emwhere the real vi would wrap a long
line onto several rows of the screen, \fIelvis\fR simply displays part of the line,
and allows you to scroll the screen sideways to see the rest of it.
.PP
The \*(OQ:preserve\*(CQ and \*(OQ:recover\*(CQ commands are missing, as
is the \fB\(enr\fR flag.
\*(OQ:Preserve" is practically never used and since use of \*(OQ:recover\\*(CQ
is so rare, it was decided to implement it as a separate program. There's no
need to load the recovery code into memory every time you edit a file.
.PP
LISP support is missing.
The \*(OQ@\*(CQ and \*(OQ:@\*(CQ commands are missing.
You cannot APPEND to a cut buffer.
.SS "Options"
.PP
A variety of options can be set as described below:
.HS
.nf
.in +0.25i
.ta 0.9i 1.35i 2.1i 3.0i
\fBName Abbr Type Default Description\fR
autoindent as Bool FALSE autoindent during input?
autowrite aw Bool FALSE write file for :n command?
charattr ca Bool FALSE display bold & underline chars?
columns co Number 80 width of screen, in characters
directory dir String /usr/tmp where tmp files are kept
errorbells eb Bool TRUE ring bell on error?
exrefresh er Bool TRUE EX mode calls write() often?
ignorecase ic Bool FALSE searches: upper/lowercase OK?
keytime kt Number 1 allow slow receipt of ESC seq?
keywordprg kp String /usr/bin/ref program to run for shift-K
lines ln Number 25 height of screen, in lines
list li Bool FALSE show tabs as \*(OQ^I\*(CQ?
magic ma Bool TRUE searches: allow metacharacters?
paragraphs pa String PPppPApa paragraphs start with .PP, etc.
readonly ro Bool FALSE no file should be written back?
report re Number 5 report changes to X lines?
scroll sc Number 12 default #lines for ^U and ^D
sections se String SEseSHsh sections start with .SE, etc.
shell sh String \fI/bin/sh\fR shell program, from environment
shiftwidth sw Number 8 width of < or > commands
sidescroll ss Number 8 #chars to scroll sideways by
sync sy Bool FALSE call sync() after each change?
tabstop ts Number 8 width of a tab character
term te String "?" terminal type, from environment
vbell vb Bool TRUE use visible bell if possible?
warn wa Bool TRUE warn if file not saved for :!cmd
wrapmargin wm Number 0 Insert newline after which col?
wrapscan ws Bool TRUE searches: wrap at EOF?
.fi
.ti -0.25i
.B autoindent
.br
During input mode, the autoindent option will cause each added line
to begin with the same amount of leading whitespace as the line above
it. Without autoindent, added lines are initially empty.
.ti -0.25i
.B autowrite
.br
When you're editing one file and decide to switch to another\(emvia
the :tag command, or :next command, perhaps\(emif your current
file has been modified, then \fIelvis\fR will normally print an error
message and refuse to switch.
However, if the autowrite option is on, then \fIelvis\fR will write the
modified version of the current file and successfully switch to the
new file.
.ti -0.25i
.B charattr
.br
Many text formatting programs allow you to designate portions of
your text to be underlined, italicized, or boldface by embedding
the special strings \\fU, \\fI, and \\fB in your text. The special
string \\fR marks the end of underlined or boldface text.
\fIElvis\fR normally treats those special strings just like any other
text.
However, if the \fIcharattr\fR option is on, then \fIelvis\fR will interpret
those special strings correctly, to display underlined or boldface
text on the screen. (This only works, of course, if your terminal
can display underlined and boldface, and if the TERMCAP entry says
how to do it.)
.ti -0.25i
.B columns
.br
This is a \*(OQread only\*(CQ option. You cannot change its value, but you
can have \fIelvis\fR print it. It shows how wide your screen is.
.ti -0.25i
.B directory
.br
Elvis uses temporary files to store changed text.
This option allows you to control where those temporary files will be.
Ideally, you should store them on in fast non-volatile memory,
such as a hard disk.
This option can only be set in the ".exrc" file.
.ti -0.25i
.B errorbells
.br
Normally, \fIelvis\fR will ring your terminal's bell if you make an error.
However, in noerrorbells mode, your terminal will remain silent.
.ti -0.25i
.B exrefresh
.br
The EX mode of \fIelvis\fR writes many lines to the screen. You can make
\fIelvis\fR either write each line to the screen separately, or save up
many lines and write them all at once.
The exrefresh option is normally on, so each line is written to the
screen separately.
You may wish to turn the exrefresh option off (:se noer) if the
\*(OQwrite\*(CQ system call is costly on your machine, or if you're using a
windowing environment. (Windowing environments scroll text a lot
faster when you write many lines at once.)
This option has no effect in \fIvi\fR mode.
.ti -0.25i
.B ignorecase
.br
Normally, when \fIelvis\fR searches for text, it treats uppercase letters
as being different for lowercase letters.
When the ignorecase option is on, uppercase and lowercase are treated
as equal.
.ti -0.25i
.B keytime
.br
The arrow keys of most terminals send a multi-character sequence.
It takes a measurable amount of time for these sequences to be
transmitted. The keytime option allows you to control the maximum
amount of time to allow for an arrow key (or other mapped key) to
be received in full.
The default keytime value is 2. Because of the way
.Ux
timekeeping works, the actual amount of time allowed will vary slightly, but it
will always be between 1 and 2 seconds.
If you set keytime to 1, then the actual amount of time allowed will
be between 0 and 1 second. This will generally make the keyboard's
response be a little faster (mostly for the ESC key), but on those
occasions where the time allowed happens to be closer to 0 than 1
second, \fIelvis\fR may fail to allow enough time for an arrow key's
sequence to be received fully. Ugh.
As a special case, you can set keytime to 0 to disable this time
limit stuff altogether. The big problem here is: If your arrow
keys' sequences start with an ESC, then every time you hit your ESC
key \fIelvis\fR will wait... and wait... to see if maybe that ESC was
part of an arrow key's sequence.
NOTE: this option is a generalization of the timeout option of the
real vi.
.ti -0.25i
.B keywordprg
.br
\fIElvis\fR has a special keyword lookup feature. You move the cursor
onto a word, and hit shift-K, and \fIelvis\fR uses another program to
look up the word and display information about it.
This option says which program gets run. It should contain the full
pathname of the program; your whole execution path is \fInot\fR checked.
The default value of this option is \fI/usr/bin/ref\fR, which is a
program that looks up the definition of a function in C. It looks
up the function name in a file called \*(OQrefs\*(CQ which is created by
ctags.
You can substitute other programs, such as an English dictionary
program or the online manual. \fIelvis\fR runs the program, using the
keyword as its only argument. The program should write information
to stdout. The program's exit status should be 0, unless you want
\fIelvis\fR to print \*(OQ<<< failed >>>".
.ti -0.25i
.B lines
.br
This \*(OQread only\*(CQ option shows how many lines you screen has.
.ti -0.25i
.B list
.br
Normally (in \*(OQnolist" mode) \fIelvis\fR will expand tabs to the proper
number of spaces on the screen, so that the file appears the same would it would
be if you printed it or looked at it with \fImore\fR.
Sometimes, though, it can be handy to have the tabs displayed as \*(OQ^I".
In \*(OQlist" mode, \fIelvis\fR does this, and also displays a \*(OQ$"
after the end of the line.
.ti -0.25i
.B magic
.br
The search mechanism in \fIelvis\fR can accept \*(OQregular
expressions\*(CQ\(emstrings in which certain characters have special meaning.
The magic option is normally on, which causes these characters to
be treated specially.
If you turn the magic option off (:se noma), then all characters
except ^ and $ are treated literally. ^ and $ retain their special
meanings regardless of the setting of magic.
.ti -0.25i
.B paragraphs
0