.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "FISH_KEY_READER" "1" "Mar 26, 2024" "3.7" "fish-shell"
.SH NAME
fish_key_reader \- explore what characters keyboard keys send
.SH SYNOPSIS
.nf
\fBfish_key_reader\fP [\fIOPTIONS\fP]
.fi
.sp
.SH DESCRIPTION
.sp
\fBfish_key_reader\fP is used to explain how you would bind a certain key sequence. By default, it prints the \fI\%bind\fP command for one key sequence read interactively over standard input.
.sp
If the character sequence matches a special key name (see \fBbind \-\-key\-names\fP),  both \fBbind CHARS ...\fP and \fBbind \-k KEYNAME ...\fP usage will be shown. In verbose mode (enabled by passing \fB\-\-verbose\fP), additional details about the characters received, such as the delay between chars, are written to standard error.
.sp
The following options are available:
.INDENT 0.0
.TP
\fB\-c\fP or \fB\-\-continuous\fP
Begins a session where multiple key sequences can be inspected. By default the program exits after capturing a single key sequence.
.TP
\fB\-V\fP or \fB\-\-verbose\fP
Tells fish_key_reader to output timing information and explain the sequence in more detail.
.TP
\fB\-h\fP or \fB\-\-help\fP
Displays help about using this command.
.TP
\fB\-v\fP or \fB\-\-version\fP
Displays the current \fBfish\fP version and then exits.
.UNINDENT
.SH USAGE NOTES
.sp
In verbose mode, the delay in milliseconds since the previous character was received is included in the diagnostic information written to standard error. This information may be useful to determine the optimal \fBfish_escape_delay_ms\fP setting or learn the amount of lag introduced by tools like \fBssh\fP, \fBmosh\fP or \fBtmux\fP\&.
.sp
\fBfish_key_reader\fP intentionally disables handling of many signals. To terminate \fBfish_key_reader\fP in \fB\-\-continuous\fP mode do:
.INDENT 0.0
.IP \(bu 2
press \fBControl\fP+\fBC\fP twice, or
.IP \(bu 2
press \fBControl\fP+\fBD\fP twice, or
.IP \(bu 2
type \fBexit\fP, or
.IP \(bu 2
type \fBquit\fP
.UNINDENT
.SH EXAMPLE
.INDENT 0.0
.INDENT 3.5
.sp
.EX
> fish_key_reader
Press a key:
# press up\-arrow
bind \ee\e[A \(aqdo something\(aq

> fish_key_reader \-\-verbose
Press a key:
# press alt+enter
           hex:   1B  char: \ee
(  0.027 ms)  hex:    D  char: \ecM  (or \er)
bind \ee\er \(aqdo something\(aq
.EE
.UNINDENT
.UNINDENT
.SH COPYRIGHT
2024, fish-shell developers
.\" Generated by docutils manpage writer.
.