summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.tex')
-rw-r--r--Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.tex49
1 files changed, 49 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.tex b/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.tex
new file mode 100644
index 00000000000..3655b96c1d1
--- /dev/null
+++ b/Master/texmf-dist/doc/luatex/lua-visual-debug/lvdebug-doc.tex
@@ -0,0 +1,49 @@
+\documentclass{article}
+\usepackage{graphicx,listings,lmodern}
+\newcommand\LuaLaTeX{Lua\LaTeX}
+
+\newcommand*\pgsmall{\fontsize{8.5}{8.7}\selectfont\ttfamily}
+\lstset{basicstyle=\pgsmall,
+ basewidth=0.55em,
+ columns=fullflexible,
+ breakautoindent=true,
+ breaklines=true,
+ prebreak=,
+ postbreak=\mbox{$\hookrightarrow$},
+}
+
+\begin{document}
+\title{The lua-visual-debug package (V0.2)}
+\author{Patrick Gundlach}
+% \address{patrick@gundla.ch}
+\maketitle
+\section{About}
+
+This package aids debugging your \TeX\ and \LaTeX\ document by drawing rectangles around boxes and rules where glue is inserted. Other items are marked as well: kerns, hyphenation points and penalties.
+
+\section{How to use}
+
+When you load the package \texttt{lua-visual-debug} in your \LuaLaTeX\ document (or use \verb|\input lua-visual-debug.sty| in plain \TeX), Lua\TeX\ will highlight boxes, penalties, glues and kerns in the PDF. This package requires you to process the document with \LaTeX\ (plain and LaTeX formats).
+
+\section{A \LaTeX\ example}
+\lstinputlisting[language=tex]{sample.tex}
+
+\noindent yields \vspace{5mm}
+
+\noindent \includegraphics[width=\textwidth]{sample-crop.pdf}
+
+\section{A plain \TeX\ example}
+
+\lstinputlisting[language=tex]{sample-plain.tex}
+
+\noindent yields \vspace{5mm}
+
+\noindent \includegraphics{sample-plain-crop.pdf}
+
+
+\section{Copying}
+
+Copyright 2012 Patrick Gundlach (patrick@gundla.ch), licensed under the MIT license. See the Lua file for details.
+
+
+\end{document}