git.r.bdr.sh - rbdr/dotfiles/blob - vim/doc/ack.txt

   1 *ack.txt*   Plugin that integrates ack with Vim
   2
   3 ==============================================================================
   4 Author:  Antoine Imbert <antoine.imbert+ackvim@gmail.com>         *ack-author*
   5 License: Same terms as Vim itself (see |license|)
   6
   7 ==============================================================================
   8 INTRODUCTION                                                             *ack*
   9
  10 This plugin is a front for the Perl module App::Ack.  Ack can be used as a
  11 replacement for grep.  This plugin will allow you to run ack from vim, and
  12 shows the results in a split window.
  13
  14 :Ack[!] [options] {pattern} [{directory}]                               *:Ack*
  15
  16     Search recursively in {directory} (which defaults to the current
  17     directory) for the {pattern}.  Behaves just like the |:grep| command, but
  18     will open the |Quickfix| window for you. If [!] is not given the first
  19     error is jumped to.
  20
  21 :AckAdd [options] {pattern} [{directory}]                            *:AckAdd*
  22
  23     Just like |:Ack|, but instead of making a new list, the matches are
  24     appended to the current |quickfix| list.
  25
  26 :AckFromSearch [{directory}]                                  *:AckFromSearch*
  27
  28     Just like |:Ack| but the pattern is from previous search.
  29
  30 :LAck [options] {pattern} [{directory}]                                *:LAck*
  31
  32     Just like |:Ack| but instead of the |quickfix| list, matches are placed in
  33     the current |location-list|.
  34
  35 :LAckAdd [options] {pattern} [{directory}]                          *:LAckAdd*
  36
  37     Just like |:AckAdd| but instead of the |quickfix| list, matches are added
  38     to the current |location-list|
  39
  40 :AckFile [options] {pattern} [{directory}]                          *:AckFile*
  41
  42     Search recursively in {directory} (which defaults to the current
  43     directory) for filenames matching the {pattern}.  Behaves just like the
  44     |:grep| command, but will open the |Quickfix| window for you.
  45
  46 Files containing the search term will be listed in the split window, along
  47 with the line number of the occurrence, once for each occurrence.  <Enter> on
  48 a line in this window will open the file, and place the cursor on the matching
  49 line.
  50
  51 See http://betterthangrep.com/ for more information.