summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/lua-visual-debug/doc/README.md
blob: 0e07af14c1edd126359e80802719324873b798e1 (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
Visual debugging for LuaTeX
===========================

The LuaTeX package `lua-visual-debug` shows boxes, glues, kerns and penalties in the PDF output.

Usage:

LaTeX:

    \usepackage{lua-visual-debug}

or (plain)

    \input lua-visual-debug.sty



Requirements: The package has only been tested with LuaTeX and
  the formats plain and LaTeX. Other formats might work as well,
  but other engines only show a warning message.


Copyright 2012–2021 Patrick Gundlach (<patrick@gundla.ch>) and others (see Git information)

Package version: 0.8

Public repository: <https://github.com/pgundlach/lvdebug>

Licensed under the MIT license. See the Lua file for details.

The idea is heavily inspired by Hans Hagen's <http://pragma-ade.com/articles/art-visi.pdf>


Example output
--------------

<p align="center"><img width="300px" src="https://i.imgur.com/S78jTxb.png"></p>