summaryrefslogtreecommitdiff
path: root/docs/manual-mutool-draw.html
diff options
context:
space:
mode:
authorTor Andersson <tor.andersson@artifex.com>2017-04-07 16:18:53 +0200
committerTor Andersson <tor.andersson@artifex.com>2017-04-13 13:52:16 +0200
commitc88941abc6f0fe91a41dc35dcaa1874d4de2c429 (patch)
tree51ff32d773f80219922a0458ec76f401ba21e138 /docs/manual-mutool-draw.html
parent9c805cc9f934cd12e89014db8ad70e3191cdaf2d (diff)
downloadmupdf-c88941abc6f0fe91a41dc35dcaa1874d4de2c429.tar.xz
Organize docs into HTML files.
Diffstat (limited to 'docs/manual-mutool-draw.html')
-rw-r--r--docs/manual-mutool-draw.html149
1 files changed, 149 insertions, 0 deletions
diff --git a/docs/manual-mutool-draw.html b/docs/manual-mutool-draw.html
new file mode 100644
index 00000000..bdd95170
--- /dev/null
+++ b/docs/manual-mutool-draw.html
@@ -0,0 +1,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/">DOWNLOAD</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>