summaryrefslogtreecommitdiff
path: root/support/tikztosvg/man
diff options
context:
space:
mode:
Diffstat (limited to 'support/tikztosvg/man')
-rw-r--r--support/tikztosvg/man/man.adoc69
-rw-r--r--support/tikztosvg/man/tikztosvg.1103
2 files changed, 172 insertions, 0 deletions
diff --git a/support/tikztosvg/man/man.adoc b/support/tikztosvg/man/man.adoc
new file mode 100644
index 0000000000..5c3bb734fc
--- /dev/null
+++ b/support/tikztosvg/man/man.adoc
@@ -0,0 +1,69 @@
+= tikzsvg(1)
+:doctype: manpage
+:man manual: TikzToSvg Manual
+:man source: TikzToSvg 0.1.0
+:page-layout: base
+
+== NAME
+
+tikzsvg - Render TikZ diagrams to SVG.
+
+== SYNOPSIS
+
+*tikzsvg* [_OPTION_]... _INPUT_PATH_
+
+== DESCRIPTION
+
+The tikzsvg(1) command renders TikZ diagrams to SVG.
+
+== 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*::
+ Prints version information.
+
+== ENVIRONMENT
+
+*TikzToSvg* requires _bash_, _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 Emílio Escobar Gavira <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 GitHub:* https://github.com/GarkGarcia/tikzsvg
+
+== COPYING
+
+Copyright \(C) 2020 Pablo Emílio Escobar Gaviria.
+Free use of this software is granted under the terms of the GPL-3.0 License.
+
diff --git a/support/tikztosvg/man/tikztosvg.1 b/support/tikztosvg/man/tikztosvg.1
new file mode 100644
index 0000000000..6ac4e5de93
--- /dev/null
+++ b/support/tikztosvg/man/tikztosvg.1
@@ -0,0 +1,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. \ No newline at end of file