summaryrefslogtreecommitdiff
path: root/dviware/dvisvgm/doc/dvisvgm.txt.in
diff options
context:
space:
mode:
Diffstat (limited to 'dviware/dvisvgm/doc/dvisvgm.txt.in')
-rw-r--r--dviware/dvisvgm/doc/dvisvgm.txt.in34
1 files changed, 27 insertions, 7 deletions
diff --git a/dviware/dvisvgm/doc/dvisvgm.txt.in b/dviware/dvisvgm/doc/dvisvgm.txt.in
index a5968c2bcc..5b31c8d092 100644
--- a/dviware/dvisvgm/doc/dvisvgm.txt.in
+++ b/dviware/dvisvgm/doc/dvisvgm.txt.in
@@ -22,7 +22,7 @@ Martin Gieseking <@PACKAGE_BUGREPORT@>
:man source: dvisvgm
:man version: @VERSION@
:man manual: dvisvgm Manual
-:revdate: 2023-02-21 19:20 +0100
+:revdate: 2023-07-05 10:37 +0200
Name
----
@@ -206,6 +206,16 @@ In order to apply these color names rather than their RGB values, call dvisvgm w
Adds comments with further information about selected data to the SVG file. Currently, only
font elements and font CSS rules related to native fonts are annotated.
+*--currentcolor*[='color']::
+This option tells dvisvgm to replace the specified color with CSS variable `currentColor` which
+holds the current foreground color set by CSS property `color`. This way an application or website
+can change the color via CSS without the need to modify the SVG code.
++
+The optional argument of `--currentcolor` specifies the RGB color value to be replaced and must
+be given as either https://www.w3.org/TR/css-color/#typedef-hex-color[three or six digit hex color value]
+preceded by character `#`, e.g. `#0000ff` or `#00f` for blue. If the optional argument is omitted, black
+is assumed.
+
*--embed-bitmaps*::
Embeds the contents of bitmap files into the generated SVG files instead of adding file references.
Because of the base64-encoded data, the SVG files are usually much bigger but at the same time
@@ -572,16 +582,17 @@ If this option is given, dvisvgm does not expect a DVI but a PDF input file, and
it to SVG. Similar to the conversion of DVI files, only the first page is processed by default.
Option *--page* can be used to select different pages, page ranges, and/or page sequences.
+
-If a Ghostcript version < 10.1.0 is found, dvisvgm uses Ghostscript to process the PDF file. In
+If a Ghostcript version < 10.01.0 is found, dvisvgm uses Ghostscript to process the PDF file. In
this case, the conversion is realized by creating a single 'pdffile' special command which is
forwarded to dvisvgm's PostScript special handler. Therefore, this option is only available if
dvisvgm was built with PostScript support enabled, and requires Ghostscript to be accessible.
See option *--libgs* for further information.
+
-As of Ghostscript 10.1.0, this will no longer work due to the introduction of a new PDF interpreter.
-Therefore, an alternative conversion module based on https://mupdf.com/docs/mutool.html[mutool]
-has been introduced. It's automatically invoked if Ghostscript can't be used and if a working
-+mutool+ executable is present in a directory which is part of the system's search path.
+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 _mutool_, a utility which is part of the
+[MuPDF](https://mupdf.com) package, has been introduced. It's automatically invoked if Ghostscript
+can't be used and if a working +mutool+ executable is present in a directory which is part of the
+system's search path.
+
Alternatively, environment variable +DVISVGM_PDF_PROC+ can be used to select the PDF processor.
The currently supported values are +gs+ and +mutool+.
@@ -869,6 +880,10 @@ dvisvgm offers its own small set of specials. The following list gives a brief o
The points ('x1','y1') and ('x2','y2') denote the absolute coordinates of two diagonal corners of the rectangle.
As with the relative special variant described above, the optional modifier +transform+ allows for applying the
current transformation matrix to the bounding box.
+
+ *dvisvgm:message* 'msg';;
+ Prints the given text 'msg' to the console. It may also contain the macros '{?...}' mentioned above
+ (see *dvisvgm:raw*).
+
The following TeX snippet adds two raw SVG elements to the output and updates the bounding box accordingly:
+
@@ -882,6 +897,11 @@ The following TeX snippet adds two raw SVG elements to the output and updates th
\special{dvisvgm:bbox abs 10bp 200bp 100bp 250bp transform}
-------------------------------------------------------------------------------------
+
+ *dvisvgm:currentcolor* [on|off];;
+ This special works similar to option `--currentcolor` but doesn't require an explicit color argument. Instead,
+ it takes the currently active color and replaces it with `currentColor`. Therefore, the result depends on the
+ placement of the special and the preceding color changes. Argument `on` &#x2013; which activates the 'currentColor'
+ functionality &#x2013; can be omitted. When called with argument `off`, the functionality is deactivated again.
*em*::
These specials were introduced with the 'emTeX' distribution by Eberhard Mattes. They provide line drawing
@@ -1025,7 +1045,7 @@ All malformed entries in the list are silently ignored.
of progress indicators (+pi+) to cyan (+5+) on default background (+*+).
Variable *DVISVGM_PDF_PROC* allows you to select the desired PDF processor. dvisvgm requires either
-Ghostscript (version < 10.1.0) or mutool to process PDF files. IF *DVISVGM_PDF_PROC* is not set, dvisvgm
+Ghostscript (version < 10.01.0) or mutool to process PDF files. IF *DVISVGM_PDF_PROC* is not set, dvisvgm
tries to detect the available processors. See option *--pdf* for further information. To select a
specific PDF processor, you can set *DVISVGM_PDF_PROC* to +gs+ or +mutool+ which forces the use of
Ghostscript and mutool respectively.