docs: regenerate man page from README

This commit is contained in:
lestrrat 2026-06-05 05:10:47 +00:00 committed by github-actions[bot]
parent 41a8422b22
commit 8762bd7da0

View file

@ -741,6 +741,38 @@ behavior, unchanged).
alternate screen buffer, and restores the original value on exit. alternate screen buffer, and restores the original value on exit.
If peco is killed abnormally (e.g.\ \f[V]SIGKILL\f[R]), you may need to If peco is killed abnormally (e.g.\ \f[V]SIGKILL\f[R]), you may need to
unset this variable manually: \f[V]unset TCELL_ALTSCREEN\f[R]. unset this variable manually: \f[V]unset TCELL_ALTSCREEN\f[R].
.SS -f, \[en]follow
.PP
When specified, peco follows streaming input, automatically scrolling to
keep the newest lines visible at the bottom of the list, just like
\f[V]tail -f\f[R].
This is useful for live log streams:
.IP
.nf
\f[C]
journalctl -f -n 1000 | peco --follow --layout top-down-query-bottom
\f[R]
.fi
.PP
Moving the cursor manually (e.g.\ with the arrow keys) turns follow mode
off so you can scroll back through the history.
The \f[V]ToggleFollow\f[R] action turns it back on; bind it to a key in
your configuration file, for example:
.IP
.nf
\f[C]
{
\[dq]Keymap\[dq]: {
\[dq]C-f\[dq]: \[dq]peco.ToggleFollow\[dq]
}
}
\f[R]
.fi
.PP
Follow mode can also be enabled by default with the \f[V]Follow\f[R]
configuration variable.
The \f[V]--follow\f[R] command line option takes precedence over the
configuration file.
.SH Configuration File .SH Configuration File
.PP .PP
peco by default consults a few locations for the config files. peco by default consults a few locations for the config files.
@ -1399,6 +1431,11 @@ T}@T{
Start selecting by range, or append selecting range to selections Start selecting by range, or append selecting range to selections
T} T}
T{ T{
peco.ToggleFollow
T}@T{
Toggle follow mode (auto-scroll to the newest lines, like tail -f)
T}
T{
peco.ToggleSelectMode peco.ToggleSelectMode
T}@T{ T}@T{
(DEPRECATED) Alias to ToggleRangeMode (DEPRECATED) Alias to ToggleRangeMode