diff options
author | Norbert Preining <norbert@preining.info> | 2020-08-17 03:00:53 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2020-08-17 03:00:53 +0000 |
commit | 50a9f2d0b130f011b55cf5a93d5282ac9e92c2e3 (patch) | |
tree | d42295221fbe622608c0acd9898b10963ea1e552 /support/tikztosvg/README.md | |
parent | 774981e6b2a6a0bb37b56e4b78d772fdb954876e (diff) |
CTAN sync 202008170300
Diffstat (limited to 'support/tikztosvg/README.md')
-rw-r--r-- | support/tikztosvg/README.md | 66 |
1 files changed, 27 insertions, 39 deletions
diff --git a/support/tikztosvg/README.md b/support/tikztosvg/README.md index 683461931e..ac986ae747 100644 --- a/support/tikztosvg/README.md +++ b/support/tikztosvg/README.md @@ -1,79 +1,67 @@ # 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). +Pablo Emilio Escobar Gaviria <<pablo-escobar@riseup.net>> + +The `tikztosvg(1)` command renders TikZ diagrams to SVG, using [`xetex`](http://xetex.sourceforge.net/) and [`pdf2svg`](https://github.com/dawbarton/pdf2svg). ## Usage -``` -tikztosvg [OPTION]... INPUT_PATH -``` + tikztosvg [OPTION]... INPUT_PATH + +If *INPUT\_PATH* is set to *-* the input will be read from stdin. ### 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. +**-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. +**-p, --package**=+*PACKAGE* +Include `\usepackage{PACKAGE}` when rendering the diagram. -**-q, --quiet** -* Silence application log messages and script warnings. +**-q, --quiet** +Silence application log messages and script warnings. -**-h, --help** -* Print a help message. +**-h, --help** +Print a help message. -**-v, --version** -* Print version information. +**-v, --version** +Print version information. ## Example -Let's say you want to convert the file `exemple.tikz` to SVG: +Let’s say you want to convert the file `example.tikz` to SVG: -```tex +``` latex \begin{tikzcd} G \arrow[r, "\varphi"] \arrow[d, "\psi"', two heads] & H \\ - \sfrac{G}{\ker \varphi} \arrow[ru, dotted] & + \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 -``` + 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) +![example](examples/example.svg) ## Installation -The `tikztosvg(1)` command and it's man page can be installed in Unix systems by -running: +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 -``` + $ curl -s https://gitlab.com/pablo-escobar/tikztosvg/-/raw/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/`. +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). +**tikztosvg** was written by [Pablo Emilio Escobar Gaviria](mailto:pablo-escobar@riseup.net). -**pdf2svg** was written by [David Barton](mailto:davebarton@cityinthesky.co.uk) -and [Matthew Flaschen](mailto:matthew.flaschen@gatech.edu). +**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. +© 2020 Pablo Emilio Escobar Gaviria. Free use of this software is granted under the terms of the GPL-3.0 License. - |