mirror of
https://github.com/nvim-telescope/telescope.nvim
synced 2024-09-16 21:24:02 +02:00
[docgen] Update doc/telescope.txt
skip-checks: true
This commit is contained in:
parent
16aacf6443
commit
a8d7185eac
1 changed files with 18 additions and 17 deletions
|
@ -529,20 +529,11 @@ telescope.setup({opts}) *telescope.setup()*
|
|||
vimgrep_arguments: ~
|
||||
Defines the command that will be used for `live_grep` and `grep_string`
|
||||
pickers.
|
||||
Hint: Make sure that color is currently set to `never` because we do
|
||||
not yet interpret color codes
|
||||
Hint 2: Make sure that these options are in your changes arguments:
|
||||
"--no-heading", "--with-filename", "--line-number", "--column"
|
||||
because we need them so the ripgrep output is in the correct format.
|
||||
|
||||
Default: {
|
||||
"rg",
|
||||
"--color=never",
|
||||
"--no-heading",
|
||||
"--with-filename",
|
||||
"--line-number",
|
||||
"--column",
|
||||
"--smart-case"
|
||||
"--smart-case",
|
||||
"--json",
|
||||
}
|
||||
|
||||
*telescope.defaults.use_less*
|
||||
|
@ -795,10 +786,14 @@ builtin.live_grep({opts}) *telescope.builtin.live_grep()*
|
|||
{type_filter} (string) argument to be used with
|
||||
`--type`, e.g. "rust", see `rg
|
||||
--type-list`
|
||||
{use_regex} (boolean) if true, special characters
|
||||
won't be escaped, allows for
|
||||
using regex (default: false)
|
||||
{word_match} (string) can be set to `-w` to enable
|
||||
exact word matches
|
||||
{additional_args} (function|table) additional arguments to be
|
||||
passed on. Can be fn(opts) ->
|
||||
tbl
|
||||
{max_results} (number) define a upper result value
|
||||
{disable_coordinates} (boolean) don't show the line & row
|
||||
numbers (default: false)
|
||||
{file_encoding} (string) file encoding for the entry &
|
||||
|
@ -825,19 +820,25 @@ builtin.grep_string({opts}) *telescope.builtin.grep_string()*
|
|||
{search_dirs} (table) directory/directories/files to
|
||||
search, mutually exclusive
|
||||
with `grep_open_files`
|
||||
{glob_pattern} (string|table) argument to be used with
|
||||
`--glob`, e.g. "*.toml", can
|
||||
use the opposite "!*.toml"
|
||||
{type_filter} (string) argument to be used with
|
||||
`--type`, e.g. "rust", see `rg
|
||||
--type-list`
|
||||
{additional_args} (function|table) additional arguments to be
|
||||
passed on. Can be fn(opts) ->
|
||||
tbl
|
||||
{use_regex} (boolean) if true, special characters
|
||||
won't be escaped, allows for
|
||||
using regex (default: false)
|
||||
{word_match} (string) can be set to `-w` to enable
|
||||
exact word matches
|
||||
{additional_args} (function|table) additional arguments to be
|
||||
passed on. Can be fn(opts) ->
|
||||
tbl
|
||||
{disable_coordinates} (boolean) don't show the line and row
|
||||
numbers (default: false)
|
||||
{only_sort_text} (boolean) only sort the text, not the
|
||||
file, line or row (default:
|
||||
false)
|
||||
{disable_coordinates} (boolean) don't show the line and row
|
||||
numbers (default: false)
|
||||
{file_encoding} (string) file encoding for the entry &
|
||||
previewer
|
||||
|
||||
|
|
Loading…
Reference in a new issue