diff options
author | Tor Andersson <tor.andersson@artifex.com> | 2013-06-19 15:29:44 +0200 |
---|---|---|
committer | Tor Andersson <tor.andersson@artifex.com> | 2013-06-20 16:45:35 +0200 |
commit | 0a927854a10e1e6b9770a81e2e1d9f3093631757 (patch) | |
tree | 3d65d820d9fdba2d0d394d99c36290c851b78ca0 /docs/man | |
parent | 1ae8f19179c5f0f8c6352b3c7855465325d5449a (diff) | |
download | mupdf-0a927854a10e1e6b9770a81e2e1d9f3093631757.tar.xz |
Rearrange source files.
Diffstat (limited to 'docs/man')
-rw-r--r-- | docs/man/mudraw.1 | 89 | ||||
-rw-r--r-- | docs/man/mupdf.1 | 92 | ||||
-rw-r--r-- | docs/man/mutool.1 | 77 |
3 files changed, 258 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. diff --git a/docs/man/mupdf.1 b/docs/man/mupdf.1 new file mode 100644 index 00000000..a4a268a5 --- /dev/null +++ b/docs/man/mupdf.1 @@ -0,0 +1,92 @@ +.TH MUPDF 1 "June 12, 2012" +.\" Please adjust this date whenever revising the manpage. +.SH NAME +mupdf \- MuPDF is a lightweight PDF viewer written in portable C +.SH SYNOPSIS +.B mupdf +.RI [ options ] " PDFfile" +.SH DESCRIPTION +This manual page briefly describes the +.B mupdf +command. +.PP +.SH OPTIONS +A description of each of the supported options is included below. +.TP +.B \-p password +Uses the given password to open an encrypted PDF file. +The password is tried both as user and owner password. +.TP +.B \-r resolution +Changes the initial zoom level, specified as the resolution in dpi. +The default value is 72. +.SH MOUSE AND KEY BINDINGS +In addition to the key bindings described below, the mouse can also be +used. Clicking the left mouse button follows links within the PDF while +dragging with the left mouse button pans the page. Dragging with the right +mouse button selects an area and copies the enclosed text to the clipboard +buffer. Using the scroll-wheel while pressing Control zooms in/out, if +Shift is pressed on the other hand then the page is panned. +.TP +.B L, R +Rotate page left (clockwise) or right (counter-clockwise). +.TP +.B h, j, k, l +Scroll page left, down, up, or right. +.TP +.B \+, \- +Zoom in or out. +.TP +.B W, H +Zoom so page exactly fits width or height of window. +.TP +.B w +Shrinkwrap window to fit the page. +.TP +.B r +Reload file. +.TP +.B . pgdn right space +Go to the next page +.TP +.B , pgup left b backspace +Go to the previous page +.TP +.B <, > +Skip back/forth 10 pages at a time. +.TP +.B m +Mark page for snap back. +.TP +.B t +Pop back to the latest mark. +.TP +.B [0-9]m +Save the current page number in the numbered register. +.TP +.B [0-9]t +Go to the page saved in the numbered register. +.TP +.B 123g +Go to page 123. +.TP +.B / +Search for text. +.TP +.B n, N +Find the next/previous search result. +.TP +.B c +Toggle between color and grayscale rendering. +.TP +.B i +Toggle between normal and inverted color rendering. +.P +Sending a \fBSIGHUP\fR signal to the mupdf process will also cause the viewed +file to be reloaded automatically, for use in e.g. build scripts. +.SH SEE ALSO +.BR mupdfclean (1), +.BR mupdfdraw (1), +.BR mupdfshow (1). +.SH AUTHOR +MuPDF is Copyright 2006-2013 Artifex Software, Inc. diff --git a/docs/man/mutool.1 b/docs/man/mutool.1 new file mode 100644 index 00000000..d1c7079b --- /dev/null +++ b/docs/man/mutool.1 @@ -0,0 +1,77 @@ +.TH "MUTOOL" "1" "Oct 02, 2012" +.\" Please adjust this date whenever revising the manpage. +.\" no hyphenation +.nh +.\" adjust left +.ad l +.SH NAME +mutool \- all purpose tool for dealing with PDF files +.SH SYNOPSIS +mutool <sub-command> [options] +.SH DESCRIPTION +mutool is a tool based on MuPDF for dealing with PDF files in various manners. +There are several sub commands available, as described below. +.SH CLEAN +mutool clean [options] input.pdf [output.pdf] [pages] +.PP +The clean command pretty prints and rewrites the syntax of a PDF file. +It can be used to repair broken files, expand compressed streams, filter +out a range of pages, etc. +.PP +If no output file is specified, it will write the cleaned PDF to "out.pdf" +in the current directory. +.TP +.B \-p password +Use the specified password if the file is encrypted. +.TP +.B \-g +Garbage collect objects that have no references from other objects. +Give the option twice to renumber all objects and compact the cross reference table. +Give it three times to merge and reuse duplicate objects. +.TP +.B \-d +Decompress streams. This will make the output file larger, but provides +easy access for reading and editing the contents with a text editor. +.TP +.B pages +Comma separated list of page ranges to include. +.SH EXTRACT +TODO +.SH INFO +TODO +.SH POSTER +TODO +.SH SHOW +mutool show [options] file.pdf [object numbers ...] +.PP +The show command will print the specified objects and streams to stdout. +Streams are decoded and non-printable characters are represented +with a period by default. +.TP +.B \-b +Print streams as binary data and omit the object header. +.TP +.B \-e +Print streams in their original encoded (or compressed) form. +.TP +.B \-p password +Use the specified password if the file is encrypted. +.PP +Specify objects by number, or use one of the following special names: +.TP +.B 'xref' or 'x' +Print the cross reference table. +.TP +.B 'trailer' or 't' +Print the trailer dictionary. +.TP +.B 'pages' or 'p' +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. +.SH SEE ALSO +.BR mupdf (1), +.BR mudraw (1). +.SH AUTHOR +MuPDF is Copyright 2006-2013 Artifex Software, Inc. |