summaryrefslogtreecommitdiff
path: root/dviware/dvisvgm/src/options.xml
blob: b1911694ddddea097df4f34bdc0ecd2e66fe7504 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<?xml version="1.0"?>
<!-- *********************************************************************
** options.xml                                                          **
**                                                                      **
** This file is part of dvisvgm - a fast DVI to SVG converter           **
** Copyright (C) 2005-2020 Martin Gieseking <martin.gieseking@uos.de>   **
**                                                                      **
** This program is free software; you can redistribute it and/or        **
** modify it under the terms of the GNU General Public License as       **
** published by the Free Software Foundation; either version 3 of       **
** the License, or (at your option) any later version.                  **
**                                                                      **
** This program is distributed in the hope that it will be useful, but  **
** WITHOUT ANY WARRANTY; without even the implied warranty of           **
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the         **
** GNU General Public License for more details.                         **
**                                                                      **
** You should have received a copy of the GNU General Public License    **
** along with this program; if not, see <http://www.gnu.org/licenses/>. **
***********************************************************************-->
<!DOCTYPE cmdline SYSTEM "options.dtd">

<cmdline class="CommandLine">
	<program>
		<usage>[options] dvifile</usage>
		<usage>--eps [options] epsfile</usage>
		<usage>--pdf [options] pdffile</usage>
		<description>This program converts DVI files, as created by TeX/LaTeX, as well as\nEPS and PDF files to the XML-based scalable vector graphics format SVG.</description>
		<copyright>Copyright (C) 2005-2020 Martin Gieseking &lt;martin.gieseking@uos.de></copyright>
	</program>
	<options>
		<section title="Input options">
			<option long="page" short="p">
				<arg type="string" name="ranges" default="1"/>
				<description>choose page(s) to convert</description>
			</option>
			<option long="fontmap" short="m">
				<arg type="string" name="filenames"/>
				<description>evaluate (additional) font map files</description>
			</option>
			<option long="eps" short="E" if="!defined(DISABLE_GS)">
				<description>convert EPS file to SVG</description>
			</option>
			<option long="pdf" short="P" if="!defined(DISABLE_GS)">
				<description>convert PDF file to SVG</description>
			</option>
			<option long="stdin">
				<description>read input file from stdin</description>
			</option>
		</section>
		<section title="SVG output options">
			<option long="bbox" short="b">
				<arg type="string" name="size" default="min"/>
				<description>set size of bounding box</description>
			</option>
			<option long="bitmap-format" short="B" if="!defined(DISABLE_GS)">
				<arg type="string" name="fmt" default="jpeg"/>
				<description>set format used to embed PS/EPS bitmaps</description>
			</option>
			<option long="clipjoin" short="j" if="!defined(DISABLE_GS)">
				<description>compute intersection of clipping paths</description>
			</option>
			<option long="colornames">
				<description>prefer color names to RGB values if possible</description>
			</option>
			<option long="comments">
				<description>add comments with additional information</description>
			</option>
			<option long="font-format" short="f" if="!defined(DISABLE_WOFF)">
				<arg type="string" name="format" default="svg"/>
				<description>set file format of embedded fonts</description>
			</option>
			<option long="grad-overlap" if="!defined(DISABLE_GS)">
				<description>create overlapping color gradient segments</description>
			</option>
			<option long="grad-segments" if="!defined(DISABLE_GS)">
				<arg type="int" name="number" default="20"/>
				<description>number of color gradient segments per row</description>
			</option>
			<option long="grad-simplify" if="!defined(DISABLE_GS)">
				<arg type="double" name="delta" default="0.05"/>
				<description>reduce level of detail for small segments</description>
			</option>
			<option long="linkmark" short="L">
				<arg type="string" name="style" default="box"/>
				<description>select how to mark hyperlinked areas</description>
			</option>
			<option long="optimize" short="O">
				<arg name="modules" type="string" default="all" optional="yes"/>
				<description>perform several SVG optimizations</description>
			</option>
			<option long="output" short="o">
				<arg type="string" name="pattern"/>
				<description>set name pattern of output files</description>
			</option>
			<option long="precision" short="d">
				<arg type="int" name="number" default="0"/>
				<description>set number of decimal points (0-6)</description>
			</option>
			<option long="relative" short="R">
				<description>create relative path commands</description>
			</option>
			<option long="stdout" short="s">
				<description>write SVG output to stdout</description>
			</option>
			<option long="tmpdir">
				<arg type="string" name="path" optional="yes"/>
				<description>set/print the directory for temporary files</description>
			</option>
			<option long="no-fonts" short="n">
				<arg type="int" name="variant" default="0" optional="yes"/>
				<description>draw glyphs by using path elements</description>
			</option>
			<option long="no-merge">
				<description>don't merge adjacent text elements</description>
			</option>
			<option long="no-styles">
				<description>don't use CSS styles to reference fonts</description>
			</option>
			<option long="zip" short="z">
				<arg type="int" name="level" default="9" optional="yes"/>
				<description>create compressed .svgz file</description>
			</option>
		</section>
		<section title="SVG transformations">
			<option long="rotate" short="r">
				<arg type="double" name="angle"/>
				<description>rotate page content clockwise</description>
			</option>
			<option long="scale" short="c">
				<arg type="string" name="sx[,sy]"/>
				<description>scale page content</description>
			</option>
			<option long="translate" short="t">
				<arg type="string" name="tx[,ty]"/>
				<description>shift page content</description>
			</option>
			<option long="transform" short="T">
				<arg type="string" name="commands"/>
				<description>transform page content</description>
			</option>
			<option long="zoom" short="Z">
				<arg type="double" name="factor" default="1.0"/>
				<description>zoom page content</description>
			</option>
		</section>
		<section title="Processing options">
			<option long="cache" short="C">
				<arg type="string" name="dir" optional="yes"/>
				<description>set/print path of cache directory</description>
			</option>
			<option long="exact-bbox" short="e">
				<description>compute exact glyph bounding boxes</description>
			</option>
			<option long="keep">
				<description>keep temporary files</description>
			</option>
			<option long="libgs" if="!defined(HAVE_LIBGS) &amp;&amp; !defined(DISABLE_GS)">
				<arg name="filename" type="string"/>
				<description>set name of Ghostscript shared library</description>
			</option>
			<option long="mag" short="M">
				<arg type="double" name="factor" default="4"/>
				<description>magnification of Metafont output</description>
			</option>
			<option long="no-mktexmf">
				<description>don't try to create missing fonts</description>
			</option>
			<option long="no-specials" short="S">
				<arg type="string" name="prefixes" optional="yes"/>
				<description>don't process [selected] specials</description>
			</option>
			<option long="page-hashes" short="H">
				<arg type="string" name="params" optional="yes" default="xxh64"/>
				<description>activate usage of page hashes</description>
			</option>
			<option long="trace-all" short="a">
				<arg name="retrace" type="bool" optional="yes" default="false"/>
				<description>trace all glyphs of bitmap fonts</description>
			</option>
		</section>
		<section title="Message options">
			<option long="color">
				<description>colorize messages</description>
			</option>
			<option long="help" short="h">
				<arg name="mode" type="int" optional="yes" default="0"/>
				<description>print this summary of options and exit</description>
			</option>
			<option long="list-specials" short="l">
				<description>print supported special sets and exit</description>
			</option>
			<option long="progress">
				<arg name="delay" type="double" optional="yes" default="0.5"/>
				<description>enable progress indicator</description>
			</option>
			<option long="verbosity" short="v">
				<arg type="unsigned" name="level" default="7"/>
				<description>set verbosity level (0-7)</description>
			</option>
			<option long="version" short="V">
				<arg type="bool" name="extended" optional="yes" default="false"/>
				<description>print version and exit</description>
			</option>
		</section>
	</options>
</cmdline>