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 / doc / quickfix.txt < prev    next >
Encoding:
Text File  |  2011-05-27  |  58.9 KB  |  1,457 lines

  1. *quickfix.txt*  For Vim version 7.3.  Last change: 2011 May 10
  2.  
  3.  
  4.           VIM REFERENCE MANUAL    by Bram Moolenaar
  5.  
  6.  
  7. This subject is introduced in section |30.1| of the user manual.
  8.  
  9. 1. Using QuickFix commands        |quickfix|
  10. 2. The error window            |quickfix-window|
  11. 3. Using more than one list of errors    |quickfix-error-lists|
  12. 4. Using :make                |:make_makeprg|
  13. 5. Using :grep                |grep|
  14. 6. Selecting a compiler            |compiler-select|
  15. 7. The error format            |error-file-format|
  16. 8. The directory stack            |quickfix-directory-stack|
  17. 9. Specific error file formats        |errorformats|
  18.  
  19. {Vi does not have any of these commands}
  20.  
  21. The quickfix commands are not available when the |+quickfix| feature was
  22. disabled at compile time.
  23.  
  24. =============================================================================
  25. 1. Using QuickFix commands            *quickfix* *Quickfix* *E42*
  26.  
  27. Vim has a special mode to speedup the edit-compile-edit cycle.  This is
  28. inspired by the quickfix option of the Manx's Aztec C compiler on the Amiga.
  29. The idea is to save the error messages from the compiler in a file and use Vim
  30. to jump to the errors one by one.  You can examine each problem and fix it,
  31. without having to remember all the error messages.
  32.  
  33. In Vim the quickfix commands are used more generally to find a list of
  34. positions in files.  For example, |:vimgrep| finds pattern matches.  You can
  35. use the positions in a script with the |getqflist()| function.  Thus you can
  36. do a lot more than the edit/compile/fix cycle!
  37.  
  38. If you are using Manx's Aztec C compiler on the Amiga look here for how to use
  39. it with Vim: |quickfix-manx|.  If you are using another compiler you should
  40. save the error messages in a file and start Vim with "vim -q filename".  An
  41. easy way to do this is with the |:make| command (see below).  The
  42. 'errorformat' option should be set to match the error messages from your
  43. compiler (see |errorformat| below).
  44.  
  45.                         *location-list* *E776*
  46. A location list is similar to a quickfix list and contains a list of positions
  47. in files.  A location list is associated with a window and each window can
  48. have a separate location list.  A location list can be associated with only
  49. one window.  The location list is independent of the quickfix list.
  50.  
  51. When a window with a location list is split, the new window gets a copy of the
  52. location list.  When there are no references to a location list, the location
  53. list is destroyed.
  54.  
  55. The following quickfix commands can be used.  The location list commands are
  56. similar to the quickfix commands, replacing the 'c' prefix in the quickfix
  57. command with 'l'.
  58.  
  59.                             *:cc*
  60. :cc[!] [nr]        Display error [nr].  If [nr] is omitted, the same
  61.             error is displayed again.  Without [!] this doesn't
  62.             work when jumping to another buffer, the current buffer
  63.             has been changed, there is the only window for the
  64.             buffer and both 'hidden' and 'autowrite' are off.
  65.             When jumping to another buffer with [!] any changes to
  66.             the current buffer are lost, unless 'hidden' is set or
  67.             there is another window for this buffer.
  68.             The 'switchbuf' settings are respected when jumping
  69.             to a buffer.
  70.  
  71.                             *:ll*
  72. :ll[!] [nr]        Same as ":cc", except the location list for the
  73.             current window is used instead of the quickfix list.
  74.  
  75.                             *:cn* *:cnext* *E553*
  76. :[count]cn[ext][!]    Display the [count] next error in the list that
  77.             includes a file name.  If there are no file names at
  78.             all, go to the [count] next error.  See |:cc| for
  79.             [!] and 'switchbuf'.
  80.  
  81.                             *:lne* *:lnext*
  82. :[count]lne[xt][!]    Same as ":cnext", except the location list for the
  83.             current window is used instead of the quickfix list.
  84.  
  85. :[count]cN[ext][!]            *:cp* *:cprevious* *:cN* *:cNext*
  86. :[count]cp[revious][!]    Display the [count] previous error in the list that
  87.             includes a file name.  If there are no file names at
  88.             all, go to the [count] previous error.  See |:cc| for
  89.             [!] and 'switchbuf'.
  90.  
  91.  
  92. :[count]lN[ext][!]            *:lp* *:lprevious* *:lN* *:lNext*
  93. :[count]lp[revious][!]    Same as ":cNext" and ":cprevious", except the location
  94.             list for the current window is used instead of the
  95.             quickfix list.
  96.  
  97.                             *:cnf* *:cnfile*
  98. :[count]cnf[ile][!]    Display the first error in the [count] next file in
  99.             the list that includes a file name.  If there are no
  100.             file names at all or if there is no next file, go to
  101.             the [count] next error.  See |:cc| for [!] and
  102.             'switchbuf'.
  103.  
  104.                             *:lnf* *:lnfile*
  105. :[count]lnf[ile][!]    Same as ":cnfile", except the location list for the
  106.             current window is used instead of the quickfix list.
  107.  
  108. :[count]cNf[ile][!]            *:cpf* *:cpfile* *:cNf* *:cNfile*
  109. :[count]cpf[ile][!]    Display the last error in the [count] previous file in
  110.             the list that includes a file name.  If there are no
  111.             file names at all or if there is no next file, go to
  112.             the [count] previous error.  See |:cc| for [!] and
  113.             'switchbuf'.
  114.  
  115.  
  116. :[count]lNf[ile][!]            *:lpf* *:lpfile* *:lNf* *:lNfile*
  117. :[count]lpf[ile][!]    Same as ":cNfile" and ":cpfile", except the location
  118.             list for the current window is used instead of the
  119.             quickfix list.
  120.  
  121.                             *:crewind* *:cr*
  122. :cr[ewind][!] [nr]    Display error [nr].  If [nr] is omitted, the FIRST
  123.             error is displayed.  See |:cc|.
  124.  
  125.                             *:lrewind* *:lr*
  126. :lr[ewind][!] [nr]    Same as ":crewind", except the location list for the
  127.             current window is used instead of the quickfix list.
  128.  
  129.                             *:cfirst* *:cfir*
  130. :cfir[st][!] [nr]    Same as ":crewind".
  131.  
  132.                             *:lfirst* *:lfir*
  133. :lfir[st][!] [nr]    Same as ":lrewind".
  134.  
  135.                             *:clast* *:cla*
  136. :cla[st][!] [nr]    Display error [nr].  If [nr] is omitted, the LAST
  137.             error is displayed.  See |:cc|.
  138.  
  139.                             *:llast* *:lla*
  140. :lla[st][!] [nr]    Same as ":clast", except the location list for the
  141.             current window is used instead of the quickfix list.
  142.  
  143.                             *:cq* *:cquit*
  144. :cq[uit][!]        Quit Vim with an error code, so that the compiler
  145.             will not compile the same file again.
  146.             WARNING: All changes in files are lost!  Also when the
  147.             [!] is not used.  It works like ":qall!" |:qall|,
  148.             except that Vim returns a non-zero exit code.
  149.  
  150.                             *:cf* *:cfile*
  151. :cf[ile][!] [errorfile]    Read the error file and jump to the first error.
  152.             This is done automatically when Vim is started with
  153.             the -q option.  You can use this command when you
  154.             keep Vim running while compiling.  If you give the
  155.             name of the errorfile, the 'errorfile' option will
  156.             be set to [errorfile].  See |:cc| for [!].
  157.  
  158.                             *:lf* *:lfile*
  159. :lf[ile][!] [errorfile]    Same as ":cfile", except the location list for the
  160.             current window is used instead of the quickfix list.
  161.             You can not use the -q command-line option to set
  162.             the location list.
  163.  
  164.  
  165. :cg[etfile] [errorfile]                    *:cg* *:cgetfile*
  166.             Read the error file.  Just like ":cfile" but don't
  167.             jump to the first error.
  168.  
  169.  
  170. :lg[etfile] [errorfile]                    *:lg* *:lgetfile*
  171.             Same as ":cgetfile", except the location list for the
  172.             current window is used instead of the quickfix list.
  173.  
  174.                             *:caddf* *:caddfile*
  175. :caddf[ile] [errorfile]    Read the error file and add the errors from the
  176.             errorfile to the current quickfix list. If a quickfix
  177.             list is not present, then a new list is created.
  178.  
  179.                             *:laddf* *:laddfile*
  180. :laddf[ile] [errorfile]    Same as ":caddfile", except the location list for the
  181.             current window is used instead of the quickfix list.
  182.  
  183.                         *:cb* *:cbuffer* *E681*
  184. :cb[uffer][!] [bufnr]    Read the error list from the current buffer.
  185.             When [bufnr] is given it must be the number of a
  186.             loaded buffer.  That buffer will then be used instead
  187.             of the current buffer.
  188.             A range can be specified for the lines to be used.
  189.             Otherwise all lines in the buffer are used.
  190.             See |:cc| for [!].
  191.  
  192.                         *:lb* *:lbuffer*
  193. :lb[uffer][!] [bufnr]    Same as ":cbuffer", except the location list for the
  194.             current window is used instead of the quickfix list.
  195.  
  196.                         *:cgetb* *:cgetbuffer*
  197. :cgetb[uffer] [bufnr]    Read the error list from the current buffer.  Just
  198.             like ":cbuffer" but don't jump to the first error.
  199.  
  200.                         *:lgetb* *:lgetbuffer*
  201. :lgetb[uffer] [bufnr]    Same as ":cgetbuffer", except the location list for
  202.             the current window is used instead of the quickfix
  203.             list.
  204.  
  205.                             *:caddb* *:caddbuffer*
  206. :caddb[uffer] [bufnr]    Read the error list from the current buffer and add
  207.             the errors to the current quickfix list.  If a
  208.             quickfix list is not present, then a new list is
  209.             created. Otherwise, same as ":cbuffer".
  210.  
  211.                             *:laddb* *:laddbuffer*
  212. :laddb[uffer] [bufnr]    Same as ":caddbuffer", except the location list for
  213.             the current window is used instead of the quickfix
  214.             list.
  215.  
  216.                             *:cex* *:cexpr* *E777*
  217. :cex[pr][!] {expr}    Create a quickfix list using the result of {expr} and
  218.             jump to the first error.
  219.             If {expr} is a String, then each new-line terminated
  220.             line in the String is processed using the global value
  221.             of 'errorformat' and the result is added to the
  222.             quickfix list.
  223.             If {expr} is a List, then each String item in the list
  224.             is processed and added to the quickfix list.  Non
  225.             String items in the List are ignored.
  226.             See |:cc| for [!].
  227.             Examples: >
  228.                 :cexpr system('grep -n xyz *')
  229.                 :cexpr getline(1, '$')
  230. <
  231.                             *:lex* *:lexpr*
  232. :lex[pr][!] {expr}    Same as |:cexpr|, except the location list for the
  233.             current window is used instead of the quickfix list.
  234.  
  235.                             *:cgete* *:cgetexpr*
  236. :cgete[xpr] {expr}    Create a quickfix list using the result of {expr}.
  237.             Just like |:cexpr|, but don't jump to the first error.
  238.  
  239.                             *:lgete* *:lgetexpr*
  240. :lgete[xpr] {expr}    Same as |:cgetexpr|, except the location list for the
  241.             current window is used instead of the quickfix list.
  242.  
  243.                             *:cad* *:caddexpr*
  244. :cad[dexpr] {expr}    Evaluate {expr} and add the resulting lines to the
  245.             current quickfix list. If a quickfix list is not
  246.             present, then a new list is created. The current
  247.             cursor position will not be changed. See |:cexpr| for
  248.             more information.
  249.             Example: >
  250.     :g/mypattern/caddexpr expand("%") . ":" . line(".") .  ":" . getline(".")
  251. <
  252.                             *:lad* *:laddexpr*
  253. :lad[dexpr] {expr}    Same as ":caddexpr", except the location list for the
  254.             current window is used instead of the quickfix list.
  255.  
  256.                             *:cl* *:clist*
  257. :cl[ist] [from] [, [to]]
  258.             List all errors that are valid |quickfix-valid|.
  259.             If numbers [from] and/or [to] are given, the respective
  260.             range of errors is listed.  A negative number counts
  261.             from the last error backwards, -1 being the last error.
  262.             The 'switchbuf' settings are respected when jumping
  263.             to a buffer.
  264.  
  265. :cl[ist]! [from] [, [to]]
  266.             List all errors.
  267.  
  268.                             *:lli* *:llist*
  269. :lli[st] [from] [, [to]]
  270.             Same as ":clist", except the location list for the
  271.             current window is used instead of the quickfix list.
  272.  
  273. :lli[st]! [from] [, [to]]
  274.             List all the entries in the location list for the
  275.             current window.
  276.  
  277. If you insert or delete lines, mostly the correct error location is still
  278. found because hidden marks are used.  Sometimes, when the mark has been
  279. deleted for some reason, the message "line changed" is shown to warn you that
  280. the error location may not be correct.  If you quit Vim and start again the
  281. marks are lost and the error locations may not be correct anymore.
  282.  
  283. If vim is built with |+autocmd| support, two autocommands are available for
  284. running commands before and after a quickfix command (':make', ':grep' and so
  285. on) is executed. See |QuickFixCmdPre| and |QuickFixCmdPost| for details.
  286.  
  287.                         *QuickFixCmdPost-example*
  288. When 'encoding' differs from the locale, the error messages may have a
  289. different encoding from what Vim is using.  To convert the messages you can
  290. use this code: >
  291.     function QfMakeConv()
  292.        let qflist = getqflist()
  293.        for i in qflist
  294.           let i.text = iconv(i.text, "cp936", "utf-8")
  295.        endfor
  296.        call setqflist(qflist)
  297.     endfunction
  298.  
  299.     au QuickfixCmdPost make call QfMakeConv()
  300.  
  301.  
  302. =============================================================================
  303. 2. The error window                    *quickfix-window*
  304.  
  305.                         *:cope* *:copen* *w:quickfix_title*
  306. :cope[n] [height]    Open a window to show the current list of errors.
  307.             When [height] is given, the window becomes that high
  308.             (if there is room).  Otherwise the window is made ten
  309.             lines high.
  310.             The window will contain a special buffer, with
  311.             'buftype' equal to "quickfix".  Don't change this!
  312.             If there already is a quickfix window, it will be made
  313.             the current window.  It is not possible to open a
  314.             second quickfix window. The window will have the
  315.             w:quickfix_title variable set which will indicate the
  316.             command that produced the quickfix list. This can be
  317.             used to compose a custom status line if the value of
  318.             'statusline' is adjusted properly.
  319.  
  320.                             *:lop* *:lopen*
  321. :lop[en] [height]    Open a window to show the location list for the
  322.             current window. Works only when the location list for
  323.             the current window is present.  You can have more than
  324.             one location window opened at a time.  Otherwise, it
  325.             acts the same as ":copen".
  326.  
  327.                             *:ccl* *:cclose*
  328. :ccl[ose]        Close the quickfix window.
  329.  
  330.                             *:lcl* *:lclose*
  331. :lcl[ose]        Close the window showing the location list for the
  332.             current window.
  333.  
  334.                             *:cw* *:cwindow*
  335. :cw[indow] [height]    Open the quickfix window when there are recognized
  336.             errors.  If the window is already open and there are
  337.             no recognized errors, close the window.
  338.  
  339.                             *:lw* *:lwindow*
  340. :lw[indow] [height]    Same as ":cwindow", except use the window showing the
  341.             location list for the current window.
  342.  
  343. Normally the quickfix window is at the bottom of the screen.  If there are
  344. vertical splits, it's at the bottom of the rightmost column of windows.  To
  345. make it always occupy the full width: >
  346.     :botright cwindow
  347. You can move the window around with |window-moving| commands.
  348. For example, to move it to the top: CTRL-W K
  349. The 'winfixheight' option will be set, which means that the window will mostly
  350. keep its height, ignoring 'winheight' and 'equalalways'.  You can change the
  351. height manually (e.g., by dragging the status line above it with the mouse).
  352.  
  353. In the quickfix window, each line is one error.  The line number is equal to
  354. the error number.  You can use ":.cc" to jump to the error under the cursor.
  355. Hitting the <Enter> key or double-clicking the mouse on a line has the same
  356. effect.  The file containing the error is opened in the window above the
  357. quickfix window.  If there already is a window for that file, it is used
  358. instead.  If the buffer in the used window has changed, and the error is in
  359. another file, jumping to the error will fail.  You will first have to make
  360. sure the window contains a buffer which can be abandoned.
  361.                     *CTRL-W_<Enter>* *CTRL-W_<CR>*
  362. You can use CTRL-W <Enter> to open a new window and jump to the error there.
  363.  
  364. When the quickfix window has been filled, two autocommand events are
  365. triggered.  First the 'filetype' option is set to "qf", which triggers the
  366. FileType event.  Then the BufReadPost event is triggered, using "quickfix" for
  367. the buffer name.  This can be used to perform some action on the listed
  368. errors.  Example: >
  369.     au BufReadPost quickfix  setlocal modifiable
  370.         \ | silent exe 'g/^/s//\=line(".")." "/'
  371.         \ | setlocal nomodifiable
  372. This prepends the line number to each line.  Note the use of "\=" in the
  373. substitute string of the ":s" command, which is used to evaluate an
  374. expression.
  375. The BufWinEnter event is also triggered, again using "quickfix" for the buffer
  376. name.
  377.  
  378. Note: Making changes in the quickfix window has no effect on the list of
  379. errors.  'modifiable' is off to avoid making changes.  If you delete or insert
  380. lines anyway, the relation between the text and the error number is messed up.
  381. If you really want to do this, you could write the contents of the quickfix
  382. window to a file and use ":cfile" to have it parsed and used as the new error
  383. list.
  384.  
  385.                         *location-list-window*
  386. The location list window displays the entries in a location list.  When you
  387. open a location list window, it is created below the current window and
  388. displays the location list for the current window.  The location list window
  389. is similar to the quickfix window, except that you can have more than one
  390. location list window open at a time. When you use a location list command in
  391. this window, the displayed location list is used.
  392.  
  393. When you select a file from the location list window, the following steps are
  394. used to find a window to edit the file:
  395.  
  396. 1. If a window with the location list displayed in the location list window is
  397.    present, then the file is opened in that window.
  398. 2. If the above step fails and if the file is already opened in another
  399.    window, then that window is used.
  400. 3. If the above step fails then an existing window showing a buffer with
  401.    'buftype' not set is used.
  402. 4. If the above step fails, then the file is edited in a new window.
  403.  
  404. In all of the above cases, if the location list for the selected window is not
  405. yet set, then it is set to the location list displayed in the location list
  406. window.
  407.  
  408. =============================================================================
  409. 3. Using more than one list of errors            *quickfix-error-lists*
  410.  
  411. So far has been assumed that there is only one list of errors.  Actually the
  412. ten last used lists are remembered.  When starting a new list, the previous
  413. ones are automatically kept.  Two commands can be used to access older error
  414. lists.  They set one of the existing error lists as the current one.
  415.  
  416.                         *:colder* *:col* *E380*
  417. :col[der] [count]    Go to older error list.  When [count] is given, do
  418.             this [count] times.  When already at the oldest error
  419.             list, an error message is given.
  420.  
  421.                         *:lolder* *:lol*
  422. :lol[der] [count]    Same as ":colder", except use the location list for
  423.             the current window instead of the quickfix list.
  424.  
  425.                         *:cnewer* *:cnew* *E381*
  426. :cnew[er] [count]    Go to newer error list.  When [count] is given, do
  427.             this [count] times.  When already at the newest error
  428.             list, an error message is given.
  429.  
  430.                         *:lnewer* *:lnew*
  431. :lnew[er] [count]    Same as ":cnewer", except use the location list for
  432.             the current window instead of the quickfix list.
  433.  
  434. When adding a new error list, it becomes the current list.
  435.  
  436. When ":colder" has been used and ":make" or ":grep" is used to add a new error
  437. list, one newer list is overwritten.  This is especially useful if you are
  438. browsing with ":grep" |grep|.  If you want to keep the more recent error
  439. lists, use ":cnewer 99" first.
  440.  
  441. =============================================================================
  442. 4. Using :make                        *:make_makeprg*
  443.  
  444.                             *:mak* *:make*
  445. :mak[e][!] [arguments]    1. If vim was built with |+autocmd|, all relevant
  446.                |QuickFixCmdPre| autocommands are executed.
  447.             2. If the 'autowrite' option is on, write any changed
  448.                buffers
  449.             3. An errorfile name is made from 'makeef'.  If
  450.                'makeef' doesn't contain "##", and a file with this
  451.                name already exists, it is deleted.
  452.             4. The program given with the 'makeprg' option is
  453.                started (default "make") with the optional
  454.                [arguments] and the output is saved in the
  455.                errorfile (for Unix it is also echoed on the
  456.                screen).
  457.             5. The errorfile is read using 'errorformat'.
  458.             6. If vim was built with |+autocmd|, all relevant
  459.                |QuickFixCmdPost| autocommands are executed.
  460.                See example below.
  461.             7. If [!] is not given the first error is jumped to.
  462.             8. The errorfile is deleted.
  463.             9. You can now move through the errors with commands
  464.                like |:cnext| and |:cprevious|, see above.
  465.             This command does not accept a comment, any "
  466.             characters are considered part of the arguments.
  467.  
  468.                             *:lmak* *:lmake*
  469. :lmak[e][!] [arguments]
  470.             Same as ":make", except the location list for the
  471.             current window is used instead of the quickfix list.
  472.  
  473. The ":make" command executes the command given with the 'makeprg' option.
  474. This is done by passing the command to the shell given with the 'shell'
  475. option.  This works almost like typing
  476.  
  477.     ":!{makeprg} [arguments] {shellpipe} {errorfile}".
  478.  
  479. {makeprg} is the string given with the 'makeprg' option.  Any command can be
  480. used, not just "make".  Characters '%' and '#' are expanded as usual on a
  481. command-line.  You can use "%<" to insert the current file name without
  482. extension, or "#<" to insert the alternate file name without extension, for
  483. example: >
  484.    :set makeprg=make\ #<.o
  485.  
  486. [arguments] is anything that is typed after ":make".
  487. {shellpipe} is the 'shellpipe' option.
  488. {errorfile} is the 'makeef' option, with ## replaced to make it unique.
  489.  
  490. The placeholder "$*" can be used for the argument list in {makeprg} if the
  491. command needs some additional characters after its arguments.  The $* is
  492. replaced then by all arguments.  Example: >
  493.    :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
  494. or simpler >
  495.    :let &mp = 'latex \\nonstopmode \\input\{$*}'
  496. "$*" can be given multiple times, for example: >
  497.    :set makeprg=gcc\ -o\ $*\ $*
  498.  
  499. The 'shellpipe' option defaults to ">" for the Amiga, MS-DOS and Win32.  This
  500. means that the output of the compiler is saved in a file and not shown on the
  501. screen directly.  For Unix "| tee" is used.  The compiler output is shown on
  502. the screen and saved in a file the same time.  Depending on the shell used
  503. "|& tee" or "2>&1| tee" is the default, so stderr output will be included.
  504.  
  505. If 'shellpipe' is empty, the {errorfile} part will be omitted.  This is useful
  506. for compilers that write to an errorfile themselves (e.g., Manx's Amiga C).
  507.  
  508.  
  509. Using QuickFixCmdPost to fix the encoding ~
  510.  
  511. It may be that 'encoding' is set to an encoding that differs from the messages
  512. your build program produces.  This example shows how to fix this after Vim has
  513. read the error messages: >
  514.  
  515.     function QfMakeConv()
  516.        let qflist = getqflist()
  517.        for i in qflist
  518.           let i.text = iconv(i.text, "cp936", "utf-8")
  519.        endfor
  520.        call setqflist(qflist)
  521.     endfunction
  522.  
  523.     au QuickfixCmdPost make call QfMakeConv()
  524.  
  525. (Example by Faque Cheng)
  526.  
  527. ==============================================================================
  528. 5. Using :vimgrep and :grep                *grep* *lid*
  529.  
  530. Vim has two ways to find matches for a pattern: Internal and external.  The
  531. advantage of the internal grep is that it works on all systems and uses the
  532. powerful Vim search patterns.  An external grep program can be used when the
  533. Vim grep does not do what you want.
  534.  
  535. The internal method will be slower, because files are read into memory.  The
  536. advantages are:
  537. - Line separators and encoding are automatically recognized, as if a file is
  538.   being edited.
  539. - Uses Vim search patterns.  Multi-line patterns can be used.
  540. - When plugins are enabled: compressed and remote files can be searched.
  541.     |gzip| |netrw|
  542.  
  543. To be able to do this Vim loads each file as if it is being edited.  When
  544. there is no match in the file the associated buffer is wiped out again.  The
  545. 'hidden' option is ignored here to avoid running out of memory or file
  546. descriptors when searching many files.  However, when the |:hide| command
  547. modifier is used the buffers are kept loaded.  This makes following searches
  548. in the same files a lot faster.
  549.  
  550. Note that |:copen| (or |:lopen| for |:lgrep|) may be used to open a buffer
  551. containing the search results in linked form.  The |:silent| command may be
  552. used to suppress the default full screen grep output.  The ":grep!" form of
  553. the |:grep| command doesn't jump to the first match automatically.  These
  554. commands can be combined to create a NewGrep command: >
  555.  
  556.         command! -nargs=+ NewGrep execute 'silent grep! <args>' | copen 42
  557.  
  558.  
  559. 5.1 using Vim's internal grep
  560.  
  561.                     *:vim* *:vimgrep* *E682* *E683*
  562. :vim[grep][!] /{pattern}/[g][j] {file} ...
  563.             Search for {pattern} in the files {file} ... and set
  564.             the error list to the matches.
  565.             Without the 'g' flag each line is added only once.
  566.             With 'g' every match is added.
  567.  
  568.             {pattern} is a Vim search pattern.  Instead of
  569.             enclosing it in / any non-ID character (see
  570.             |'isident'|) can be used, so long as it does not
  571.             appear in {pattern}.
  572.             'ignorecase' applies.  To overrule it put |/\c| in the
  573.             pattern to ignore case or |/\C| to match case.
  574.             'smartcase' is not used.
  575.  
  576.             When a number is put before the command this is used
  577.             as the maximum number of matches to find.  Use
  578.             ":1vimgrep pattern file" to find only the first.
  579.             Useful if you only want to check if there is a match
  580.             and quit quickly when it's found.
  581.  
  582.             Without the 'j' flag Vim jumps to the first match.
  583.             With 'j' only the quickfix list is updated.
  584.             With the [!] any changes in the current buffer are
  585.             abandoned.
  586.  
  587.             Every second or so the searched file name is displayed
  588.             to give you an idea of the progress made.
  589.             Examples: >
  590.                 :vimgrep /an error/ *.c
  591.                 :vimgrep /\<FileName\>/ *.h include/*
  592.                 :vimgrep /myfunc/ **/*.c
  593. <            For the use of "**" see |starstar-wildcard|.
  594.  
  595. :vim[grep][!] {pattern} {file} ...
  596.             Like above, but instead of enclosing the pattern in a
  597.             non-ID character use a white-separated pattern.  The
  598.             pattern must start with an ID character.
  599.             Example: >
  600.                 :vimgrep Error *.c
  601. <
  602.                             *:lv* *:lvimgrep*
  603. :lv[imgrep][!] /{pattern}/[g][j] {file} ...
  604. :lv[imgrep][!] {pattern} {file} ...
  605.             Same as ":vimgrep", except the location list for the
  606.             current window is used instead of the quickfix list.
  607.  
  608.                         *:vimgrepa* *:vimgrepadd*
  609. :vimgrepa[dd][!] /{pattern}/[g][j] {file} ...
  610. :vimgrepa[dd][!] {pattern} {file} ...
  611.             Just like ":vimgrep", but instead of making a new list
  612.             of errors the matches are appended to the current
  613.             list.
  614.  
  615.                         *:lvimgrepa* *:lvimgrepadd*
  616. :lvimgrepa[dd][!] /{pattern}/[g][j] {file} ...
  617. :lvimgrepa[dd][!] {pattern} {file} ...
  618.             Same as ":vimgrepadd", except the location list for
  619.             the current window is used instead of the quickfix
  620.             list.
  621.  
  622. 5.2 External grep
  623.  
  624. Vim can interface with "grep" and grep-like programs (such as the GNU
  625. id-utils) in a similar way to its compiler integration (see |:make| above).
  626.  
  627. [Unix trivia: The name for the Unix "grep" command comes from ":g/re/p", where
  628. "re" stands for Regular Expression.]
  629.  
  630.                                 *:gr* *:grep*
  631. :gr[ep][!] [arguments]    Just like ":make", but use 'grepprg' instead of
  632.             'makeprg' and 'grepformat' instead of 'errorformat'.
  633.             When 'grepprg' is "internal" this works like
  634.             |:vimgrep|.  Note that the pattern needs to be
  635.             enclosed in separator characters then.
  636.  
  637.                                 *:lgr* *:lgrep*
  638. :lgr[ep][!] [arguments]    Same as ":grep", except the location list for the
  639.             current window is used instead of the quickfix list.
  640.  
  641.                             *:grepa* *:grepadd*
  642. :grepa[dd][!] [arguments]
  643.             Just like ":grep", but instead of making a new list of
  644.             errors the matches are appended to the current list.
  645.             Example: >
  646.                 :call setqflist([])
  647.                 :bufdo grepadd! something %
  648. <            The first command makes a new error list which is
  649.             empty.  The second command executes "grepadd" for each
  650.             listed buffer.  Note the use of ! to avoid that
  651.             ":grepadd" jumps to the first error, which is not
  652.             allowed with |:bufdo|.
  653.             An example that uses the argument list and avoids
  654.             errors for files without matches: >
  655.                                 :silent argdo try 
  656.                   \ | grepadd! something %
  657.                   \ | catch /E480:/
  658.                   \ | endtry"
  659. <
  660.                             *:lgrepa* *:lgrepadd*
  661. :lgrepa[dd][!] [arguments]
  662.             Same as ":grepadd", except the location list for the
  663.             current window is used instead of the quickfix list.
  664.  
  665. 5.3 Setting up external grep
  666.  
  667. If you have a standard "grep" program installed, the :grep command may work
  668. well with the defaults.  The syntax is very similar to the standard command: >
  669.  
  670.     :grep foo *.c
  671.  
  672. Will search all files with the .c extension for the substring "foo".  The
  673. arguments to :grep are passed straight to the "grep" program, so you can use
  674. whatever options your "grep" supports.
  675.  
  676. By default, :grep invokes grep with the -n option (show file and line
  677. numbers).  You can change this with the 'grepprg' option.  You will need to set
  678. 'grepprg' if:
  679.  
  680. a)    You are using a program that isn't called "grep"
  681. b)    You have to call grep with a full path
  682. c)    You want to pass other options automatically (e.g. case insensitive
  683.     search.)
  684.  
  685. Once "grep" has executed, Vim parses the results using the 'grepformat'
  686. option.  This option works in the same way as the 'errorformat' option - see
  687. that for details.  You may need to change 'grepformat' from the default if
  688. your grep outputs in a non-standard format, or you are using some other
  689. program with a special format.
  690.  
  691. Once the results are parsed, Vim loads the first file containing a match and
  692. jumps to the appropriate line, in the same way that it jumps to a compiler
  693. error in |quickfix| mode.  You can then use the |:cnext|, |:clist|, etc.
  694. commands to see the other matches.
  695.  
  696.  
  697. 5.4 Using :grep with id-utils
  698.  
  699. You can set up :grep to work with the GNU id-utils like this: >
  700.  
  701.     :set grepprg=lid\ -Rgrep\ -s
  702.     :set grepformat=%f:%l:%m
  703.  
  704. then >
  705.     :grep (regexp)
  706.  
  707. works just as you'd expect.
  708. (provided you remembered to mkid first :)
  709.  
  710.  
  711. 5.5 Browsing source code with :vimgrep or :grep
  712.  
  713. Using the stack of error lists that Vim keeps, you can browse your files to
  714. look for functions and the functions they call.  For example, suppose that you
  715. have to add an argument to the read_file() function.  You enter this command: >
  716.  
  717.     :vimgrep /\<read_file\>/ *.c
  718.  
  719. You use ":cn" to go along the list of matches and add the argument.  At one
  720. place you have to get the new argument from a higher level function msg(), and
  721. need to change that one too.  Thus you use: >
  722.  
  723.     :vimgrep /\<msg\>/ *.c
  724.  
  725. While changing the msg() functions, you find another function that needs to
  726. get the argument from a higher level.  You can again use ":vimgrep" to find
  727. these functions.  Once you are finished with one function, you can use >
  728.  
  729.     :colder
  730.  
  731. to go back to the previous one.
  732.  
  733. This works like browsing a tree: ":vimgrep" goes one level deeper, creating a
  734. list of branches.  ":colder" goes back to the previous level.  You can mix
  735. this use of ":vimgrep" and "colder" to browse all the locations in a tree-like
  736. way.  If you do this consistently, you will find all locations without the
  737. need to write down a "todo" list.
  738.  
  739. =============================================================================
  740. 6. Selecting a compiler                    *compiler-select*
  741.  
  742.                         *:comp* *:compiler* *E666*
  743. :comp[iler][!] {name}        Set options to work with compiler {name}.
  744.                 Without the "!" options are set for the
  745.                 current buffer.  With "!" global options are
  746.                 set.
  747.                 If you use ":compiler foo" in "file.foo" and
  748.                 then ":compiler! bar" in another buffer, Vim
  749.                 will keep on using "foo" in "file.foo".
  750.                 {not available when compiled without the
  751.                 |+eval| feature}
  752.  
  753.  
  754. The Vim plugins in the "compiler" directory will set options to use the
  755. selected compiler.  For ":compiler" local options are set, for ":compiler!"
  756. global options.
  757.                             *current_compiler*
  758. To support older Vim versions, the plugins always use "current_compiler" and
  759. not "b:current_compiler".  What the command actually does is the following:
  760.  
  761. - Delete the "current_compiler" and "b:current_compiler" variables.
  762. - Define the "CompilerSet" user command.  With "!" it does ":set", without "!"
  763.   it does ":setlocal".
  764. - Execute ":runtime! compiler/{name}.vim".  The plugins are expected to set
  765.   options with "CompilerSet" and set the "current_compiler" variable to the
  766.   name of the compiler.
  767. - Delete the "CompilerSet" user command.
  768. - Set "b:current_compiler" to the value of "current_compiler".
  769. - Without "!" the old value of "current_compiler" is restored.
  770.  
  771.  
  772. For writing a compiler plugin, see |write-compiler-plugin|.
  773.  
  774.  
  775. GCC                    *quickfix-gcc*    *compiler-gcc*
  776.  
  777. There's one variable you can set for the GCC compiler:
  778.  
  779. g:compiler_gcc_ignore_unmatched_lines
  780.                 Ignore lines that don't match any patterns
  781.                 defined for GCC.  Useful if output from
  782.                 commands run from make are generating false
  783.                 positives.
  784.  
  785.  
  786. MANX AZTEC C                *quickfix-manx* *compiler-manx*
  787.  
  788. To use Vim with Manx's Aztec C compiler on the Amiga you should do the
  789. following:
  790. - Set the CCEDIT environment variable with the command: >
  791.     mset "CCEDIT=vim -q"
  792. - Compile with the -qf option.  If the compiler finds any errors, Vim is
  793.   started and the cursor is positioned on the first error.  The error message
  794.   will be displayed on the last line.  You can go to other errors with the
  795.   commands mentioned above.  You can fix the errors and write the file(s).
  796. - If you exit Vim normally the compiler will re-compile the same file.  If you
  797.   exit with the :cq command, the compiler will terminate.  Do this if you
  798.   cannot fix the error, or if another file needs to be compiled first.
  799.  
  800. There are some restrictions to the Quickfix mode on the Amiga.  The
  801. compiler only writes the first 25 errors to the errorfile (Manx's
  802. documentation does not say how to get more).  If you want to find the others,
  803. you will have to fix a few errors and exit the editor.  After recompiling,
  804. up to 25 remaining errors will be found.
  805.  
  806. If Vim was started from the compiler, the :sh and some :!  commands will not
  807. work, because Vim is then running in the same process as the compiler and
  808. stdin (standard input) will not be interactive.
  809.  
  810.  
  811. PERL                    *quickfix-perl* *compiler-perl*
  812.  
  813. The Perl compiler plugin doesn't actually compile, but invokes Perl's internal
  814. syntax checking feature and parses the output for possible errors so you can
  815. correct them in quick-fix mode.
  816.  
  817. Warnings are forced regardless of "no warnings" or "$^W = 0" within the file
  818. being checked.  To disable this set g:perl_compiler_force_warnings to a zero
  819. value.  For example: >
  820.     let g:perl_compiler_force_warnings = 0
  821.  
  822.  
  823. PYUNIT COMPILER                        *compiler-pyunit*
  824.  
  825. This is not actually a compiler, but a unit testing framework for the
  826. Python language.  It is included into standard Python distribution
  827. starting from version 2.0.  For older versions, you can get it from
  828. http://pyunit.sourceforge.net.
  829.  
  830. When you run your tests with the help of the framework, possible errors
  831. are parsed by Vim and presented for you in quick-fix mode.
  832.  
  833. Unfortunately, there is no standard way to run the tests.
  834. The alltests.py script seems to be used quite often, that's all.
  835. Useful values for the 'makeprg' options therefore are:
  836.  setlocal makeprg=./alltests.py " Run a testsuite
  837.  setlocal makeprg=python %      " Run a single testcase
  838.  
  839. Also see http://vim.sourceforge.net/tip_view.php?tip_id=280.
  840.  
  841.  
  842. TEX COMPILER                        *compiler-tex*
  843.  
  844. Included in the distribution compiler for TeX ($VIMRUNTIME/compiler/tex.vim)
  845. uses make command if possible.  If the compiler finds a file named "Makefile"
  846. or "makefile" in the current directory, it supposes that you want to process
  847. your *TeX files with make, and the makefile does the right work.  In this case
  848. compiler sets 'errorformat' for *TeX output and leaves 'makeprg' untouched.  If
  849. neither "Makefile" nor "makefile" is found, the compiler will not use make.
  850. You can force the compiler to ignore makefiles by defining
  851. b:tex_ignore_makefile or g:tex_ignore_makefile variable (they are checked for
  852. existence only).
  853.  
  854. If the compiler chose not to use make, it need to choose a right program for
  855. processing your input.  If b:tex_flavor or g:tex_flavor (in this precedence)
  856. variable exists, it defines TeX flavor for :make (actually, this is the name
  857. of executed command), and if both variables do not exist, it defaults to
  858. "latex".  For example, while editing chapter2.tex \input-ed from mypaper.tex
  859. written in AMS-TeX: >
  860.  
  861.     :let b:tex_flavor = 'amstex'
  862.     :compiler tex
  863. <    [editing...] >
  864.     :make mypaper
  865.  
  866. Note that you must specify a name of the file to process as an argument (to
  867. process the right file when editing \input-ed or \include-ed file; portable
  868. solution for substituting % for no arguments is welcome).  This is not in the
  869. semantics of make, where you specify a target, not source, but you may specify
  870. filename without extension ".tex" and mean this as "make filename.dvi or
  871. filename.pdf or filename.some_result_extension according to compiler".
  872.  
  873. Note: tex command line syntax is set to usable both for MikTeX (suggestion
  874. by Srinath Avadhanula) and teTeX (checked by Artem Chuprina).  Suggestion
  875. from |errorformat-LaTeX| is too complex to keep it working for different
  876. shells and OSes and also does not allow to use other available TeX options,
  877. if any.  If your TeX doesn't support "-interaction=nonstopmode", please
  878. report it with different means to express \nonstopmode from the command line.
  879.  
  880. =============================================================================
  881. 7. The error format                    *error-file-format*
  882.  
  883.                     *errorformat* *E372* *E373* *E374*
  884.                         *E375* *E376* *E377* *E378*
  885. The 'errorformat' option specifies a list of formats that are recognized.  The
  886. first format that matches with an error message is used.  You can add several
  887. formats for different messages your compiler produces, or even entries for
  888. multiple compilers.  See |efm-entries|.
  889.  
  890. Each entry in 'errorformat' is a scanf-like string that describes the format.
  891. First, you need to know how scanf works.  Look in the documentation of your
  892. C compiler.  Below you find the % items that Vim understands.  Others are
  893. invalid.
  894.  
  895. Special characters in 'errorformat' are comma and backslash.  See
  896. |efm-entries| for how to deal with them.  Note that a literal "%" is matched
  897. by "%%", thus it is not escaped with a backslash.
  898.  
  899. Note: By default the difference between upper and lowercase is ignored.  If
  900. you want to match case, add "\C" to the pattern |/\C|.
  901.  
  902.  
  903. Basic items
  904.  
  905.     %f        file name (finds a string)
  906.     %l        line number (finds a number)
  907.     %c        column number (finds a number representing character
  908.             column of the error, (1 <tab> == 1 character column))
  909.     %v        virtual column number (finds a number representing
  910.             screen column of the error (1 <tab> == 8 screen
  911.             columns))
  912.     %t        error type (finds a single character)
  913.     %n        error number (finds a number)
  914.     %m        error message (finds a string)
  915.     %r        matches the "rest" of a single-line file message %O/P/Q
  916.     %p        pointer line (finds a sequence of '-', '.' or ' ' and
  917.             uses the length for the column number)
  918.     %*{conv}    any scanf non-assignable conversion
  919.     %%        the single '%' character
  920.     %s        search text (finds a string)
  921.  
  922. The "%f" conversion may depend on the current 'isfname' setting.  "~/" is
  923. expanded to the home directory and environment variables are expanded.
  924.  
  925. The "%f" and "%m" conversions have to detect the end of the string.  This
  926. normally happens by matching following characters and items.  When nothing is
  927. following the rest of the line is matched.  If "%f" is followed by a '%' or a
  928. backslash, it will look for a sequence of 'isfname' characters.
  929.  
  930. On MS-DOS, MS-Windows and OS/2 a leading "C:" will be included in "%f", even
  931. when using "%f:".  This means that a file name which is a single alphabetical
  932. letter will not be detected.
  933.  
  934. The "%p" conversion is normally followed by a "^".  It's used for compilers
  935. that output a line like: >
  936.         ^
  937. or >
  938.    ---------^
  939. to indicate the column of the error.  This is to be used in a multi-line error
  940. message.  See |errorformat-javac| for a  useful example.
  941.  
  942. The "%s" conversion specifies the text to search for to locate the error line.
  943. The text is used as a literal string.  The anchors "^" and "$" are added to
  944. the text to locate the error line exactly matching the search text and the
  945. text is prefixed with the "\V" atom to make it "very nomagic".  The "%s"
  946. conversion can be used to locate lines without a line number in the error
  947. output.  Like the output of the "grep" shell command.
  948. When the pattern is present the line number will not be used.
  949.  
  950. Changing directory
  951.  
  952. The following uppercase conversion characters specify the type of special
  953. format strings.  At most one of them may be given as a prefix at the begin
  954. of a single comma-separated format pattern.
  955. Some compilers produce messages that consist of directory names that have to
  956. be prepended to each file name read by %f (example: GNU make).  The following
  957. codes can be used to scan these directory names; they will be stored in an
  958. internal directory stack.                    *E379*
  959.     %D        "enter directory" format string; expects a following
  960.               %f that finds the directory name
  961.     %X        "leave directory" format string; expects following %f
  962.  
  963. When defining an "enter directory" or "leave directory" format, the "%D" or
  964. "%X" has to be given at the start of that substring.  Vim tracks the directory
  965. changes and prepends the current directory to each erroneous file found with a
  966. relative path.  See |quickfix-directory-stack| for details, tips and
  967. limitations.
  968.  
  969.  
  970. Multi-line messages                *errorformat-multi-line*
  971.  
  972. It is possible to read the output of programs that produce multi-line
  973. messages, i.e. error strings that consume more than one line.  Possible
  974. prefixes are:
  975.     %E        start of a multi-line error message
  976.     %W        start of a multi-line warning message
  977.     %I        start of a multi-line informational message
  978.     %A        start of a multi-line message (unspecified type)
  979.     %>        for next line start with current pattern again |efm-%>|
  980.     %C        continuation of a multi-line message
  981.     %Z        end of a multi-line message
  982. These can be used with '+' and '-', see |efm-ignore| below.
  983.  
  984. Using "\n" in the pattern won't work to match multi-line messages.
  985.  
  986. Example: Your compiler happens to write out errors in the following format
  987. (leading line numbers not being part of the actual output):
  988.  
  989.      1    Error 275 ~
  990.      2    line 42 ~
  991.      3    column 3 ~
  992.      4    ' ' expected after '--' ~
  993.  
  994. The appropriate error format string has to look like this: >
  995.    :set efm=%EError\ %n,%Cline\ %l,%Ccolumn\ %c,%Z%m
  996.  
  997. And the |:clist| error message generated for this error is:
  998.  
  999.  1:42 col 3 error 275:  ' ' expected after '--'
  1000.  
  1001. Another example: Think of a Python interpreter that produces the following
  1002. error message (line numbers are not part of the actual output):
  1003.  
  1004.      1    ==============================================================
  1005.      2    FAIL: testGetTypeIdCachesResult (dbfacadeTest.DjsDBFacadeTest)
  1006.      3    --------------------------------------------------------------
  1007.      4    Traceback (most recent call last):
  1008.      5      File "unittests/dbfacadeTest.py", line 89, in testFoo
  1009.      6        self.assertEquals(34, dtid)
  1010.      7      File "/usr/lib/python2.2/unittest.py", line 286, in
  1011.      8     failUnlessEqual
  1012.      9        raise self.failureException, \
  1013.     10    AssertionError: 34 != 33
  1014.     11
  1015.     12    --------------------------------------------------------------
  1016.     13    Ran 27 tests in 0.063s
  1017.  
  1018. Say you want |:clist| write the relevant information of this message only,
  1019. namely:
  1020.  5 unittests/dbfacadeTest.py:89:  AssertionError: 34 != 33
  1021.  
  1022. Then the error format string could be defined as follows: >
  1023.   :set efm=%C\ %.%#,%A\ \ File\ \"%f\"\\,\ line\ %l%.%#,%Z%[%^\ ]%\\@=%m
  1024.  
  1025. Note that the %C string is given before the %A here: since the expression
  1026. ' %.%#' (which stands for the regular expression ' .*') matches every line
  1027. starting with a space, followed by any characters to the end of the line,
  1028. it also hides line 7 which would trigger a separate error message otherwise.
  1029. Error format strings are always parsed pattern by pattern until the first
  1030. match occurs.
  1031.                             *efm-%>*
  1032. The %> item can be used to avoid trying patterns that appear earlier in
  1033. 'errorformat'.  This is useful for patterns that match just about anything.
  1034. For example, if the error looks like this:
  1035.  
  1036.     Error in line 123 of foo.c: ~
  1037.     unknown variable "i" ~
  1038.  
  1039. This can be found with: >
  1040.     :set efm=xxx,%E%>Error in line %l of %f:,%Z%m
  1041. Where "xxx" has a pattern that would also match the second line.
  1042.  
  1043. Important: There is no memory of what part of the errorformat matched before;
  1044. every line in the error file gets a complete new run through the error format
  1045. lines.  For example, if one has: >
  1046.   setlocal efm=aa,bb,cc,dd,ee
  1047. Where aa, bb, etc. are error format strings.  Each line of the error file will
  1048. be matched to the pattern aa, then bb, then cc, etc.  Just because cc matched
  1049. the previous error line does _not_ mean that dd will be tried first on the
  1050. current line, even if cc and dd are multi-line errorformat strings.
  1051.  
  1052.  
  1053.  
  1054. Separate file name            *errorformat-separate-filename*
  1055.  
  1056. These prefixes are useful if the file name is given once and multiple messages
  1057. follow that refer to this file name.
  1058.     %O        single-line file message: overread the matched part
  1059.     %P        single-line file message: push file %f onto the stack
  1060.     %Q        single-line file message: pop the last file from stack
  1061.  
  1062. Example: Given a compiler that produces the following error logfile (without
  1063. leading line numbers):
  1064.  
  1065.      1    [a1.tt]
  1066.      2    (1,17)  error: ';' missing
  1067.      3    (21,2)  warning: variable 'z' not defined
  1068.      4    (67,3)  error: end of file found before string ended
  1069.      5
  1070.      6    [a2.tt]
  1071.      7
  1072.      8    [a3.tt]
  1073.      9    NEW compiler v1.1
  1074.     10    (2,2)   warning: variable 'x' not defined
  1075.     11    (67,3)  warning: 's' already defined
  1076.  
  1077. This logfile lists several messages for each file enclosed in [...] which are
  1078. properly parsed by an error format like this: >
  1079.   :set efm=%+P[%f],(%l\\,%c)%*[\ ]%t%*[^:]:\ %m,%-Q
  1080.  
  1081. A call of |:clist| writes them accordingly with their correct filenames:
  1082.  
  1083.   2 a1.tt:1 col 17 error: ';' missing
  1084.   3 a1.tt:21 col 2 warning: variable 'z' not defined
  1085.   4 a1.tt:67 col 3 error: end of file found before string ended
  1086.   8 a3.tt:2 col 2 warning: variable 'x' not defined
  1087.   9 a3.tt:67 col 3 warning: 's' already defined
  1088.  
  1089. Unlike the other prefixes that all match against whole lines, %P, %Q and %O
  1090. can be used to match several patterns in the same line.  Thus it is possible
  1091. to parse even nested files like in the following line:
  1092.   {"file1" {"file2" error1} error2 {"file3" error3 {"file4" error4 error5}}}
  1093. The %O then parses over strings that do not contain any push/pop file name
  1094. information.  See |errorformat-LaTeX| for an extended example.
  1095.  
  1096.  
  1097. Ignoring and using whole messages            *efm-ignore*
  1098.  
  1099. The codes '+' or '-' can be combined with the uppercase codes above; in that
  1100. case they have to precede the letter, e.g. '%+A' or '%-G':
  1101.     %-        do not include the matching multi-line in any output
  1102.     %+        include the whole matching line in the %m error string
  1103.  
  1104. One prefix is only useful in combination with '+' or '-', namely %G.  It parses
  1105. over lines containing general information like compiler version strings or
  1106. other headers that can be skipped.
  1107.     %-G        ignore this message
  1108.     %+G        general message
  1109.  
  1110.  
  1111. Pattern matching
  1112.  
  1113. The scanf()-like "%*[]" notation is supported for backward-compatibility
  1114. with previous versions of Vim.  However, it is also possible to specify
  1115. (nearly) any Vim supported regular expression in format strings.
  1116. Since meta characters of the regular expression language can be part of
  1117. ordinary matching strings or file names (and therefore internally have to
  1118. be escaped), meta symbols have to be written with leading '%':
  1119.     %\        The single '\' character.  Note that this has to be
  1120.             escaped ("%\\") in ":set errorformat=" definitions.
  1121.     %.        The single '.' character.
  1122.     %#        The single '*'(!) character.
  1123.     %^        The single '^' character.  Note that this is not
  1124.             useful, the pattern already matches start of line.
  1125.     %$        The single '$' character.  Note that this is not
  1126.             useful, the pattern already matches end of line.
  1127.     %[        The single '[' character for a [] character range.
  1128.     %~        The single '~' character.
  1129. When using character classes in expressions (see |/\i| for an overview),
  1130. terms containing the "\+" quantifier can be written in the scanf() "%*"
  1131. notation.  Example: "%\\d%\\+" ("\d\+", "any number") is equivalent to "%*\\d".
  1132. Important note: The \(...\) grouping of sub-matches can not be used in format
  1133. specifications because it is reserved for internal conversions.
  1134.  
  1135.  
  1136. Multiple entries in 'errorformat'            *efm-entries*
  1137.  
  1138. To be able to detect output from several compilers, several format patterns
  1139. may be put in 'errorformat', separated by commas (note: blanks after the comma
  1140. are ignored).  The first pattern that has a complete match is used.  If no
  1141. match is found, matching parts from the last one will be used, although the
  1142. file name is removed and the error message is set to the whole message.  If
  1143. there is a pattern that may match output from several compilers (but not in a
  1144. right way), put it after one that is more restrictive.
  1145.  
  1146. To include a comma in a pattern precede it with a backslash (you have to type
  1147. two in a ":set" command).  To include a backslash itself give two backslashes
  1148. (you have to type four in a ":set" command).  You also need to put a backslash
  1149. before a space for ":set".
  1150.  
  1151.  
  1152. Valid matches                        *quickfix-valid*
  1153.  
  1154. If a line does not completely match one of the entries in 'errorformat', the
  1155. whole line is put in the error message and the entry is marked "not valid"
  1156. These lines are skipped with the ":cn" and ":cp" commands (unless there is
  1157. no valid line at all).  You can use ":cl!" to display all the error messages.
  1158.  
  1159. If the error format does not contain a file name Vim cannot switch to the
  1160. correct file.  You will have to do this by hand.
  1161.  
  1162.  
  1163. Examples
  1164.  
  1165. The format of the file from the Amiga Aztec compiler is:
  1166.  
  1167.     filename>linenumber:columnnumber:errortype:errornumber:errormessage
  1168.  
  1169.     filename    name of the file in which the error was detected
  1170.     linenumber    line number where the error was detected
  1171.     columnnumber    column number where the error was detected
  1172.     errortype    type of the error, normally a single 'E' or 'W'
  1173.     errornumber    number of the error (for lookup in the manual)
  1174.     errormessage    description of the error
  1175.  
  1176. This can be matched with this 'errorformat' entry:
  1177.     %f>%l:%c:%t:%n:%m
  1178.  
  1179. Some examples for C compilers that produce single-line error outputs:
  1180. %f:%l:\ %t%*[^0123456789]%n:\ %m    for Manx/Aztec C error messages
  1181.                     (scanf() doesn't understand [0-9])
  1182. %f\ %l\ %t%*[^0-9]%n:\ %m        for SAS C
  1183. \"%f\"\\,%*[^0-9]%l:\ %m        for generic C compilers
  1184. %f:%l:\ %m                for GCC
  1185. %f:%l:\ %m,%Dgmake[%*\\d]:\ Entering\ directory\ `%f',
  1186. %Dgmake[%*\\d]:\ Leaving\ directory\ `%f'
  1187.                     for GCC with gmake (concat the lines!)
  1188. %f(%l)\ :\ %*[^:]:\ %m            old SCO C compiler (pre-OS5)
  1189. %f(%l)\ :\ %t%*[^0-9]%n:\ %m        idem, with error type and number
  1190. %f:%l:\ %m,In\ file\ included\ from\ %f:%l:,\^I\^Ifrom\ %f:%l%m
  1191.                     for GCC, with some extras
  1192.  
  1193. Extended examples for the handling of multi-line messages are given below,
  1194. see |errorformat-Jikes| and |errorformat-LaTeX|.
  1195.  
  1196. Note the backslash in front of a space and double quote.  It is required for
  1197. the :set command.  There are two backslashes in front of a comma, one for the
  1198. :set command and one to avoid recognizing the comma as a separator of error
  1199. formats.
  1200.  
  1201.  
  1202. Filtering messages
  1203.  
  1204. If you have a compiler that produces error messages that do not fit in the
  1205. format string, you could write a program that translates the error messages
  1206. into this format.  You can use this program with the ":make" command by
  1207. changing the 'makeprg' option.  For example: >
  1208.    :set mp=make\ \\\|&\ error_filter
  1209. The backslashes before the pipe character are required to avoid it to be
  1210. recognized as a command separator.  The backslash before each space is
  1211. required for the set command.
  1212.  
  1213. =============================================================================
  1214. 8. The directory stack                *quickfix-directory-stack*
  1215.  
  1216. Quickfix maintains a stack for saving all used directories parsed from the
  1217. make output.  For GNU-make this is rather simple, as it always prints the
  1218. absolute path of all directories it enters and leaves.  Regardless if this is
  1219. done via a 'cd' command in the makefile or with the parameter "-C dir" (change
  1220. to directory before reading the makefile).  It may be useful to use the switch
  1221. "-w" to force GNU-make to print out the working directory before and after
  1222. processing.
  1223.  
  1224. Maintaining the correct directory is more complicated if you don't use
  1225. GNU-make.  AIX-make for example doesn't print any information about its
  1226. working directory.  Then you need to enhance the makefile.  In the makefile of
  1227. LessTif there is a command which echoes "Making {target} in {dir}".  The
  1228. special problem here is that it doesn't print information on leaving the
  1229. directory and that it doesn't print the absolute path.
  1230.  
  1231. To solve the problem with relative paths and missing "leave directory"
  1232. messages Vim uses following algorithm:
  1233.  
  1234. 1) Check if the given directory is a subdirectory of the current directory.
  1235.    If this is true, store it as the current directory.
  1236. 2) If it is not a subdir of the current directory, try if this is a
  1237.    subdirectory of one of the upper directories.
  1238. 3) If the directory still isn't found, it is assumed to be a subdirectory
  1239.    of Vim's current directory.
  1240.  
  1241. Additionally it is checked for every file, if it really exists in the
  1242. identified directory.  If not, it is searched in all other directories of the
  1243. directory stack (NOT the directory subtree!).  If it is still not found, it is
  1244. assumed that it is in Vim's current directory.
  1245.  
  1246. There are limitations in this algorithm.  These examples assume that make just
  1247. prints information about entering a directory in the form "Making all in dir".
  1248.  
  1249. 1) Assume you have following directories and files:
  1250.    ./dir1
  1251.    ./dir1/file1.c
  1252.    ./file1.c
  1253.  
  1254.    If make processes the directory "./dir1" before the current directory and
  1255.    there is an error in the file "./file1.c", you will end up with the file
  1256.    "./dir1/file.c" loaded by Vim.
  1257.  
  1258.    This can only be solved with a "leave directory" message.
  1259.  
  1260. 2) Assume you have following directories and files:
  1261.    ./dir1
  1262.    ./dir1/dir2
  1263.    ./dir2
  1264.  
  1265.    You get the following:
  1266.  
  1267.    Make output              Directory interpreted by Vim
  1268.    ------------------------      ----------------------------
  1269.    Making all in dir1          ./dir1
  1270.    Making all in dir2          ./dir1/dir2
  1271.    Making all in dir2          ./dir1/dir2
  1272.  
  1273.    This can be solved by printing absolute directories in the "enter directory"
  1274.    message or by printing "leave directory" messages..
  1275.  
  1276. To avoid this problem, ensure to print absolute directory names and "leave
  1277. directory" messages.
  1278.  
  1279. Examples for Makefiles:
  1280.  
  1281. Unix:
  1282.     libs:
  1283.         for dn in $(LIBDIRS); do                \
  1284.         (cd $$dn; echo "Entering dir '$$(pwd)'"; make); \
  1285.         echo "Leaving dir";                \
  1286.         done
  1287.  
  1288. Add
  1289.     %DEntering\ dir\ '%f',%XLeaving\ dir
  1290. to your 'errorformat' to handle the above output.
  1291.  
  1292. Note that Vim doesn't check if the directory name in a "leave directory"
  1293. messages is the current directory.  This is why you could just use the message
  1294. "Leaving dir".
  1295.  
  1296. =============================================================================
  1297. 9. Specific error file formats            *errorformats*
  1298.  
  1299.                         *errorformat-Jikes*
  1300. Jikes(TM), a source-to-bytecode Java compiler published by IBM Research,
  1301. produces simple multi-line error messages.
  1302.  
  1303. An 'errorformat' string matching the produced messages is shown below.
  1304. The following lines can be placed in the user's |vimrc| to overwrite Vim's
  1305. recognized default formats, or see |:set+=| how to install this format
  1306. additionally to the default. >
  1307.  
  1308.   :set efm=%A%f:%l:%c:%*\\d:%*\\d:,
  1309.     \%C%*\\s%trror:%m,
  1310.     \%+C%*[^:]%trror:%m,
  1311.     \%C%*\\s%tarning:%m,
  1312.     \%C%m
  1313. <
  1314. Jikes(TM) produces a single-line error message when invoked with the option
  1315. "+E", and can be matched with the following: >
  1316.  
  1317.   :setl efm=%f:%l:%v:%*\\d:%*\\d:%*\\s%m
  1318. <
  1319.                         *errorformat-javac*
  1320. This 'errorformat' has been reported to work well for javac, which outputs a
  1321. line with "^" to indicate the column of the error: >
  1322.   :setl efm=%A%f:%l:\ %m,%-Z%p^,%-C%.%#
  1323. or: >
  1324.   :setl efm=%A%f:%l:\ %m,%+Z%p^,%+C%.%#,%-G%.%#
  1325. <
  1326. Here is an alternative from Michael F. Lamb for Unix that filters the errors
  1327. first: >
  1328.   :setl errorformat=%Z%f:%l:\ %m,%A%p^,%-G%*[^sl]%.%#
  1329.   :setl makeprg=javac\ %\ 2>&1\ \\\|\ vim-javac-filter
  1330.  
  1331. You need to put the following in "vim-javac-filter" somewhere in your path
  1332. (e.g., in ~/bin) and make it executable: >
  1333.    #!/bin/sed -f
  1334.    /\^$/s/\t/\ /g;/:[0-9]\+:/{h;d};/^[ \t]*\^/G;
  1335.  
  1336. In English, that sed script:
  1337. - Changes single tabs to single spaces and
  1338. - Moves the line with the filename, line number, error message to just after
  1339.   the pointer line. That way, the unused error text between doesn't break
  1340.   vim's notion of a "multi-line message" and also doesn't force us to include
  1341.   it as a "continuation of a multi-line message."
  1342.  
  1343.                         *errorformat-ant*
  1344. For ant (http://jakarta.apache.org/) the above errorformat has to be modified
  1345. to honour the leading [javac] in front of each javac output line: >
  1346.   :set efm=%A\ %#[javac]\ %f:%l:\ %m,%-Z\ %#[javac]\ %p^,%-C%.%#
  1347.  
  1348. The 'errorformat' can also be configured to handle ant together with either
  1349. javac or jikes.  If you're using jikes, you should tell ant to use jikes' +E
  1350. command line switch which forces jikes to generate one-line error messages.
  1351. This is what the second line (of a build.xml file) below does: >
  1352.   <property name = "build.compiler"       value = "jikes"/>
  1353.   <property name = "build.compiler.emacs" value = "true"/>
  1354.  
  1355. The 'errorformat' which handles ant with both javac and jikes is: >
  1356.   :set efm=\ %#[javac]\ %#%f:%l:%c:%*\\d:%*\\d:\ %t%[%^:]%#:%m,
  1357.        \%A\ %#[javac]\ %f:%l:\ %m,%-Z\ %#[javac]\ %p^,%-C%.%#
  1358. <
  1359.                         *errorformat-jade*
  1360. parsing jade (see http://www.jclark.com/) errors is simple: >
  1361.   :set efm=jade:%f:%l:%c:%t:%m
  1362. <
  1363.                         *errorformat-LaTeX*
  1364. The following is an example how an 'errorformat' string can be specified
  1365. for the (La)TeX typesetting system which displays error messages over
  1366. multiple lines.  The output of ":clist" and ":cc" etc. commands displays
  1367. multi-lines in a single line, leading white space is removed.
  1368. It should be easy to adopt the above LaTeX errorformat to any compiler output
  1369. consisting of multi-line errors.
  1370.  
  1371. The commands can be placed in a |vimrc| file or some other Vim script file,
  1372. e.g. a script containing LaTeX related stuff which is loaded only when editing
  1373. LaTeX sources.
  1374. Make sure to copy all lines of the example (in the given order), afterwards
  1375. remove the comment lines.  For the '\' notation at the start of some lines see
  1376. |line-continuation|.
  1377.  
  1378.         First prepare 'makeprg' such that LaTeX will report multiple
  1379.         errors; do not stop when the first error has occurred: >
  1380.  :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
  1381. <
  1382.         Start of multi-line error messages: >
  1383.  :set efm=%E!\ LaTeX\ %trror:\ %m,
  1384.     \%E!\ %m,
  1385. <        Start of multi-line warning messages; the first two also
  1386.         include the line number.  Meaning of some regular expressions:
  1387.           - "%.%#"  (".*")   matches a (possibly empty) string
  1388.           - "%*\\d" ("\d\+") matches a number >
  1389.     \%+WLaTeX\ %.%#Warning:\ %.%#line\ %l%.%#,
  1390.     \%+W%.%#\ at\ lines\ %l--%*\\d,
  1391.     \%WLaTeX\ %.%#Warning:\ %m,
  1392. <        Possible continuations of error/warning messages; the first
  1393.         one also includes the line number: >
  1394.     \%Cl.%l\ %m,
  1395.     \%+C\ \ %m.,
  1396.     \%+C%.%#-%.%#,
  1397.     \%+C%.%#[]%.%#,
  1398.     \%+C[]%.%#,
  1399.     \%+C%.%#%[{}\\]%.%#,
  1400.     \%+C<%.%#>%.%#,
  1401.     \%C\ \ %m,
  1402. <        Lines that match the following patterns do not contain any
  1403.         important information; do not include them in messages: >
  1404.     \%-GSee\ the\ LaTeX%m,
  1405.     \%-GType\ \ H\ <return>%m,
  1406.     \%-G\ ...%.%#,
  1407.     \%-G%.%#\ (C)\ %.%#,
  1408.     \%-G(see\ the\ transcript%.%#),
  1409. <        Generally exclude any empty or whitespace-only line from
  1410.         being displayed: >
  1411.     \%-G\\s%#,
  1412. <        The LaTeX output log does not specify the names of erroneous
  1413.         source files per line; rather they are given globally,
  1414.         enclosed in parentheses.
  1415.         The following patterns try to match these names and store
  1416.         them in an internal stack.  The patterns possibly scan over
  1417.         the same input line (one after another), the trailing "%r"
  1418.         conversion indicates the "rest" of the line that will be
  1419.         parsed in the next go until the end of line is reached.
  1420.  
  1421.         Overread a file name enclosed in '('...')'; do not push it
  1422.         on a stack since the file apparently does not contain any
  1423.         error: >
  1424.     \%+O(%f)%r,
  1425. <        Push a file name onto the stack.  The name is given after '(': >
  1426.     \%+P(%f%r,
  1427.     \%+P\ %\\=(%f%r,
  1428.     \%+P%*[^()](%f%r,
  1429.     \%+P[%\\d%[^()]%#(%f%r,
  1430. <        Pop the last stored file name when a ')' is scanned: >
  1431.     \%+Q)%r,
  1432.     \%+Q%*[^()])%r,
  1433.     \%+Q[%\\d%*[^()])%r
  1434.  
  1435. Note that in some cases file names in the LaTeX output log cannot be parsed
  1436. properly.  The parser might have been messed up by unbalanced parentheses
  1437. then.  The above example tries to catch the most relevant cases only.
  1438. You can customize the given setting to suit your own purposes, for example,
  1439. all the annoying "Overfull ..." warnings could be excluded from being
  1440. recognized as an error.
  1441. Alternatively to filtering the LaTeX compiler output, it is also possible
  1442. to directly read the *.log file that is produced by the [La]TeX compiler.
  1443. This contains even more useful information about possible error causes.
  1444. However, to properly parse such a complex file, an external filter should
  1445. be used.  See the description further above how to make such a filter known
  1446. by Vim.
  1447.  
  1448.                         *errorformat-Perl*
  1449. In $VIMRUNTIME/tools you can find the efm_perl.pl script, which filters Perl
  1450. error messages into a format that quickfix mode will understand.  See the
  1451. start of the file about how to use it.  (This script is deprecated, see
  1452. |compiler-perl|.)
  1453.  
  1454.  
  1455.  
  1456.  vim:tw=78:ts=8:ft=help:norl:
  1457.