diff options
Diffstat (limited to 'dviware/dvisvgm/doc/dvisvgm.1')
-rw-r--r-- | dviware/dvisvgm/doc/dvisvgm.1 | 52 |
1 files changed, 31 insertions, 21 deletions
diff --git a/dviware/dvisvgm/doc/dvisvgm.1 b/dviware/dvisvgm/doc/dvisvgm.1 index b4bb1cb3c8..430a1de890 100644 --- a/dviware/dvisvgm/doc/dvisvgm.1 +++ b/dviware/dvisvgm/doc/dvisvgm.1 @@ -1,13 +1,13 @@ '\" t -.\" Title: dvisvgm Manual +.\" Title: dvisvgm .\" Author: Martin Gieseking <martin.gieseking@uos.de> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 2023-07-05 +.\" Date: 2023-09-12 .\" Manual: dvisvgm Manual -.\" Source: dvisvgm 3.1 +.\" Source: dvisvgm 3.1.2 .\" Language: English .\" -.TH "DVISVGM MANUAL" "1" "2023\-07\-05" "dvisvgm 3\&.1" "dvisvgm Manual" +.TH "DVISVGM" "1" "2023\-09\-12" "dvisvgm 3\&.1\&.2" "dvisvgm Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -309,7 +309,7 @@ which holds the current foreground color set by CSS property The optional argument of \fB\-\-currentcolor\fR specifies the RGB color value to be replaced and must be given as either -three or six digit hex color value (\m[blue]https://www.w3.org/TR/css-color/#typedef-hex-color\m[]) +six or three digit hex color value (\m[blue]https://www.w3.org/TR/css-color/#typedef-hex-color\m[]) preceded by character \fB#\fR, e\&.g\&. \fB#0000ff\fR @@ -619,7 +619,15 @@ By default, dvisvgm creates CSS styles and class attributes to reference fonts\& \fB\-O, \-\-optimize\fR[=\fImodules\fR] .RS 4 Applies several optimizations on the generated SVG tree to reduce the file size\&. The optimizations are performed by running separate optimizer modules specified by optional argument -\fImodules\fR\&. It may consist of a single module name or a comma\-separated list of several module names\&. The corresponding modules are executed one by one in the given order and thus transform the XML tree gradually\&. +\fImodules\fR\&. It may consist of a single module name or a comma\-separated list of several module names\&. The corresponding modules are executed one by one in the given order and thus transform the XML tree gradually\&. A leading hyphen (\fB\-\fR) can be used to exclude a module from processing\&. For example +\fB\-Oall,\-collapse\-groups\fR +performs all optimizations except +\fBcollapse\-groups\fR\&. If the first module name in the list starts with a hyphen, dvisvgm automatically inserts +\fBall\fR +at the beginning, i\&.e\&. +\fB\-O\-collapse\-groups\fR +is identical to +\fB\-Oall,\-collapse\-groups\fR\&. .sp The following list describes the currently available optimizer modules\&. .PP @@ -639,9 +647,9 @@ can\(cqt be combined with other module names\&. .RS 4 Performs all optimizations listed below\&. This is also the default if option \fB\-\-optimize\fR -is used without argument\&. The modules are executed in a predefined order that usually leads to the best results\&. +is used without any arguments\&. The modules are executed in a predefined order that usually leads to the best results\&. \fBall\fR -can\(cqt be combined with other module names\&. +must be the only or the first entry in the list of module names\&. .RE .PP \fBcollapse\-groups\fR @@ -879,7 +887,9 @@ special command which is forwarded to dvisvgm\(cqs PostScript special handler\&. for further information\&. .sp As of Ghostscript 10\&.01\&.0, this will no longer work due to the introduction of a new PDF interpreter\&. Therefore, an alternative conversion module based on -\fImutool\fR, a utility which is part of the [MuPDF](\m[blue]\fBhttps://mupdf\&.com\fR\m[]) package, has been introduced\&. It\(cqs automatically invoked if Ghostscript can\(cqt be used and if a working +\fImutool\fR, a utility which is part of the +MuPDF (\m[blue]https://mupdf.com\m[]) +package, has been introduced\&. It\(cqs automatically invoked if Ghostscript can\(cqt be used and if a working \fBmutool\fR executable is present in a directory which is part of the system\(cqs search path\&. .sp @@ -1251,7 +1261,7 @@ attributes are omitted\&. .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\&. .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\&. +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\&. .PP \fBbgcolor\fR .RS 4 @@ -1423,16 +1433,6 @@ allows for applying the current transformation matrix to the bounding box\&. This variant of the bbox special assigns an absolute (final) bounding box to the resulting SVG\&. After executing this command, dvisvgm doesn\(cqt further alter the bounding box coordinates, except this special is called again later\&. The points (\fIx1\fR,\fIy1\fR) and (\fIx2\fR,\fIy2\fR) denote the absolute coordinates of two diagonal corners of the rectangle\&. As with the relative special variant described above, the optional modifier \fBtransform\fR allows for applying the current transformation matrix to the bounding box\&. -.RE -.PP -\fBdvisvgm:message\fR \fImsg\fR -.RS 4 -Prints the given text -\fImsg\fR -to the console\&. It may also contain the macros -\fI{?\&...}\fR -mentioned above (see -\fBdvisvgm:raw\fR)\&. .sp The following TeX snippet adds two raw SVG elements to the output and updates the bounding box accordingly: .sp @@ -1464,6 +1464,16 @@ but doesn\(cqt require an explicit color argument\&. Instead, it takes the curre functionality \(en can be omitted\&. When called with argument \fBoff\fR, the functionality is deactivated again\&. .RE +.PP +\fBdvisvgm:message\fR \fImsg\fR +.RS 4 +Prints the given text +\fImsg\fR +to the console\&. It may also contain the macros +\fI{?\&...}\fR +mentioned above (see +\fBdvisvgm:raw\fR)\&. +.RE .RE .PP \fBem\fR @@ -1502,7 +1512,7 @@ pdfTeX and dvipdfmx introduced several special commands related to the generatio \fIpdf:pagesize\fR is similar to the \fIpapersize\fR -special (see above) which specifies the size of the current and all folowing pages\&. In order to actually apply the extents to the generated SVG files, option +special (see above) which specifies the size of the current and all following pages\&. In order to actually apply the extents to the generated SVG files, option \fB\-\-bbox=papersize\fR must be given\&. .sp |