summaryrefslogtreecommitdiff
path: root/docs/man/mudraw.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/mudraw.1')
-rw-r--r--docs/man/mudraw.189
1 files changed, 89 insertions, 0 deletions
diff --git a/docs/man/mudraw.1 b/docs/man/mudraw.1
new file mode 100644
index 00000000..eec79f7b
--- /dev/null
+++ b/docs/man/mudraw.1
@@ -0,0 +1,89 @@
+.TH MUDRAW 1 "March 28, 2012"
+.\" Please adjust this date whenever revising the manpage.
+.SH NAME
+mudraw \- render PDF/XPS/CBZ documents
+.SH SYNOPSIS
+.B mudraw
+.RI [ options ]
+.RI input.{pdf,xps,cbz}
+.RI [ pages]
+.SH DESCRIPTION
+.B mudraw
+will render a document of a supported document format to image files.
+The supported document formats are: pdf, xps and cbz.
+The supported image formats are: pgm, ppm, pam and png.
+Select the pages to be rendered by specifying a comma
+separated list of ranges and individual page numbers (for example: 1,5,10-15).
+In no pages are specified all the pages will be rendered.
+.SH OPTIONS
+.TP
+.B \-o output
+The image format is deduced from the output file name.
+Embed %d in the name to indicate the page number (for example: "page%d.png").
+.TP
+.B \-p password
+Use the specified password if the file is encrypted.
+.TP
+.B \-r resolution
+Render the page at the specified resolution.
+The default resolution is 72 dpi.
+.TP
+.B \-w width
+Render the page at the specified width (or, if the -r flag is used,
+render with a maximum width).
+.TP
+.B \-h height
+Render the page at the specified height (or, if the -r flag is used,
+render with a maximum height).
+.TP
+.B \-f
+'Fit' exactly; ignore the aspect ratio when matching specified width/heights.
+.TP
+.B \-R angle
+Rotate clockwise by given number of degrees.
+.TP
+.B \-a
+Save the alpha channel.
+The default behavior is to render each page with a white background.
+With this option, the page background is transparent.
+Only supported for pam and png output formats.
+.TP
+.B \-g
+Render in grayscale.
+The default is to render a full color RGB image.
+If the output format is pgm or ppm this option is ignored.
+.TP
+.B \-m
+Show timing information.
+Take the time it takes for each page to render and print
+a summary at the end.
+.TP
+.B \-5
+Print an MD5 checksum of the rendered image data for each page.
+.TP
+.B \-t
+Print the text contents of each page in UTF-8 encoding.
+Give the option twice to print detailed information
+about the location of each character in XML format.
+.TP
+.B \-x
+Print the display list used to render each page.
+.TP
+.B \-A
+Disable the use of accelerated functions.
+.TP
+.B \-G gamma
+Gamma correct the output image.
+Some typical values are 0.7 or 1.4 to thin or darken text rendering.
+.TP
+.B \-I
+Invert the output image colors.
+.TP
+.B pages
+Comma separated list of ranges to render.
+.SH SEE ALSO
+.BR mupdf (1),
+.BR mupdfclean (1).
+.BR mupdfshow (1).
+.SH AUTHOR
+MuPDF is Copyright 2006-2013 Artifex Software, Inc.