.\" Generated by manscript from tdcompare.1.txt
.TH "TDCOMPARE" "1" "2013/03/03" "2.2" "termdebug"
.SH NAME
tdcompare \- compare two recordings of a terminal program
.SH SYNOPSIS
\fBtdcompare\fR [\fIOPTIONS\fR]... \fIOLD\fR \fINEW\fR
.SH DESCRIPTION
\fBtdcompare\fR compares two recordings of a terminal program to determine whether
they represent the same output. The comparison can be both at the input/output
level, or at the visual level. When comparing at the input/output level, the
difference will be reported as line numbers in the \fIOLD\fR and \fINEW\fR files. For
visual comparisons, a textual description of the first difference can be
produced, and a picture of the first different terminal state can be
written (if \fBtermdebug\fR was compiled with Cairo support).
.PP
\fBtdcompare\fR is useful to verify that a new recording of the same program produced
the same result. To do on-line verification, use \fBtdreplay\fR(1) instead.
.SH OPTIONS
\fBtdcompare\fR accepts the following options:
.PP
.TP
\fB\-h\fR, \fB\-\-help\fR
Display a short help message.
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version and copyright information.
.TP
\fB\-v\fR, \fB\-\-visual\-compare\fR
Check for visual equality, rather than exact input/output behaviour.
(Requires a build with ncurses support.)
.TP
\fB\-D\fR, \fB\-\-describe\fR
Write a description of the first visual difference encountered. Only useful
with \fB\-v\fR/\fB\-\-visual\-compare\fR. (Requires a build with ncurses support.)
.TP
\fB\-p\fR \fIname\fR, \fB\-\-picture\fR=\fIname\fR
Write a picture of the difference to \fIname\fR. Only useful with
\fB\-v\fR/\fB\-\-visual\-compare\fR. (Requires a build with ncurses and Cairo support.)
.TP
\fB\-f\fR \fIfont\fR, \fB\-\-font\fR=\fIfont\fR
Use \fIfont\fR to show text in generated pictures. Only useful with
\fB\-p\fR/\fB\-\-picture\fR or \fB\-P\fR/\fB\-\-picture\-series\fR. (Requires a build with ncurses
and Cairo support.)
.TP
\fB\-W\fR \fIwidth\fR, \fB\-\-cell\-width\fR=\fIwidth\fR
Use cells of \fIwidth\fR pixels wide in generated pictures. Only useful with
\fB\-p\fR/\fB\-\-picture\fR or \fB\-P\fR/\fB\-\-picture\-series\fR. (Requires a build with ncurses
and Cairo support.)
.TP
\fB\-H\fR \fIheight\fR, \fB\-\-cell\-height\fR=\fIheight\fR
Use cells of \fIheight\fR pixels wide in generated pictures. Only useful with
\fB\-p\fR/\fB\-\-picture\fR or \fB\-P\fR/\fB\-\-picture\-series\fR. (Requires a build with ncurses
and Cairo support.)
.TP
\fB\-P\fR \fIname\fR, \fB\-\-picture\-series\fR=\fIname\fR
Create a series of pictures, representing the different visual steps in the
client interface, using \fIname\fR as the file name template. \fIname\fR is a
\fBprintf\fR(3) format string, where a single d-type conversion is required.
(Requires a build with ncurses and Cairo support.)
.TP
\fB\-s\fR, \fB\-\-stop\-on\-difference\fR
Stop when the first visual difference is found. Only valid with
\fB\-P\fR/\fB\-\-picture\-series\fR.
.PP
To stop \fBtdcompare\fR from interpreting file names that start with a dash as
options, one can specify a double dash (\-\-) after which tdreplay will interpret
any following arguments as files to read.
.SH BUGS
If you think you have found a bug, please check that you are using the latest
version of \fBtermdebug\fR <http://os.ghalkes.nl/termdebug>. When reporting bugs,
please include a minimal example that demonstrates the problem.
.SH AUTHOR
G.P. Halkes <termdebug@ghalkes.nl>
.SH COPYRIGHT
Copyright \(co 2010,2012\-2013 G.P. Halkes
.br
\fBtermdebug\fR is licensed under the GNU General Public License version 3.
.br
For more details on the license, see the file COPYING in the documentation
directory. On Un*x systems this is usually /usr/share/doc/termdebug.
.SH SEE\ ALSO
\fBtermdebug\fR(1), \fBtdrecord\fR(1), \fBtdrerecord\fR(1), \fBtdview\fR(1), \fBtdreplay\fR(1)
.RS
.ft CW