summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/dvisvgm.1
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-04-08 21:16:34 +0000
committerKarl Berry <karl@freefriends.org>2013-04-08 21:16:34 +0000
commit2f4bc28da880ebec11e7dfb4287e9de5316dfa57 (patch)
treece9d23beba36aba5dafc1d6d49ddfdd67997c9f8 /Master/texmf-dist/doc/man/man1/dvisvgm.1
parentcd661e137bb3f43f933fd680fe265e0925fdae3c (diff)
tl-update-man
git-svn-id: svn://tug.org/texlive/trunk@29764 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/dvisvgm.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/dvisvgm.1177
1 files changed, 124 insertions, 53 deletions
diff --git a/Master/texmf-dist/doc/man/man1/dvisvgm.1 b/Master/texmf-dist/doc/man/man1/dvisvgm.1
index 0be9c2352ea..54a376f687b 100644
--- a/Master/texmf-dist/doc/man/man1/dvisvgm.1
+++ b/Master/texmf-dist/doc/man/man1/dvisvgm.1
@@ -2,12 +2,12 @@
.\" Title: dvisvgm
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 03/09/2012
+.\" Date: 03/01/2013
.\" Manual: dvisvgm Manual
-.\" Source: dvisvgm 1.0.11
+.\" Source: dvisvgm 1.2
.\" Language: English
.\"
-.TH "DVISVGM" "1" "03/09/2012" "dvisvgm 1\&.0\&.11" "dvisvgm Manual"
+.TH "DVISVGM" "1" "03/01/2013" "dvisvgm 1\&.2" "dvisvgm Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -171,15 +171,6 @@ only affects the bounding box and does not transform the page content\&. Hence,
.RE
.RE
.PP
-\fB\-c, \-\-scale\fR=\fIsx\fR[,\fIsy\fR]
-.RS 4
-Scales the page content horizontally by
-\fIsx\fR
-and vertically by
-\fIsy\fR\&. This option is equivalent to
-\fB\-TS\fR\fIsx\fR,\fIsy\fR\&.
-.RE
-.PP
\fB\-C, \-\-cache\fR[=\fIdir\fR]
.RS 4
To speed up the conversion process of bitmap fonts, dvisvgm saves intermediate conversion information in cache files\&. By default, these files are stored in $HOME/\&.dvisvgm/cache\&. If you prefer a different location, use option
@@ -196,20 +187,88 @@ Enables colorization of messages printed during the conversion process\&. The co
DVISVGM_COLORS\&. See the ENVIRONMENT section below for further information\&.
.RE
.PP
+\fB\-E, \-\-eps\fR
+.RS 4
+If this option is given, dvisvgm does not expect a DVI but an EPS input file, and tries to convert it to SVG\&. In order to do so, a single
+\fIpsfile\fR
+special command is created and forwarded to the PostScript special handler\&. This option is only available if dvisvgm was built with PostScript support enabled, and requires Ghostscript to be available\&. See option
+\fB\-\-libgs\fR
+for further information\&.
+.RE
+.PP
\fB\-e, \-\-exact\fR
.RS 4
If this option is given, dvisvgm computes the precise bounding box of each character\&. By default, the values stored in a font\(cqs TFM file are used to determine a glyph\(cqs extent\&. As these values are intended to realize optimal character placements and are not designed to represent the exact dimensions, they don\(cqt necessarily correspond with the bounds of the visual glyphs\&. Thus, width and/or height of some glyphs may be larger than the respective TFM values\&. As a result, this can lead to clipped characters at the bounds of the SVG graphic\&. With option
\fB\-\-exact\fR, dvisvgm analyzes the actual shape of each character and derives a usually tight bounding box\&.
.RE
.PP
-\fB\-h, \-\-help\fR
+\fB\-m, \-\-fontmap\fR=\fIfilenames\fR
+.RS 4
+Loads and evaluates a single or multiple font map files\&. These files are required to resolve font file names and encodings\&. dvisvgm does not provide its own map file but tries to read available ones coming with dvips or dvipdfm\&. If option
+\fB\-\-fonrmapm\fR
+is not given, dvisvgm looks for the default map files
+ps2pk\&.map,
+dvipdfm\&.map, and
+psfonts\&.map
+(in this order)\&. Otherwise, the listed files are used\&. Multiple filenames must be separated by commas without leading and/or trailing whitespace\&. The map files are evaluated in the given order\&. By default, redefined mappings do not replace previous ones\&. However, each filename can be preceded by an optional mode specifier (\fB+\fR,
+\fB\-\fR, or
+\fB=\fR) to change this behavior:
+.PP
++mapfile
+.RS 4
+Only those entries in the given map file that don\(cqt redefine a font mapping are applied\&. That\(cqs also the default mode if no mode specifier is given\&.
+.RE
+.PP
+\-mapfile
.RS 4
-Prints a short summary of all available command\-line options\&. This is also the default action if dvisvgm is called without parameters\&.
+Ensures that none of the font mappings defined in the given map file are used, i\&.e\&. previously defined mappings for the specified fonts are removed\&.
.RE
.PP
-\fB\-\-libgs=filename\fR
+=mapfile
.RS 4
-This option is only available if the Ghostscript library is not directly linked to dvisvgm and if PostScript support was not completely disabled during compilation\&. In this case, dvisvgm tries to load the shared GS library dynamically during runtime\&. By default, it expects the library\(cqs name to be libgs\&.so (on Unix\-like systems) or gsdll32\&.dll (Windows)\&. Option
+All mappings defined in the map file are applied\&. Previously defined settings for the same font are replaced\&.
+.sp
+If the first filename in the filename sequence is preceded by a mode specifier, dvisvgm loads the default font map (see above) and applies the other map files afterwards\&. Otherwise, none of default map files will be loaded automatically\&.
+.sp
+Examples:
+\fB\-\-fontmap=myfile1\&.map,+myfile2\&.map\fR
+loads
+myfile1\&.map
+followed by
+myfile2\&.map
+where all redefinitions of
+myfile2\&.map
+are ignored\&.
+\fB\-\-fontmap==myfile1\&.map,\-myfile2\&.map\fR
+loads the default map file followed by
+myfile1\&.map
+and
+myfile2\&.map
+where all redefinitions of
+myfile1\&.map
+replace previous entries\&. Afterwards, all definitions for the fonts given in
+myfile2\&.map
+are removed again\&.
+.sp
+For further information about the map file formats, see the manuals of dvips and dvipdfm\&.
+.RE
+.RE
+.PP
+\fB\-h, \-\-help\fR[=\fImode\fR]
+.RS 4
+Prints a short summary of all available command\-line options\&. The optional
+\fImode\fR
+parameter is an integer value between 0 and 2\&. It selects the display variant of the help text\&. Mode 0 lists all options divided into categories with section headers\&. This is also the default if dvisvgm is called without parameters\&. Mode 1 lists all options ordered by the short option name, while mode 2 sorts the lines by the long option name\&.
+.RE
+.PP
+\fB\-\-keep\fR
+.RS 4
+Disables the removal of temporary files as created by Metafont (usually \&.gf, \&.tfm, and \&.log files)\&.
+.RE
+.PP
+\fB\-\-libgs\fR=\fIfilename\fR
+.RS 4
+This option is only available if the Ghostscript library is not directly linked to dvisvgm and if PostScript support was not completely disabled during compilation\&. In this case, dvisvgm tries to load the shared GS library dynamically during runtime\&. By default, it expects the library\(cqs name to be libgs\&.so (on Unix\-like systems) or gsdll32\&.dll/gsdll64\&.dll (Windows)\&. Option
\fB\-\-libgs\fR
can be used to give a different name\&. Alternatively, it\(cqs also possible to set the GS library name by the environment variable
LIBGS\&. The latter has less precedence than the command\-line option\&.
@@ -223,30 +282,14 @@ or
\fIps\fR\&.
.RE
.PP
-\fB\-\-keep\fR
+\fB\-M, \-\-mag\fR=\fIfactor\fR
.RS 4
-Disables the removal of temporary files as created by Metafont (usually \&.gf, \&.tfm, and \&.log files)\&.
+Sets the magnification factor applied in conjunction with Metafont calls prior tracing the glyphs\&. The larger this value, the better the tracing results\&. Nevertheless, large magnification values can cause Metafont arithmetic errors due to number overflows\&. So, use this option with care\&. The default setting usually produces nice results\&.
.RE
.PP
-\fB\-m, \-\-map\-file\fR=\fIfile\fR
-.RS 4
-Sets the map file used to look up font names and encodings\&. dvisvgm does not provide its own map file but tries to read available ones coming with dvips or dvipdfm\&. If option
-\fB\-m\fR
-is not given, dvisvgm looks for
-ps2pk\&.map,
-dvipdfm\&.map, and
-psfonts\&.map
-(in this order)\&. Without further options, the file specified by option
-\fB\-m\fR
-will be used instead of the default maps\&. If you want dvisgvm to load the given file additionally to the default maps, add a leading
-\fI+\fR
-to the file/path, e\&.g\&.
-\-\-map\-file=+myfonts\&.map\&. For further information about the map file formats, see the manuals of dvips and dvipdfm\&.
-.RE
-.PP
-\fB\-M, \-\-mag\fR=\fIfactor\fR
+\fB\-\-no\-mktexmf\fR
.RS 4
-Sets the maginfication factor applied in conjunction with Metafont calls prior tracing the glyphs\&. The larger this value, the better the tracing results\&. Nevertheless, large magnification values can cause Metafont arithmetic errors due to number overflows\&. So, use this option with care\&. The default setting usually produces nice results\&.
+Suppresses the generation of missing font files\&. If dvisvgm can\(cqt find a font file through the kpathsea lookup mechanism, it calls the external tools mktextfm or mktexmf by\&. This option disables these calls\&.
.RE
.PP
\fB\-n, \-\-no\-fonts\fR[=\fIvariant\fR]
@@ -269,6 +312,15 @@ implies
\fB\-\-no\-styles\fR\&.
.RE
.PP
+\fB\-c, \-\-scale\fR=\fIsx\fR[,\fIsy\fR]
+.RS 4
+Scales the page content horizontally by
+\fIsx\fR
+and vertically by
+\fIsy\fR\&. This option is equivalent to
+\fB\-TS\fR\fIsx\fR,\fIsy\fR\&.
+.RE
+.PP
\fB\-S, \-\-no\-specials\fR[=\fInames\fR]
.RS 4
Disable processing of special commands embedded in the DVI file\&. If no further parameter is given, all specials are ignored\&. To selectively disable sets of specials, an optional comma\-separated list of names can be appended to this option\&. A
@@ -284,11 +336,6 @@ By default, dvisvgm creates CSS styles and class attributes to reference fonts b
\fB\-\-no\-styles\fR\&.
.RE
.PP
-\fB\-\-no\-mktexmf\fR
-.RS 4
-Suppresses the generation of missing font files\&. If dvisvgm can\(cqt find a font file through the kpathsea lookup mechanism, it calls the external tools mktextfm or mktexmf by\&. This option disables these calls\&.
-.RE
-.PP
\fB\-o, \-\-output\fR=\fIpattern\fR
.RS 4
Sets the name pattern of the output file\&. Parameter
@@ -329,6 +376,14 @@ converts all pages up to page 10,
converts all pages starting with page 10\&. Please consider that the page values don\(cqt refer to the page numbers printed on the page\&. Instead, the physical page count is expected, where the first page always gets number 1\&.
.RE
.PP
+\fB\-d, \-\-precision\fR=\fIdigits\fR
+.RS 4
+Specifies the maximal number of decimal places applied to floating\-point attribute values\&. All attribute values written to the generated SVG file(s) are rounded accordingly\&. The parameter
+\fIdigits\fR
+allows integer values from 0 to 6, where 0 enables the automatic selection of significant decimal places\&. This is also the default value if dvisvgm is called without option
+\fB\-\-precision\fR\&.
+.RE
+.PP
\fB\-P, \-\-progress\fR[=\fIdelay\fR]
.RS 4
Enables a simple progress indicator shown when time\-consuming operations like PostScript specials are processed\&. The indicator doesn\(cqt appear before the given delay (in seconds) has elapsed\&. The default delay value is 0\&.5 seconds\&.
@@ -348,12 +403,6 @@ Don\(cqt write the SVG output to a file but redirect it to
\fBstdout\fR\&.
.RE
.PP
-\fB\-t, \-\-translate\fR=\fItx\fR[,\fIty\fR]
-.RS 4
-Translates (moves) the page content in direction of vector (\fItx\fR,\fIty\fR)\&. This option is equivalent to
-\fB\-TT\fR\fItx\fR,\fIty\fR\&.
-.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
@@ -523,6 +572,12 @@ and
.RE
.RE
.PP
+\fB\-t, \-\-translate\fR=\fItx\fR[,\fIty\fR]
+.RS 4
+Translates (moves) the page content in direction of vector (\fItx\fR,\fIty\fR)\&. This option is equivalent to
+\fB\-TT\fR\fItx\fR,\fIty\fR\&.
+.RE
+.PP
\fB\-v, \-\-verbosity\fR=\fIlevel\fR
.RS 4
Controls the type of messages printed during a dvisvgm run:
@@ -708,16 +763,29 @@ The following TeX snippet adds two raw SVG elements to the output and updates th
These specials were introduced with the emTeX 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 (see CTAN)\&.
.RE
.PP
+\fBpdf\fR
+.RS 4
+pdfTeX and dvipdfmx introduced several special commands related to the generation of PDF files\&. Currently, only two of them,
+\fIpdf:mapfile\fR
+and
+\fIpdf:mapline\fR
+are supported by dvisvgm\&. These specials allow modifying the font map tree during the processing of DVI files\&. 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 \epdfmapfile in the pdfTeX user manual\&.
+.RE
+.PP
\fBps\fR
.RS 4
-The famous DVI driver dvips 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 a large amount of it to SVG\&. However, 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 corrdinates\&. Therefore, the relative locations of the graphic elements may slightly differ from those computed by dvips\&.
+The famous DVI driver dvips 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 a large amount of it to SVG\&. However, 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 try to implement its own PostScript interpreter but relies on Ghostscript instead\&. If the Ghostscript library was not linked while building dvisvgm, it is looked up and dynamically loaded during runtime\&. In this case, dvisvgm looks for
+Since PostScript is a rather complex language, dvisvgm does not try to implement its own PostScript interpreter but relies on Ghostscript instead\&. If the Ghostscript library was not linked while building dvisvgm, it is looked up and loaded dynamically during runtime\&. In this case, dvisvgm looks for
\fIlibgs\&.so\fR
on Unix\-like systems, and for
\fIgsdll32\&.dll\fR
-on Windows\&. You can override these default file names with the environment variable
-LIBGS\&. The library must be installed and must be reachable through the ld search path (*nix) or the PATH environment variable (Windows)\&. If it cannot be found, the evaluation of PostScript specials is disabled\&. Use option
+or
+\fIgsdll64\&.dll\fR
+on Windows\&. You can override these default file names with environment variable
+LIBGS
+or the command\-line option
+\fB\-\-libgs\fR\&. The library must be installed and reachable through the ld search path (*nix) or the PATH environment variable (Windows)\&. If it cannot be found, the processing of PostScript specials is disabled\&. Use option
\fB\-\-list\-specials\fR
to check whether PS support is available, i\&.e\&. the entry
\fIps\fR
@@ -783,7 +851,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 LIBGS can be used to specify path and file name of the library\&.
.sp
-The pre\-compiled Windows version of dvisvgm requires a working installation of MiKTeX 2\&.9 or above\&. To enable evaluation of PostScript specials, the original Ghostscript DLL \fIgsdll32\&.dll\fR must be present and reachable through the search path\&.
+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 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 www\&.ghostscript\&.com\&.
.sp
The environment variable DVISVGM_COLORS 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 DVISVGM_COLORS 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 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
@@ -953,9 +1021,12 @@ SourceForge project site
http://sourceforge\&.net/projects/dvisvgm
.RE
+.SH "BUGS"
+.sp
+Please report bugs using the bug tracker at Launchpad (see https://launchpad\&.net/dvisvgm)\&.
.SH "AUTHOR"
.sp
Written by Martin Gieseking <martin\&.gieseking@uos\&.de>
.SH "COPYING"
.sp
-Copyright \(co 2005\-2012 Martin Gieseking\&. Free use of this software is granted under the terms of the GNU General Public License (GPL) version 3 or, (at your option) any later version\&.
+Copyright \(co 2005\-2013 Martin Gieseking\&. Free use of this software is granted under the terms of the GNU General Public License (GPL) version 3 or, (at your option) any later version\&.