code.delx.au - gnu-emacs-elpa/blob - packages/ack/README.rst

   1 ==============================================================
   2  Emacs Interface to `Ack <http://beyondgrep.com>`_-like Tools
   3 ==============================================================
   4
   5 This package brings the full power of `ack <http://beyondgrep.com>`_
   6 to `emacs <http://www.gnu.org/software/emacs>`_ by allowing you to run
   7 it seamlessly with its large set of options. Ack-like tools such as
   8 `the silver searcher <https://github.com/ggreer/the_silver_searcher>`_
   9 and ``git/hg/bzr grep`` are well supported too.
  10
  11 It is part of `GNU ELPA <http://elpa.gnu.org>`_ - the official package
  12 archive for `emacs <http://www.gnu.org/software/emacs>`_. Patches,
  13 feature requests and bug reports are welcome.
  14
  15 Features
  16 --------
  17
  18 - Keep all features of `ack <http://beyondgrep.com>`_ and more
  19 - Handle colors using the standard library ``ansi-color.el``
  20 - Completion for ack options while reading from the minibuffer
  21 - Support `the silver search (ag)
  22   <https://github.com/ggreer/the_silver_searcher>`_
  23 - Support ``git grep``, ``hg grep`` and ``bzr grep``
  24
  25 Install
  26 -------
  27
  28 ``M-x package-install RET ack RET``
  29
  30 Screenshots
  31 -----------
  32
  33 * ack
  34
  35 .. figure:: http://i.imgur.com/VwWyzAe.png
  36    :target: http://i.imgur.com/VwWyzAe.png
  37    :alt: ack.png
  38
  39 * git grep
  40
  41 .. figure:: http://i.imgur.com/rwjC4pa.png
  42    :target: http://i.imgur.com/rwjC4pa.png
  43    :alt: ack-git-grep.png
  44
  45 Usage
  46 -----
  47
  48 - Type ``M-x ack`` and provide a pattern to search.
  49 - Type ``C-u M-x ack`` to search from current project root.
  50 - Type ``C-u C-u M-x ack`` to interactively choose a directory to search.
  51
  52 While reading ack command and args from the minibuffer, the following
  53 key bindings may be useful:
  54
  55 - ``M-I`` => insert a template for case-insensitive file name search
  56 - ``M-G`` => insert a template for ``git grep``, ``hg grep`` or ``bzr grep``
  57 - ``M-Y`` => grab the symbol at point from the window before entering
  58   the minibuffer
  59 - ``TAB`` => completion for ack options
  60
  61 Emacs23
  62 -------
  63
  64 Check out the `emacs23
  65 <https://github.com/leoliu/ack-el/tree/emacs23>`_ branch.
  66
  67 Bugs
  68 ----
  69
  70 https://github.com/leoliu/ack-el/issues
  71
  72 Contributors
  73 ------------
  74 Phillip Lord