summaryrefslogtreecommitdiff
path: root/support/tikztosvg/README.md
blob: 683461931e13a0dea1d1fe46ac4f5389020d5001 (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
# tikztosvg(1)
Pablo Emílio Escobar Gaviria <pablo-escobar@riseup.net>

The `tikztosvg(1)` command renders TikZ diagrams to SVG, using 
[`bash`](https://www.gnu.org/software/bash/), [`xetex`](http://xetex.sourceforge.net/) and 
[`pdf2svg`](https://github.com/dawbarton/pdf2svg).

## Usage

```
tikztosvg [OPTION]... INPUT_PATH
```

### Options

**-o, --output=OUTPUT_PATH**
* Write output to file *OUTPUT_PATH*.
  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.

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

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

**-v, --version**
* Print version information.

## Example

Let's say you want to convert the file `exemple.tikz` to SVG:

```tex
\begin{tikzcd}
    G \arrow[r, "\varphi"] \arrow[d, "\psi"', two heads] & H \\
    \sfrac{G}{\ker \varphi} \arrow[ru, dotted]           &  
\end{tikzcd}
```

You could achieve that by running the following command:

```
tikztosvg -p tikz-cd -p xfrac example.tikz
```

The results will be stored in the file `example.svg`:

![example](https://github.com/GarkGarcia/tikztosvg/raw/master/example/example.svg)

## Installation

The `tikztosvg(1)` command and it's man page can be installed in Unix systems by 
running:

```
$ curl -s https://raw.githubusercontent.com/GarkGarcia/tikztosvg/master/install.sh | sudo sh
```

The executable is installed in `$HOME/.local/bin/` and the man-page is 
installed in `$HOME/.local/share/man/man1/`.

## Authors

**TikzToSvg** was written by 
[Pablo Emílio Escobar Gavira](mailto:pablo-escobar@riseup.net).

**pdf2svg** was written by [David Barton](mailto:davebarton@cityinthesky.co.uk) 
and [Matthew Flaschen](mailto:matthew.flaschen@gatech.edu).

## License

© 2020 Pablo Emílio Escobar Gaviria.

Free use of this software is granted under the terms of the GPL-3.0 License.