.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "TP 1"
.TH TP 1 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
tp \- a pure perl pager
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    tp \-[JSenrs] [\-cols] [\-f STR] [\-j|+ #] [\-p|+/ STR] [FILE]...
.Ve
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-e\fR 4
.IX Item "-e"
Exit at end of file.
.IP "\fB\-f STR\fR" 4
.IX Item "-f STR"
If defined, the pager will pause when the character sequence specified
by STR is encountered in the input text.
.Sp
The default value when enabled is formfeed i.e; ^L; in order to mimic
traditional behavior of "1" in more, but due to the pecularities of
Getopt::Long> you need to use the \-\- argument separator in order to
to trigger this e.g;
.Sp
.Vb 1
\&    tp \-f \-\- foo #pauses on lines in foo with "^L" in them
.Ve
.Sp
You might also supply a regular expression as STR e.g;
.Sp
.Vb 1
\&    tp \-f \*(Aq[ie]t\*(Aq bar #pauses on lines in bar with "it" or "et" in them
.Ve
.IP \fB\-J\fR 4
.IX Item "-J"
Add a column with markers indicating which lines match a search expression.
.IP \fB\-n\fR 4
.IX Item "-n"
Display line numbering. Toggleable at run time with \fI#\fR.
.IP \fB\-r\fR 4
.IX Item "-r"
Send raw control characters from input unadulterated to the terminal.
By default, chracters other than tab and newline will be converted to
caret notation e.g; ^@ for null or ^L for form feed.
.IP \fB\-s\fR 4
.IX Item "-s"
Squeeze multiple blank lines into one.
.IP \fB\-S\fR 4
.IX Item "-S"
Do not fold long lines.
.IP "\fB\-[\fR or \fB\-\-scrollbar\fR" 4
.IX Item "-[ or --scrollbar"
Display an interactive scrollbar in the right-most column.
.IP "\fB\-$\fR or \fB\-\-tail\fR" 4
.IX Item "-$ or --tail"
Keep checking the displayed file for new content.
Only available when paging a single file.
.IP \fB\-\-cols\fR 4
.IX Item "--cols"
Set the number of columns for the pager.
.Sp
If absent, the terminal is queried directly with Term::ReadKey if
loaded or \f(CW\*(C`stty\*(C'\fR or \f(CW\*(C`tput\*(C'\fR, and if these fail it defaults to 80.
.SH "User Interface"
.IX Header "User Interface"
\&\f(CW\*(C`C\-\*(C'\fR is Control, \f(CW\*(C`M\-\*(C'\fR is Meta/Alt, \f(CW\*(C`S\-\*(C'\fR is Shift, and \f(CW\*(C`\ed+\*(C'\fR is a sequence of digits
.SS General
.IX Subsection "General"
.ie n .IP "help \- ""h"" or ""H""" 4
.el .IP "help \- \f(CWh\fR or \f(CWH\fR" 4
.IX Item "help - h or H"
.PD 0
.ie n .IP "close \- ""q"" or ""Q"" or "":q"" or "":Q""" 4
.el .IP "close \- \f(CWq\fR or \f(CWQ\fR or \f(CW:q\fR or \f(CW:Q\fR" 4
.IX Item "close - q or Q or :q or :Q"
.ie n .IP "refresh \- ""r"" or ""C\-l"" or ""C\-R""" 4
.el .IP "refresh \- \f(CWr\fR or \f(CWC\-l\fR or \f(CWC\-R\fR" 4
.IX Item "refresh - r or C-l or C-R"
.ie n .IP "flush buffer \- ""R""" 4
.el .IP "flush buffer \- \f(CWR\fR" 4
.IX Item "flush buffer - R"
.ie n .IP "save buffer \- "":w""" 4
.el .IP "save buffer \- \f(CW:w\fR" 4
.IX Item "save buffer - :w"
.ie n .IP "open file \- "":e""" 4
.el .IP "open file \- \f(CW:e\fR" 4
.IX Item "open file - :e"
.PD
.SS Navigation
.IX Subsection "Navigation"
.ie n .IP "down one line \- ""ENTER"" or ""e"" or ""j"" or ""J"" or ""C\-e"" or ""C\-n"" or ""down arrow""" 4
.el .IP "down one line \- \f(CWENTER\fR or \f(CWe\fR or \f(CWj\fR or \f(CWJ\fR or \f(CWC\-e\fR or \f(CWC\-n\fR or \f(CWdown arrow\fR" 4
.IX Item "down one line - ENTER or e or j or J or C-e or C-n or down arrow"
.PD 0
.ie n .IP "down half page \- ""d"" or ""C\-d""" 4
.el .IP "down half page \- \f(CWd\fR or \f(CWC\-d\fR" 4
.IX Item "down half page - d or C-d"
.ie n .IP "down one page \- ""SPACE"" ""f"" or ""z"" or ""C\-f"" or ""C\-v"" or ""M\-space"" or ""PgDn""" 4
.el .IP "down one page \- \f(CWSPACE\fR \f(CWf\fR or \f(CWz\fR or \f(CWC\-f\fR or \f(CWC\-v\fR or \f(CWM\-space\fR or \f(CWPgDn\fR" 4
.IX Item "down one page - SPACE f or z or C-f or C-v or M-space or PgDn"
.ie n .IP "up one page \- ""b"" or ""w"" or ""C\-b"" or ""M\-v"" or ""PgUp""" 4
.el .IP "up one page \- \f(CWb\fR or \f(CWw\fR or \f(CWC\-b\fR or \f(CWM\-v\fR or \f(CWPgUp\fR" 4
.IX Item "up one page - b or w or C-b or M-v or PgUp"
.ie n .IP "up half page \- ""u"" or ""C\-u""" 4
.el .IP "up half page \- \f(CWu\fR or \f(CWC\-u\fR" 4
.IX Item "up half page - u or C-u"
.ie n .IP "up one line \- ""k"" or ""y"" or ""K"" or ""Y"" or ""C\-K"" or ""C\-P"" or ""C\-Y"" or ""up arrow""" 4
.el .IP "up one line \- \f(CWk\fR or \f(CWy\fR or \f(CWK\fR or \f(CWY\fR or \f(CWC\-K\fR or \f(CWC\-P\fR or \f(CWC\-Y\fR or \f(CWup arrow\fR" 4
.IX Item "up one line - k or y or K or Y or C-K or C-P or C-Y or up arrow"
.ie n .IP "to bottom \- ""G"" or ""$"" or "">"" or ""M\->"" or ""End""" 4
.el .IP "to bottom \- \f(CWG\fR or \f(CW$\fR or \f(CW>\fR or \f(CWM\->\fR or \f(CWEnd\fR" 4
.IX Item "to bottom - G or $ or > or M-> or End"
.ie n .IP "to top \- ""g"" or ""<"" or ""M\-<""" 4
.el .IP "to top \- \f(CWg\fR or \f(CW<\fR or \f(CWM\-<\fR" 4
.IX Item "to top - g or < or M-<"
.ie n .IP "left one tab \- ""left arrow""" 4
.el .IP "left one tab \- \f(CWleft arrow\fR" 4
.IX Item "left one tab - left arrow"
.ie n .IP "left half screen \- ""S\-left arrow""" 4
.el .IP "left half screen \- \f(CWS\-left arrow\fR" 4
.IX Item "left half screen - S-left arrow"
.ie n .IP "right one tab \- ""right arrow""" 4
.el .IP "right one tab \- \f(CWright arrow\fR" 4
.IX Item "right one tab - right arrow"
.ie n .IP "right half screen  \- ""S\-right arrow""" 4
.el .IP "right half screen  \- \f(CWS\-right arrow\fR" 4
.IX Item "right half screen - S-right arrow"
.ie n .IP "jump to line number \- ""\ed+""" 4
.el .IP "jump to line number \- \f(CW\ed+\fR" 4
.IX Item "jump to line number - d+"
.ie n .IP "next file \- "":n"" or ""S\-M\-right arrow""" 4
.el .IP "next file \- \f(CW:n\fR or \f(CWS\-M\-right arrow\fR" 4
.IX Item "next file - :n or S-M-right arrow"
.ie n .IP "previous file \- "":p"" or ""S\-M\-left arrow""" 4
.el .IP "previous file \- \f(CW:p\fR or \f(CWS\-M\-left arrow\fR" 4
.IX Item "previous file - :p or S-M-left arrow"
.PD
.PP
\fIBookmarks\fR
.IX Subsection "Bookmarks"
.ie n .IP "Save mark \- ""m"" or ""Ins""" 4
.el .IP "Save mark \- \f(CWm\fR or \f(CWIns\fR" 4
.IX Item "Save mark - m or Ins"
.PD 0
.ie n .IP "Goto mark \- ""\*(Aq""" 4
.el .IP "Goto mark \- \f(CW\*(Aq\fR" 4
.IX Item "Goto mark - "
.ie n .IP "Special mark: Beginning of file \- ""^""" 4
.el .IP "Special mark: Beginning of file \- \f(CW^\fR" 4
.IX Item "Special mark: Beginning of file - ^"
.ie n .IP "Special mark: End of file \- ""$""" 4
.el .IP "Special mark: End of file \- \f(CW$\fR" 4
.IX Item "Special mark: End of file - $"
.ie n .IP "Special mark: Previous location \- ""\*(Aq""" 4
.el .IP "Special mark: Previous location \- \f(CW\*(Aq\fR" 4
.IX Item "Special mark: Previous location - "
.ie n .IP "Special mark: List user-created marks \- """"""" 4
.el .IP "Special mark: List user-created marks \- \f(CW""\fR" 4
.IX Item "Special mark: List user-created marks - """
.ie n .IP "Special mark: ""\ed"" \- Top of file \ed when viewing multiple files" 4
.el .IP "Special mark: \f(CW\ed\fR \- Top of file \ed when viewing multiple files" 4
.IX Item "Special mark: d - Top of file d when viewing multiple files"
.PD
.SS Search
.IX Subsection "Search"
.IP "forward \- /" 4
.IX Item "forward - /"
.PD 0
.IP "backward \- ?" 4
.IX Item "backward - ?"
.IP "next match \- n or P" 4
.IX Item "next match - n or P"
.IP "previous match \- p or N" 4
.IX Item "previous match - p or N"
.IP "grep (show only matching lines) \- &" 4
.IX Item "grep (show only matching lines) - &"
.PD
.SH Options
.IX Header "Options"
.IP "toggle line-numbering \- #" 4
.IX Item "toggle line-numbering - #"
.PD 0
.IP "toggle folding \- S" 4
.IX Item "toggle folding - S"
.IP "toggle raw/cooked output \- C" 4
.IX Item "toggle raw/cooked output - C"
.PD
.SH ENVIRONMENT
.IX Header "ENVIRONMENT"
tp checks the \fILESS\fR, \fIMORE\fR, \fITPOPT\fR, \fITERM\fR and \fITERMCAP\fR variables.
.PP
The \fITPOPT\fR variable is used to set options explicitly for tp, by
concatenating undecorated options together e.g; Sr for squished raw output.
.PP
\&\fILESS\fR and \fIMORE\fR are checked for options that tp supports, and if detected
they are enabled.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
IO::Pager::Perl, \fBless\fR\|(1)
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 1
\&    Jerrad Pierce jpierce@cpan.org
.Ve
.SH LICENSE
.IX Header "LICENSE"
.IP \(bu 4
Thou shalt not claim ownership of unmodified materials.
.IP \(bu 4
Thou shalt not claim whole ownership of modified materials.
.IP \(bu 4
Thou shalt grant the indemnity of the provider of materials.
.IP \(bu 4
Thou shalt use and dispense freely without other restrictions.
.PP
Or, if you prefer:
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.0 or,
at your option, any later version of Perl 5 you may have available.