summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/pagelayout/scripts/textestvis.1.md
blob: 00b475d93534555fa641e7066bfe72a9a9e6151c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
textestvis(1) -- visual regression tests for LaTeX
====

## SYNOPSIS

`textestvis` [-cs] [-e ENGINE] [-d DENSITY] [PATTERN]

`textestvis approve` [-e ENGINE] [PATTERN]

`textestvis compare` [-d DENSITY] FILE FILE

`textestvis perf` [-cs] [-e ENGINE] FILE

## DESCRIPTION

Perform visual regression tests for LaTeX documents.

* `textestvis`:
    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.

* `textestvis approve`:
    Replaces the reference files with the test files.

* `textestvis compare`:
    Creates a visual diff for two pdf files.

* `textestvis perf`:
    Measures the time for creating a pdf file from the given tex file.

## OPTIONS

* `-c`:
    Clears cache.
* `-s`:
    Enables shell escape.
* `-d` <DENSITY>:
    Sets density in ppi (default 72).
* `-e` <ENGINE>:
    Sets latex engine (default xelatex).
* `--help`:
    Prints a help message.
* `--version`:
    Prints version information.

## ENVIRONMENT

`textestvis` requires ImageMagick 7.0 or later.

## AUTHOR

`textestvis` was written by Friedemann Bartels. <https://github.com/friedemannbartels>

## LICENSE

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.