Skip to content

Commit

Permalink
minor additions/fixes of manpage and README
Browse files Browse the repository at this point in the history
  • Loading branch information
mgieseki committed Nov 10, 2017
1 parent 5293969 commit 829440b
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 17 deletions.
5 changes: 1 addition & 4 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,7 @@ DEPENDENCIES
version of xxHash is bundled with the dvisvgm sources.

* zlib (http://www.zlib.org)
Compressed SVG files are produced by using functions of this library and the
Gzstream wrapper classes (http://www.cs.unc.edu/Research/compgeom/gzstream)
which are licensed under LGPL version 2.1 (or optionally any later version)
and should be included with this package.
This library is required to create compressed SVGZ files.

If you want to build and run the test suite located in the tests subdirectory,
you also need the Google Test libraries (https://github.com/google/googletest).
Expand Down
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Short overview of the main features:
* Approximates PostScript [color gradient fills](http://dvisvgm.bplaced.net/Gradients) not directly supported by SVG 1.1.
* Optionally creates compressed [SVGZ](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics#Compression) files.
* Provides options for applying page transformations, like translation, rotation, scaling, and skewing.
* Evaluates color, emTeX, tpic, hyperref/HyperTeX, papersize, PDF mapfile, and PostScript [specials](http://www.tex.ac.uk/cgi-bin/texfaq2html?label=specials).
* Evaluates several [specials](http://www.tex.ac.uk/cgi-bin/texfaq2html?label=specials) including color, emTeX, tpic, hyperref/HyperTeX, papersize, PDF hyperlink and mapfile, as well as PostScript specials.
* The converter was successfully tested on various Linux ([TeX Live](https://www.tug.org/texlive)) and Windows ([MiKTeX](https://www.miktex.org), [W32TeX](http://w32tex.org)) systems.
* _dvisvgm_ has been added to [TeX Live](https://www.tug.org/texlive), [W32TeX](http://w32tex.org), and [MiKTeX](https://www.miktex.org). It is therefore available for a wide range of operating systems.

Expand Down Expand Up @@ -90,10 +90,7 @@ _dvisvgm_ relies on the following free libraries:
bundled with the _dvisvgm_ sources.

* [zlib](http://www.zlib.org)
Compressed SVG files are produced by using functions of this library and the
[Gzstream wrapper classes](http://www.cs.unc.edu/Research/compgeom/gzstream)
which are licensed under LGPL version 2.1 (or optionally any later version)
and should be included with this package.
This library is required to create compressed [SVGZ](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics#Compression) files.

If you want to build and run the test suite located in the _tests_
subdirectory, you also need the [Google Test](https://github.com/google/googletest)
Expand Down
17 changes: 9 additions & 8 deletions doc/dvisvgm.txt.in
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The results are not as perfect as most (manually optimized) PFB or OTF counterpa
nonetheless really nice in most cases.

When running dvisvgm without option *--no-fonts*, it creates 'font' elements (+<font>+...+</font>+)
to embed the font data into the SVG files. Unfortunately, only few SVG renderes support these
to embed the font data into the SVG files. Unfortunately, only few SVG renderers support these
elements yet. Most web browsers and vector graphics applications don't evaluate them properly so
that the text components of the resulting graphics might look strange. In order to create more
compatible SVG files, command-line option *--no-fonts* can be given to replace the font elements
Expand All @@ -77,7 +77,8 @@ specifying the options is not significant, i.e. you can add them in any order wi
dvisvgm's behavior. Certain options accept or require additional parameters which are directly
appended to or separated by whitespace from a short option (e.g. +-v0+ or +-v 0+). Long options
require an additional equals sign (+=+) between option name and argument but without any surrounding
whitespace (e.g. +--verbosity=0+).
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
Expand Down Expand Up @@ -372,7 +373,7 @@ For example, +--output="%f-%(p-1)"+ creates filenames where the numbering starts
than 1.
+
The default pattern is +%f-%p.svg+ if the DVI file consists of more than one page, and
*%f.svg* otherwise. That means, a DVI file 'foo.dvi' is converted to 'foo.svg' if 'foo.dvi'
+%f.svg+ otherwise. That means, a DVI file 'foo.dvi' is converted to 'foo.svg' if 'foo.dvi'
is a single-page document. Otherwise, multiple SVG files 'foo-01.svg', 'foo-02.svg', etc. are
produced. In Windows environments, the percent sign indicates dereferenced environment
variables, and must therefore be protected by a second percent sign, e.g. +--output=%%f-%%p+.
Expand Down Expand Up @@ -680,11 +681,11 @@ 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
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), and for 'gsdll32.dll' or 'gsdll64.dll' on
Windows. You can override the default file names with environment variable *LIBGS* or the command-line
option *--libgs*. The library must be reachable through the ld search path (\*nix) or the PATH environment
variable (Windows). Alternatively, the absolute file path can be specified. If the library cannot be found,
dvisvgm disables the processing of PostScript specials and prints a warning message.
'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
*LIBGS* or the command-line option *--libgs*. The library must be reachable through the ld search path (\*nix)
or the PATH environment variable (Windows). Alternatively, the absolute file path can be specified. If the library
cannot be found, dvisvgm disables the processing of PostScript specials and prints a warning message.
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
Expand Down

0 comments on commit 829440b

Please sign in to comment.