.TH irtestcase "1" "Last change: Oct 2015" "irtestcase 0.10.1" "User Commands"
.SH NAME
.P
\fBirtestcas\fRe - Create or check decoding testcases.
.SH SYNOPSIS
.P
\fBirtestcase\fR [\fI-l lircrc-file -p prog\fR] <\fIsocket\fR>
.P
\fBirtestcase\fR [\fI-l lircrc-file -p prog\fR] -t \fItestdata\fR <\fIsocket\fR>
.P
\fBirtestcase\fR [\fI-v\fR|\fI-h\fR]

.SH DESCRIPTION
.P
\fBirtestcase\fR is a tool which can record keypresses from a remote together
with the decoded values. Given output from another session, it can
also verify that the decoding still works as expected.
.P
In the first form irtestcase will wait for input and create log files
for it. Doing so, it also echoes received buttons on stdout. There is
no way to stop the program in a clean way, just use ctrl-C when completed.
.P
In the second form it will feed the data from the testdata file to lircd
and log the the decoded data as usually. Thus, this makes it possible to
test the output from the remote which generated the testdata.  In this
form lircd must be running with the "file" driver.
.P
The optional socket is the lircd output socket (lircd must be running). It
defaults to LIRC_SOCKET_PATH in environment, falling back to a hardcoded
default value (/var/run/lirc/lircd).

.SH OPTIONS

.TP 4
\fB-l, --lircrc\fR  \fI<lircrc config file>\fR
Log also applications strings (as ircat(1)) using lircrc type config file.

.TP 4
\fB-p, --prog\fR \fI<program id>\fR
When using -l/--lircrc, the program name matching the PROG = entries
in lircrc

.TP 4
\fB-t, --testdata\fR
Use data i file instead of "live" input from the remote. This can be
the durations.log file from a previous run, see FILES. It can also
be logged output from mode2(1).

.TP 4
\fB-v , --version\fR
Print version and exit.

.TP 4
\fB-h , --help\fR
Print help message.

.SH ENVIRONMENT
irtestcase respects LIRC_SOCKET_PATH which if defined holds the
path to the lircd output socket to listen to.

.SH FILES
.TP 4
.B /tmp/irtestcase
irtestcase creates files in /tmp/irtestcase (hardcoded, sorry). After a
successful run here is:
.RS 4
.TP 4
.B durations.log
Printable space/pulse durations in the same format as mode2(1). This file
is usable as -t/--testdata input.
.TP 4
.B codes.log
The decoded  buttons, in same format as irw(1).
.TP 4
.B app_strings.log
The application strings, as presented by ircat(1).
.RE
.TP 4
.B ~/.cache/irtestcase.log
Debug log. Setting the XDG_CACHE_HOME environment variable relocates this
file to $XDG_CACHE_HOME/irtestcase.log. The amount of logging respects the
LIRC_LOGLEVEL environment variable, defaulting to the \fidebug\fR value
in the \fi[lircd]\fR section of lirc_options.conf.

.SH "SEE ALSO"
.P
The documentation for \fBlirc\fR
is maintained as html pages. They are located under html/ in the
documentation directory.