From dd302372d8cdbe867c55bbea51f1f2a4842c3353 Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Sat, 21 Aug 2021 03:03:19 +0000 Subject: CTAN sync 202108210303 --- support/tikztosvg/README.md | 65 +++++++++++++++++++++++++++++---------------- 1 file changed, 42 insertions(+), 23 deletions(-) (limited to 'support/tikztosvg/README.md') diff --git a/support/tikztosvg/README.md b/support/tikztosvg/README.md index b8710da39f..97678fddfa 100644 --- a/support/tikztosvg/README.md +++ b/support/tikztosvg/README.md @@ -1,7 +1,7 @@ # tikztosvg(1) The `tikztosvg(1)` command renders TikZ diagrams to SVG, using -[XeTeX](http://xetex.sourceforge.net/) and +[TeXLive](https://tug.org/texlive/) and [pdf2svg](https://github.com/dawbarton/pdf2svg). ## Usage @@ -14,66 +14,77 @@ If *INPUT\_PATH* is set to *-* the input will be read from stdin. ### Options -**-o, --output**=*OUTPUT\_PATH* +**-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* +**-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* +**-l, \-\-library**=+*LIBRARY* Include `\usetikzlibrary{LIBRARY}` when rendering the diagram. -**-q, --quiet** +**-q, \-\-quiet** Silence application log messages and script warnings. -**-h, --help** +**\-\-lualatex** +Use [LuaTeX](http://luatex.org/) as the TeX engine. LuaTeX is already the +default, so this option doesn't really do much. + +**\-\-xelatex** +Use [XeTeX](http://xetex.sourceforge.net/) as the TeX engine. + +**\-\-pdflatex** +Use [pdfTeX](https://www.tug.org/applications/pdftex/) as the TeX engine. + +**-h, \-\-help** Print a help message. -**-v, --version** +**-v, \-\-version** Print version information. ## Example -Let’s say you want to convert the file `example.tikz` to SVG: +Let’s say you want to convert the file `example.tikz` to SVG ``` latex \begin{tikzcd} - G \arrow[r, "\varphi"] \arrow[d, "\psi"', two heads] & H \\ - \mathlarger{\sfrac{G}{\ker \varphi}} \arrow[ru, dotted] & + G \arrow{r}{\varphi} \arrow[two heads]{d} & H \\ + \mathlarger{\sfrac{G}{\ker \varphi}} \arrow[dotted]{ru} & \end{tikzcd} ``` -You could achieve this by running: +You could achieve this by running ``` sh -# xfrac and relsize are only there so that we can -# call \sfrac and \mathlarger +$ # xfrac and relsize are only there so that we can +$ # call \sfrac and \mathlarger $ tikztosvg -p xfrac -p relsize example.tikz ``` The results will be stored in the file `example.svg`. -## Installation +## Dependencies -The `tikztosvg(1)` command and it’s man page can be installed in Unix systems -by running - -``` sh -$ curl -s https://git.sr.ht/~pablo-pie/tikztosvg/blob/master/install.sh | sudo sh -``` +* A regular TeXLive installation: you'll need LuaTeX and optionally XeTeX and + pdfTeX +* pdf2svg -or it can be installed via Git with +## Installation +The `tikztosvg(1)` command and it’s man page can be installed in Unix systems +via Git by running ``` sh $ git clone https://git.sr.ht/~pablo-pie/tikztosvg $ cd tikztosvg $ sudo make install ``` -The executable is installed in `/usr/bin/` and the man-page is -installed in `/usr/share/man/man1/`. +The `BIN_TARGET` Make variable (defaults to `/usr/bin/`) controls the +directory the binary is installed in, while the `MAN_TARGET` Make variable +(defaults to `/usr/share/man/man1/`) controls the directory the man page +is installed in. ## Resources @@ -83,6 +94,14 @@ installed in `/usr/share/man/man1/`. **CTAN package:** +**TeXLive** + +**LuaTeX** + +**XeTeX** + +**pdfTeX** + ## Authors **tikztosvg** was written by [Pablo](mailto:pablo-escobar@riseup.net). -- cgit v1.2.3