| 1 |
= tikztosvg(1) |
| 2 |
:doctype: manpage |
| 3 |
:man-manual: tikztosvg Manual |
| 4 |
:man-source: tikztosvg 0.3.0 |
| 5 |
:page-layout: base |
| 6 |
|
| 7 |
== NAME |
| 8 |
|
| 9 |
tikztosvg - Render TikZ diagrams to SVG. |
| 10 |
|
| 11 |
== SYNOPSIS |
| 12 |
|
| 13 |
*tikztosvg* [_OPTION_]... _INPUT_PATH_ |
| 14 |
|
| 15 |
== DESCRIPTION |
| 16 |
|
| 17 |
The tikztosvg(1) command renders TikZ diagrams to SVG. |
| 18 |
|
| 19 |
If _INPUT_PATH_ is set to _-_ the input will be read from stdin. |
| 20 |
|
| 21 |
== OPTIONS |
| 22 |
|
| 23 |
*-o, --output*=_OUTPUT_PATH_:: |
| 24 |
Write output to file _OUTPUT_PATH_. |
| 25 |
If set to _-_ the output will be written to stdout. |
| 26 |
Defaults to the base name of the input file suffixed with the _.svg_ |
| 27 |
extension. The file is resolved relative to the working directory. |
| 28 |
|
| 29 |
*-p, --package*=+_PACKAGE_:: |
| 30 |
Include _\usepackage{PACKAGE}_ when rendering the diagram. The tikz, tikz-cd, |
| 31 |
pgfplots, amsmath and amssymb packages are always included by default. |
| 32 |
|
| 33 |
*-l, --library*=+_LIBRARY:: |
| 34 |
Include _\usetikzlibrary{LIBRARY}_ when rendering the diagram. |
| 35 |
|
| 36 |
*-q, --quiet*:: |
| 37 |
Silence application log messages and script warnings. |
| 38 |
|
| 39 |
*--lualatex*:: |
| 40 |
Use LuaTeX as the TeX engine. LuaTeX is already the |
| 41 |
default, so this option doesn't really do much. |
| 42 |
|
| 43 |
*--xelatex*:: |
| 44 |
Use XeTeX as the TeX engine. |
| 45 |
|
| 46 |
*--pdflatex*:: |
| 47 |
Use pdfTeX as the TeX engine. |
| 48 |
|
| 49 |
*-h, --help*:: |
| 50 |
Print a help message. |
| 51 |
|
| 52 |
*-v, --version*:: |
| 53 |
Prints version information. |
| 54 |
|
| 55 |
== ENVIRONMENT |
| 56 |
|
| 57 |
*tikztosvg* requires XeTeX and pdf2svg to be installed. Make sure |
| 58 |
any additional LaTeX packages are installed before using them in a diagram. |
| 59 |
|
| 60 |
== EXIT STATUS |
| 61 |
|
| 62 |
*0*:: |
| 63 |
Success. |
| 64 |
|
| 65 |
*1*:: |
| 66 |
Failure (syntax or usage error; configuration error). |
| 67 |
|
| 68 |
*[n]*:: |
| 69 |
Failure (document processing failure). |
| 70 |
|
| 71 |
== AUTHORS |
| 72 |
|
| 73 |
*tikztosvg* was written by Pablo <[email protected]>. |
| 74 |
|
| 75 |
*pdf2svg* was written by David Barton <[email protected]> and |
| 76 |
Matthew Flaschen <[email protected]>. |
| 77 |
|
| 78 |
== RESOURCES |
| 79 |
|
| 80 |
Git source repository on sourcehut:: https://git.sr.ht/~pablo-pie/tikztosvg |
| 81 |
Bug tracker:: https://todo.sr.ht/~pablo-pie/tikztosvg |
| 82 |
CTAN package:: https://www.ctan.org/pkg/tikztosvg |
| 83 |
TeXLive:: https://tug.org/texlive/ |
| 84 |
LuaTeX:: http://luatex.org/ |
| 85 |
XeTeX:: http://xetex.sourceforge.net/ |
| 86 |
|
| 87 |
**pdfTeX** <https://www.tug.org/applications/pdftex/> |
| 88 |
|
| 89 |
|
| 90 |
== COPYING |
| 91 |
|
| 92 |
Copyright \(C) 2021 Pablo. |
| 93 |
Free use of this software is granted under the terms of the GPL-3.0 License. |
| 94 |
|