/docs/index.org

https://github.com/dajva/rg.el · Org · 54 lines · 44 code · 10 blank · 0 comment · 3 complexity · 6d3f03f1620f3f1291d22382632116c3 MD5 · raw file 

    

  1. #+TITLE: Rg Manual
    2. 

  2. #+AUTHOR: David Landell
    3. 

  3. #+EMAIL: david.landell@sunnyhill.email
    4. 

  4. #+DATE: 2019
    5. 

  5. #+LANGUAGE: en
    6. 

  6. #+OPTIONS: broken-links:auto, toc:nil, email:nil, num:nil, ^:nil, author:nil, date:nil
    7. 

  7. 

  8. /rg.el/ is an Emacs search package based on the [[https://github.com/BurntSushi/ripgrep][ripgrep]] command line
    9. 

  9. tool. It allows you to interactively create searches, doing automatic
    10. 

  10. searches based on the editing context, refining and modifying search
    11. 

  11. results and much more. It is also highly configurable to be able to
    12. 

  12. fit different users' needs.
    13. 

    14. 

  14. Throughout this manual this emacs package will be referred to as /rg/
    15. 

  15. while the command line utility will be referred to as /ripgrep/.
    16. 

  16. 

  17. If you are used to built-in Emacs =rgrep= command, transitioning to
    18. 

  18. /rg/ should be simple. /rg/ provides a lot of extra features
    19. 

  19. but the basics are similar.
    20. 

  20. 

  21. The big benefit of using /ripgrep/ instead of /grep/ as a backend is
    22. 

  22. speed. Especially when searching large source code repositories
    23. 

  23. where /ripgrep/ really shines. Please read [[http://blog.burntsushi.net/ripgrep/][this blog post]] for some
    24. 

  24. speed comparisons with other tools.
    25. 

  25. 

  26. #+BEGIN_EXPORT rst
    27. 

  27. .. toctree::
    28. 

  28.    :maxdepth: 2
    29. 

  29. 

  30.    usage
    31. 

  31.    configuration
    32. 

  32.    contribute
    33. 

  33. #+END_EXPORT
    34. 

  34. 

  35. * License
    36. 

  36.   :PROPERTIES:
    37. 

  37.   :CUSTOM_ID: license
    38. 

  38.   :END:
    39. 

  39.   /rg/ is free software; you can redistribute it and/or
    40. 

  40.   modify it under the terms of the GNU General Public License
    41. 

  41.   as published by the Free Software Foundation; either version 3
    42. 

  42.   of the License, or (at your option) any later version.
    43. 

  43. 

  44.   /rg/ is distributed in the hope that it will be useful,
    45. 

  45.   but WITHOUT ANY WARRANTY; without even the implied warranty of
    46. 

  46.   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    47. 

  47.   [[file:gpl.org::#gpl][GNU General Public License]] for more details.
    48. 

  48. 

  49. #+BEGIN_EXPORT rst
    50. 

  50. .. toctree::
    51. 

  51.    :maxdepth: 2
    52. 

  52. 

  53.    gpl
    54. 

  54. #+END_EXPORT
    55.