| 1 |
.\" generated with Ronn/v0.7.3 |
| 2 |
.\" http://github.com/rtomayko/ronn/tree/0.7.3 |
| 3 |
. |
| 4 |
.TH "TEXTESTVIS" "1" "December 2023" "" "" |
| 5 |
. |
| 6 |
.SH "NAME" |
| 7 |
\fBtextestvis\fR \- visual regression tests for LaTeX |
| 8 |
. |
| 9 |
.SH "SYNOPSIS" |
| 10 |
\fBtextestvis\fR [\-cs] [\-e ENGINE] [\-d DENSITY] [PATTERN] |
| 11 |
. |
| 12 |
.P |
| 13 |
\fBtextestvis approve\fR [\-e ENGINE] [PATTERN] |
| 14 |
. |
| 15 |
.P |
| 16 |
\fBtextestvis compare\fR [\-d DENSITY] FILE FILE |
| 17 |
. |
| 18 |
.P |
| 19 |
\fBtextestvis perf\fR [\-cs] [\-e ENGINE] FILE |
| 20 |
. |
| 21 |
.SH "DESCRIPTION" |
| 22 |
Perform visual regression tests for LaTeX documents\. |
| 23 |
. |
| 24 |
.TP |
| 25 |
\fBtextestvis\fR |
| 26 |
Creates PDF files for all tex files matching the pattern and performs a visual regression test\. If no pattern is specified, all files in the current directory are tested except for files whose names begin with an underscore\. |
| 27 |
. |
| 28 |
.TP |
| 29 |
\fBtextestvis approve\fR |
| 30 |
Replaces the reference files with the test files\. |
| 31 |
. |
| 32 |
.TP |
| 33 |
\fBtextestvis compare\fR |
| 34 |
Creates a visual diff for two pdf files\. |
| 35 |
. |
| 36 |
.TP |
| 37 |
\fBtextestvis perf\fR |
| 38 |
Measures the time for creating a pdf file from the given tex file\. |
| 39 |
. |
| 40 |
.SH "OPTIONS" |
| 41 |
. |
| 42 |
.TP |
| 43 |
\fB\-c\fR |
| 44 |
Clears cache\. |
| 45 |
. |
| 46 |
.TP |
| 47 |
\fB\-s\fR |
| 48 |
Enables shell escape\. |
| 49 |
. |
| 50 |
.TP |
| 51 |
\fB\-d\fR \fIDENSITY\fR |
| 52 |
Sets density in ppi (default 72)\. |
| 53 |
. |
| 54 |
.TP |
| 55 |
\fB\-e\fR \fIENGINE\fR |
| 56 |
Sets latex engine (default xelatex)\. |
| 57 |
. |
| 58 |
.TP |
| 59 |
\fB\-\-help\fR |
| 60 |
Prints a help message\. |
| 61 |
. |
| 62 |
.TP |
| 63 |
\fB\-\-version\fR |
| 64 |
Prints version information\. |
| 65 |
. |
| 66 |
.SH "ENVIRONMENT" |
| 67 |
\fBtextestvis\fR requires ImageMagick 7\.0 or later\. |
| 68 |
. |
| 69 |
.SH "AUTHOR" |
| 70 |
\fBtextestvis\fR was written by Friedemann Bartels\. \fIhttps://github\.com/friedemannbartels\fR |
| 71 |
. |
| 72 |
.SH "LICENSE" |
| 73 |
Copyright (c) 2022\-2023 Friedemann Bartels\. Free use of this software is granted under the terms of the LaTeX Project Public License version 1\.3c or later\. |