summaryrefslogtreecommitdiff
path: root/Build/source/texk/dvisvgm/dvisvgm-src/doc
diff options
context:
space:
mode:
Diffstat (limited to 'Build/source/texk/dvisvgm/dvisvgm-src/doc')
-rw-r--r--Build/source/texk/dvisvgm/dvisvgm-src/doc/conf-dblatex-pdf.xsl15
-rw-r--r--Build/source/texk/dvisvgm/dvisvgm-src/doc/dvisvgm.190
-rw-r--r--Build/source/texk/dvisvgm/dvisvgm-src/doc/dvisvgm.txt.in53
3 files changed, 86 insertions, 72 deletions
diff --git a/Build/source/texk/dvisvgm/dvisvgm-src/doc/conf-dblatex-pdf.xsl b/Build/source/texk/dvisvgm/dvisvgm-src/doc/conf-dblatex-pdf.xsl
index 07e75b2e88e..37e41f6c21b 100644
--- a/Build/source/texk/dvisvgm/dvisvgm-src/doc/conf-dblatex-pdf.xsl
+++ b/Build/source/texk/dvisvgm/dvisvgm-src/doc/conf-dblatex-pdf.xsl
@@ -49,4 +49,19 @@
</xsl:call-template>
<xsl:apply-templates/>
</xsl:template>
+
+ <!-- add named list items (e.g. command-line options, specials) to PDF bookmarks -->
+ <xsl:template match="refsect1/variablelist/varlistentry/term[emphasis]">
+ <xsl:text>\phantomsection\pdfbookmark[3]{</xsl:text>
+ <xsl:choose>
+ <xsl:when test="contains(emphasis, '--')">
+ <xsl:value-of select="concat('-{}-', substring-after(emphasis, '--'))"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="emphasis"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ <xsl:value-of select="concat('}{', generate-id(emphasis), '}&#10;')"/>
+ <xsl:apply-imports/>
+ </xsl:template>
</xsl:stylesheet>
diff --git a/Build/source/texk/dvisvgm/dvisvgm-src/doc/dvisvgm.1 b/Build/source/texk/dvisvgm/dvisvgm-src/doc/dvisvgm.1
index 8c707db8cb0..e49e2b1e6cd 100644
--- a/Build/source/texk/dvisvgm/dvisvgm-src/doc/dvisvgm.1
+++ b/Build/source/texk/dvisvgm/dvisvgm-src/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: 05/03/2018
+.\" Date: 07/07/2018
.\" Manual: dvisvgm Manual
-.\" Source: dvisvgm 2.4
+.\" Source: dvisvgm 2.4.1
.\" Language: English
.\"
-.TH "DVISVGM" "1" "05/03/2018" "dvisvgm 2\&.4" "dvisvgm Manual"
+.TH "DVISVGM" "1" "07/07/2018" "dvisvgm 2\&.4\&.1" "dvisvgm Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -51,37 +51,6 @@ When running dvisvgm without option \fB\-\-no\-fonts\fR, it creates \fIfont\fR e
.sp
dvisvgm provides a POSIX\-compliant command\-line interface with short and long option names\&. They may be given before and/or after the name of the file to be converted\&. Also, the order of specifying the options is not significant, i\&.e\&. you can add them in any order without changing dvisvgm\(cqs behavior\&. Certain options accept or require additional parameters which are directly appended to or separated by whitespace from a short option (e\&.g\&. \fB\-v0\fR or \fB\-v 0\fR)\&. Long options require an additional equals sign (\fB=\fR) between option name and argument but without any surrounding whitespace (e\&.g\&. \fB\-\-verbosity=0\fR)\&. Multiple short options that don\(cqt expect a further parameter can be combined after a single dash (e\&.g\&. \fB\-ejs\fR rather than \fB\-e \-j \-s\fR)\&.
.PP
-\fB\-a, \-\-trace\-all\fR=[\fIretrace\fR]
-.RS 4
-This option forces dvisvgm to vectorize not only the glyphs actually required to render the SVG file correctly \(en which is the default \(en, but processes all glyphs of all fonts referenced in the DVI file\&. Because dvisvgm stores the tracing results in a font cache, all following conversions of these fonts will speed up significantly\&. The boolean option
-\fIretrace\fR
-determines how to handle glyphs already stored in the cache\&. By default, these glyphs are skipped\&. Setting argument
-\fIretrace\fR
-to
-\fIyes\fR
-or
-\fItrue\fR
-forces dvisvgm to retrace the corresponding bitmaps again\&.
-.if n \{\
-.sp
-.\}
-.RS 4
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBNote\fR
-.ps -1
-.br
-This option only takes effect if font caching is active\&. Therefore,
-\fB\-\-trace\-all\fR
-cannot be combined with option
-\fB\-\-cache=none\fR\&.
-.sp .5v
-.RE
-.RE
-.PP
\fB\-b, \-\-bbox\fR=\fIfmt\fR
.RS 4
Sets the bounding box of the generated graphic to the specified format\&. The parameter
@@ -214,7 +183,7 @@ attribute\&.
.PP
\fB\-\-color\fR
.RS 4
-Enables colorization of messages printed during the conversion process\&. The colors can be customized via the environment variable
+Enables colorization of messages printed during the conversion process\&. The colors can be customized via environment variable
\fBDVISVGM_COLORS\fR\&. See the
Environment section
below for further information\&.
@@ -400,7 +369,7 @@ tells dvisvgm not to add any visible objects to hyperlinks\&. The lines and boxe
\fIcolor specifier\fR
is either a hexadecimal RGB value of the form
\fI#RRGGBB\fR, or a
-dvips color name (\m[blue]http://en.wikibooks.org/wiki/LaTeX/Colors#The_68_standard_colors_known_to_dvips\m[])\&.
+dvips color name (\m[blue]https://en.wikibooks.org/wiki/LaTeX/Colors#The_68_standard_colors_known_to_dvips\m[])\&.
.sp
Moreover, argument
\fIstyle\fR
@@ -623,6 +592,37 @@ If the optional parameter
is omitted, dvisvgm prints the location of the system\(cqs temp folder and exits\&.
.RE
.PP
+\fB\-a, \-\-trace\-all\fR=[\fIretrace\fR]
+.RS 4
+This option forces dvisvgm to vectorize not only the glyphs actually required to render the SVG file correctly \(en which is the default \(en, but processes all glyphs of all fonts referenced in the DVI file\&. Because dvisvgm stores the tracing results in a font cache, all following conversions of these fonts will speed up significantly\&. The boolean option
+\fIretrace\fR
+determines how to handle glyphs already stored in the cache\&. By default, these glyphs are skipped\&. Setting argument
+\fIretrace\fR
+to
+\fIyes\fR
+or
+\fItrue\fR
+forces dvisvgm to retrace the corresponding bitmaps again\&.
+.if n \{\
+.sp
+.\}
+.RS 4
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBNote\fR
+.ps -1
+.br
+This option only takes effect if font caching is active\&. Therefore,
+\fB\-\-trace\-all\fR
+cannot be combined with option
+\fB\-\-cache=none\fR\&.
+.sp .5v
+.RE
+.RE
+.PP
\fB\-T, \-\-transform\fR=\fIcommands\fR
.RS 4
Applies a sequence of transformations to the SVG content\&. Each transformation is described by a
@@ -859,9 +859,9 @@ Prints the version of dvisvgm and exits\&. If the optional argument is set to
Creates a compressed SVG file with suffix \&.svgz\&. The optional argument specifies the compression level\&. Valid values are in the range of 1 to 9 (default value is 9)\&. Larger values cause better compression results but may take slightly more computation time\&.
.RE
.PP
-\fB\-Z, \-\-zoom\fR[=\fIfactor\fR]
+\fB\-Z, \-\-zoom\fR=\fIfactor\fR
.RS 4
-Multiplies the
+Multiplies the values of the
\fIwidth\fR
and
\fIheight\fR
@@ -1041,7 +1041,7 @@ The following TeX snippet adds two raw SVG elements to the output and updates th
These specials were introduced with the
\fIemTeX\fR
distribution by Eberhard Mattes\&. They provide line drawing statements, instructions for embedding MSP, PCX, and BMP image files, as well as two PCL commands\&. dvisvgm supports only the line drawing statements and ignores all other em specials silently\&. A description of the command syntax can be found in the DVI driver documentation coming with
-emTeX (\m[blue]http://www.ctan.org/pkg/emtex\m[])\&.
+emTeX (\m[blue]https://ctan.org/pkg/emtex\m[])\&.
.RE
.PP
\fBhtml\fR
@@ -1050,7 +1050,7 @@ The hyperref specification defines several variants on how to mark hyperlinked a
\fIhypertex\fR\&. By default, all linked areas of the document are marked by a rectangle\&. Option
\fB\-\-linkmark\fR
allows to change this behavior\&. See above for further details\&. Information on syntax and semantics of the HyperTeX specials can be found in the
-hyperref manual (\m[blue]http://www.ctan.org/pkg/hyperref\m[])\&.
+hyperref manual (\m[blue]https://ctan.org/pkg/hyperref\m[])\&.
.RE
.PP
\fBpapersize\fR
@@ -1082,7 +1082,7 @@ and
allow for modifying the font map tree while processing the DVI file\&. They are used by CTeX, for example\&. dvisvgm supports both, the dvips and dvipdfm font map format\&. For further information on the command syntax and semantics, see the documentation of
\fB\epdfmapfile\fR
in the
-pdfTeX user manual (\m[blue]http://www.ctan.org/pkg/pdftex\m[])\&.
+pdfTeX user manual (\m[blue]https://ctan.org/pkg/pdftex\m[])\&.
.RE
.PP
\fBps\fR
@@ -1092,7 +1092,7 @@ The famous DVI driver
introduced its own set of specials in order to embed PostScript code into DVI files, which greatly improves the capabilities of DVI documents\&. One aim of dvisvgm is to completely evaluate all PostScript snippets and to convert as many of them as possible to SVG\&. In contrast to dvips, dvisvgm uses floating point arithmetics to compute the precise position of each graphic element, i\&.e\&. it doesn\(cqt round the coordinates\&. Therefore, the relative locations of the graphic elements may slightly differ from those computed by dvips\&.
.sp
Since PostScript is a rather complex language, dvisvgm does not implement its own PostScript interpreter but relies on
-Ghostscript (\m[blue]http://ghostscript.com\m[])
+Ghostscript (\m[blue]https://ghostscript.com\m[])
instead\&. If the Ghostscript library was not linked to the dvisvgm binary, it is looked up and loaded dynamically during runtime\&. In this case, dvisvgm looks for
\fIlibgs\&.so\&.X\fR
on Unix\-like systems (supported ABI versions: 7,8,9), for
@@ -1111,7 +1111,7 @@ to check whether PostScript support is available, i\&.e\&. entry
is present\&.
.sp
The PostScript handler also recognizes and evaluates bounding box data generated by the
-preview package (\m[blue]http://www.ctan.org/pkg/preview\m[])
+preview package (\m[blue]https://ctan.org/pkg/preview\m[])
with option
\fItightpage\fR\&. If such data is present in the DVI file and if dvisvgm is called with option
\fB\-\-bbox=preview\fR, dvisvgm sets the width and total height of the SVG file to the values derived from the preview data\&. Additionally, it prints a message showing the width, height, and depth of the box in TeX point units to the console\&. Especially, the depth value can be read by a post\-processor to vertically align the SVG graphics with the baseline of surrounding text in HTML or XSL\-FO documents, for example\&. Please note that SVG bounding boxes are defined by a width and (total) height\&. In contrast to TeX, SVG provides no means to differentiate between height and depth, i\&.e\&. the vertical extents above and below the baseline, respectively\&. Therefore, it is generally not possible to retrieve the depth value from the SVG file itself\&.
@@ -1192,7 +1192,7 @@ dvisvgm uses the \fBkpathsea\fR library for locating the files that it opens\&.
.sp
If dvisvgm was linked without the Ghostscript library, and if PostScript support has not been disabled, the shared Ghostscript library is looked up during runtime via dlopen()\&. The environment variable \fBLIBGS\fR can be used to specify path and file name of the library\&.
.sp
-The pre\-compiled Windows versions of dvisvgm require a working installation of MiKTeX 2\&.9 or above\&. dvisvgm does not work together with the portable edition of MiKTeX because it relies on MiKTeX\(cqs COM interface that is only accessible in a local installation\&. To enable the evaluation of PostScript specials, the original Ghostscript DLL \fIgsdll32\&.dll\fR must be present and reachable through the search path\&. 64\-bit Windows builds require the 64\-bit Ghostscript DLL \fIgsdll64\&.dll\fR\&. Both DLLs come with the corresponding Ghostscript installers available from \m[blue]\fBhttp://ghostscript\&.com\fR\m[]\&.
+The pre\-compiled Windows versions of dvisvgm require a working installation of MiKTeX 2\&.9 or above\&. dvisvgm does not work together with the portable edition of MiKTeX because it relies on MiKTeX\(cqs COM interface that is only accessible in a local installation\&. To enable the evaluation of PostScript specials, the original Ghostscript DLL \fIgsdll32\&.dll\fR must be present and reachable through the search path\&. 64\-bit Windows builds require the 64\-bit Ghostscript DLL \fIgsdll64\&.dll\fR\&. Both DLLs come with the corresponding Ghostscript installers available from \m[blue]\fBhttps://ghostscript\&.com\fR\m[]\&.
.sp
The environment variable \fBDVISVGM_COLORS\fR specifies the colors used to highlight various parts of dvisvgm\(cqs message output\&. It is only evaluated if option \fB\-\-color\fR is given\&. The value of \fBDVISVGM_COLORS\fR is a list of colon\-separated entries of the form \fIgg\fR=\fIBF\fR, where \fIgg\fR denotes one of the color group indicators listed below, and \fIBF\fR are two hexadecimal digits specifying the background (first digit) and foreground/text color (second digit)\&. The color values are defined as follows: 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=gray, 8=bright red, 9=bright green, A=bright yellow, B=bright blue, C=bright magenta, D=bright cyan, E=bright gray, F=white\&. Depending on the terminal, the colors may differ\&. Rather than changing both the text and background color, it\(cqs also possible to change only one of them: An asterisk (*) in place of a hexadecimal digit indicates the default text or background color of the terminal\&.
.sp
@@ -1353,7 +1353,7 @@ T}
.PP
Project home page
.RS 4
-\m[blue]\fBhttp://dvisvgm\&.bplaced\&.net\fR\m[]
+\m[blue]\fBhttps://dvisvgm\&.de\fR\m[]
.RE
.PP
Code repository
diff --git a/Build/source/texk/dvisvgm/dvisvgm-src/doc/dvisvgm.txt.in b/Build/source/texk/dvisvgm/dvisvgm-src/doc/dvisvgm.txt.in
index ee982c442c3..dff70dd0ceb 100644
--- a/Build/source/texk/dvisvgm/dvisvgm-src/doc/dvisvgm.txt.in
+++ b/Build/source/texk/dvisvgm/dvisvgm-src/doc/dvisvgm.txt.in
@@ -82,21 +82,6 @@ require an additional equals sign (+=+) between option name and argument but wit
whitespace (e.g. +--verbosity=0+). Multiple short options that don't expect a further parameter can
be combined after a single dash (e.g. +-ejs+ rather than +-e -j -s+).
-*-a, --trace-all*=['retrace']::
-This option forces dvisvgm to vectorize not only the glyphs actually required to render the
-SVG file correctly – which is the default –, but processes all glyphs of all fonts referenced in
-the DVI file. Because dvisvgm stores the tracing results in a font cache, all following conversions
-of these fonts will speed up significantly.
-The boolean option 'retrace' determines how to handle glyphs already stored in the cache.
-By default, these glyphs are skipped. Setting argument 'retrace' to 'yes' or 'true' forces dvisvgm
-to retrace the corresponding bitmaps again.
-+
-[NOTE]
-This option only takes effect if font caching is active. Therefore, *--trace-all* cannot be
-combined with option *--cache=none*.
-+
-
-
*-b, --bbox*='fmt'::
Sets the bounding box of the generated graphic to the specified format. The parameter 'fmt'
takes either one of the format specifiers listed below, or a sequence of four comma- or
@@ -159,7 +144,7 @@ elements containing a 'clip-path' attribute.
*--color*::
Enables colorization of messages printed during the conversion process. The colors can be
-customized via the environment variable *DVISVGM_COLORS*. See the <<environment, Environment section>>
+customized via environment variable *DVISVGM_COLORS*. See the <<environment, Environment section>>
below for further information.
*--colornames*::
@@ -299,7 +284,7 @@ the bounding rectangle, and 'none' tells dvisvgm not to add any visible objects
The lines and boxes get the current text color selected. In order to apply a different, constant color,
a colon followed by a color specifier can be appended to the style string. A 'color specifier' is either
a hexadecimal RGB value of the form '#RRGGBB', or a
-http://en.wikibooks.org/wiki/LaTeX/Colors#The_68_standard_colors_known_to_dvips[dvips color name].
+https://en.wikibooks.org/wiki/LaTeX/Colors#The_68_standard_colors_known_to_dvips[dvips color name].
+
Moreover, argument 'style' can take a single color specifier to highlight the linked region by
a frameless box filled with that color. An optional second color specifier separated by a colon
@@ -444,6 +429,20 @@ does not create this folder, so you must ensure that it actually exists before r
If the optional parameter 'path' is omitted, dvisvgm prints the location of the system's
temp folder and exits.
+*-a, --trace-all*=['retrace']::
+This option forces dvisvgm to vectorize not only the glyphs actually required to render the
+SVG file correctly – which is the default –, but processes all glyphs of all fonts referenced in
+the DVI file. Because dvisvgm stores the tracing results in a font cache, all following conversions
+of these fonts will speed up significantly.
+The boolean option 'retrace' determines how to handle glyphs already stored in the cache.
+By default, these glyphs are skipped. Setting argument 'retrace' to 'yes' or 'true' forces dvisvgm
+to retrace the corresponding bitmaps again.
++
+[NOTE]
+This option only takes effect if font caching is active. Therefore, *--trace-all* cannot be
+combined with option *--cache=none*.
++
+
*-T, --transform*='commands'::
Applies a sequence of transformations to the SVG content. Each transformation is described
by a 'command' beginning with a capital letter followed by a list of comma-separated
@@ -544,9 +543,9 @@ Creates a compressed SVG file with suffix .svgz. The optional argument specifies
level. Valid values are in the range of 1 to 9 (default value is 9). Larger values cause better
compression results but may take slightly more computation time.
-*-Z, --zoom*[='factor']::
-Multiplies the 'width' and 'height' attributes of the SVG root element by argument 'factor' while
-the coordinate system of the graphic content is retained. As a result, most SVG viewers zoom the
+*-Z, --zoom*='factor'::
+Multiplies the values of the 'width' and 'height' attributes of the SVG root element by argument 'factor'
+while the coordinate system of the graphic content is retained. As a result, most SVG viewers zoom the
graphics accordingly. If a negative zoom factor is given, the 'width' and 'height' attributes are omitted.
[[specials]]
@@ -652,14 +651,14 @@ These specials were introduced with the 'emTeX' distribution by Eberhard Mattes.
statements, instructions for embedding MSP, PCX, and BMP image files, as well as two PCL commands.
dvisvgm supports only the line drawing statements and ignores all other em specials silently.
A description of the command syntax can be found in the DVI driver documentation coming with
-http://www.ctan.org/pkg/emtex[emTeX].
+https://ctan.org/pkg/emtex[emTeX].
*html*::
The hyperref specification defines several variants on how to mark hyperlinked areas in a DVI file. dvisvgm
supports the plain HyperTeX special constructs as created with hyperref package option 'hypertex'.
By default, all linked areas of the document are marked by a rectangle. Option *--linkmark* allows to change
this behavior. See above for further details. Information on syntax and semantics of the HyperTeX specials can be
-found in the http://www.ctan.org/pkg/hyperref[hyperref manual].
+found in the https://ctan.org/pkg/hyperref[hyperref manual].
*papersize*::
The 'papersize' special, which is an extension introduced by dvips, can be used to specify the widths and
@@ -681,7 +680,7 @@ option *--bbox=papersize* must be given.
'pdf:mapfile' and 'pdf:mapline' allow for modifying the font map tree while processing the DVI file.
They are used by CTeX, for example. dvisvgm supports both, the dvips and dvipdfm font map format. For further
information on the command syntax and semantics, see the documentation of +\pdfmapfile+ in the
-http://www.ctan.org/pkg/pdftex[pdfTeX user manual].
+https://ctan.org/pkg/pdftex[pdfTeX user manual].
*ps*::
The famous DVI driver 'dvips' introduced its own set of specials in order to embed PostScript code into DVI files,
@@ -692,7 +691,7 @@ coordinates. Therefore, the relative locations of the graphic elements may sligh
by dvips.
+
Since PostScript is a rather complex language, dvisvgm does not implement its own PostScript interpreter
-but relies on http://ghostscript.com[Ghostscript] instead. If the Ghostscript library was not linked to the
+but relies on https://ghostscript.com[Ghostscript] instead. If the Ghostscript library was not linked to the
dvisvgm binary, it is looked up and loaded dynamically during runtime. In this case, dvisvgm looks for
'libgs.so.X' on Unix-like systems (supported ABI versions: 7,8,9), for 'libgs.X.dylib' on macOS, and for
'gsdll32.dll' or 'gsdll64.dll' on Windows. You can override the default file names with environment variable
@@ -702,7 +701,7 @@ cannot be found, dvisvgm disables the processing of PostScript specials and prin
Use option *--list-specials* to check whether PostScript support is available, i.e. entry 'ps' is present.
+
The PostScript handler also recognizes and evaluates bounding box data generated by the
-http://www.ctan.org/pkg/preview[preview package] with option 'tightpage'. If such data is present in the DVI file
+https://ctan.org/pkg/preview[preview package] with option 'tightpage'. If such data is present in the DVI file
and if dvisvgm is called with option *--bbox=preview*, dvisvgm sets the width and total height of the SVG file to
the values derived from the preview data. Additionally, it prints a message showing the width, height,
and depth of the box in TeX point units to the console. Especially, the depth value can be read by a post-processor
@@ -764,7 +763,7 @@ dvisvgm does not work together with the portable edition of MiKTeX because it re
interface that is only accessible in a local installation.
To enable the evaluation of PostScript specials, the original Ghostscript DLL 'gsdll32.dll' must be present
and reachable through the search path. 64-bit Windows builds require the 64-bit Ghostscript DLL 'gsdll64.dll'.
-Both DLLs come with the corresponding Ghostscript installers available from http://ghostscript.com.
+Both DLLs come with the corresponding Ghostscript installers available from https://ghostscript.com.
The environment variable *DVISVGM_COLORS* specifies the colors used to highlight various parts of dvisvgm's
message output. It is only evaluated if option *--color* is given. The value of *DVISVGM_COLORS* is a list of
@@ -813,7 +812,7 @@ See also
Resources
---------
-Project home page::: http://dvisvgm.bplaced.net
+Project home page::: https://dvisvgm.de
Code repository::: https://github.com/mgieseki/dvisvgm
Bugs