Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tomtom committed Oct 28, 2015
1 parent 0596c26 commit f32ab86
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 17 deletions.
17 changes: 12 additions & 5 deletions README
Expand Up @@ -3,11 +3,18 @@ languages, it can also find variable/function/class definitions,
function calls etc.

Other than |tags| or |cscope|, it doesn't build a database to speed up
searches but always scans all files. It can make use of external tools
like `git grep`, `ack`, or `ag` though, in order to gain acceptable
performance for medium-sized projects. The builtin vimscript-based
version file scanner and also |vimgrep| are suitable for small projects.
See |g:trag#grep_type| for available options.
searches but always scans all files. It can make use of the following
external tools in order to gain acceptable performance for medium-sized
projects:

- `git grep`
- `ack` http://beyondgrep.com/
- `ag` https://github.com/ggreer/the_silver_searcher
- `sift` https://sift-tool.org/

The builtin vimscript-based version file scanner and also
|vimgrep| are suitable for small projects. See |g:trag#grep_type| for
available options.


Usage~
Expand Down
23 changes: 17 additions & 6 deletions doc/trag.txt
@@ -1,16 +1,23 @@
*trag.txt* A language-aware source code scanner (with support for git grep, ack, ag ...)
*trag.txt* A language-aware source code scanner (with support for git grep, ack, ag, sift ...)
Author: Tom Link, micathom at gmail com

This plugin uses ad-hoc searches to find strings in files. For certain
languages, it can also find variable/function/class definitions,
function calls etc.

Other than |tags| or |cscope|, it doesn't build a database to speed up
searches but always scans all files. It can make use of external tools
like `git grep`, `ack`, or `ag` though, in order to gain acceptable
performance for medium-sized projects. The builtin vimscript-based
version file scanner and also |vimgrep| are suitable for small projects.
See |g:trag#grep_type| for available options.
searches but always scans all files. It can make use of the following
external tools in order to gain acceptable performance for medium-sized
projects:

- `git grep`
- `ack` http://beyondgrep.com/
- `ag` https://github.com/ggreer/the_silver_searcher
- `sift` https://sift-tool.org/

The builtin vimscript-based version file scanner and also
|vimgrep| are suitable for small projects. See |g:trag#grep_type| for
available options.


Usage~
Expand Down Expand Up @@ -221,6 +228,7 @@ Contents~
trag#utils#GrepaddFiles ................. |trag#utils#GrepaddFiles()|
trag#java#Rename ........................ |trag#java#Rename()|
g:trag#grep_type ........................ |g:trag#grep_type|
g:trag#assume_executable ................ |g:trag#assume_executable|
g:trag#grep_fallback_type ............... |g:trag#grep_fallback_type|
g:trag_get_files ........................ |g:trag_get_files|
g:trag_get_files_java ................... |g:trag_get_files_java|
Expand Down Expand Up @@ -596,6 +604,9 @@ g:trag#grep_type (default: 'trag')
*b:trag_grep_type*
b:trag_grep_type overrides this global variable.

*g:trag#assume_executable*
g:trag#assume_executable (default: ['vcs'])

*g:trag#grep_fallback_type*
g:trag#grep_fallback_type (default: 'trag')
Use this type for files that are not supported by |g:trag#grep_type|
Expand Down
19 changes: 13 additions & 6 deletions etc/tpl_trag.txt
@@ -1,16 +1,23 @@
*trag.txt* A language-aware source code scanner (with support for git grep, ack, ag ...)
*trag.txt* A language-aware source code scanner (with support for git grep, ack, ag, sift ...)
Author: Tom Link, micathom at gmail com

This plugin uses ad-hoc searches to find strings in files. For certain
languages, it can also find variable/function/class definitions,
function calls etc.

Other than |tags| or |cscope|, it doesn't build a database to speed up
searches but always scans all files. It can make use of external tools
like `git grep`, `ack`, or `ag` though, in order to gain acceptable
performance for medium-sized projects. The builtin vimscript-based
version file scanner and also |vimgrep| are suitable for small projects.
See |g:trag#grep_type| for available options.
searches but always scans all files. It can make use of the following
external tools in order to gain acceptable performance for medium-sized
projects:

- `git grep`
- `ack` http://beyondgrep.com/
- `ag` https://github.com/ggreer/the_silver_searcher
- `sift` https://sift-tool.org/

The builtin vimscript-based version file scanner and also
|vimgrep| are suitable for small projects. See |g:trag#grep_type| for
available options.


Usage~
Expand Down

0 comments on commit f32ab86

Please sign in to comment.