Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.ripgrep-all.enable

Whether to enable ripgrep-all (rga).

Type: boolean

Default:

false

Example:

true

Declared by:

programs.ripgrep-all.package

The ripgrep-all package to use.

Type: null or package

Default:

pkgs.ripgrep-all

Declared by:

programs.ripgrep-all.custom_adapters

Custom adapters that invoke external preprocessing scripts. See <link xlink:href=“https://github.com/phiresky/ripgrep-all/wiki#custom-adapters”/>.

Type: list of (submodule)

Default:

[ ]

Declared by:

programs.ripgrep-all.custom_adapters.*.args

The output path hint; the placeholders are the same as for rga’s args

Type: list of string

Default:

[ ]

Declared by:

programs.ripgrep-all.custom_adapters.*.binary

The path of the binary to run

Type: absolute path

Declared by:

programs.ripgrep-all.custom_adapters.*.description

A description of this adapter; shown in rga’s help

Type: string

Declared by:

programs.ripgrep-all.custom_adapters.*.disabled_by_default

If true, the adapter will be disabled by default

Type: null or boolean

Default:

null

Declared by:

programs.ripgrep-all.custom_adapters.*.extensions

The file extensions this adapter supports

Type: list of string

Default:

[ ]

Example:

[
  "pdf"
]

Declared by:

programs.ripgrep-all.custom_adapters.*.match_only_by_mime

if –rga-accurate, only match by mime types, ignore extensions completely

Type: null or boolean

Default:

null

Declared by:

programs.ripgrep-all.custom_adapters.*.mimetypes

If not null and –rga-accurate is enabled, mime type matching is used instead of file name matching

Type: null or (list of string)

Default:

null

Example:

[
  "application/pdf"
]

Declared by:

programs.ripgrep-all.custom_adapters.*.name

The unique identifier and name of this adapter; must only include a-z, 0-9, _

Type: string

Declared by:

programs.ripgrep-all.custom_adapters.*.output_path_hint

Setting this is useful if the output format is not plain text (.txt) but instead some other format that should be passed to another adapter

Type: null or string

Default:

null

Example:

"$\${input_virtual_path}.txt.asciipagebreaks"

Declared by:

programs.ripgrep-all.custom_adapters.*.version

The version identifier used to key cache entries; change if the configuration or program changes

Type: signed integer

Default:

1

Declared by: