summaryrefslogtreecommitdiff
path: root/support/tikztosvg/man/man.adoc
blob: 5f2e5554cf0f69d7857fe92fdd314e743fb22b65 (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
= tikztosvg(1)
:doctype: manpage
:man-manual: tikztosvg Manual
:man-source: tikztosvg 0.2.0
:page-layout: base

== NAME

tikztosvg - Render TikZ diagrams to SVG.

== SYNOPSIS

*tikztosvg* [_OPTION_]... _INPUT_PATH_

== DESCRIPTION

The tikztosvg(1) command renders TikZ diagrams to SVG.

If _INPUT_PATH_ is set to _-_ the input will be read from stdin.

== OPTIONS

*-o, --output*=_OUTPUT_PATH_::
  Write output to file _OUTPUT_PATH_.
  If set to _-_ the output will be written to stdout.
  Defaults to the base name of the input file suffixed with the _.svg_ 
  extension. The file is resolved relative to the working directory.

*-p, --package*=+_PACKAGE_::
  Include _\usepackage{PACKAGE}_ when rendering the diagram. The tikz, tikz-cd,
pgfplots, amsmath and amssymb packages are always included by default.

*-l, --library*=+_LIBRARY::
  Include _\usetikzlibrary{LIBRARY}_ when rendering the diagram.

*-q, --quiet*::
  Silence application log messages and script warnings.

*-h, --help*::
  Print a help message.

*-v, --version*::
  Prints version information.

== ENVIRONMENT

*tikztosvg* requires XeTeX and pdf2svg to be installed. Make sure 
any additional LaTeX packages are installed before using them in a diagram.

== EXIT STATUS

*0*::
  Success.

*1*::
  Failure (syntax or usage error; configuration error).

*[n]*::
  Failure (document processing failure).

== AUTHORS

*tikztosvg* was written by Pablo <pablo-escobar@riseup.net>.

*pdf2svg* was written by David Barton <davebarton@cityinthesky.co.uk> and 
Matthew Flaschen <matthew.flaschen@gatech.edu>.

== RESOURCES

*Git source repository on sourcehut:* https://git.sr.ht/~pablo-pie/tikztosvg

== COPYING

Copyright \(C) 2021 Pablo.
Free use of this software is granted under the terms of the GPL-3.0 License.