diff options
Diffstat (limited to 'support/tikztosvg/man')
| -rw-r--r-- | support/tikztosvg/man/man.adoc | 18 | ||||
| -rw-r--r-- | support/tikztosvg/man/tikztosvg.1 | 26 |
2 files changed, 26 insertions, 18 deletions
diff --git a/support/tikztosvg/man/man.adoc b/support/tikztosvg/man/man.adoc index 5c3bb734fc..5a8a4bf7f6 100644 --- a/support/tikztosvg/man/man.adoc +++ b/support/tikztosvg/man/man.adoc @@ -1,7 +1,7 @@ = tikzsvg(1) :doctype: manpage -:man manual: TikzToSvg Manual -:man source: TikzToSvg 0.1.0 +:man-manual: tikztosvg Manual +:man-source: tikztosvg 0.1.2 :page-layout: base == NAME @@ -16,10 +16,13 @@ tikzsvg - Render TikZ diagrams to SVG. The tikzsvg(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. @@ -37,7 +40,7 @@ The tikzsvg(1) command renders TikZ diagrams to SVG. == ENVIRONMENT -*TikzToSvg* requires _bash_, _xetex_ and _pdf2svg_ to be installed. Make sure +*tikztosvg* requires _xetex_ and _pdf2svg_ to be installed. Make sure any additional LaTeX packages are installed before using them in a diagram. == EXIT STATUS @@ -48,22 +51,23 @@ any additional LaTeX packages are installed before using them in a diagram. *1*:: Failure (syntax or usage error; configuration error). -*n*:: +*[n]*:: Failure (document processing failure). == AUTHORS -*TikzToSvg* was written by Pablo Emílio Escobar Gavira <pablo-escobar@riseup.net>. +*tikztosvg* was written by Pablo Emilio Escobar Gaviria +<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 +*Git source repository on GitLab:* https://gitlab.com/pablo-escobar/tikztosvg == COPYING -Copyright \(C) 2020 Pablo Emílio Escobar Gaviria. +Copyright \(C) 2020 Pablo Emilio 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 index 6ac4e5de93..da35ddbdcc 100644 --- a/support/tikztosvg/man/tikztosvg.1 +++ b/support/tikztosvg/man/tikztosvg.1 @@ -1,13 +1,13 @@ '\" 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 +.\" Generator: Asciidoctor 2.0.10 +.\" Date: 2020-08-16 +.\" Manual: \ \& +.\" Source: \ \& .\" Language: English .\" -.TH "TIKZSVG" "1" "2020-05-11" "TikzToSvg 0.1.0" "TikzToSvg Manual" +.TH "TIKZSVG" "1" "2020-08-16" "\ \&" "\ \&" .ie \n(.g .ds Aq \(aq .el .ds Aq ' .ss \n[.ss] 0 @@ -35,11 +35,14 @@ tikzsvg \- Render TikZ diagrams to SVG. .SH "DESCRIPTION" .sp The tikzsvg(1) command renders TikZ diagrams to SVG. +.sp +If \fIINPUT_PATH\fP is set to \fI\-\fP the input will be read from stdin. .SH "OPTIONS" .sp \fB\-o, \-\-output\fP=\fIOUTPUT_PATH\fP .RS 4 Write output to file \fIOUTPUT_PATH\fP. +If set to \fI\-\fP the output will be written to stdout. 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 @@ -65,7 +68,7 @@ Prints version information. .RE .SH "ENVIRONMENT" .sp -\fBTikzToSvg\fP requires \fIbash\fP, \fIxetex\fP and \fIpdf2svg\fP to be installed. Make sure +\fBtikztosvg\fP requires \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 @@ -79,13 +82,14 @@ Success. Failure (syntax or usage error; configuration error). .RE .sp -\fBn\fP +\fB[n]\fP .RS 4 Failure (document processing failure). .RE .SH "AUTHORS" .sp -\fBTikzToSvg\fP was written by Pablo Emílio Escobar Gavira <\c +\fBtikztosvg\fP was written by Pablo Emilio Escobar Gaviria +<\c .MTO "pablo\-escobar\(atriseup.net" "" ">." .sp \fBpdf2svg\fP was written by David Barton <\c @@ -95,9 +99,9 @@ Matthew Flaschen <\c .MTO "matthew.flaschen\(atgatech.edu" "" ">." .SH "RESOURCES" .sp -\fBGit source repository on GitHub:\fP \c -.URL "https://github.com/GarkGarcia/tikzsvg" "" "" +\fBGit source repository on GitLab:\fP \c +.URL "https://gitlab.com/pablo\-escobar/tikztosvg" "" "" .SH "COPYING" .sp -Copyright (C) 2020 Pablo Emílio Escobar Gaviria. +Copyright (C) 2020 Pablo Emilio Escobar Gaviria. Free use of this software is granted under the terms of the GPL\-3.0 License.
\ No newline at end of file |