summaryrefslogtreecommitdiff
path: root/docs/manual-mutool-draw.html
blob: d9457eb7b6ef1d67bc0ad268e9c48edb7d48845b (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
<!DOCTYPE html>
<html>
<head>
<title>mutool draw</title>
<link rel="stylesheet" href="style.css" type="text/css">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>

<body>

<header>
<h1>mutool draw</h1>
</header>

<nav>
<a href="http://mupdf.com/index.html">About</a>
<a href="http://mupdf.com/news.html">News</a>
<a href="index.html">Documentation</a>
<a href="http://mupdf.com/downloads/">Downloads</a>
<a href="http://git.ghostscript.com/?p=mupdf.git;a=summary">Source</a>
<a href="https://bugs.ghostscript.com/">Bugs</a>
</nav>

<article>

<p>
The draw command will render a document to image files, convert to
another vector format, or extract the text content.

<pre>
mutool draw [options] file [pages]
</pre>

<p>
The supported input document formats are: pdf, xps, cbz, and epub.

<p>
The supported output image formats are: pbm, pgm, ppm, pam, png, tga,
pwg, pcl and ps. The supported output vector formats are: svg, pdf,
and debug trace (as xml). The supported output text formats are: plain
text, html, and structured text (as xml).

<p>
Options:

<dl>
<dt> -p password
<dd> Use the specified password if the file is encrypted.

<dt> -o output
<dd> The output format is inferred from the output filename. Embed
%d in the name to indicate the page number (for example:
"page%d.png"). Printf modifiers are supported, for example "%03d". If no
output is specified, the output will go to stdout.

<dt> -F format
<dd> Enforce a specific output format. Only necessary when outputting
to stdout since normally the output filename is used to infer
the output format.

<dt> -R angle
<dd> Rotate clockwise by given number of degrees.

<dt> -r resolution
<dd> Render the page at the specified resolution. The default
resolution is 72 dpi.

<dt> -w width
<dd> Render the page at the specified width (or, if the -r flag is
used, render with a maximum width).

<dt> -h height
<dd> Render the page at the specified height (or, if the -r flag is
used, render with a maximum height).

<dt> -f
<dd> Fit exactly; ignore the aspect ratio when matching specified
width/heights.

<dt> -B bandheight
<dd> Render in banded mode with each band no taller than the given
height. This uses less memory during rendering. Only compatible
with pam, pgm, ppm, pnm and png output formats. Banded rendering
and md5 checksumming may not be used at the same time.

<dt> -W width
<dd> Page width in points for EPUB layout.

<dt> -H height
<dd> Page height in points for EPUB layout.

<dt> -S size
<dd> Font size in points for EPUB layout.

<dt> -U filename
<dd> User CSS stylesheet for EPUB layout.

<dt> -c colorspace
<dd> Render in the specified colorspace. Supported colorspaces are:
mono, gray, grayalpha, rgb, rgbalpha, cmyk, cmykalpha. Some
abbreviations are allowed: m, g, ga, rgba, cmyka. The default
is chosen based on the output format.

<dt> -G gamma
<dd> Apply gamma correction. Some typical values are 0.7 or 1.4 to
thin or darken text rendering.

<dt> -I
<dd> Invert colors.

<dt> -s [mft5]
<dd> Show various bits of information: m for glyph cache and total
memory usage, f for page features such as whether the page is
grayscale or color, t for per page rendering times as well
statistics, and 5 for md5 checksums of rendered images that can
be used to check if rendering has changed.

<dt> -A bits
<dd> Specify how many bits of anti-aliasing to use. The default is 8.

<dt> -D
<dd> Disable use of display lists. May cause slowdowns, but should
reduce the amount of memory used.

<dt> -i
<dd> Ignore errors.

<dt> -L
<dd> Low memory mode (avoid caching objects by clearing cache after each page).

<dt> -P
<dd> Run interpretation and rendering at the same time.

<dt> pages
<dd> Comma separated list of page numbers and ranges (for example:
1,5,10-15). If no pages are specified, then all pages will be
rendered.

</dl>

</article>

<footer>
<a href="http://artifex.com"><img src="artifex-logo.png" align="right"></a>
Copyright &copy; 2006-2017 Artifex Software Inc.
</footer>

</body>
</html>