home *** CD-ROM | disk | FTP | other *** search
/ vim.ftp.fu-berlin.de / 2015-02-03.vim.ftp.fu-berlin.de.tar / vim.ftp.fu-berlin.de / runtime / dos / doc / editing.txt < prev    next >
Encoding:
Text File  |  2012-05-31  |  69.0 KB  |  1,647 lines

  1. *editing.txt*   For Vim version 7.3.  Last change: 2012 Apr 03
  2.  
  3.  
  4.           VIM REFERENCE MANUAL    by Bram Moolenaar
  5.  
  6.  
  7. Editing files                        *edit-files*
  8.  
  9. 1.  Introduction        |edit-intro|
  10. 2.  Editing a file        |edit-a-file|
  11. 3.  The argument list        |argument-list|
  12. 4.  Writing            |writing|
  13. 5.  Writing and quitting    |write-quit|
  14. 6.  Dialogs            |edit-dialogs|
  15. 7.  The current directory    |current-directory|
  16. 8.  Editing binary files    |edit-binary|
  17. 9.  Encryption            |encryption|
  18. 10. Timestamps            |timestamps|
  19. 11. File Searching        |file-searching|
  20.  
  21. ==============================================================================
  22. 1. Introduction                        *edit-intro*
  23.  
  24. Editing a file with Vim means:
  25.  
  26. 1. reading the file into a buffer
  27. 2. changing the buffer with editor commands
  28. 3. writing the buffer into a file
  29.  
  30.                             *current-file*
  31. As long as you don't write the buffer, the original file remains unchanged.
  32. If you start editing a file (read a file into the buffer), the file name is
  33. remembered as the "current file name".  This is also known as the name of the
  34. current buffer.  It can be used with "%" on the command line |:_%|.
  35.  
  36.                             *alternate-file*
  37. If there already was a current file name, then that one becomes the alternate
  38. file name.  It can be used with "#" on the command line |:_#| and you can use
  39. the |CTRL-^| command to toggle between the current and the alternate file.
  40. However, the alternate file name is not changed when |:keepalt| is used.
  41.  
  42.                             *:keepalt* *:keepa*
  43. :keepalt {cmd}        Execute {cmd} while keeping the current alternate file
  44.             name.  Note that commands invoked indirectly (e.g.,
  45.             with a function) may still set the alternate file
  46.             name.  {not in Vi}
  47.  
  48. All file names are remembered in the buffer list.  When you enter a file name,
  49. for editing (e.g., with ":e filename") or writing (e.g., with ":w filename"),
  50. the file name is added to the list.  You can use the buffer list to remember
  51. which files you edited and to quickly switch from one file to another (e.g.,
  52. to copy text) with the |CTRL-^| command.  First type the number of the file
  53. and then hit CTRL-^.  {Vi: only one alternate file name is remembered}
  54.  
  55.  
  56. CTRL-G        or                *CTRL-G* *:f* *:fi* *:file*
  57. :f[ile]            Prints the current file name (as typed, unless ":cd"
  58.             was used), the cursor position (unless the 'ruler'
  59.             option is set), and the file status (readonly,
  60.             modified, read errors, new file).  See the 'shortmess'
  61.             option about how to make this message shorter.
  62.             {Vi does not include column number}
  63.  
  64. :f[ile]!        like |:file|, but don't truncate the name even when
  65.             'shortmess' indicates this.
  66.  
  67. {count}CTRL-G        Like CTRL-G, but prints the current file name with
  68.             full path.  If the count is higher than 1 the current
  69.             buffer number is also given.  {not in Vi}
  70.  
  71.                     *g_CTRL-G* *word-count* *byte-count*
  72. g CTRL-G        Prints the current position of the cursor in five
  73.             ways: Column, Line, Word, Character and Byte.  If the
  74.             number of Characters and Bytes is the same then the
  75.             Character position is omitted.
  76.             If there are characters in the line that take more
  77.             than one position on the screen (<Tab> or special
  78.             character), both the "real" column and the screen
  79.             column are shown, separated with a dash.
  80.             See also 'ruler' option.  {not in Vi}
  81.  
  82.                             *v_g_CTRL-G*
  83. {Visual}g CTRL-G    Similar to "g CTRL-G", but Word, Character, Line, and
  84.             Byte counts for the visually selected region are
  85.             displayed.
  86.             In Blockwise mode, Column count is also shown.  (For
  87.             {Visual} see |Visual-mode|.)
  88.             {not in VI}
  89.  
  90.                             *:file_f*
  91. :f[ile][!] {name}    Sets the current file name to {name}.  The optional !
  92.             avoids truncating the message, as with |:file|.
  93.             If the buffer did have a name, that name becomes the
  94.             |alternate-file| name.  An unlisted buffer is created
  95.             to hold the old name.
  96.                             *:0file*
  97. :0f[ile][!]        Remove the name of the current buffer.  The optional !
  98.             avoids truncating the message, as with |:file|.  {not
  99.             in Vi}
  100.  
  101. :buffers
  102. :files
  103. :ls            List all the currently known file names.  See
  104.             'windows.txt' |:files| |:buffers| |:ls|.  {not in
  105.             Vi}
  106.  
  107. Vim will remember the full path name of a file name that you enter.  In most
  108. cases when the file name is displayed only the name you typed is shown, but
  109. the full path name is being used if you used the ":cd" command |:cd|.
  110.  
  111.                             *home-replace*
  112. If the environment variable $HOME is set, and the file name starts with that
  113. string, it is often displayed with HOME replaced with "~".  This was done to
  114. keep file names short.  When reading or writing files the full name is still
  115. used, the "~" is only used when displaying file names.  When replacing the
  116. file name would result in just "~", "~/" is used instead (to avoid confusion
  117. between options set to $HOME with 'backupext' set to "~").
  118.  
  119. When writing the buffer, the default is to use the current file name.  Thus
  120. when you give the "ZZ" or ":wq" command, the original file will be
  121. overwritten.  If you do not want this, the buffer can be written into another
  122. file by giving a file name argument to the ":write" command.  For example: >
  123.  
  124.     vim testfile
  125.     [change the buffer with editor commands]
  126.     :w newfile
  127.     :q
  128.  
  129. This will create a file "newfile", that is a modified copy of "testfile".
  130. The file "testfile" will remain unchanged.  Anyway, if the 'backup' option is
  131. set, Vim renames or copies the original file before it will be overwritten.
  132. You can use this file if you discover that you need the original file.  See
  133. also the 'patchmode' option.  The name of the backup file is normally the same
  134. as the original file with 'backupext' appended.  The default "~" is a bit
  135. strange to avoid accidentally overwriting existing files.  If you prefer ".bak"
  136. change the 'backupext' option.  Extra dots are replaced with '_' on MS-DOS
  137. machines, when Vim has detected that an MS-DOS-like filesystem is being used
  138. (e.g., messydos or crossdos) or when the 'shortname' option is on.  The
  139. backup file can be placed in another directory by setting 'backupdir'.
  140.  
  141.                             *auto-shortname*
  142. Technical: On the Amiga you can use 30 characters for a file name.  But on an
  143.        MS-DOS-compatible filesystem only 8 plus 3 characters are
  144.        available.  Vim tries to detect the type of filesystem when it is
  145.        creating the .swp file.  If an MS-DOS-like filesystem is suspected,
  146.        a flag is set that has the same effect as setting the 'shortname'
  147.        option.  This flag will be reset as soon as you start editing a
  148.        new file.  The flag will be used when making the file name for the
  149.        ".swp" and ".~" files for the current file.  But when you are
  150.        editing a file in a normal filesystem and write to an MS-DOS-like
  151.        filesystem the flag will not have been set.  In that case the
  152.        creation of the ".~" file may fail and you will get an error
  153.        message.  Use the 'shortname' option in this case.
  154.  
  155. When you started editing without giving a file name, "No File" is displayed in
  156. messages.  If the ":write" command is used with a file name argument, the file
  157. name for the current file is set to that file name.  This only happens when
  158. the 'F' flag is included in 'cpoptions' (by default it is included) |cpo-F|.
  159. This is useful when entering text in an empty buffer and then writing it to a
  160. file.  If 'cpoptions' contains the 'f' flag (by default it is NOT included)
  161. |cpo-f| the file name is set for the ":read file" command.  This is useful
  162. when starting Vim without an argument and then doing ":read file" to start
  163. editing a file.
  164. When the file name was set and 'filetype' is empty the filetype detection
  165. autocommands will be triggered.
  166.                             *not-edited*
  167. Because the file name was set without really starting to edit that file, you
  168. are protected from overwriting that file.  This is done by setting the
  169. "notedited" flag.  You can see if this flag is set with the CTRL-G or ":file"
  170. command.  It will include "[Not edited]" when the "notedited" flag is set.
  171. When writing the buffer to the current file name (with ":w!"), the "notedited"
  172. flag is reset.
  173.  
  174.                             *abandon*
  175. Vim remembers whether you have changed the buffer.  You are protected from
  176. losing the changes you made.  If you try to quit without writing, or want to
  177. start editing another file, Vim will refuse this.  In order to overrule this
  178. protection, add a '!' to the command.  The changes will then be lost.  For
  179. example: ":q" will not work if the buffer was changed, but ":q!" will.  To see
  180. whether the buffer was changed use the "CTRL-G" command.  The message includes
  181. the string "[Modified]" if the buffer has been changed.
  182.  
  183. If you want to automatically save the changes without asking, switch on the
  184. 'autowriteall' option.  'autowrite' is the associated Vi-compatible option
  185. that does not work for all commands.
  186.  
  187. If you want to keep the changed buffer without saving it, switch on the
  188. 'hidden' option.  See |hidden-buffer|.
  189.  
  190. ==============================================================================
  191. 2. Editing a file                    *edit-a-file*
  192.  
  193.                             *:e* *:edit*
  194. :e[dit] [++opt] [+cmd]    Edit the current file.  This is useful to re-edit the
  195.             current file, when it has been changed outside of Vim.
  196.             This fails when changes have been made to the current
  197.             buffer and 'autowriteall' isn't set or the file can't
  198.             be written.
  199.             Also see |++opt| and |+cmd|.
  200.             {Vi: no ++opt}
  201.  
  202.                             *:edit!*
  203. :e[dit]! [++opt] [+cmd]
  204.             Edit the current file always.  Discard any changes to
  205.             the current buffer.  This is useful if you want to
  206.             start all over again.
  207.             Also see |++opt| and |+cmd|.
  208.             {Vi: no ++opt}
  209.  
  210.                             *:edit_f*
  211. :e[dit] [++opt] [+cmd] {file}
  212.             Edit {file}.
  213.             This fails when changes have been made to the current
  214.             buffer, unless 'hidden' is set or 'autowriteall' is
  215.             set and the file can be written.
  216.             Also see |++opt| and |+cmd|.
  217.             {Vi: no ++opt}
  218.  
  219.                             *:edit!_f*
  220. :e[dit]! [++opt] [+cmd] {file}
  221.             Edit {file} always.  Discard any changes to the
  222.             current buffer.
  223.             Also see |++opt| and |+cmd|.
  224.             {Vi: no ++opt}
  225.  
  226. :e[dit] [++opt] [+cmd] #[count]
  227.             Edit the [count]th buffer (as shown by |:files|).
  228.             This command does the same as [count] CTRL-^.  But ":e
  229.             #" doesn't work if the alternate buffer doesn't have a
  230.             file name, while CTRL-^ still works then.
  231.             Also see |++opt| and |+cmd|.
  232.             {Vi: no ++opt}
  233.  
  234.                             *:ene* *:enew*
  235. :ene[w]            Edit a new, unnamed buffer.  This fails when changes
  236.             have been made to the current buffer, unless 'hidden'
  237.             is set or 'autowriteall' is set and the file can be
  238.             written.
  239.             If 'fileformats' is not empty, the first format given
  240.             will be used for the new buffer.  If 'fileformats' is
  241.             empty, the 'fileformat' of the current buffer is used.
  242.             {not in Vi}
  243.  
  244.                             *:ene!* *:enew!*
  245. :ene[w]!        Edit a new, unnamed buffer.  Discard any changes to
  246.             the current buffer.
  247.             Set 'fileformat' like |:enew|.
  248.             {not in Vi}
  249.  
  250.                             *:fin* *:find*
  251. :fin[d][!] [++opt] [+cmd] {file}
  252.             Find {file} in 'path' and then |:edit| it.
  253.             {not in Vi} {not available when the |+file_in_path|
  254.             feature was disabled at compile time}
  255.  
  256. :{count}fin[d][!] [++opt] [+cmd] {file}
  257.             Just like ":find", but use the {count} match in
  258.             'path'.  Thus ":2find file" will find the second
  259.             "file" found in 'path'.  When there are fewer matches
  260.             for the file in 'path' than asked for, you get an
  261.             error message.
  262.  
  263.                             *:ex*
  264. :ex [++opt] [+cmd] [file]
  265.             Same as |:edit|.
  266.  
  267.                             *:vi* *:visual*
  268. :vi[sual][!] [++opt] [+cmd] [file]
  269.             When used in Ex mode: Leave |Ex-mode|, go back to
  270.             Normal mode.  Otherwise same as |:edit|.
  271.  
  272.                             *:vie* *:view*
  273. :vie[w][!] [++opt] [+cmd] file
  274.             When used in Ex mode: Leave |Ex mode|, go back to
  275.             Normal mode.  Otherwise same as |:edit|, but set
  276.             'readonly' option for this buffer.  {not in Vi}
  277.  
  278.                             *CTRL-^* *CTRL-6*
  279. CTRL-^            Edit the alternate file.  Mostly the alternate file is
  280.             the previously edited file.  This is a quick way to
  281.             toggle between two files.  It is equivalent to ":e #",
  282.             except that it also works when there is no file name.
  283.  
  284.             If the 'autowrite' or 'autowriteall' option is on and
  285.             the buffer was changed, write it.
  286.             Mostly the ^ character is positioned on the 6 key,
  287.             pressing CTRL and 6 then gets you what we call CTRL-^.
  288.             But on some non-US keyboards CTRL-^ is produced in
  289.             another way.
  290.  
  291. {count}CTRL-^        Edit [count]th file in the buffer list (equivalent to
  292.             ":e #[count]").  This is a quick way to switch between
  293.             files.
  294.             See |CTRL-^| above for further details.
  295.             {not in Vi}
  296.  
  297. [count]]f                        *]f* *[f*
  298. [count][f        Same as "gf".  Deprecated.
  299.  
  300.                             *gf* *E446* *E447*
  301. [count]gf        Edit the file whose name is under or after the cursor.
  302.             Mnemonic: "goto file".
  303.             Uses the 'isfname' option to find out which characters
  304.             are supposed to be in a file name.  Trailing
  305.             punctuation characters ".,:;!" are ignored.
  306.             Uses the 'path' option as a list of directory names to
  307.             look for the file.  See the 'path' option for details
  308.             about relative directories and wildcards.
  309.             Uses the 'suffixesadd' option to check for file names
  310.             with a suffix added.
  311.             If the file can't be found, 'includeexpr' is used to
  312.             modify the name and another attempt is done.
  313.             If a [count] is given, the count'th file that is found
  314.             in the 'path' is edited.
  315.             This command fails if Vim refuses to |abandon| the
  316.             current file.
  317.             If you want to edit the file in a new window use
  318.             |CTRL-W_CTRL-F|.
  319.             If you do want to edit a new file, use: >
  320.                 :e <cfile>
  321. <            To make gf always work like that: >
  322.                 :map gf :e <cfile><CR>
  323. <            If the name is a hypertext link, that looks like
  324.             "type://machine/path", you need the |netrw| plugin.
  325.             For Unix the '~' character is expanded, like in
  326.             "~user/file".  Environment variables are expanded too
  327.             |expand-env|.
  328.             {not in Vi}
  329.             {not available when the |+file_in_path| feature was
  330.             disabled at compile time}
  331.  
  332.                             *v_gf*
  333. {Visual}[count]gf    Same as "gf", but the highlighted text is used as the
  334.             name of the file to edit.  'isfname' is ignored.
  335.             Leading blanks are skipped, otherwise all blanks and
  336.             special characters are included in the file name.
  337.             (For {Visual} see |Visual-mode|.)
  338.             {not in VI}
  339.  
  340.                             *gF*
  341. [count]gF        Same as "gf", except if a number follows the file
  342.             name, then the cursor is positioned on that line in
  343.             the file. The file name and the number must be
  344.             separated by a non-filename (see 'isfname') and
  345.             non-numeric character. White space between the
  346.             filename, the separator and the number are ignored.
  347.             Examples:
  348.                 eval.c:10 ~
  349.                 eval.c @ 20 ~
  350.                 eval.c (30) ~
  351.                 eval.c 40 ~
  352.  
  353.                             *v_gF*
  354. {Visual}[count]gF    Same as "v_gf".
  355.  
  356. These commands are used to start editing a single file.  This means that the
  357. file is read into the buffer and the current file name is set.  The file that
  358. is opened depends on the current directory, see |:cd|.
  359.  
  360. See |read-messages| for an explanation of the message that is given after the
  361. file has been read.
  362.  
  363. You can use the ":e!" command if you messed up the buffer and want to start
  364. all over again.  The ":e" command is only useful if you have changed the
  365. current file name.
  366.  
  367.                             *:filename* *{file}*
  368. Besides the things mentioned here, more special items for where a filename is
  369. expected are mentioned at |cmdline-special|.
  370.  
  371. Note for systems other than Unix: When using a command that accepts a single
  372. file name (like ":edit file") spaces in the file name are allowed, but
  373. trailing spaces are ignored.  This is useful on systems that regularly embed
  374. spaces in file names (like MS-Windows and the Amiga).  Example: The command
  375. ":e   Long File Name " will edit the file "Long File Name".  When using a
  376. command that accepts more than one file name (like ":next file1 file2")
  377. embedded spaces must be escaped with a backslash.
  378.  
  379.                         *wildcard* *wildcards*
  380. Wildcards in {file} are expanded.  Which wildcards are supported depends on
  381. the system.  These are the common ones:
  382.     ?    matches one character
  383.     *    matches anything, including nothing
  384.     **    matches anything, including nothing, recurses into directories
  385.     [abc]    match 'a', 'b' or 'c'
  386.  
  387. To avoid the special meaning of the wildcards prepend a backslash.  However,
  388. on MS-Windows the backslash is a path separator and "path\[abc]" is still seen
  389. as a wildcard when "[" is in the 'isfname' option.  A simple way to avoid this
  390. is to use "path\[[]abc]".  Then the file "path[abc]" literally.
  391.  
  392.                     *starstar-wildcard*
  393. Expanding "**" is possible on Unix, Win32, Mac OS/X and a few other systems.
  394. This allows searching a directory tree.  This goes up to 100 directories deep.
  395. Note there are some commands where this works slightly different, see
  396. |file-searching|.
  397. Example: >
  398.     :n **/*.txt
  399. Finds files:
  400.     ttt.txt
  401.     subdir/ttt.txt
  402.     a/b/c/d/ttt.txt
  403. When non-wildcard characters are used these are only matched in the first
  404. directory.  Example: >
  405.     :n /usr/inc**/*.h
  406. Finds files:
  407.     /usr/include/types.h
  408.     /usr/include/sys/types.h
  409.     /usr/inc_old/types.h
  410.                     *backtick-expansion* *`-expansion*
  411. On Unix and a few other systems you can also use backticks in the file name,
  412. for example: >
  413.     :e `find . -name ver\\*.c -print`
  414. The backslashes before the star are required to prevent "ver*.c" to be
  415. expanded by the shell before executing the find program.
  416. This also works for most other systems, with the restriction that the
  417. backticks must be around the whole item.  It is not possible to have text
  418. directly before the first or just after the last backtick.
  419.  
  420.                             *`=*
  421. You can have the backticks expanded as a Vim expression, instead of an
  422. external command, by using the syntax `={expr}` e.g.: >
  423.     :e `=tempname()`
  424. The expression can contain just about anything, thus this can also be used to
  425. avoid the special meaning of '"', '|', '%' and '#'.  Names are to be separated
  426. with line breaks.  When the result is a |List| then each item is used as a
  427. name.  Line breaks also separate names.
  428.  
  429.                             *++opt* *[++opt]*
  430. The [++opt] argument can be used to force the value of 'fileformat',
  431. 'fileencoding' or 'binary' to a value for one command, and to specify the
  432. behavior for bad characters.  The form is: >
  433.     ++{optname}
  434. Or: >
  435.     ++{optname}={value}
  436.  
  437. Where {optname} is one of:        *++ff* *++enc* *++bin* *++nobin* *++edit*
  438.     ff     or  fileformat   overrides 'fileformat'
  439.     enc    or  encoding        overrides 'fileencoding'
  440.     bin    or  binary        sets 'binary'
  441.     nobin  or  nobinary        resets 'binary'
  442.     bad                specifies behavior for bad characters
  443.     edit            for |:read| only: keep option values as if editing
  444.                 a file
  445.  
  446. {value} cannot contain white space.  It can be any valid value for these
  447. options.  Examples: >
  448.     :e ++ff=unix
  449. This edits the same file again with 'fileformat' set to "unix". >
  450.  
  451.     :w ++enc=latin1 newfile
  452. This writes the current buffer to "newfile" in latin1 format.
  453.  
  454. There may be several ++opt arguments, separated by white space.  They must all
  455. appear before any |+cmd| argument.
  456.  
  457.                                 *++bad*
  458. The argument of "++bad=" specifies what happens with characters that can't be
  459. converted and illegal bytes.  It can be one of three things:
  460.     ++bad=X      A single-byte character that replaces each bad character.
  461.     ++bad=keep   Keep bad characters without conversion.  Note that this may
  462.          result in illegal bytes in your text!
  463.     ++bad=drop   Remove the bad characters.
  464.  
  465. The default is like "++bad=?": Replace each bad character with a question
  466. mark.  In some places an inverted question mark is used (0xBF).
  467.  
  468. Note that not all commands use the ++bad argument, even though they do not
  469. give an error when you add it.  E.g. |:write|.
  470.  
  471. Note that when reading, the 'fileformat' and 'fileencoding' options will be
  472. set to the used format.  When writing this doesn't happen, thus a next write
  473. will use the old value of the option.  Same for the 'binary' option.
  474.  
  475.  
  476.                             *+cmd* *[+cmd]*
  477. The [+cmd] argument can be used to position the cursor in the newly opened
  478. file, or execute any other command:
  479.     +        Start at the last line.
  480.     +{num}        Start at line {num}.
  481.     +/{pat}        Start at first line containing {pat}.
  482.     +{command}    Execute {command} after opening the new file.
  483.             {command} is any Ex command.
  484. To include a white space in the {pat} or {command}, precede it with a
  485. backslash.  Double the number of backslashes. >
  486.     :edit  +/The\ book         file
  487.     :edit  +/dir\ dirname\\      file
  488.     :edit  +set\ dir=c:\\\\temp  file
  489. Note that in the last example the number of backslashes is halved twice: Once
  490. for the "+cmd" argument and once for the ":set" command.
  491.  
  492.                             *file-formats*
  493. The 'fileformat' option sets the <EOL> style for a file:
  494. 'fileformat'    characters       name                ~
  495.   "dos"        <CR><NL> or <NL>   DOS format        *DOS-format*
  496.   "unix"    <NL>           Unix format        *Unix-format*
  497.   "mac"        <CR>           Mac format        *Mac-format*
  498. Previously 'textmode' was used.  It is obsolete now.
  499.  
  500. When reading a file, the mentioned characters are interpreted as the <EOL>.
  501. In DOS format (default for MS-DOS, OS/2 and Win32), <CR><NL> and <NL> are both
  502. interpreted as the <EOL>.  Note that when writing the file in DOS format,
  503. <CR> characters will be added for each single <NL>.  Also see |file-read|.
  504.  
  505. When writing a file, the mentioned characters are used for <EOL>.  For DOS
  506. format <CR><NL> is used.  Also see |DOS-format-write|.
  507.  
  508. You can read a file in DOS format and write it in Unix format.  This will
  509. replace all <CR><NL> pairs by <NL> (assuming 'fileformats' includes "dos"): >
  510.     :e file
  511.     :set fileformat=unix
  512.     :w
  513. If you read a file in Unix format and write with DOS format, all <NL>
  514. characters will be replaced with <CR><NL> (assuming 'fileformats' includes
  515. "unix"): >
  516.     :e file
  517.     :set fileformat=dos
  518.     :w
  519.  
  520. If you start editing a new file and the 'fileformats' option is not empty
  521. (which is the default), Vim will try to detect whether the lines in the file
  522. are separated by the specified formats.  When set to "unix,dos", Vim will
  523. check for lines with a single <NL> (as used on Unix and Amiga) or by a <CR>
  524. <NL> pair (MS-DOS).  Only when ALL lines end in <CR><NL>, 'fileformat' is set
  525. to "dos", otherwise it is set to "unix".  When 'fileformats' includes "mac",
  526. and no <NL> characters are found in the file, 'fileformat' is set to "mac".
  527.  
  528. If the 'fileformat' option is set to "dos" on non-MS-DOS systems the message
  529. "[dos format]" is shown to remind you that something unusual is happening.  On
  530. MS-DOS systems you get the message "[unix format]" if 'fileformat' is set to
  531. "unix".  On all systems but the Macintosh you get the message "[mac format]"
  532. if 'fileformat' is set to "mac".
  533.  
  534. If the 'fileformats' option is empty and DOS format is used, but while reading
  535. a file some lines did not end in <CR><NL>, "[CR missing]" will be included in
  536. the file message.
  537. If the 'fileformats' option is empty and Mac format is used, but while reading
  538. a file a <NL> was found, "[NL missing]" will be included in the file message.
  539.  
  540. If the new file does not exist, the 'fileformat' of the current buffer is used
  541. when 'fileformats' is empty.  Otherwise the first format from 'fileformats' is
  542. used for the new file.
  543.  
  544. Before editing binary, executable or Vim script files you should set the
  545. 'binary' option.  A simple way to do this is by starting Vim with the "-b"
  546. option.  This will avoid the use of 'fileformat'.  Without this you risk that
  547. single <NL> characters are unexpectedly replaced with <CR><NL>.
  548.  
  549. You can encrypt files that are written by setting the 'key' option.  This
  550. provides some security against others reading your files. |encryption|
  551.  
  552.  
  553. ==============================================================================
  554. 3. The argument list                *argument-list* *arglist*
  555.  
  556. If you give more than one file name when starting Vim, this list is remembered
  557. as the argument list.  You can jump to each file in this list.
  558.  
  559. Do not confuse this with the buffer list, which you can see with the
  560. |:buffers| command.  The argument list was already present in Vi, the buffer
  561. list is new in Vim.  Every file name in the argument list will also be present
  562. in the buffer list (unless it was deleted with |:bdel| or |:bwipe|).  But it's
  563. common that names in the buffer list are not in the argument list.
  564.  
  565. This subject is introduced in section |07.2| of the user manual.
  566.  
  567. There is one global argument list, which is used for all windows by default.
  568. It is possible to create a new argument list local to a window, see
  569. |:arglocal|.
  570.  
  571. You can use the argument list with the following commands, and with the
  572. expression functions |argc()| and |argv()|.  These all work on the argument
  573. list of the current window.
  574.  
  575.                             *:ar* *:args*
  576. :ar[gs]            Print the argument list, with the current file in
  577.             square brackets.
  578.  
  579. :ar[gs] [++opt] [+cmd] {arglist}            *:args_f*
  580.             Define {arglist} as the new argument list and edit
  581.             the first one.  This fails when changes have been made
  582.             and Vim does not want to |abandon| the current buffer.
  583.             Also see |++opt| and |+cmd|.
  584.             {Vi: no ++opt}
  585.  
  586. :ar[gs]! [++opt] [+cmd] {arglist}            *:args_f!*
  587.             Define {arglist} as the new argument list and edit
  588.             the first one.  Discard any changes to the current
  589.             buffer.
  590.             Also see |++opt| and |+cmd|.
  591.             {Vi: no ++opt}
  592.  
  593. :[count]arge[dit][!] [++opt] [+cmd] {name}        *:arge* *:argedit*
  594.             Add {name} to the argument list and edit it.
  595.             When {name} already exists in the argument list, this
  596.             entry is edited.
  597.             This is like using |:argadd| and then |:edit|.
  598.             Note that only one file name is allowed, and spaces
  599.             inside the file name are allowed, like with |:edit|.
  600.             [count] is used like with |:argadd|.
  601.             [!] is required if the current file cannot be
  602.             |abandon|ed.
  603.             Also see |++opt| and |+cmd|.
  604.             {not in Vi}
  605.  
  606. :[count]arga[dd] {name} ..            *:arga* *:argadd* *E479*
  607.             Add the {name}s to the argument list.
  608.             If [count] is omitted, the {name}s are added just
  609.             after the current entry in the argument list.
  610.             Otherwise they are added after the [count]'th file.
  611.             If the argument list is "a b c", and "b" is the
  612.             current argument, then these commands result in:
  613.                 command        new argument list ~
  614.                 :argadd x    a b x c
  615.                 :0argadd x    x a b c
  616.                 :1argadd x    a x b c
  617.                 :99argadd x    a b c x
  618.             There is no check for duplicates, it is possible to
  619.             add a file to the argument list twice.
  620.             The currently edited file is not changed.
  621.             {not in Vi} {not available when compiled without the
  622.             |+listcmds| feature}
  623.             Note: you can also use this method: >
  624.                 :args ## x
  625. <            This will add the "x" item and sort the new list.
  626.  
  627. :argd[elete] {pattern} ..            *:argd* *:argdelete* *E480*
  628.             Delete files from the argument list that match the
  629.             {pattern}s.  {pattern} is used like a file pattern,
  630.             see |file-pattern|.  "%" can be used to delete the
  631.             current entry.
  632.             This command keeps the currently edited file, also
  633.             when it's deleted from the argument list.
  634.             Example: >
  635.                 :argdel *.obj
  636. <            {not in Vi} {not available when compiled without the
  637.             |+listcmds| feature}
  638.  
  639. :{range}argd[elete]    Delete the {range} files from the argument list.
  640.             When the last number in the range is too high, up to
  641.             the last argument is deleted.  Example: >
  642.                 :10,1000argdel
  643. <            Deletes arguments 10 and further, keeping 1-9.
  644.             {not in Vi} {not available when compiled without the
  645.             |+listcmds| feature}
  646.  
  647.                             *:argu* *:argument*
  648. :[count]argu[ment] [count] [++opt] [+cmd]
  649.             Edit file [count] in the argument list.  When [count]
  650.             is omitted the current entry is used.  This fails
  651.             when changes have been made and Vim does not want to
  652.             |abandon| the current buffer.
  653.             Also see |++opt| and |+cmd|.
  654.             {not in Vi} {not available when compiled without the
  655.             |+listcmds| feature}
  656.  
  657. :[count]argu[ment]! [count] [++opt] [+cmd]
  658.             Edit file [count] in the argument list, discard any
  659.             changes to the current buffer.  When [count] is
  660.             omitted the current entry is used.
  661.             Also see |++opt| and |+cmd|.
  662.             {not in Vi} {not available when compiled without the
  663.             |+listcmds| feature}
  664.  
  665. :[count]n[ext] [++opt] [+cmd]            *:n* *:ne* *:next* *E165* *E163*
  666.             Edit [count] next file.  This fails when changes have
  667.             been made and Vim does not want to |abandon| the
  668.             current buffer.  Also see |++opt| and |+cmd|.  {Vi: no
  669.             count or ++opt}.
  670.  
  671. :[count]n[ext]! [++opt] [+cmd]
  672.             Edit [count] next file, discard any changes to the
  673.             buffer.  Also see |++opt| and |+cmd|.  {Vi: no count
  674.             or ++opt}.
  675.  
  676. :n[ext] [++opt] [+cmd] {arglist}            *:next_f*
  677.             Same as |:args_f|.
  678.  
  679. :n[ext]! [++opt] [+cmd] {arglist}
  680.             Same as |:args_f!|.
  681.  
  682. :[count]N[ext] [count] [++opt] [+cmd]            *:Next* *:N* *E164*
  683.             Edit [count] previous file in argument list.  This
  684.             fails when changes have been made and Vim does not
  685.             want to |abandon| the current buffer.
  686.             Also see |++opt| and |+cmd|.  {Vi: no count or ++opt}.
  687.  
  688. :[count]N[ext]! [count] [++opt] [+cmd]
  689.             Edit [count] previous file in argument list.  Discard
  690.             any changes to the buffer.  Also see |++opt| and
  691.             |+cmd|.  {Vi: no count or ++opt}.
  692.  
  693. :[count]prev[ious] [count] [++opt] [+cmd]        *:prev* *:previous*
  694.             Same as :Next.  Also see |++opt| and |+cmd|.  {Vi:
  695.             only in some versions}
  696.  
  697.                             *:rew* *:rewind*
  698. :rew[ind] [++opt] [+cmd]
  699.             Start editing the first file in the argument list.
  700.             This fails when changes have been made and Vim does
  701.             not want to |abandon| the current buffer.
  702.             Also see |++opt| and |+cmd|. {Vi: no ++opt}
  703.  
  704. :rew[ind]! [++opt] [+cmd]
  705.             Start editing the first file in the argument list.
  706.             Discard any changes to the buffer.  Also see |++opt|
  707.             and |+cmd|. {Vi: no ++opt}
  708.  
  709.                             *:fir* *:first*
  710. :fir[st][!] [++opt] [+cmd]
  711.             Other name for ":rewind". {not in Vi}
  712.  
  713.                             *:la* *:last*
  714. :la[st] [++opt] [+cmd]
  715.             Start editing the last file in the argument list.
  716.             This fails when changes have been made and Vim does
  717.             not want to |abandon| the current buffer.
  718.             Also see |++opt| and |+cmd|.  {not in Vi}
  719.  
  720. :la[st]! [++opt] [+cmd]
  721.             Start editing the last file in the argument list.
  722.             Discard any changes to the buffer.  Also see |++opt|
  723.             and |+cmd|.  {not in Vi}
  724.  
  725.                             *:wn* *:wnext*
  726. :[count]wn[ext] [++opt]
  727.             Write current file and start editing the [count]
  728.             next file.  Also see |++opt| and |+cmd|.  {not in Vi}
  729.  
  730. :[count]wn[ext] [++opt] {file}
  731.             Write current file to {file} and start editing the
  732.             [count] next file, unless {file} already exists and
  733.             the 'writeany' option is off.  Also see |++opt| and
  734.             |+cmd|.  {not in Vi}
  735.  
  736. :[count]wn[ext]! [++opt] {file}
  737.             Write current file to {file} and start editing the
  738.             [count] next file.  Also see |++opt| and |+cmd|.  {not
  739.             in Vi}
  740.  
  741. :[count]wN[ext][!] [++opt] [file]        *:wN* *:wNext*
  742. :[count]wp[revious][!] [++opt] [file]        *:wp* *:wprevious*
  743.             Same as :wnext, but go to previous file instead of
  744.             next.  {not in Vi}
  745.  
  746. The [count] in the commands above defaults to one.  For some commands it is
  747. possible to use two counts.  The last one (rightmost one) is used.
  748.  
  749. If no [+cmd] argument is present, the cursor is positioned at the last known
  750. cursor position for the file.  If 'startofline' is set, the cursor will be
  751. positioned at the first non-blank in the line, otherwise the last know column
  752. is used.  If there is no last known cursor position the cursor will be in the
  753. first line (the last line in Ex mode).
  754.  
  755.                             *{arglist}*
  756. The wildcards in the argument list are expanded and the file names are sorted.
  757. Thus you can use the command "vim *.c" to edit all the C files.  From within
  758. Vim the command ":n *.c" does the same.
  759.  
  760. White space is used to separate file names.  Put a backslash before a space or
  761. tab to include it in a file name.  E.g., to edit the single file "foo bar": >
  762.     :next foo\ bar
  763.  
  764. On Unix and a few other systems you can also use backticks, for example: >
  765.     :next `find . -name \\*.c -print`
  766. The backslashes before the star are required to prevent "*.c" to be expanded
  767. by the shell before executing the find program.
  768.  
  769.                             *arglist-position*
  770. When there is an argument list you can see which file you are editing in the
  771. title of the window (if there is one and 'title' is on) and with the file
  772. message you get with the "CTRL-G" command.  You will see something like
  773.     (file 4 of 11)
  774. If 'shortmess' contains 'f' it will be
  775.     (4 of 11)
  776. If you are not really editing the file at the current position in the argument
  777. list it will be
  778.     (file (4) of 11)
  779. This means that you are position 4 in the argument list, but not editing the
  780. fourth file in the argument list.  This happens when you do ":e file".
  781.  
  782.  
  783. LOCAL ARGUMENT LIST
  784.  
  785. {not in Vi}
  786. {not available when compiled without the |+windows| or |+listcmds| features}
  787.  
  788.                             *:arglocal*
  789. :argl[ocal]        Make a local copy of the global argument list.
  790.             Doesn't start editing another file.
  791.  
  792. :argl[ocal][!] [++opt] [+cmd] {arglist}
  793.             Define a new argument list, which is local to the
  794.             current window.  Works like |:args_f| otherwise.
  795.  
  796.                             *:argglobal*
  797. :argg[lobal]        Use the global argument list for the current window.
  798.             Doesn't start editing another file.
  799.  
  800. :argg[lobal][!] [++opt] [+cmd] {arglist}
  801.             Use the global argument list for the current window.
  802.             Define a new global argument list like |:args_f|.
  803.             All windows using the global argument list will see
  804.             this new list.
  805.  
  806. There can be several argument lists.  They can be shared between windows.
  807. When they are shared, changing the argument list in one window will also
  808. change it in the other window.
  809.  
  810. When a window is split the new window inherits the argument list from the
  811. current window.  The two windows then share this list, until one of them uses
  812. |:arglocal| or |:argglobal| to use another argument list.
  813.  
  814.  
  815. USING THE ARGUMENT LIST
  816.  
  817.                         *:argdo*
  818. :argdo[!] {cmd}        Execute {cmd} for each file in the argument list.
  819.             It works like doing this: >
  820.                 :rewind
  821.                 :{cmd}
  822.                 :next
  823.                 :{cmd}
  824.                 etc.
  825. <            When the current file can't be |abandon|ed and the [!]
  826.             is not present, the command fails.
  827.             When an error is detected on one file, further files
  828.             in the argument list will not be visited.
  829.             The last file in the argument list (or where an error
  830.             occurred) becomes the current file.
  831.             {cmd} can contain '|' to concatenate several commands.
  832.             {cmd} must not change the argument list.
  833.             Note: While this command is executing, the Syntax
  834.             autocommand event is disabled by adding it to
  835.             'eventignore'.  This considerably speeds up editing
  836.             each file.
  837.             {not in Vi} {not available when compiled without the
  838.             |+listcmds| feature}
  839.             Also see |:windo|, |:tabdo| and |:bufdo|.
  840.  
  841. Example: >
  842.     :args *.c
  843.     :argdo set ff=unix | update
  844. This sets the 'fileformat' option to "unix" and writes the file if it is now
  845. changed.  This is done for all *.c files.
  846.  
  847. Example: >
  848.     :args *.[ch]
  849.     :argdo %s/\<my_foo\>/My_Foo/ge | update
  850. This changes the word "my_foo" to "My_Foo" in all *.c and *.h files.  The "e"
  851. flag is used for the ":substitute" command to avoid an error for files where
  852. "my_foo" isn't used.  ":update" writes the file only if changes were made.
  853.  
  854. ==============================================================================
  855. 4. Writing                    *writing* *save-file*
  856.  
  857. Note: When the 'write' option is off, you are not able to write any file.
  858.  
  859.                             *:w* *:write*
  860.                         *E502* *E503* *E504* *E505*
  861.                         *E512* *E514* *E667* *E796*
  862. :w[rite] [++opt]    Write the whole buffer to the current file.  This is
  863.             the normal way to save changes to a file.  It fails
  864.             when the 'readonly' option is set or when there is
  865.             another reason why the file can't be written.
  866.             For ++opt see |++opt|, but only ++bin, ++nobin, ++ff
  867.             and ++enc are effective.
  868.  
  869. :w[rite]! [++opt]    Like ":write", but forcefully write when 'readonly' is
  870.             set or there is another reason why writing was
  871.             refused.
  872.             Note: This may change the permission and ownership of
  873.             the file and break (symbolic) links.  Add the 'W' flag
  874.             to 'cpoptions' to avoid this.
  875.  
  876. :[range]w[rite][!] [++opt]
  877.             Write the specified lines to the current file.  This
  878.             is unusual, because the file will not contain all
  879.             lines in the buffer.
  880.  
  881.                             *:w_f* *:write_f*
  882. :[range]w[rite] [++opt]    {file}
  883.             Write the specified lines to {file}, unless it
  884.             already exists and the 'writeany' option is off.
  885.  
  886.                             *:w!*
  887. :[range]w[rite]! [++opt] {file}
  888.             Write the specified lines to {file}.  Overwrite an
  889.             existing file.
  890.  
  891.                         *:w_a* *:write_a* *E494*
  892. :[range]w[rite][!] [++opt] >>
  893.             Append the specified lines to the current file.
  894.  
  895. :[range]w[rite][!] [++opt] >> {file}
  896.             Append the specified lines to {file}.  '!' forces the
  897.             write even if file does not exist.
  898.  
  899.                             *:w_c* *:write_c*
  900. :[range]w[rite] [++opt] !{cmd}
  901.             Execute {cmd} with [range] lines as standard input
  902.             (note the space in front of the '!').  {cmd} is
  903.             executed like with ":!{cmd}", any '!' is replaced with
  904.             the previous command |:!|.
  905.  
  906. The default [range] for the ":w" command is the whole buffer (1,$).  If you
  907. write the whole buffer, it is no longer considered changed.  When you
  908. write it to a different file with ":w somefile" it depends on the "+" flag in
  909. 'cpoptions'.  When included, the write command will reset the 'modified' flag,
  910. even though the buffer itself may still be different from its file.
  911.  
  912. If a file name is given with ":w" it becomes the alternate file.  This can be
  913. used, for example, when the write fails and you want to try again later with
  914. ":w #".  This can be switched off by removing the 'A' flag from the
  915. 'cpoptions' option.
  916.  
  917.                             *:sav* *:saveas*
  918. :sav[eas][!] [++opt] {file}
  919.             Save the current buffer under the name {file} and set
  920.             the filename of the current buffer to {file}.  The
  921.             previous name is used for the alternate file name.
  922.             The [!] is needed to overwrite an existing file.
  923.             When 'filetype' is empty filetype detection is done
  924.             with the new name, before the file is written.
  925.             When the write was successful 'readonly' is reset.
  926.             {not in Vi}
  927.  
  928.                             *:up* *:update*
  929. :[range]up[date][!] [++opt] [>>] [file]
  930.             Like ":write", but only write when the buffer has been
  931.             modified.  {not in Vi}
  932.  
  933.  
  934. WRITING WITH MULTIPLE BUFFERS                *buffer-write*
  935.  
  936.                             *:wa* *:wall*
  937. :wa[ll]            Write all changed buffers.  Buffers without a file
  938.             name or which are readonly are not written. {not in
  939.             Vi}
  940.  
  941. :wa[ll]!        Write all changed buffers, even the ones that are
  942.             readonly.  Buffers without a file name are not
  943.             written. {not in Vi}
  944.  
  945.  
  946. Vim will warn you if you try to overwrite a file that has been changed
  947. elsewhere.  See |timestamp|.
  948.  
  949.                 *backup* *E207* *E506* *E507* *E508* *E509* *E510*
  950. If you write to an existing file (but do not append) while the 'backup',
  951. 'writebackup' or 'patchmode' option is on, a backup of the original file is
  952. made.  The file is either copied or renamed (see 'backupcopy').  After the
  953. file has been successfully written and when the 'writebackup' option is on and
  954. the 'backup' option is off, the backup file is deleted.  When the 'patchmode'
  955. option is on the backup file may be renamed.
  956.  
  957.                             *backup-table*
  958. 'backup' 'writebackup'    action    ~
  959.    off         off    no backup made
  960.    off         on        backup current file, deleted afterwards (default)
  961.    on         off    delete old backup, backup current file
  962.    on         on        delete old backup, backup current file
  963.  
  964. When the 'backupskip' pattern matches with the name of the file which is
  965. written, no backup file is made.  The values of 'backup' and 'writebackup' are
  966. ignored then.
  967.  
  968. When the 'backup' option is on, an old backup file (with the same name as the
  969. new backup file) will be deleted.  If 'backup' is not set, but 'writebackup'
  970. is set, an existing backup file will not be deleted.  The backup file that is
  971. made while the file is being written will have a different name.
  972.  
  973. On some filesystems it's possible that in a crash you lose both the backup and
  974. the newly written file (it might be there but contain bogus data).  In that
  975. case try recovery, because the swap file is synced to disk and might still be
  976. there. |:recover|
  977.  
  978. The directories given with the 'backupdir' option is used to put the backup
  979. file in.  (default: same directory as the written file).
  980.  
  981. Whether the backup is a new file, which is a copy of the original file, or the
  982. original file renamed depends on the 'backupcopy' option.  See there for an
  983. explanation of when the copy is made and when the file is renamed.
  984.  
  985. If the creation of a backup file fails, the write is not done.  If you want
  986. to write anyway add a '!' to the command.
  987.  
  988.                             *write-permissions*
  989. When writing a new file the permissions are read-write.  For unix the mask is
  990. 0666 with additionally umask applied.  When writing a file that was read Vim
  991. will preserve the permissions, but clear the s-bit.
  992.  
  993.                             *write-readonly*
  994. When the 'cpoptions' option contains 'W', Vim will refuse to overwrite a
  995. readonly file.  When 'W' is not present, ":w!" will overwrite a readonly file,
  996. if the system allows it (the directory must be writable).
  997.  
  998.                             *write-fail*
  999. If the writing of the new file fails, you have to be careful not to lose
  1000. your changes AND the original file.  If there is no backup file and writing
  1001. the new file failed, you have already lost the original file!  DON'T EXIT VIM
  1002. UNTIL YOU WRITE OUT THE FILE!  If a backup was made, it is put back in place
  1003. of the original file (if possible).  If you exit Vim, and lose the changes
  1004. you made, the original file will mostly still be there.  If putting back the
  1005. original file fails, there will be an error message telling you that you
  1006. lost the original file.
  1007.  
  1008.                         *DOS-format-write*
  1009. If the 'fileformat' is "dos", <CR> <NL> is used for <EOL>.  This is default
  1010. for MS-DOS, Win32 and OS/2.  On other systems the message "[dos format]" is
  1011. shown to remind you that an unusual <EOL> was used.
  1012.                         *Unix-format-write*
  1013. If the 'fileformat' is "unix", <NL> is used for <EOL>.  On MS-DOS, Win32 and
  1014. OS/2 the message "[unix format]" is shown.
  1015.                         *Mac-format-write*
  1016. If the 'fileformat' is "mac", <CR> is used for <EOL>.  On non-Mac systems the
  1017. message "[mac format]" is shown.
  1018.  
  1019. See also |file-formats| and the 'fileformat' and 'fileformats' options.
  1020.  
  1021.                         *ACL*
  1022. ACL stands for Access Control List.  It is an advanced way to control access
  1023. rights for a file.  It is used on new MS-Windows and Unix systems, but only
  1024. when the filesystem supports it.
  1025.    Vim attempts to preserve the ACL info when writing a file.  The backup file
  1026. will get the ACL info of the original file.
  1027.    The ACL info is also used to check if a file is read-only (when opening the
  1028. file).
  1029.  
  1030.                         *read-only-share*
  1031. When MS-Windows shares a drive on the network it can be marked as read-only.
  1032. This means that even if the file read-only attribute is absent, and the ACL
  1033. settings on NT network shared drives allow writing to the file, you can still
  1034. not write to the file.  Vim on Win32 platforms will detect read-only network
  1035. drives and will mark the file as read-only.  You will not be able to override
  1036. it with |:write|.
  1037.  
  1038.                         *write-device*
  1039. When the file name is actually a device name, Vim will not make a backup (that
  1040. would be impossible).  You need to use "!", since the device already exists.
  1041. Example for Unix: >
  1042.     :w! /dev/lpt0
  1043. and for MS-DOS or MS-Windows: >
  1044.     :w! lpt0
  1045. For Unix a device is detected when the name doesn't refer to a normal file or
  1046. a directory.  A fifo or named pipe also looks like a device to Vim.
  1047. For MS-DOS and MS-Windows the device is detected by its name:
  1048.     AUX
  1049.     CON
  1050.     CLOCK$
  1051.     NUL
  1052.     PRN
  1053.     COMn    n=1,2,3... etc
  1054.     LPTn    n=1,2,3... etc
  1055. The names can be in upper- or lowercase.
  1056.  
  1057. ==============================================================================
  1058. 5. Writing and quitting                    *write-quit*
  1059.  
  1060.                             *:q* *:quit*
  1061. :q[uit]            Quit the current window.  Quit Vim if this is the last
  1062.             window.  This fails when changes have been made and
  1063.             Vim refuses to |abandon| the current buffer, and when
  1064.             the last file in the argument list has not been
  1065.             edited.
  1066.             If there are other tab pages and quitting the last
  1067.             window in the current tab page the current tab page is
  1068.             closed |tab-page|.
  1069.  
  1070. :conf[irm] q[uit]    Quit, but give prompt when changes have been made, or
  1071.             the last file in the argument list has not been
  1072.             edited.  See |:confirm| and 'confirm'.  {not in Vi}
  1073.  
  1074. :q[uit]!        Quit without writing, also when visible buffers have
  1075.             changes.  Does not exit when there are changed hidden
  1076.             buffers.  Use ":qall!" to exit always.
  1077.  
  1078. :cq[uit]        Quit always, without writing, and return an error
  1079.             code.  See |:cq|.  Used for Manx's QuickFix mode (see
  1080.             |quickfix|).  {not in Vi}
  1081.  
  1082.                             *:wq*
  1083. :wq [++opt]        Write the current file and quit.  Writing fails when
  1084.             the file is read-only or the buffer does not have a
  1085.             name.  Quitting fails when the last file in the
  1086.             argument list has not been edited.
  1087.  
  1088. :wq! [++opt]        Write the current file and quit.  Writing fails when
  1089.             the current buffer does not have a name.
  1090.  
  1091. :wq [++opt] {file}    Write to {file} and quit.  Quitting fails when the
  1092.             last file in the argument list has not been edited.
  1093.  
  1094. :wq! [++opt] {file}    Write to {file} and quit.
  1095.  
  1096. :[range]wq[!] [++opt] [file]
  1097.             Same as above, but only write the lines in [range].
  1098.  
  1099.                             *:x* *:xit*
  1100. :[range]x[it][!] [++opt] [file]
  1101.             Like ":wq", but write only when changes have been
  1102.             made.
  1103.             When 'hidden' is set and there are more windows, the
  1104.             current buffer becomes hidden, after writing the file.
  1105.  
  1106.                             *:exi* *:exit*
  1107. :[range]exi[t][!] [++opt] [file]
  1108.             Same as :xit.
  1109.  
  1110.                             *ZZ*
  1111. ZZ            Write current file, if modified, and quit (same as
  1112.             ":x").  (Note: If there are several windows for the
  1113.             current file, the file is written if it was modified
  1114.             and the window is closed).
  1115.  
  1116.                             *ZQ*
  1117. ZQ            Quit without checking for changes (same as ":q!").
  1118.             {not in Vi}
  1119.  
  1120. MULTIPLE WINDOWS AND BUFFERS                *window-exit*
  1121.  
  1122.                             *:qa* *:qall*
  1123. :qa[ll]        Exit Vim, unless there are some buffers which have been
  1124.         changed.  (Use ":bmod" to go to the next modified buffer).
  1125.         When 'autowriteall' is set all changed buffers will be
  1126.         written, like |:wqall|. {not in Vi}
  1127.  
  1128. :conf[irm] qa[ll]
  1129.         Exit Vim.  Bring up a prompt when some buffers have been
  1130.         changed.  See |:confirm|. {not in Vi}
  1131.  
  1132. :qa[ll]!    Exit Vim.  Any changes to buffers are lost. {not in Vi}
  1133.         Also see |:cquit|, it does the same but exits with a non-zero
  1134.         value.
  1135.  
  1136.                             *:quita* *:quitall*
  1137. :quita[ll][!]    Same as ":qall". {not in Vi}
  1138.  
  1139. :wqa[ll] [++opt]                *:wqa* *:wqall* *:xa* *:xall*
  1140. :xa[ll]        Write all changed buffers and exit Vim.  If there are buffers
  1141.         without a file name, which are readonly or which cannot be
  1142.         written for another reason, Vim will not quit. {not in Vi}
  1143.  
  1144. :conf[irm] wqa[ll] [++opt]
  1145. :conf[irm] xa[ll]
  1146.         Write all changed buffers and exit Vim.  Bring up a prompt
  1147.         when some buffers are readonly or cannot be written for
  1148.         another reason.  See |:confirm|. {not in Vi}
  1149.  
  1150. :wqa[ll]! [++opt]
  1151. :xa[ll]!    Write all changed buffers, even the ones that are readonly,
  1152.         and exit Vim.  If there are buffers without a file name or
  1153.         which cannot be written for another reason, Vim will not quit.
  1154.         {not in Vi}
  1155.  
  1156. ==============================================================================
  1157. 6. Dialogs                        *edit-dialogs*
  1158.  
  1159.                             *:confirm* *:conf*
  1160. :conf[irm] {command}    Execute {command}, and use a dialog when an
  1161.             operation has to be confirmed.  Can be used on the
  1162.             |:q|, |:qa| and |:w| commands (the latter to override
  1163.             a read-only setting), and any other command that can
  1164.             fail in such a way, such as |:only|, |:buffer|,
  1165.             |:bdelete|, etc.
  1166.  
  1167. Examples: >
  1168.   :confirm w foo
  1169. <    Will ask for confirmation when "foo" already exists. >
  1170.   :confirm q
  1171. <    Will ask for confirmation when there are changes. >
  1172.   :confirm qa
  1173. <    If any modified, unsaved buffers exist, you will be prompted to save
  1174.     or abandon each one.  There are also choices to "save all" or "abandon
  1175.     all".
  1176.  
  1177. If you want to always use ":confirm", set the 'confirm' option.
  1178.  
  1179.             *:browse* *:bro* *E338* *E614* *E615* *E616* *E578*
  1180. :bro[wse] {command}    Open a file selection dialog for an argument to
  1181.             {command}.  At present this works for |:e|, |:w|,
  1182.             |:wall|, |:wq|, |:wqall|, |:x|, |:xall|, |:exit|,
  1183.             |:view|, |:sview|, |:r|, |:saveas|, |:sp|, |:mkexrc|,
  1184.             |:mkvimrc|, |:mksession|, |:mkview|, |:split|,
  1185.             |:vsplit|, |:tabe|, |:tabnew|, |:cfile|, |:cgetfile|,
  1186.             |:caddfile|, |:lfile|, |:lgetfile|, |:laddfile|,
  1187.             |:diffsplit|, |:diffpatch|, |:open|, |:pedit|,
  1188.             |:redir|, |:source|, |:update|, |:visual|, |:vsplit|,
  1189.             and |:qall| if 'confirm' is set.
  1190.             {only in Win32, Athena, Motif, GTK and Mac GUI}
  1191.             When ":browse" is not possible you get an error
  1192.             message.  If the |+browse| feature is missing or the
  1193.             {command} doesn't support browsing, the {command} is
  1194.             executed without a dialog.
  1195.             ":browse set" works like |:options|.
  1196.             See also |:oldfiles| for ":browse oldfiles".
  1197.  
  1198. The syntax is best shown via some examples: >
  1199.     :browse e $vim/foo
  1200. <        Open the browser in the $vim/foo directory, and edit the
  1201.         file chosen. >
  1202.     :browse e
  1203. <        Open the browser in the directory specified with 'browsedir',
  1204.         and edit the file chosen. >
  1205.     :browse w
  1206. <        Open the browser in the directory of the current buffer,
  1207.         with the current buffer filename as default, and save the
  1208.         buffer under the filename chosen. >
  1209.     :browse w C:/bar
  1210. <        Open the browser in the C:/bar directory, with the current
  1211.         buffer filename as default, and save the buffer under the
  1212.         filename chosen.
  1213. Also see the |'browsedir'| option.
  1214. For versions of Vim where browsing is not supported, the command is executed
  1215. unmodified.
  1216.  
  1217.                             *browsefilter*
  1218. For MS Windows, you can modify the filters that are used in the browse dialog.
  1219. By setting the g:browsefilter or b:browsefilter variables, you can change the
  1220. filters globally or locally to the buffer.  The variable is set to a string in
  1221. the format "{filter label}\t{pattern};{pattern}\n" where {filter label} is the
  1222. text that appears in the "Files of Type" comboBox, and {pattern} is the
  1223. pattern which filters the filenames.  Several patterns can be given, separated
  1224. by ';'.
  1225.  
  1226. For Motif the same format is used, but only the very first pattern is actually
  1227. used (Motif only offers one pattern, but you can edit it).
  1228.  
  1229. For example, to have only Vim files in the dialog, you could use the following
  1230. command: >
  1231.  
  1232.      let g:browsefilter="Vim Scripts\t*.vim\nVim Startup Files\t*vimrc\n"
  1233.  
  1234. You can override the filter setting on a per-buffer basis by setting the
  1235. b:browsefilter variable.  You would most likely set b:browsefilter in a
  1236. filetype plugin, so that the browse dialog would contain entries related to
  1237. the type of file you are currently editing.  Disadvantage: This makes it
  1238. difficult to start editing a file of a different type.  To overcome this, you
  1239. may want to add "All Files\t*.*\n" as the final filter, so that the user can
  1240. still access any desired file.
  1241.  
  1242. ==============================================================================
  1243. 7. The current directory                *current-directory*
  1244.  
  1245. You may use the |:cd| and |:lcd| commands to change to another directory, so
  1246. you will not have to type that directory name in front of the file names.  It
  1247. also makes a difference for executing external commands, e.g. ":!ls".
  1248.  
  1249. Changing directory fails when the current buffer is modified, the '.' flag is
  1250. present in 'cpoptions' and "!" is not used in the command.
  1251.  
  1252.                             *:cd* *E747* *E472*
  1253. :cd[!]            On non-Unix systems: Print the current directory
  1254.             name.  On Unix systems: Change the current directory
  1255.             to the home directory.  Use |:pwd| to print the
  1256.             current directory on all systems.
  1257.  
  1258. :cd[!] {path}        Change the current directory to {path}.
  1259.             If {path} is relative, it is searched for in the
  1260.             directories listed in |'cdpath'|.
  1261.             Does not change the meaning of an already opened file,
  1262.             because its full path name is remembered.  Files from
  1263.             the |arglist| may change though!
  1264.             On MS-DOS this also changes the active drive.
  1265.             To change to the directory of the current file: >
  1266.                 :cd %:h
  1267. <
  1268.                             *:cd-* *E186*
  1269. :cd[!] -        Change to the previous current directory (before the
  1270.             previous ":cd {path}" command). {not in Vi}
  1271.  
  1272.                             *:chd* *:chdir*
  1273. :chd[ir][!] [path]    Same as |:cd|.
  1274.  
  1275.                             *:lc* *:lcd*
  1276. :lc[d][!] {path}    Like |:cd|, but only set the current directory for the
  1277.             current window.  The current directory for other
  1278.             windows is not changed. {not in Vi}
  1279.  
  1280.                             *:lch* *:lchdir*
  1281. :lch[dir][!]        Same as |:lcd|. {not in Vi}
  1282.  
  1283.                             *:pw* *:pwd* *E187*
  1284. :pw[d]            Print the current directory name.  {Vi: no pwd}
  1285.             Also see |getcwd()|.
  1286.  
  1287. So long as no |:lcd| command has been used, all windows share the same current
  1288. directory.  Using a command to jump to another window doesn't change anything
  1289. for the current directory.
  1290. When a |:lcd| command has been used for a window, the specified directory
  1291. becomes the current directory for that window.  Windows where the |:lcd|
  1292. command has not been used stick to the global current directory.  When jumping
  1293. to another window the current directory will become the last specified local
  1294. current directory.  If none was specified, the global current directory is
  1295. used.
  1296. When a |:cd| command is used, the current window will lose his local current
  1297. directory and will use the global current directory from now on.
  1298.  
  1299. After using |:cd| the full path name will be used for reading and writing
  1300. files.  On some networked file systems this may cause problems.  The result of
  1301. using the full path name is that the file names currently in use will remain
  1302. referring to the same file.  Example: If you have a file a:test and a
  1303. directory a:vim the commands ":e test" ":cd vim" ":w" will overwrite the file
  1304. a:test and not write a:vim/test.  But if you do ":w test" the file a:vim/test
  1305. will be written, because you gave a new file name and did not refer to a
  1306. filename before the ":cd".
  1307.  
  1308. ==============================================================================
  1309. 8. Editing binary files                    *edit-binary*
  1310.  
  1311. Although Vim was made to edit text files, it is possible to edit binary
  1312. files.  The |-b| Vim argument (b for binary) makes Vim do file I/O in binary
  1313. mode, and sets some options for editing binary files ('binary' on, 'textwidth'
  1314. to 0, 'modeline' off, 'expandtab' off).  Setting the 'binary' option has the
  1315. same effect.  Don't forget to do this before reading the file.
  1316.  
  1317. There are a few things to remember when editing binary files:
  1318. - When editing executable files the number of characters must not change.
  1319.   Use only the "R" or "r" command to change text.  Do not delete characters
  1320.   with "x" or by backspacing.
  1321. - Set the 'textwidth' option to 0.  Otherwise lines will unexpectedly be
  1322.   split in two.
  1323. - When there are not many <EOL>s, the lines will become very long.  If you
  1324.   want to edit a line that does not fit on the screen reset the 'wrap' option.
  1325.   Horizontal scrolling is used then.  If a line becomes too long (more than
  1326.   about 32767 characters on the Amiga, much more on 32-bit systems, see
  1327.   |limits|) you cannot edit that line.  The line will be split when reading
  1328.   the file.  It is also possible that you get an "out of memory" error when
  1329.   reading the file.
  1330. - Make sure the 'binary' option is set BEFORE loading the
  1331.   file.  Otherwise both <CR> <NL> and <NL> are considered to end a line
  1332.   and when the file is written the <NL> will be replaced with <CR> <NL>.
  1333. - <Nul> characters are shown on the screen as ^@.  You can enter them with
  1334.   "CTRL-V CTRL-@" or "CTRL-V 000" {Vi cannot handle <Nul> characters in the
  1335.   file}
  1336. - To insert a <NL> character in the file split up a line.  When writing the
  1337.   buffer to a file a <NL> will be written for the <EOL>.
  1338. - Vim normally appends an <EOL> at the end of the file if there is none.
  1339.   Setting the 'binary' option prevents this.  If you want to add the final
  1340.   <EOL>, set the 'endofline' option.  You can also read the value of this
  1341.   option to see if there was an <EOL> for the last line (you cannot see this
  1342.   in the text).
  1343.  
  1344. ==============================================================================
  1345. 9. Encryption                        *encryption*
  1346.  
  1347. Vim is able to write files encrypted, and read them back.  The encrypted text
  1348. cannot be read without the right key.
  1349. {only available when compiled with the |+cryptv| feature}  *E833*
  1350.  
  1351. The text in the swap file and the undo file is also encrypted.  *E843*
  1352.  
  1353. Note: The text in memory is not encrypted.  A system administrator may be able
  1354. to see your text while you are editing it.  When filtering text with
  1355. ":!filter" or using ":w !command" the text is not encrypted, this may reveal
  1356. it to others.  The 'viminfo' file is not encrypted.
  1357.  
  1358. WARNING: If you make a typo when entering the key and then write the file and
  1359. exit, the text will be lost!
  1360.  
  1361. The normal way to work with encryption, is to use the ":X" command, which will
  1362. ask you to enter a key.  A following write command will use that key to
  1363. encrypt the file.  If you later edit the same file, Vim will ask you to enter
  1364. a key.  If you type the same key as that was used for writing, the text will
  1365. be readable again.  If you use a wrong key, it will be a mess.
  1366.  
  1367.                             *:X*
  1368. :X    Prompt for an encryption key.  The typing is done without showing the
  1369.     actual text, so that someone looking at the display won't see it.
  1370.     The typed key is stored in the 'key' option, which is used to encrypt
  1371.     the file when it is written.  The file will remain unchanged until you
  1372.     write it.  See also |-x|.
  1373.  
  1374. The value of the 'key' options is used when text is written.  When the option
  1375. is not empty, the written file will be encrypted, using the value as the
  1376. encryption key.  A magic number is prepended, so that Vim can recognize that
  1377. the file is encrypted.
  1378.  
  1379. To disable the encryption, reset the 'key' option to an empty value: >
  1380.     :set key=
  1381.  
  1382. You can use the 'cryptmethod' option to select the type of encryption, use one
  1383. of these two: >
  1384.     :setlocal cm=zip       " weak method, backwards compatible
  1385.     :setlocal cm=blowfish  " strong method
  1386. Do this before writing the file.  When reading an encrypted file it will be
  1387. set automatically to the method used when that file was written.  You can
  1388. change 'cryptmethod' before writing that file to change the method.
  1389. To set the default method, used for new files, use one of these in your
  1390. |vimrc| file: >
  1391.     set cm=zip
  1392.     set cm=blowfish
  1393. The message given for reading and writing a file will show "[crypted]" when
  1394. using zip, "[blowfish]" when using blowfish.
  1395.  
  1396. When writing an undo file, the same key and method will be used for the text
  1397. in the undo file. |persistent-undo|.
  1398.  
  1399.                         *E817* *E818* *E819* *E820*
  1400. When encryption does not work properly, you would be able to write your text
  1401. to a file and never be able to read it back.  Therefore a test is performed to
  1402. check if the encryption works as expected.  If you get one of these errors
  1403. don't write the file encrypted!  You need to rebuild the Vim binary to fix
  1404. this.
  1405.  
  1406. *E831* This is an internal error, "cannot happen".  If you can reproduce it,
  1407. please report to the developers.
  1408.  
  1409. When reading a file that has been encrypted and the 'key' option is not empty,
  1410. it will be used for decryption.  If the value is empty, you will be prompted
  1411. to enter the key.  If you don't enter a key, or you enter the wrong key, the
  1412. file is edited without being decrypted.  There is no warning about using the
  1413. wrong key (this makes brute force methods to find the key more difficult).
  1414.  
  1415. If want to start reading a file that uses a different key, set the 'key'
  1416. option to an empty string, so that Vim will prompt for a new one.  Don't use
  1417. the ":set" command to enter the value, other people can read the command over
  1418. your shoulder.
  1419.  
  1420. Since the value of the 'key' option is supposed to be a secret, its value can
  1421. never be viewed.  You should not set this option in a vimrc file.
  1422.  
  1423. An encrypted file can be recognized by the "file" command, if you add these
  1424. lines to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the
  1425. "magic" file: >
  1426.      0    string    VimCrypt~    Vim encrypted file
  1427.      >9    string    01    - "zip" cryptmethod
  1428.      >9    string    02    - "blowfish" cryptmethod
  1429.  
  1430.  
  1431. Notes:
  1432. - Encryption is not possible when doing conversion with 'charconvert'.
  1433. - Text you copy or delete goes to the numbered registers.  The registers can
  1434.   be saved in the .viminfo file, where they could be read.  Change your
  1435.   'viminfo' option to be safe.
  1436. - Someone can type commands in Vim when you walk away for a moment, he should
  1437.   not be able to get the key.
  1438. - If you make a typing mistake when entering the key, you might not be able to
  1439.   get your text back!
  1440. - If you type the key with a ":set key=value" command, it can be kept in the
  1441.   history, showing the 'key' value in a viminfo file.
  1442. - There is never 100% safety.  The encryption in Vim has not been tested for
  1443.   robustness.
  1444. - The algorithm used for 'cryptmethod' "zip" is breakable.  A 4 character key
  1445.   in about one hour, a 6 character key in one day (on a Pentium 133 PC).  This
  1446.   requires that you know some text that must appear in the file.  An expert
  1447.   can break it for any key.  When the text has been decrypted, this also means
  1448.   that the key can be revealed, and other files encrypted with the same key
  1449.   can be decrypted.
  1450. - Pkzip uses the same encryption as 'cryptmethod' "zip", and US Govt has no
  1451.   objection to its export.  Pkzip's public file APPNOTE.TXT describes this
  1452.   algorithm in detail.
  1453. - Vim originates from the Netherlands.  That is where the sources come from.
  1454.   Thus the encryption code is not exported from the USA.
  1455.  
  1456. ==============================================================================
  1457. 10. Timestamps                    *timestamp* *timestamps*
  1458.  
  1459. Vim remembers the modification timestamp of a file when you begin editing it.
  1460. This is used to avoid that you have two different versions of the same file
  1461. (without you knowing this).
  1462.  
  1463. After a shell command is run (|:!cmd| |suspend| |:read!| |K|) timestamps are
  1464. compared for all buffers in a window.   Vim will run any associated
  1465. |FileChangedShell| autocommands or display a warning for any files that have
  1466. changed.  In the GUI this happens when Vim regains input focus.
  1467.  
  1468.                             *E321* *E462*
  1469. If you want to automatically reload a file when it has been changed outside of
  1470. Vim, set the 'autoread' option.  This doesn't work at the moment you write the
  1471. file though, only when the file wasn't changed inside of Vim.
  1472.  
  1473. Note that if a FileChangedShell autocommand is defined you will not get a
  1474. warning message or prompt.  The autocommand is expected to handle this.
  1475.  
  1476. There is no warning for a directory (e.g., with |netrw-browse|).  But you do
  1477. get warned if you started editing a new file and it was created as a directory
  1478. later.
  1479.  
  1480. When Vim notices the timestamp of a file has changed, and the file is being
  1481. edited in a buffer but has not changed, Vim checks if the contents of the file
  1482. is equal.  This is done by reading the file again (into a hidden buffer, which
  1483. is immediately deleted again) and comparing the text.  If the text is equal,
  1484. you will get no warning.
  1485.  
  1486. If you don't get warned often enough you can use the following command.
  1487.  
  1488.                             *:checkt* *:checktime*
  1489. :checkt[ime]        Check if any buffers were changed outside of Vim.
  1490.             This checks and warns you if you would end up with two
  1491.             versions of a file.
  1492.             If this is called from an autocommand, a ":global"
  1493.             command or is not typed the actual check is postponed
  1494.             until a moment the side effects (reloading the file)
  1495.             would be harmless.
  1496.             Each loaded buffer is checked for its associated file
  1497.             being changed.  If the file was changed Vim will take
  1498.             action.  If there are no changes in the buffer and
  1499.             'autoread' is set, the buffer is reloaded.  Otherwise,
  1500.             you are offered the choice of reloading the file.  If
  1501.             the file was deleted you get an error message.
  1502.             If the file previously didn't exist you get a warning
  1503.             if it exists now.
  1504.             Once a file has been checked the timestamp is reset,
  1505.             you will not be warned again.
  1506.  
  1507. :[N]checkt[ime] {filename}
  1508. :[N]checkt[ime] [N]
  1509.             Check the timestamp of a specific buffer.  The buffer
  1510.             may be specified by name, number or with a pattern.
  1511.  
  1512.  
  1513.                             *E813* *E814*
  1514. Vim will reload the buffer if you chose to.  If a window is visible that
  1515. contains this buffer, the reloading will happen in the context of this window.
  1516. Otherwise a special window is used, so that most autocommands will work.  You
  1517. can't close this window.  A few other restrictions apply.  Best is to make
  1518. sure nothing happens outside of the current buffer.  E.g., setting
  1519. window-local options may end up in the wrong window.  Splitting the window,
  1520. doing something there and closing it should be OK (if there are no side
  1521. effects from other autocommands).  Closing unrelated windows and buffers will
  1522. get you into trouble.
  1523.  
  1524. Before writing a file the timestamp is checked.  If it has changed, Vim will
  1525. ask if you really want to overwrite the file:
  1526.  
  1527.     WARNING: The file has been changed since reading it!!!
  1528.     Do you really want to write to it (y/n)?
  1529.  
  1530. If you hit 'y' Vim will continue writing the file.  If you hit 'n' the write is
  1531. aborted.  If you used ":wq" or "ZZ" Vim will not exit, you will get another
  1532. chance to write the file.
  1533.  
  1534. The message would normally mean that somebody has written to the file after
  1535. the edit session started.  This could be another person, in which case you
  1536. probably want to check if your changes to the file and the changes from the
  1537. other person should be merged.  Write the file under another name and check for
  1538. differences (the "diff" program can be used for this).
  1539.  
  1540. It is also possible that you modified the file yourself, from another edit
  1541. session or with another command (e.g., a filter command).  Then you will know
  1542. which version of the file you want to keep.
  1543.  
  1544. There is one situation where you get the message while there is nothing wrong:
  1545. On a Win32 system on the day daylight saving time starts.  There is something
  1546. in the Win32 libraries that confuses Vim about the hour time difference.  The
  1547. problem goes away the next day.
  1548.  
  1549. ==============================================================================
  1550. 11. File Searching                    *file-searching*
  1551.  
  1552. {not available when compiled without the |+path_extra| feature}
  1553.  
  1554. The file searching is currently used for the 'path', 'cdpath' and 'tags'
  1555. options, for |finddir()| and |findfile()|.  Other commands use |wildcards|
  1556. which is slightly different.
  1557.  
  1558. There are three different types of searching:
  1559.  
  1560. 1) Downward search:                    *starstar*
  1561.    Downward search uses the wildcards '*', '**' and possibly others
  1562.    supported by your operating system.  '*' and '**' are handled inside Vim,
  1563.    so they work on all operating systems.  Note that "**" only acts as a
  1564.    special wildcard when it is at the start of a name.
  1565.  
  1566.    The usage of '*' is quite simple: It matches 0 or more characters.  In a
  1567.    search pattern this would be ".*".  Note that the "." is not used for file
  1568.    searching.
  1569.  
  1570.    '**' is more sophisticated:
  1571.       - It ONLY matches directories.
  1572.       - It matches up to 30 directories deep by default, so you can use it to
  1573.     search an entire directory tree
  1574.       - The maximum number of levels matched can be given by appending a number
  1575.     to '**'.
  1576.     Thus '/usr/**2' can match: >
  1577.         /usr
  1578.         /usr/include
  1579.         /usr/include/sys
  1580.         /usr/include/g++
  1581.         /usr/lib
  1582.         /usr/lib/X11
  1583.         ....
  1584. <    It does NOT match '/usr/include/g++/std' as this would be three
  1585.     levels.
  1586.     The allowed number range is 0 ('**0' is removed) to 100
  1587.     If the given number is smaller than 0 it defaults to 30, if it's
  1588.     bigger than 100 then 100 is used.  The system also has a limit on the
  1589.     path length, usually 256 or 1024 bytes.
  1590.       - '**' can only be at the end of the path or be followed by a path
  1591.     separator or by a number and a path separator.
  1592.  
  1593.    You can combine '*' and '**' in any order: >
  1594.     /usr/**/sys/*
  1595.     /usr/*tory/sys/**
  1596.     /usr/**2/sys/*
  1597.  
  1598. 2) Upward search:
  1599.    Here you can give a directory and then search the directory tree upward for
  1600.    a file.  You could give stop-directories to limit the upward search.  The
  1601.    stop-directories are appended to the path (for the 'path' option) or to
  1602.    the filename (for the 'tags' option) with a ';'.  If you want several
  1603.    stop-directories separate them with ';'.  If you want no stop-directory
  1604.    ("search upward till the root directory) just use ';'. >
  1605.     /usr/include/sys;/usr
  1606. <   will search in: >
  1607.        /usr/include/sys
  1608.        /usr/include
  1609.        /usr
  1610. <
  1611.    If you use a relative path the upward search is started in Vim's current
  1612.    directory or in the directory of the current file (if the relative path
  1613.    starts with './' and 'd' is not included in 'cpoptions').
  1614.  
  1615.    If Vim's current path is /u/user_x/work/release and you do >
  1616.     :set path=include;/u/user_x
  1617. <  and then search for a file with |gf| the file is searched in: >
  1618.     /u/user_x/work/release/include
  1619.     /u/user_x/work/include
  1620.     /u/user_x/include
  1621.  
  1622. 3) Combined up/downward search:
  1623.    If Vim's current path is /u/user_x/work/release and you do >
  1624.     set path=**;/u/user_x
  1625. <  and then search for a file with |gf| the file is searched in: >
  1626.     /u/user_x/work/release/**
  1627.     /u/user_x/work/**
  1628.     /u/user_x/**
  1629. <
  1630.    BE CAREFUL!  This might consume a lot of time, as the search of
  1631.    '/u/user_x/**' includes '/u/user_x/work/**' and
  1632.    '/u/user_x/work/release/**'.  So '/u/user_x/work/release/**' is searched
  1633.    three times and '/u/user_x/work/**' is searched twice.
  1634.  
  1635.    In the above example you might want to set path to: >
  1636.     :set path=**,/u/user_x/**
  1637. <  This searches:
  1638.     /u/user_x/work/release/** ~
  1639.     /u/user_x/** ~
  1640.    This searches the same directories, but in a different order.
  1641.  
  1642.    Note that completion for ":find", ":sfind", and ":tabfind" commands do not
  1643.    currently work with 'path' items that contain a url or use the double star
  1644.    with depth limiter (/usr/**2) or upward search (;) notations.
  1645.  
  1646.  vim:tw=78:ts=8:ft=help:norl:
  1647.