Debian Codegraph @

texmf-dist/scripts/pagelayout/textestvis.1.md

raw
1 textestvis(1) -- visual regression tests for LaTeX
2 ====
3
4 ## SYNOPSIS
5
6 `textestvis` [-cs] [-e ENGINE] [-d DENSITY] [PATTERN]
7
8 `textestvis approve` [-e ENGINE] [PATTERN]
9
10 `textestvis compare` [-d DENSITY] FILE FILE
11
12 `textestvis perf` [-cs] [-e ENGINE] FILE
13
14 ## DESCRIPTION
15
16 Perform visual regression tests for LaTeX documents.
17
18 * `textestvis`:
19 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.
20
21 * `textestvis approve`:
22 Replaces the reference files with the test files.
23
24 * `textestvis compare`:
25 Creates a visual diff for two pdf files.
26
27 * `textestvis perf`:
28 Measures the time for creating a pdf file from the given tex file.
29
30 ## OPTIONS
31
32 * `-c`:
33 Clears cache.
34 * `-s`:
35 Enables shell escape.
36 * `-d` <DENSITY>:
37 Sets density in ppi (default 72).
38 * `-e` <ENGINE>:
39 Sets latex engine (default xelatex).
40 * `--help`:
41 Prints a help message.
42 * `--version`:
43 Prints version information.
44
45 ## ENVIRONMENT
46
47 `textestvis` requires ImageMagick 7.0 or later.
48
49 ## AUTHOR
50
51 `textestvis` was written by Friedemann Bartels. <https://github.com/friedemannbartels>
52
53 ## LICENSE
54
55 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.