utils-shell/peco.peco
1
0
Fork 0
mirror of https://github.com/peco/peco.git synced 2026-09-10 07:16:29 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #605 from peco/update-manpage

Browse source 
docs: update man page
This commit is contained in:
lestrrat 2026-02-16 21:24:38 +09:00 committed by GitHub
parent e0de14a560 731c3972b7
commit 0fb619016d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 0 additions and 192 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

192
contrib/man/peco.1
View file

@ -26,11 +26,6 @@ to the state of \f[V]peco\f[R] in whatever current branch you are
viewing, \f[I]not\f[R] necessarily the state of a currently released
version.
Please make sure to checkout the Changes file for features and changes.
.PP
This README is long and comprehensive.
Use the Table of Contents to navigate to the section that interests you.
It has been placed at the bottom of the README file because of its
length.
.RS
.PP
If you use peco, please consider sponsoring the authors of this project
@ -1856,190 +1851,3 @@ Naruki Tanabe (narugit)
.PP
Obviously, kudos to the original percol: https://github.com/mooz/percol
Much code stolen from https://github.com/mattn/gof
.SH Table of Contents
.IP \[bu] 2
peco
.IP \[bu] 2
Description
.RS 2
.IP \[bu] 2
Demo
.RE
.IP \[bu] 2
Features
.RS 2
.IP \[bu] 2
Incremental Search
.IP \[bu] 2
Negative Matching
.IP \[bu] 2
Select Multiple Lines
.IP \[bu] 2
Select Range Of Lines
.IP \[bu] 2
Select Filters
.IP \[bu] 2
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
.IP \[bu] 2
Inline Mode (\[en]height)
.IP \[bu] 2
Works on Windows!
.RE
.IP \[bu] 2
Installation
.RS 2
.IP \[bu] 2
Just want the binary?
.IP \[bu] 2
macOS (Homebrew, Scarf)
.IP \[bu] 2
Debian and Ubuntu based distributions (APT, Scarf)
.IP \[bu] 2
Void Linux (XBPS)
.IP \[bu] 2
Arch Linux
.IP \[bu] 2
Windows (Chocolatey NuGet Users)
.IP \[bu] 2
Building peco yourself
.IP \[bu] 2
go get IS NOT RECOMMENDED
.RE
.IP \[bu] 2
Command Line Options
.RS 2
.IP \[bu] 2
-h, \[en]help
.IP \[bu] 2
\[en]version
.IP \[bu] 2
\[en]query
.IP \[bu] 2
\[en]print-query
.IP \[bu] 2
\[en]rcfile
.IP \[bu] 2
-b, \[en]buffer-size
.IP \[bu] 2
\[en]null
.IP \[bu] 2
\[en]initial-index
.IP \[bu] 2
\[en]initial-filter
\f[V]IgnoreCase|CaseSensitive|SmartCase|IRegexp|Regexp|Fuzzy\f[R]
.IP \[bu] 2
\[en]prompt
.IP \[bu] 2
\[en]layout \f[V]top-down|bottom-up\f[R]
.IP \[bu] 2
\[en]select-1
.IP \[bu] 2
\[en]on-cancel \f[V]success|error\f[R]
.IP \[bu] 2
\[en]selection-prefix \f[V]string\f[R]
.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
Configuration File
.RS 2
.IP \[bu] 2
Global
.RS 2
.IP \[bu] 2
Prompt
.IP \[bu] 2
InitialMatcher
.IP \[bu] 2
InitialFilter
.IP \[bu] 2
FuzzyLongestSort
.IP \[bu] 2
StickySelection
.IP \[bu] 2
SuppressStatusMsg
.IP \[bu] 2
OnCancel
.IP \[bu] 2
MaxScanBufferSize
.IP \[bu] 2
ANSI
.IP \[bu] 2
Height
.RE
.IP \[bu] 2
Keymaps
.RS 2
.IP \[bu] 2
Key sequences
.IP \[bu] 2
Combined actions
.IP \[bu] 2
Available keys
.IP \[bu] 2
Key workarounds
.IP \[bu] 2
Available actions
.IP \[bu] 2
Default Keymap
.RE
.IP \[bu] 2
Styles
.RS 2
.IP \[bu] 2
Foreground Colors
.IP \[bu] 2
Background Colors
.IP \[bu] 2
Attributes
.RE
.IP \[bu] 2
CustomFilter
.RS 2
.IP \[bu] 2
Examples
.RE
.IP \[bu] 2
Layout
.IP \[bu] 2
SingleKeyJump
.IP \[bu] 2
SelectionPrefix
.IP \[bu] 2
Use256Color
.RE
.IP \[bu] 2
FAQ
.RS 2
.IP \[bu] 2
Does peco work on (msys2|cygwin)?
.IP \[bu] 2
Non-latin fonts (e.g.\ Japanese) look weird on my Windows machine\&...?
.IP \[bu] 2
Seeing escape sequences \f[V][200\[ti]\f[R] and \f[V][201\[ti]\f[R] when
pasting text?
.RE
.IP \[bu] 2
Hacking
.IP \[bu] 2
TODO
.IP \[bu] 2
AUTHORS
.IP \[bu] 2
CONTRIBUTORS
.IP \[bu] 2
Notes
.IP \[bu] 2
Table of Contents