| 1 |
'\" t |
| 2 |
.\" Title: tikztosvg |
| 3 |
.\" Author: [see the "AUTHOR(S)" section] |
| 4 |
.\" Generator: Asciidoctor 2.0.16 |
| 5 |
.\" Date: 2021-08-19 |
| 6 |
.\" Manual: \ \& |
| 7 |
.\" Source: \ \& |
| 8 |
.\" Language: English |
| 9 |
.\" |
| 10 |
.TH "TIKZTOSVG" "1" "2021-08-19" "\ \&" "\ \&" |
| 11 |
.ie \n(.g .ds Aq \(aq |
| 12 |
.el .ds Aq ' |
| 13 |
.ss \n[.ss] 0 |
| 14 |
.nh |
| 15 |
.ad l |
| 16 |
.de URL |
| 17 |
\fI\\$2\fP <\\$1>\\$3 |
| 18 |
.. |
| 19 |
.als MTO URL |
| 20 |
.if \n[.g] \{\ |
| 21 |
. mso www.tmac |
| 22 |
. am URL |
| 23 |
. ad l |
| 24 |
. . |
| 25 |
. am MTO |
| 26 |
. ad l |
| 27 |
. . |
| 28 |
. LINKSTYLE blue R < > |
| 29 |
.\} |
| 30 |
.SH "NAME" |
| 31 |
tikztosvg \- Render TikZ diagrams to SVG. |
| 32 |
.SH "SYNOPSIS" |
| 33 |
.sp |
| 34 |
\fBtikztosvg\fP [\fIOPTION\fP]... \fIINPUT_PATH\fP |
| 35 |
.SH "DESCRIPTION" |
| 36 |
.sp |
| 37 |
The tikztosvg(1) command renders TikZ diagrams to SVG. |
| 38 |
.sp |
| 39 |
If \fIINPUT_PATH\fP is set to \fI\-\fP the input will be read from stdin. |
| 40 |
.SH "OPTIONS" |
| 41 |
.sp |
| 42 |
\fB\-o, \-\-output\fP=\fIOUTPUT_PATH\fP |
| 43 |
.RS 4 |
| 44 |
Write output to file \fIOUTPUT_PATH\fP. |
| 45 |
If set to \fI\-\fP the output will be written to stdout. |
| 46 |
Defaults to the base name of the input file suffixed with the \fI.svg\fP |
| 47 |
extension. The file is resolved relative to the working directory. |
| 48 |
.RE |
| 49 |
.sp |
| 50 |
\fB\-p, \-\-package\fP=+\fIPACKAGE\fP |
| 51 |
.RS 4 |
| 52 |
Include \fI\(rsusepackage{PACKAGE}\fP when rendering the diagram. The tikz, tikz\-cd, |
| 53 |
pgfplots, amsmath and amssymb packages are always included by default. |
| 54 |
.RE |
| 55 |
.sp |
| 56 |
\fB\-l, \-\-library\fP=+_LIBRARY |
| 57 |
.RS 4 |
| 58 |
Include \fI\(rsusetikzlibrary{LIBRARY}\fP when rendering the diagram. |
| 59 |
.RE |
| 60 |
.sp |
| 61 |
\fB\-q, \-\-quiet\fP |
| 62 |
.RS 4 |
| 63 |
Silence application log messages and script warnings. |
| 64 |
.RE |
| 65 |
.sp |
| 66 |
\fB\-\-lualatex\fP |
| 67 |
.RS 4 |
| 68 |
Use LuaTeX as the TeX engine. LuaTeX is already the |
| 69 |
default, so this option doesn\(cqt really do much. |
| 70 |
.RE |
| 71 |
.sp |
| 72 |
\fB\-\-xelatex\fP |
| 73 |
.RS 4 |
| 74 |
Use XeTeX as the TeX engine. |
| 75 |
.RE |
| 76 |
.sp |
| 77 |
\fB\-\-pdflatex\fP |
| 78 |
.RS 4 |
| 79 |
Use pdfTeX as the TeX engine. |
| 80 |
.RE |
| 81 |
.sp |
| 82 |
\fB\-h, \-\-help\fP |
| 83 |
.RS 4 |
| 84 |
Print a help message. |
| 85 |
.RE |
| 86 |
.sp |
| 87 |
\fB\-v, \-\-version\fP |
| 88 |
.RS 4 |
| 89 |
Prints version information. |
| 90 |
.RE |
| 91 |
.SH "ENVIRONMENT" |
| 92 |
.sp |
| 93 |
\fBtikztosvg\fP requires XeTeX and pdf2svg to be installed. Make sure |
| 94 |
any additional LaTeX packages are installed before using them in a diagram. |
| 95 |
.SH "EXIT STATUS" |
| 96 |
.sp |
| 97 |
\fB0\fP |
| 98 |
.RS 4 |
| 99 |
Success. |
| 100 |
.RE |
| 101 |
.sp |
| 102 |
\fB1\fP |
| 103 |
.RS 4 |
| 104 |
Failure (syntax or usage error; configuration error). |
| 105 |
.RE |
| 106 |
.sp |
| 107 |
\fB[n]\fP |
| 108 |
.RS 4 |
| 109 |
Failure (document processing failure). |
| 110 |
.RE |
| 111 |
.SH "AUTHORS" |
| 112 |
.sp |
| 113 |
\fBtikztosvg\fP was written by Pablo \c |
| 114 |
.MTO "pablo\-escobar\(atriseup.net" "" "." |
| 115 |
.sp |
| 116 |
\fBpdf2svg\fP was written by David Barton \c |
| 117 |
.MTO "davebarton\(atcityinthesky.co.uk" "" "" |
| 118 |
and |
| 119 |
Matthew Flaschen \c |
| 120 |
.MTO "matthew.flaschen\(atgatech.edu" "" "." |
| 121 |
.SH "RESOURCES" |
| 122 |
.sp |
| 123 |
Git source repository on sourcehut |
| 124 |
.RS 4 |
| 125 |
.URL "https://git.sr.ht/~pablo\-pie/tikztosvg" "" "" |
| 126 |
.RE |
| 127 |
.sp |
| 128 |
Bug tracker |
| 129 |
.RS 4 |
| 130 |
.URL "https://todo.sr.ht/~pablo\-pie/tikztosvg" "" "" |
| 131 |
.RE |
| 132 |
.sp |
| 133 |
CTAN package |
| 134 |
.RS 4 |
| 135 |
.URL "https://www.ctan.org/pkg/tikztosvg" "" "" |
| 136 |
.RE |
| 137 |
.sp |
| 138 |
TeXLive |
| 139 |
.RS 4 |
| 140 |
.URL "https://tug.org/texlive/" "" "" |
| 141 |
.RE |
| 142 |
.sp |
| 143 |
LuaTeX |
| 144 |
.RS 4 |
| 145 |
.URL "http://luatex.org/" "" "" |
| 146 |
.RE |
| 147 |
.sp |
| 148 |
XeTeX |
| 149 |
.RS 4 |
| 150 |
.URL "http://xetex.sourceforge.net/" "" "" |
| 151 |
.RE |
| 152 |
.sp |
| 153 |
\fBpdfTeX\fP \c |
| 154 |
.URL "https://www.tug.org/applications/pdftex/" "" "" |
| 155 |
.SH "COPYING" |
| 156 |
.sp |
| 157 |
Copyright (C) 2021 Pablo. |
| 158 |
Free use of this software is granted under the terms of the GPL\-3.0 License. |