vi.doc
上传用户:dfpj888
上传日期:2007-01-05
资源大小:100k
文件大小:23k
源码类别:

编辑器/阅读器

开发平台:

DOS

  1. calvin(1)    MS-DOG programmer's manual        calvin(1)
  2.   ------------------------------------------------------------
  3.   --                   Calvin version 2.2.                  --
  4.   --  Copyright 1988, 1989, 1990, 1992, 1993 by Paul Vojta. --
  5.   --     This program may be freely distributed provided:   --
  6.   --                                                        --
  7.   --  1.  All files (vi.exe, vi.doc, and read.me) are       --
  8.   --      distributed together in unmodified form (use of   --
  9.   --      universally available file compression software   --
  10.   --      is allowed, however); and                         --
  11.   --                                                        --
  12.   --  2.  No fee is charged other than a nominal processing --
  13.   --      charge or a connect time charge.                  --
  14.   ------------------------------------------------------------
  15.   (Earlier versions of Calvin have been released under the name
  16.   "Free VI.")
  17. SYNOPSIS
  18. vi file ...
  19. vi +[number] file ...
  20. vi +/pattern file ...
  21. Wild cards may be used on the command line.
  22. Calvin also supports the EXINIT environment variable, which may contain
  23. :set commands (put spaces in place of equals signs).
  24. DESCRIPTION
  25. Calvin is a screen text editor written for the IBM PC.  It implements
  26. a subset of the Unix screen editor vi(1).  Users familiar with Unix can
  27. skip to the command summary at the end of this file.  (Unix is a
  28. trademark of Bell Laboratories.)
  29. This editor requires MS-DOS 2 or higher and 128K of memory.  It will
  30. use all available memory for storing the file, etc.; optionally, it can
  31. store additional information on disk.
  32. It supports EGA 43-line and VGA 50-line modes.
  33. INSTALLATION
  34. Installation is fairly straightforward; you should copy vi.exe into
  35. some directory mentioned on your PATH command.
  36. There is one catch, however.  If you want Calvin to use the disk to
  37. store information which does not fit into memory (i.e., long files),
  38. then you should tell it which drive and directory to use.  This can be
  39. done at any time using the :set directory command (see below).
  40. However, if you edit long files often, it would perhaps be most
  41. convenient to always set it when Calvin starts up.  This can be done by
  42. the DOS command line
  43. set EXINIT=set directory c:/tmp
  44. if, for example, you wanted to use c:/tmp as the temporary directory.
  45. This line can also be placed in the autoexec.bat file.
  46. GETTING STARTED
  47. To edit an existing file, type
  48. vi name
  49. as a DOS command.  The first few lines of the file will then appear on
  50. the screen, and you may use any of the editing commands to modify it.
  51. For example:
  52. dw     delete a word
  53. de     delete a word, leaving punctuation
  54. dd     delete a line
  55. 3dd     delete three lines
  56. itext<End>  insert text (note that <End> refers to the "End"
  57.     key on the numeric keypad)
  58. /string     search for string
  59. xp     transpose characters (actually two commands)
  60. In addition, all of the keys on the numeric keypad perform as labeled.
  61. When you are finished editing, type ZZ or ":x" to write the corrections
  62. to disk and quit.  If no corrections were made, then ZZ just quits.  To
  63. quit without saving corrections, use ":q!".
  64. If the file named in the DOS command "vi name" does not exist, Calvin
  65. starts with an empty file, into which text can be inserted.  This is
  66. how Calvin can be used to create a file.
  67. EDITOR MODES
  68. Calvin has three modes, all of which occur in at least one of the above
  69. commands.  They are,
  70. o    Command mode.  This is the normal and initial state.  All commands
  71.      return here after completion.
  72. o    Insert mode.  Characters typed in insert mode are, as the name
  73.      implies, copied into the file instead of interpreted as commands.
  74.      The "Escape", "End", and "Insert" keys return Calvin to command
  75.      mode (and vice versa for "Insert").  In this mode the cursor is
  76.      larger than in command mode, in order to help you keep track of
  77.      the program's mode.
  78. o    Last line mode.  In this mode the editor is reading text for a ":"
  79.      command or a "/" or "?" search.  The text ends with <cr> or
  80.      "Escape".  Control-U deletes the text but not the ":", "/", or "?"
  81.      (unless there is no text).
  82. COUNTS BEFORE EDITOR COMMANDS
  83. Many Calvin commands can be preceded by a number.  The effect of this
  84. number is usually to repeat the effect of the command.  Sometimes,
  85. however, it has other meanings.  In many cases it is ignored.
  86. THE SCREEN
  87. Most of the screen is used to display the file; the last line is used
  88. for last line mode and for messages.  Lines past the end of the file
  89. appear as lines consisting of a single tilde ("~").  Tabs are expanded
  90. to columns 9, 17, 25, ... (although this can be changed).  Long lines
  91. are wrapped around, so that they may take up several lines of the
  92. screen.  "@" lines indicate that the next line is too long to fit on
  93. the remainder of the screen.  The user should not create lines too long
  94. to fit on a screen, although Calvin will not stop him or her from
  95. trying.
  96. In case DOS (or a program bug) scrambles the screen, ^L (Control-L)
  97. will restore it to what it should be.
  98. If a command causes the cursor to move to a part of the file which is
  99. not currently displayed on the screen, Calvin will automatically scroll
  100. as necessary.  Calvin also has commands to explicitly request scrolling:
  101.     ^F or PgDn Move the screen Forward one screenful, keeping the last
  102. two lines of the old screen as the first two lines of
  103. the new.
  104.     ^B or PgUp Move Backwards one screenful.
  105.     ^D Move Down 1/2 screen.
  106.     ^U Move Up 1/2 screen.
  107.     ^E Move Down one line.
  108.     ^Y Move Up one line.
  109. MOTION COMMANDS
  110. The arrows on the numeric keypad perform as labeled.  Also, Calvin has
  111. a rich assortment of other commands to move the cursor.  These are:
  112.     + or <cr> Move the cursor to the first nonblank character of the
  113. next line in the file.  (All motions referring to lines
  114. put the cursor on the first nonblank character of that
  115. line.)
  116.     - Move to the previous line.
  117.     $ Move to the end of the current line.
  118.     0 Move to the beginning of the line.
  119.     fx Find the next occurrence of the given character.  The
  120. search is limited to the current line.
  121.     Fx Same as fx, backwards.
  122.     ; Repeat the previous f or F.
  123.     /string<cr> Search for the next occurrence of the given string.
  124. This search starts at the current position, but may
  125. wrap around the beginning of the file.
  126.     ?string<cr> Same as "/", searching backwards.
  127.     n Repeat last "/" or "?" search.
  128.     N Same as "n", in the opposite direction.
  129.     H or Home Move the cursor to the first line of the screen.
  130.     M Move to the middle line of the screen.
  131.     L or End Move to the last line of the screen.
  132.     nG Move to the <n>th line of the file.
  133.     G Move to the last line.
  134.     % Move to the matching parenthesis, bracket, or brace.
  135. SEARCHING
  136. The backslash character `' has a special meaning in strings used for
  137. searching.  Generally, it either adds or removes special meaning to or
  138. from the following character.  Currently, this means that  is
  139. translated into the null character (Calvin treats null characters just
  140. like any others), and that any other character is taken literally when
  141. preceded by a backslash.  Otherwise, a '/' indicates the end of a '/'
  142. search string, and likewise indicates the end of a reverse search
  143. pattern.  So if you want to search forward for the string /, use /\/
  144. (the first slash means search forwards, the next two backslashes
  145. translate into one backslash, the / then is translated into a single
  146. forward slash).  As for other `magic' characters available under
  147. Unix<tm> vi, Calvin has not implemented them yet.
  148. These comments apply equally well to search strings present in ':'
  149. commands or '+' parameters.
  150. THE DELETE OPERATOR
  151. If one of the above motions is preceded by the letter "d", then Calvin
  152. will delete the text, from the old position to the new position.  This
  153. called an operator because it changes the effect of the ensuing motion
  154. command.  The repetition count for the motion command may either
  155. precede or follow the "d"; the effect is the same.
  156. Also, "d" may be doubled (i.e. dd or 7dd) to delete one or several
  157. lines.  If D is capitalized, it deletes through the end of the line.
  158. Other operators are "c" (change), "y" (yank), and "!" (shell filter);
  159. they are described later.
  160. OTHER DELETION COMMANDS
  161.     x or Delete Functions the same as d<Space>; deletes one character.
  162.     X Deletes backwards one character; same as dh.
  163. INSERT MODE
  164. A number of commands place the user in insert mode.  They are:
  165.    i Enter insert mode, inserting text before the current character.
  166.    a Insert after the current character.
  167.    A Insert after end of line.
  168.    o Open a new line after the current line and enter insert mode.
  169.    O Open before current line.
  170.    c<motion>, cc, C
  171. "c" is an operator, similar to "d".  It deletes text and leaves
  172. the editor in insert mode.  For example, "cw" changes the
  173. current word; "cc", the current line.
  174. To exit insert mode, use the Esc key, the Ins key, or the End key.  To
  175. delete all characters typed so far in the current line, type Control-U.
  176. Insert mode also supports Control-W to delete the most recently typed
  177. word, and Control-V to strip the next character of any special meaning.
  178. In this version of vi, the backspace key will also allow you to delete
  179. a mistakenly typed carriage return.
  180. OTHER MODIFICATION COMMANDS
  181.     rx Replaces the current character with the character  x.
  182.     J Joins two lines; i.e. concatenates them, adding a space between
  183. them.
  184. UNDO AND REPEAT
  185. In case of a mistake, the "u" command will undo the effect of the last
  186. command which modified the file.  Only the most recent change can be
  187. undone in this way.
  188. The dot command (".") will repeat the last command which changed the
  189. file.
  190. MOVING TEXT
  191. To move part of a file, one uses the operations of yanking and putting.
  192. Yanking consists of copying part of a file into a special buffer;
  193. putting copies that buffer into another part of the file.
  194. To yank text, use the "y" operator (y<motion>, yy, or Y) in the same
  195. manner as the delete or change operators.  Then move the cursor and use
  196. the put command (p) or put-before command (P) to put the text
  197. elsewhere.  For example,
  198. 5G yy 9G p
  199. places another copy of the fifth line of the file after the ninth line.
  200. The delete and change operators also save the deleted text in a yank
  201. buffer.  Thus the command "xp" (actually two commands) exchanges two
  202. characters by deleting the first and reinserting it after the second.
  203. In addition to the default yank buffer, Calvin has 26 other yank
  204. buffers, tagged by (lower-case) letters of the alphabet.  To let a
  205. yank, put, delete, or change command command refer to one of these
  206. buffers, precede the command with the quote character and the letter of
  207. the buffer.
  208. Transferring text between files can be done in one of several ways.
  209. First, the command
  210. :r name
  211. reads the named file into the current file, following the current line.
  212. You can also indicate that the file is to be read at a given line by
  213. typing <n>:r name, where <n> is the line number (0 to insert at the
  214. beginning of the file).
  215. The reverse of this operation is the command,
  216. <n>,<m>:w name
  217. which writes lines <n> through <m>, inclusive, into a file of the given
  218. name, destroying the file's previous contents, if any.
  219. The last way of transferring text between files is to yank one or more
  220. pieces of text, switch the main file via
  221. :e name or :e! name
  222. and then put the text into the new main file.
  223. MARKING POSITIONS IN THE FILE
  224. You can mark your current position in the file by typing `mx', where
  225. `x' may be any lower case letter.  You can then return to that spot by
  226. typing 'x to return to that line or `x to return to the exact
  227. character.  Of course, you can also use 'x or `x in an operator, e.g.,
  228. m'x or y`x.  Also, '' or `` will return to the starting point of the
  229. last `/', `?', `n', `N', `G', `H', `M', `L', `%', ``', or `'' motion.
  230. END-OF-LINE CONVERSIONS
  231. Internally, Calvin uses the Unix<tm> end-of-line convention, that the
  232. single character 'n' indicates the end of a line.  Unless otherwise
  233. specified, it will convert all DOS 'rn' end-of-lines to this
  234. convention when reading a file, in addition to recognizing a single
  235. 'n' as an end of line.  When writing files, by default Calvin will
  236. write end-of-lines in the DOS manner.  A consequence of this is that
  237. Calvin can read a file with Unix<tm> end-of-lines and interpret it
  238. correctly without you even noticing.  You can even use Calvin to
  239. convert from Unix<tm> format to DOS format by doing `vi file' and
  240. immediately `:wq'.
  241. You can also convert back to Unix<tm> format by doing:
  242. vi file
  243. :set binary
  244. :wq
  245. This is a little less convenient, but you probably won't have occasion
  246. to use this feature often.
  247. HELPFUL HINTS
  248. In addition to ending insert and last line modes, the Escape key can be
  249. used to delete a partially complete command.  It also momentarily
  250. enlarges the cursor.  This makes it easier to see--it is easy to lose
  251. the cursor after a locate operation.
  252. To insert an escape code into the file, use control-[ or Alt-27, or
  253. precede it with ^V in insert mode.
  254. One feature that Calvin currently lacks is the ability to change all
  255. occurrences of a given string to another string.  This can be done with
  256. alternate uses of the "n" and "." commands (and a little patience).
  257. MEMORY USAGE
  258. By default, Calvin will use all available memory in the lower 640K to
  259. store the file being edited and yanked text, etc.  You can also get
  260. Calvin to use disk space as well, by means of the `:set directory'
  261. option described below.  In either case, however, it is always a
  262. possibility that you will run out of memory.  In that case, you will
  263. receive the message `Out of memory--save what you have, immediately.'
  264. It is strongly suggested that you do so, as the editor will be in an
  265. unstable state; continuing to use it after such a message would likely
  266. result in loss of data.
  267. THE NAME
  268. As noted already, Calvin has formerly been called "Free VI."  Since the
  269. appearance of Stevie and Elvis, I decided that a more unique name was
  270. necessary.  Hence the name "Calvin", which has the requisite two-letter
  271. substring, as well as the string "Cal", indicating that it came from
  272. "Cal" (University of California), Berkeley.  (And also, it's seven
  273. years old :-> ).
  274. ------------------------------------------------------------
  275. The above is a tutorial introduction to some of the most common Calvin
  276. commands.  A list of all Calvin commands appears in the command summary, below.
  277. COMMAND SUMMARY
  278. ------- -------
  279. Colon commands:
  280.     :edit name edit new file
  281.     :edit +<n> name edit new file, starting at line <n>
  282.     :edit +/pattern name edit new file, starting at the first occurrence
  283. of the given string.
  284.     :edit! [+colon_command] name
  285. discard corrections and edit new file
  286.     :edit[!] [+colon_command] # edit the file last edited.
  287.     :file print file name, status, and length.
  288.     :file name change the name of the file being edited to
  289. `name'.
  290.     :next edit the next file in the command line
  291.     :quit quit the editor
  292.     :quit abort (quit without saving corrections)
  293.     :read file read the given file and insert it after the
  294. current line
  295.     :<n>read file read the given file and insert it after line
  296. <n>.
  297.     :r synonym for :read
  298.     :r !command read in the output of the given DOS command
  299.     :rewind return to editing the first file given on the
  300. vi command line (cf. :next)
  301.     :set option=value set the given option to the given value
  302. the `=' may be replaced by a space (useful in
  303. EXINIT).
  304.     :set option set the given boolean option to TRUE
  305.     :set nooption set the given boolena option to FALSE
  306.     :set option? print the current value of the option
  307.     :set all print the values of all options
  308.     :set print the values of all options which are not
  309. equal to their defaults
  310.     :shell escape to DOS (return via EXIT)
  311.     :version print Calvin's version number.  Currently the
  312. message printed is:  "Calvin version 2.1.  (C)
  313. Copyright 1987, 1988, 1989, 1990, 1992 by Paul
  314. Vojta.  For copying conditions, please see the
  315. documentation file."
  316.     :wq [file] synonym for :write followed by :quit
  317.     :write write the current file to disk, using the name
  318. it was edited using
  319.     :write file write the current file to disk, using the name
  320. given
  321.     :write !command pipe the current file into the given DOS
  322. command; note the spacing.
  323.     :<n>,<m>write [file] write lines <n> through <m> to disk
  324.     :w synonym for :write
  325.     :x synonym for :wq (if the current file has been
  326. changed), or :quit (if not)
  327.     :<n>= print the value of <n>
  328.     :<n> move to line <n>
  329.     :!command execute the given DOS command
  330.     :!! execute the last DOS command
  331. Command names (and :set options, below) may be abbreviated by shortening them,
  332. provided they still refer to a unique command.  They may be combined on one
  333. line by separating them by `|'.
  334. Addresses (written as <n> or <m> in the above list) may be given by one of the
  335. following:
  336. <line number>
  337. /pattern/
  338. ?pattern?
  339. 'a, ..., 'z
  340. . (refers to the current line number)
  341. $ (refers to the end of the file)
  342. You may also use the following synonyms in visual mode:
  343. ZZ :x
  344. ^6 :e #
  345. ^G :f
  346. Options for the :set command:
  347. autowrite (synonym aw) (default false)
  348. If the file has been modified, then automatically write it to
  349. disk for any :edit, :quit, :rewind, or :next commands.
  350. binary (default false)
  351. Read and write files in binary mode (that is, without end-of-
  352. line conversions).  See the section END-OF-LINE CONVERSIONS.
  353. cpmeof (default false)
  354. Under early versions of DOS, text files were supposed to end in
  355. ^Z (Control-Z).  This option causes Calvin to write a ^Z at the
  356. ends of files that it creates.
  357. directory (default none)
  358. Directory to use for storing temporary files.  This option may
  359. only be changed once.
  360. dosesc (default false)
  361. Causes the Escape key to act as a line delete character instead
  362. of as the character which ends insert mode.  (You can always
  363. leave insert mode by using the End key.)  The usual line delete
  364. character is ^U (Control-U).
  365. eolateof (default true)
  366. Indicates that the file being edit ends with an end-of-line
  367. character.  Usually this is the case.  This flag is
  368. automatically set or cleared when editing a file, and is
  369. automatically cleared when doing a line change command at the
  370. end of a file.
  371. ignorecase (synonym ic) (default false)
  372. Causes Calvin to ignore the case of letters when searching for
  373. strings.
  374. marginbell (synonym mb) (default 0, none)
  375. Causes Calvin to beep when you reach the indicated column in
  376. insert mode.
  377. printable (default 126)
  378. Gives the highest character value to be printed as is, instead
  379. of being translated into, e.g., 127.
  380. showmode (default false)
  381. Causes Calvin to show its mode (e.g., INSERT MODE) in the lower
  382. right-hand corner of the screen.
  383. tabstop (default 8)
  384. Indicates the number of characters per tab stop.
  385. thoroughshell (default False)
  386. Instructs calvin to use the COMSPEC variable to load the
  387. command interpreter when running every DOS command, not just
  388. the internal ones.  This is useful if you use a different
  389. command interpreter, such as 4dos, which has a different set of
  390. internal commands or other features which you wish to use.
  391. vidcompat (default 0)
  392. Indicates the compatibility lever for video operations.
  393. Setting it to a higher value may cause some screen-related
  394. problems to go away if you have slightly non-standard hardware.
  395. With vidcompat=1, Calvin does not use the alternate screen
  396. feature of CGA adapters, and with vidcompat=2, it does not save
  397. and restore the screen after editing.
  398. Character motions:
  399.     h or Backspace or Leftarrow  back <n> character(s)
  400.     Space or l or Rightarrow   forward <n> characters
  401.     j or ^J or ^N or Downarrow   down <n> lines, same column
  402.     k or ^P or Uparrow     up <n> lines, same column
  403.     $ down <n-1> lines, end of line
  404.     0 beginning of line
  405.     ^ first non-white character in line
  406.     w next <n> words
  407.     b back <n> words
  408.     e end of <n>th word from here
  409.     W, B, E same as w, b, e, with blank-delimited words
  410.     | move to column <n>
  411.     % match (), [], or {}.
  412.     `x character of mx command (x=any lower case letter)
  413.     `` start of last /?nNGHML%' or ` motion
  414.     /string search
  415.     ?string backwards search
  416.     /<cr> or ?<cr> forward or backwards search, same pattern
  417.     /string/+3 the third line past the next occurrence of the given string
  418.     n repeat last search
  419.     N repeat last search, opposite direction
  420.     fx find next <n>th occurrence of x
  421.     Fx find previous <n>th x
  422.     tx next <n>th x (not inclusive)
  423.     Tx previous <n>th x (not inclusive)
  424.     ; repeat last f, F, t, or T
  425.     , reverse of ,
  426. Line motions:
  427.     + or <cr> <n>th next line (first nonwhite)
  428.     - <n>th previous line
  429. current line or <n-1>st next line
  430.     H or Home top of screen (or <n>th line on screen)
  431.     M middle of screen
  432.     L or End last line of screen (or <n>th line from bottom)
  433.     nG go to <n>th line (end default)
  434.     'x line of mx command (x=any lower case letter)
  435.     '' start of last /?nNGHML%' or ` motion
  436. Operators:
  437.     d<motion>, dd, D delete
  438.     c<motion>, cc, C change
  439.     y<motion>, yy, Y yank
  440. (Note that in this implementation 'Y' is equivalent to
  441. 'y$' instead of 'yy').
  442.     !<motion>, !! filter through a DOS command
  443. Insert Mode:
  444.     i or Insert insert before current character
  445.     a insert after current character
  446.     I insert before first nonblank character in line
  447.     A append to end of line
  448.     o open after current line
  449.     O open before current line
  450. Other modification commands:
  451.     x or Delete delete character; same as "d "
  452.     X delete previous character; same as "dh"
  453.     s delete character and enter insert mode; same as "c "
  454.     S delete line and enter insert mode; same as "cc"
  455.     r replace <n> characters by the given one
  456.     J join two lines
  457.     p put yanked text
  458.     P put yanked text before current line or character
  459.     u undo previous command
  460.     . repeat previous command
  461. Screen commands:
  462.     ^L redraw screen
  463.     ^F or PgDn forward <n> screens
  464.     ^B or PgUp back <n> screens
  465.     ^U, ^D up (or down) 1/2 screen (<n> changes the number of lines
  466. counted as 1/2 screen)
  467.     ^Y, ^E up (or down) <n> lines
  468.     z<cr> or zh redraw with current line (or <n>th line) on top
  469.     z. or zm redraw with current line (or <n>th line) in middle
  470.     z- or zl redraw with current line (or <n>th line) at bottom
  471.     z+ redraw with current bottom line (or <n>th line) at top
  472. Miscellaneous:
  473.     mx mark here as mark `x' (Cf. 'x and `x above.)
  474. (x = any lower case letter)