.TH clitest "1"  "Oct 2015" "CLITEST 0.0" "performs automatic testing in command lines"
.\" Text automatically generated by txt2man
.SH NAME
\fBclitest \fP- performs automatic testing in command lines
.SH SYNOPSIS
.nf
.fam C
\fBclitest\fP [\fIoptions\fP] <file \.\.\.>
.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
Clitest is a portable POSIX shell script that performs automatic
testing in Unix command lines. This script was carefully coded to
be portable between POSIX shells
.PP
It's the same concept as in Python's doctest module: you document
both the commands and their expected output, using the familiar
interactive prompt format, and a specialized tool tests them.
.PP
The \fBclitest\fP command searches for pieces of text that look like
interactive Unix command lines, and then executes those command
lines to verify that they work exactly as shown.
.SH OPTIONS
.TP
.B
\fB-1\fP, \fB--first\fP
Stop execution upon first failed test
.TP
.B
\fB-l\fP, \fB--list\fP
List all the tests (no execution)
.TP
.B
\fB-L\fP, \fB--list-run\fP
List all the tests with OK/FAIL status
.TP
.B
\fB-t\fP, \fB--test\fP RANGE
Run specific tests, by number (1,2,4-7)
.TP
.B
\fB-s\fP, \fB--skip\fP RANGE
Skip specific tests, by number (1,2,4-7)
.TP
.B
\fB-q\fP, \fB--quiet\fP
Quiet operation, no output shown
.TP
.B
\fB-V\fP, \fB--version\fP
Show program version and exit
.TP
.B
\fB-P\fP, \fB--progress\fP TYPE
Set progress indicator: test, number, dot, none
.TP
.B
\fB--pre-flight\fP COMMAND
Execute command before running the first test
.TP
.B
\fB--post-flight\fP COMMAND
Execute command after running the last test
.TP
.B
\fB--color\fP WHEN
Set when to use colors: auto, always, never
.TP
.B
\fB--diff\fP-\fIoptions\fP OPTIONS
Set diff command \fIoptions\fP (default: '\fB-u\fP')
.TP
.B
\fB--inline-prefix\fP PREFIX
Set inline output prefix (default: '#→ ')
.TP
.B
\fB--prefix\fP PREFIX
Set command line prefix (default: '')
.TP
.B
\fB--prompt\fP STRING
Set prompt string (default: '$ ')
.SH AUTHOR
The CLITEST was written by Aurelio Jargas <verde@aurelio.net>.
.PP
This manual page was written by Giovani Augusto Ferreira <giovani@riseup.net>
for the Debian project (but may be used by others).