mirror of
https://github.com/peco/peco.git
synced 2026-09-10 07:16:29 -04:00
docs: regenerate man page from README
This commit is contained in:
parent
dc696bc92f
commit
4b49f65118
|
|
@ -313,6 +313,39 @@ do not appear at all, try increasing \f[V]MaxScanBufferSize\f[R] in your
|
|||
config.
|
||||
The default is 256 (KB), which limits the maximum length of a single
|
||||
input line.
|
||||
.SS ANSI Color Support
|
||||
.PP
|
||||
When the \f[V]--ansi\f[R] flag is enabled, peco parses ANSI SGR (Select
|
||||
Graphic Rendition) escape sequences from the input and renders the
|
||||
original colors in the terminal.
|
||||
This lets you pipe colored output from tools like
|
||||
\f[V]git log --color\f[R], \f[V]rg --color=always\f[R], or
|
||||
\f[V]ls --color\f[R] through peco while preserving the visual
|
||||
formatting.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
git log --color=always | peco --ansi
|
||||
rg --color=always pattern | peco --ansi
|
||||
ls --color=always | peco --ansi
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
Supported ANSI features: - Basic 8 foreground and background colors
|
||||
(30-37, 40-47) - 256-color palette (38;5;N, 48;5;N) - 24-bit truecolor
|
||||
(38;2;R;G;B, 48;2;R;G;B) - Bold, underline, and reverse attributes -
|
||||
Reset sequences
|
||||
.PP
|
||||
When ANSI mode is enabled: - Filtering and matching operate against the
|
||||
\f[B]stripped\f[R] (plain text) version of each line, so escape codes do
|
||||
not interfere with your queries - ANSI colors are displayed as the
|
||||
\f[B]base layer\f[R]; peco\[cq]s own selection and match highlighting
|
||||
take precedence over ANSI colors - Selected lines\[cq] output preserves
|
||||
the \f[B]original\f[R] ANSI codes, so downstream tools receive colored
|
||||
text
|
||||
.PP
|
||||
ANSI mode can also be enabled permanently via the configuration file
|
||||
(see ANSI under Global configuration).
|
||||
.SS Context Lines (Zoom In/Out)
|
||||
.PP
|
||||
When filtering results (e.g.\ searching for \[lq]error\[rq] in a log
|
||||
|
|
@ -652,6 +685,15 @@ your external command repeatedly afterwards.
|
|||
.PP
|
||||
To exit out of peco when running in this mode, you must execute the
|
||||
Cancel command, usually the escape key.
|
||||
.SS \[en]ansi
|
||||
.PP
|
||||
Enables ANSI color code support.
|
||||
When this flag is set, peco parses ANSI SGR escape sequences from the
|
||||
input and renders the colors in the terminal UI.
|
||||
Filtering is performed against the plain text with ANSI codes stripped,
|
||||
and selected output preserves the original ANSI codes.
|
||||
.PP
|
||||
See ANSI Color Support in the Features section for details.
|
||||
.SS \[en]height \f[V]num|percentage\f[R]
|
||||
.PP
|
||||
When specified, peco renders inline at the bottom of the terminal using
|
||||
|
|
@ -717,6 +759,8 @@ Prompt
|
|||
InitialMatcher
|
||||
.IP \[bu] 2
|
||||
Use256Color
|
||||
.IP \[bu] 2
|
||||
ANSI
|
||||
.SS Global
|
||||
.PP
|
||||
Global configurations that change the global behavior.
|
||||
|
|
@ -810,6 +854,25 @@ If you believe that your input has very long lines that prohibit peco
|
|||
from reading them, try increasing this number.
|
||||
.PP
|
||||
The same time, the default MaxScanBuferSize is 256kb.
|
||||
.SS ANSI
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
{
|
||||
\[dq]ANSI\[dq]: true
|
||||
}
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
Enables ANSI color code support.
|
||||
When set to \f[V]true\f[R], peco parses and renders ANSI SGR escape
|
||||
sequences from the input.
|
||||
This is equivalent to using the \f[V]--ansi\f[R] command line flag.
|
||||
The command line flag takes precedence if both are specified.
|
||||
.PP
|
||||
Default value for ANSI is \f[V]false\f[R].
|
||||
.PP
|
||||
See ANSI Color Support in the Features section for details.
|
||||
.SS Height
|
||||
.IP
|
||||
.nf
|
||||
|
|
@ -1820,6 +1883,8 @@ Multi-Stage Filtering (Freeze Results)
|
|||
.IP \[bu] 2
|
||||
Horizontal Scrolling
|
||||
.IP \[bu] 2
|
||||
ANSI Color Support
|
||||
.IP \[bu] 2
|
||||
Context Lines (Zoom In/Out)
|
||||
.IP \[bu] 2
|
||||
Selectable Layout
|
||||
|
|
@ -1883,6 +1948,8 @@ Command Line Options
|
|||
.IP \[bu] 2
|
||||
\[en]exec \f[V]string\f[R]
|
||||
.IP \[bu] 2
|
||||
\[en]ansi
|
||||
.IP \[bu] 2
|
||||
\[en]height \f[V]num|percentage\f[R]
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
|
|
@ -1908,6 +1975,8 @@ OnCancel
|
|||
.IP \[bu] 2
|
||||
MaxScanBufferSize
|
||||
.IP \[bu] 2
|
||||
ANSI
|
||||
.IP \[bu] 2
|
||||
Height
|
||||
.RE
|
||||
.IP \[bu] 2
|
||||
|
|
|
|||
Loading…
Reference in a new issue