summaryrefslogtreecommitdiff
path: root/dviware/dvisvgm/doc
diff options
context:
space:
mode:
Diffstat (limited to 'dviware/dvisvgm/doc')
-rw-r--r--dviware/dvisvgm/doc/Makefile.in1
-rw-r--r--dviware/dvisvgm/doc/dvisvgm.116
-rw-r--r--dviware/dvisvgm/doc/dvisvgm.txt.in39
3 files changed, 30 insertions, 26 deletions
diff --git a/dviware/dvisvgm/doc/Makefile.in b/dviware/dvisvgm/doc/Makefile.in
index 3ec7a8cac2..b5be695f04 100644
--- a/dviware/dvisvgm/doc/Makefile.in
+++ b/dviware/dvisvgm/doc/Makefile.in
@@ -186,7 +186,6 @@ CODE_COVERAGE_CPPFLAGS = @CODE_COVERAGE_CPPFLAGS@
CODE_COVERAGE_CXXFLAGS = @CODE_COVERAGE_CXXFLAGS@
CODE_COVERAGE_ENABLED = @CODE_COVERAGE_ENABLED@
CODE_COVERAGE_LIBS = @CODE_COVERAGE_LIBS@
-CPP = @CPP@
CPPFLAGS = @CPPFLAGS@
CSCOPE = @CSCOPE@
CTAGS = @CTAGS@
diff --git a/dviware/dvisvgm/doc/dvisvgm.1 b/dviware/dvisvgm/doc/dvisvgm.1
index dbcd907ab5..8e6814b7e6 100644
--- a/dviware/dvisvgm/doc/dvisvgm.1
+++ b/dviware/dvisvgm/doc/dvisvgm.1
@@ -2,12 +2,12 @@
.\" Title: dvisvgm
.\" Author: Martin Gieseking <martin.gieseking@uos.de>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 2024-01-06
+.\" Date: 2024-02-04
.\" Manual: dvisvgm Manual
-.\" Source: dvisvgm 3.2
+.\" Source: dvisvgm 3.2.2
.\" Language: English
.\"
-.TH "DVISVGM" "1" "2024\-01\-06" "dvisvgm 3\&.2" "dvisvgm Manual"
+.TH "DVISVGM" "1" "2024\-02\-04" "dvisvgm 3\&.2\&.2" "dvisvgm Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-dvisvgm \- converts DVI and EPS files to the XML\-based SVG format
+dvisvgm \- converts DVI, EPS, and PDF files to the XML\-based SVG format
.SH "SYNOPSIS"
.sp
\fBdvisvgm\fR [\fIoptions\fR] \fIfile\fR[\&.dvi]
@@ -1283,9 +1283,11 @@ attributes are omitted\&.
.RE
.SH "SUPPORTED SPECIALS"
.sp
-dvisvgm supports several \fIspecial commands\fR that enrich the DVI command set with additional instructions for features, like color, graphics, and hyperlinks\&. The term \fIspecial command\fR, or just \fIspecial\fR, originates from the TeX command \fB\especial{\&...}\fR which does almost nothing\&. TeX only forwards the whole command to the DVI file and delegates its execution to the DVI driver\&. The DVI driver can then decide to either process or ignore it, depending on the supported statements\&. The parameter of TeX\(cqs \fB\especial\fR command is given in curly braces and may consist of an arbitrary character sequence representing the actual instruction, for example \fBcolor Red\fR\&.
+dvisvgm supports several \fIspecial commands\fR that enrich the DVI command set with additional instructions for features, like color, graphics, and hyperlinks\&. The term \fIspecial command\fR, or just \fIspecial\fR, originates from the TeX command \fB\especial{\&...}\fR which does almost nothing\&. TeX only forwards the argument of this command to the DVI file using the corresponding \fIxxx\fR opcode, thus delegating its execution to the DVI driver\&. The driver can then decide to either process or ignore it, depending on the supported statements\&. The parameter of TeX\(cqs \fB\especial\fR command is given in curly braces and may consist of an arbitrary character sequence representing the actual instruction, for example \fBcolor Red\fR\&.
.sp
-dvisvgm delegates the evaluation of special commands to dedicated handlers\&. Each handler is responsible for all special statements of the same command set, i\&.e\&. commands usually \(en but not necessarily \(en beginning with a common prefix\&. For example, all PDF specials start with the prefix \fBpdf:\fR, while the TPIC special set consists of 13 different commands without common identifier\&. The PDF specials are processed by dvisvgm\(cqs \fIpdf\fR handler, the TPIC ones by the \fItpic\fR handler\&. To get a list of the actually provided special handlers, use option \fB\-\-list\-specials\fR (see above)\&. The following list gives an overview of the special sets currently supported\&. The names of the handlers can also be used to disable the processing of individual sets of specials\&. For further information on this, see option \fB\-\-no\-specials\fR\&.
+It might be worth mentioning that specials are only evaluated when processing DVI files\&. PS/EPS and PDF don\(cqt know anything about the concept of specials and therefore don\(cqt provide means to represent them\&.
+.sp
+In order to evaluate the special commands, dvisvgm implements several dedicated handlers\&. Each handler is responsible for all special statements belonging to the same command set, i\&.e\&. commands usually \(en but not necessarily \(en beginning with a common prefix\&. For example, all PDF specials start with the prefix \fBpdf:\fR, while the TPIC special set consists of 13 different commands without common identifier\&. The PDF specials are processed by dvisvgm\(cqs \fIpdf\fR handler, the TPIC ones by the \fItpic\fR handler\&. To get a list of the actually provided special handlers, use option \fB\-\-list\-specials\fR (see above)\&. The following list gives an overview of the special sets currently supported\&. The names of the handlers can also be used to disable the processing of individual sets of specials\&. For further information on this, see option \fB\-\-no\-specials\fR\&.
.PP
\fBbgcolor\fR
.RS 4
@@ -1302,7 +1304,7 @@ Statements of this command set provide instructions to change the text/paint col
.PP
\fBdvisvgm\fR
.RS 4
-dvisvgm offers its own small set of specials\&. The following list gives a brief overview\&.
+The following list gives a brief overview of dvisvgm\(cqs own set of currently supported specials\&.
.PP
\fBdvisvgm:raw\fR \fItext\fR
.RS 4
diff --git a/dviware/dvisvgm/doc/dvisvgm.txt.in b/dviware/dvisvgm/doc/dvisvgm.txt.in
index db5b48a35b..f055998145 100644
--- a/dviware/dvisvgm/doc/dvisvgm.txt.in
+++ b/dviware/dvisvgm/doc/dvisvgm.txt.in
@@ -22,11 +22,11 @@ Martin Gieseking <@PACKAGE_BUGREPORT@>
:man source: dvisvgm
:man version: @VERSION@
:man manual: dvisvgm Manual
-:revdate: 2024-01-06 14:30 +0100
+:revdate: 2024-02-04 15:33 +0100
Name
----
-dvisvgm - converts DVI and EPS files to the XML-based SVG format
+dvisvgm - converts DVI, EPS, and PDF files to the XML-based SVG format
Synopsis
@@ -785,20 +785,23 @@ Supported Specials
------------------
dvisvgm supports several 'special commands' that enrich the DVI command set with additional instructions
for features, like color, graphics, and hyperlinks. The term 'special command', or just 'special', originates
-from the TeX command +\special{...}+ which does almost nothing. TeX only forwards the whole command to the
-DVI file and delegates its execution to the DVI driver. The DVI driver can then decide to either process or
-ignore it, depending on the supported statements. The parameter of TeX's +\special+ command is given in curly
-braces and may consist of an arbitrary character sequence representing the actual instruction, for example
-+color Red+.
-
-dvisvgm delegates the evaluation of special commands to dedicated handlers. Each handler is responsible for
-all special statements of the same command set, i.e. commands usually &#x2013; but not necessarily &#x2013;
-beginning with a common prefix. For example, all PDF specials start with the prefix +pdf:+, while the TPIC
-special set consists of 13 different commands without common identifier. The PDF specials are processed by
-dvisvgm's 'pdf' handler, the TPIC ones by the 'tpic' handler. To get a list of the actually provided special
-handlers, use option *--list-specials* (see above). The following list gives an overview of the special sets
-currently supported. The names of the handlers can also be used to disable the processing of individual sets
-of specials. For further information on this, see option *--no-specials*.
+from the TeX command +\special{...}+ which does almost nothing. TeX only forwards the argument of this command
+to the DVI file using the corresponding 'xxx' opcode, thus delegating its execution to the DVI driver. The
+driver can then decide to either process or ignore it, depending on the supported statements. The parameter
+of TeX's +\special+ command is given in curly braces and may consist of an arbitrary character sequence
+representing the actual instruction, for example +color Red+.
+
+It might be worth mentioning that specials are only evaluated when processing DVI files. PS/EPS and PDF
+don't know anything about the concept of specials and therefore don't provide means to represent them.
+
+In order to evaluate the special commands, dvisvgm implements several dedicated handlers. Each handler is
+responsible for all special statements belonging to the same command set, i.e. commands usually &#x2013;
+but not necessarily &#x2013; beginning with a common prefix. For example, all PDF specials start with the
+prefix +pdf:+, while the TPIC special set consists of 13 different commands without common identifier. The
+PDF specials are processed by dvisvgm's 'pdf' handler, the TPIC ones by the 'tpic' handler. To get a list of
+the actually provided special handlers, use option *--list-specials* (see above). The following list gives an
+overview of the special sets currently supported. The names of the handlers can also be used to disable the
+processing of individual sets of specials. For further information on this, see option *--no-specials*.
*bgcolor*::
Special statements for changing the background/page color. Currently, dvisvgm only supports the +background+
@@ -813,8 +816,8 @@ Statements of this command set provide instructions to change the text/paint col
exact syntax, see the documentation of dvips, for instance.
*dvisvgm*::
-dvisvgm offers its own small set of specials. The following list gives a brief overview.
- *dvisvgm:raw* 'text';;
+The following list gives a brief overview of dvisvgm's own set of currently supported specials.
+*dvisvgm:raw* 'text';;
Adds an arbitrary sequence of XML nodes to the page section of the SVG document. dvisvgm checks syntax and
proper nesting of the inserted elements but does not perform any validation, thus the user has to ensure
that the resulting SVG is still valid. Opening and closing tags may be distributed among different 'raw'