summaryrefslogtreecommitdiff
path: root/support/tikztosvg/man/tikztosvg.1
blob: 6ac4e5de939642bfadda5d214769aac50c8a3ca6 (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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
'\" t
.\"     Title: tikzsvg
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 1.5.8
.\"      Date: 2020-05-11
.\"    Manual: TikzToSvg Manual
.\"    Source: TikzToSvg 0.1.0
.\"  Language: English
.\"
.TH "TIKZSVG" "1" "2020-05-11" "TikzToSvg 0.1.0" "TikzToSvg Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
tikzsvg \- Render TikZ diagrams to SVG.
.SH "SYNOPSIS"
.sp
\fBtikzsvg\fP [\fIOPTION\fP]... \fIINPUT_PATH\fP
.SH "DESCRIPTION"
.sp
The tikzsvg(1) command renders TikZ diagrams to SVG.
.SH "OPTIONS"
.sp
\fB\-o, \-\-output\fP=\fIOUTPUT_PATH\fP
.RS 4
Write output to file \fIOUTPUT_PATH\fP.
Defaults to the base name of the input file suffixed with the \fI.svg\fP
extension. The file is resolved relative to the working directory.
.RE
.sp
\fB\-p, \-\-package\fP=+\fIPACKAGE\fP
.RS 4
Include \fI\(rsusepackage{PACKAGE}\fP when rendering the diagram.
.RE
.sp
\fB\-q, \-\-quiet\fP
.RS 4
Silence application log messages and script warnings.
.RE
.sp
\fB\-h, \-\-help\fP
.RS 4
Print a help message.
.RE
.sp
\fB\-v, \-\-version\fP
.RS 4
Prints version information.
.RE
.SH "ENVIRONMENT"
.sp
\fBTikzToSvg\fP requires \fIbash\fP, \fIxetex\fP and \fIpdf2svg\fP to be installed. Make sure
any additional LaTeX packages are installed before using them in a diagram.
.SH "EXIT STATUS"
.sp
\fB0\fP
.RS 4
Success.
.RE
.sp
\fB1\fP
.RS 4
Failure (syntax or usage error; configuration error).
.RE
.sp
\fBn\fP
.RS 4
Failure (document processing failure).
.RE
.SH "AUTHORS"
.sp
\fBTikzToSvg\fP was written by Pablo Emílio Escobar Gavira <\c
.MTO "pablo\-escobar\(atriseup.net" "" ">."
.sp
\fBpdf2svg\fP was written by David Barton <\c
.MTO "davebarton\(atcityinthesky.co.uk" "" ">"
and
Matthew Flaschen <\c
.MTO "matthew.flaschen\(atgatech.edu" "" ">."
.SH "RESOURCES"
.sp
\fBGit source repository on GitHub:\fP \c
.URL "https://github.com/GarkGarcia/tikzsvg" "" ""
.SH "COPYING"
.sp
Copyright (C) 2020 Pablo Emílio Escobar Gaviria.
Free use of this software is granted under the terms of the GPL\-3.0 License.