ptx

Options

--auto-reference, -A

ptx-help-auto-reference

--traditional, -G

ptx-help-traditional

--flag-truncation=<STRING>, -F <STRING>

ptx-help-flag-truncation

--macro-name=<STRING>, -M <STRING>

ptx-help-macro-name

--format

-O

ptx-help-roff

-T

ptx-help-tex

--right-side-refs, -R

ptx-help-right-side-refs

--sentence-regexp=<REGEXP>, -S <REGEXP>

ptx-help-sentence-regexp

--word-regexp=<REGEXP>, -W <REGEXP>

ptx-help-word-regexp

--break-file=<FILE>, -b <FILE>

ptx-help-break-file

--ignore-case, -f

ptx-help-ignore-case

--gap-size=<NUMBER>, -g <NUMBER>

ptx-help-gap-size

--ignore-file=<FILE>, -i <FILE>

ptx-help-ignore-file

--only-file=<FILE>, -o <FILE>

ptx-help-only-file

--references=<FILE>, -r <FILE>

ptx-help-references

--width=<NUMBER>, -w <NUMBER>

ptx-help-width

Examples

Generate a permuted index where the first field of each line is an index reference:

ptx {{[-r|--references]}} {{path/to/file}}

Generate a permuted index with automatically generated index references:

ptx {{[-A|--auto-reference]}} {{path/to/file}}

Generate a permuted index with a fixed width:

ptx {{[-w|--width]}} {{width_in_columns}} {{path/to/file}}

Generate a permuted index with a list of filtered words:

ptx {{[-o|--only-file]}} {{path/to/filter}} {{path/to/file}}

Generate a permuted index with SYSV-style behaviors:

ptx {{[-G|--traditional]}} {{path/to/file}}

The examples are provided by the tldr-pages project under the CC BY 4.0 License.

Please note that, as uutils is a work in progress, some examples might fail.