.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "TERMREC 1"
.TH TERMREC 1 "2020-04-19" "0.19" "termrec"
.\" 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"
termrec \- a tty recorder
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBtermrec\fR [\fB\-f\fR \fIformat\fR] [\fB\-e\fR \fIcommand\fR] [\fIoutfile\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBTermrec\fR is a tty recorder; it can record the output of any text mode program
which you can then replay with \fBtermplay\fR, \fBttyplay\fR, \fBipbt\fR, \fBttyplayer\fR,
\&\fBnh-recorder\fR, \fBasciinema\fR or similar.
.PP
If \fIoutfile\fR ends in \fB.gz\fR, \fB.xz\fR, \fB.bz2\fR or \fB.zst\fR, the data will be
appropriately compressed.
.PP
If no \fIoutfile\fR is given, \fBtermrec\fR will produce a name like 2008\-11\-27.13\-02\-42.ttyrec.bz2
.PP
You can write directly to some remote URLs, such as
\&\fBtcp://\fR\fIhost\fR\fB:\fR\fIport\fR but that's usually of little use.
.SS "Options:"
.IX Subsection "Options:"
.IP "\fB\-f\fR \fIformat\fR, \fB\-\-format\fR" 4
.IX Item "-f format, --format"
You can specify a format other than ttyrec.  Those available are:
.RS 4
.IP "ansi" 4
.IX Item "ansi"
No timing data.  This is same as the output of \fBscript\fR\|(1).
.IP "ttyrec" 4
.IX Item "ttyrec"
Compatible with \fBttyrec\fR by Satoru Takabayashi.
.IP "nh-recorder" 4
.IX Item "nh-recorder"
Compatible with \fBnh-recorder\fR by Helge Dennhardt.
.IP "asciicast" 4
.IX Item "asciicast"
Compatible with \fBasciinema\fR by Marcin Kulik; format v2.
.IP "asciicast\-v1" 4
.IX Item "asciicast-v1"
Likewise, format v1.
.RE
.RS 4
.RE
.IP "\fB\-e\fR \fIcommand\fR, \fB\-\-exec\fR" 4
.IX Item "-e command, --exec"
Runs a \fIcommand\fR instead of spawning a shell and records its output.
.IP "\fB\-r\fR, \fB\-\-raw\fR" 4
.IX Item "-r, --raw"
Inhibits noting info about your terminal size and UTFness.  This data is usually a good
thing, but can confuse some programs.  Also note that none of the formats provides a way
to mark which exactly charset you use \*(-- only if it's \s-1UTF\-8\s0 or one of ancient ones.
.IP "\fB\-a\fR, \fB\-\-append\fR" 4
.IX Item "-a, --append"
If the output file exists, it will be appended instead being overwritten.
.IP "\fB\-h\fR, \fB\-\-help\fR" 4
.IX Item "-h, --help"
Shows a short explanation of parameters.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
.IP "\s-1SHELL\s0" 4
.IX Item "SHELL"
Unless \fB\-e\fR is given, this will be the shell spawned, falling back to \fB/bin/sh\fR
if not set.  On Windows, \s-1COMSPEC\s0 is used instead.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBtermplay\fR\|(1), \fBtermtime\fR\|(1), \fBtermcat\fR\|(1).