From f32ab865c37ed002c8662e1d62f2dbf29036559b Mon Sep 17 00:00:00 2001 From: Tom Date: Wed, 28 Oct 2015 20:46:10 +0100 Subject: [PATCH] docs --- README | 17 ++++++++++++----- doc/trag.txt | 23 +++++++++++++++++------ etc/tpl_trag.txt | 19 +++++++++++++------ 3 files changed, 42 insertions(+), 17 deletions(-) diff --git a/README b/README index babe5a2..79aa172 100644 --- a/README +++ b/README @@ -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~ diff --git a/doc/trag.txt b/doc/trag.txt index a2a55d6..6666db3 100644 --- a/doc/trag.txt +++ b/doc/trag.txt @@ -1,4 +1,4 @@ -*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 @@ -6,11 +6,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~ @@ -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| @@ -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| diff --git a/etc/tpl_trag.txt b/etc/tpl_trag.txt index 8bb8433..3474fa7 100644 --- a/etc/tpl_trag.txt +++ b/etc/tpl_trag.txt @@ -1,4 +1,4 @@ -*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 @@ -6,11 +6,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~