summaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
authorTor Andersson <tor.andersson@artifex.com>2015-03-31 16:46:36 +0200
committerRobin Watts <robin.watts@artifex.com>2015-04-01 11:01:02 +0100
commitd16ad89284cab160dd527f67e45142b146a6b99e (patch)
treeb99808db42ef6b3ca21b95d35ad46a75b1fd5c7f /docs/man
parentbdad9d2713be21c2ee092cbdf1c7e75d6ba3cba3 (diff)
downloadmupdf-d16ad89284cab160dd527f67e45142b146a6b99e.tar.xz
Clean up mudraw command line syntax.
... and move outline printing to mutool show.
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/mudraw.199
-rw-r--r--docs/man/mutool.17
2 files changed, 56 insertions, 50 deletions
diff --git a/docs/man/mudraw.1 b/docs/man/mudraw.1
index 6964b044..172ec45f 100644
--- a/docs/man/mudraw.1
+++ b/docs/man/mudraw.1
@@ -1,32 +1,45 @@
-.TH MUDRAW 1 "July 25, 2013"
+.TH MUDRAW 1 "March 31, 2015"
.\" Please adjust this date whenever revising the manpage.
+.\" no hyphenation
+.nh
+.\" adjust left
+.ad l
.SH NAME
-mudraw \- render PDF/XPS/CBZ documents
+mudraw \- render PDF/XPS/CBZ/EPUB documents
.SH SYNOPSIS
.B mudraw
.RI [ options ]
-.RI input.{pdf,xps,cbz}
+.RI file
.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.
+will render a document of a supported document format to image files,
+convert to another vector format, or extract the text content.
+
+The supported input document formats are: pdf, xps, cbz, and epub.
+
+The supported output image formats are: pbm, pgm, ppm, pam, png, tga, pwg, and pcl.
+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).
.SH OPTIONS
.TP
+.B \-p password
+Use the specified password if the file is encrypted.
+.TP
.B \-o output
-The image format is deduced from the output file name.
+The output format is inferred from the output file name.
Embed %d in the name to indicate the page number (for example: "page%d.png").
+If no output is specified, the output will go to stdout.
.TP
-.B \-p password
-Use the specified password if the file is encrypted.
+.B \-F format
+Enforce a specific output format. Use this when outputting to stdout.
+.TP
+.B \-R angle
+Rotate clockwise by given number of degrees.
.TP
.B \-r resolution
Render the page at the specified resolution.
@@ -43,52 +56,42 @@ render with a maximum height).
.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.
+.B \-c colorspace
+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.
.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.
+.B -G gamma
+Apply gamma correction.
+Some typical values are 0.7 or 1.4 to thin or darken text rendering.
.TP
-.B \-x
-Print the display list used to render each page.
+.B -I
+Invert colors.
.TP
-.B \-A
-Disable the use of accelerated functions.
+.B \-s [mft5]
+Show various bits of information:
+memory use,
+features,
+timings, and/or
+md5 checksum.
.TP
-.B \-G gamma
-Gamma correct the output image.
-Some typical values are 0.7 or 1.4 to thin or darken text rendering.
+.B \-A bits
+Specify how many bits of anti-aliasing to use. The default is 8.
.TP
-.B \-I
-Invert the output image colors.
+.B \-D
+Disable use of display lists. May cause slowdowns, but should reduce
+the amount of memory used.
+.B \-i
+Ignore errors.
.TP
.B pages
-Comma separated list of ranges to render.
+Comma separated list of ranges and individual page numbers (for example: 1,5,10-15).
+If no pages are specified, then all pages will be rendered.
.SH SEE ALSO
.BR mupdf (1),
.BR mutool (1).
.SH AUTHOR
-MuPDF is Copyright 2006-2014 Artifex Software, Inc.
+MuPDF is Copyright 2006-2015 Artifex Software, Inc.
diff --git a/docs/man/mutool.1 b/docs/man/mutool.1
index a936a22c..164b33db 100644
--- a/docs/man/mutool.1
+++ b/docs/man/mutool.1
@@ -1,4 +1,4 @@
-.TH "MUTOOL" "1" "July 25, 2013"
+.TH "MUTOOL" "1" "March 31, 2015"
.\" Please adjust this date whenever revising the manpage.
.\" no hyphenation
.nh
@@ -118,10 +118,13 @@ List the object numbers for every page.
.TP
.B 'grep' or 'g'
Print all the objects in the file in a compact one-line format suitable for piping to grep.
+.TP
+.B 'outline' or 'o'
+Print the outline (table of contents).
.SH SEE ALSO
.BR mudraw (1).
.BR mupdf (1),
.SH AUTHOR
-MuPDF is Copyright 2006-2014 Artifex Software, Inc.
+MuPDF is Copyright 2006-2015 Artifex Software, Inc.