summaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
authorTor Andersson <tor.andersson@artifex.com>2013-07-26 02:00:45 +0200
committerSebastian Rasmussen <sebras@gmail.com>2013-07-26 02:14:29 +0200
commit8853bae8e33237a8b5470624e848bd976a19e663 (patch)
tree2d0191d7f6adee526088ead405403b7e7f5a6299 /docs/man
parent13fea96f5290a7abd52611bb96c2486e2ecc2169 (diff)
downloadmupdf-8853bae8e33237a8b5470624e848bd976a19e663.tar.xz
Expand and reorganize manpage text.
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/mudraw.111
-rw-r--r--docs/man/mupdf.183
-rw-r--r--docs/man/mutool.158
3 files changed, 128 insertions, 24 deletions
diff --git a/docs/man/mudraw.1 b/docs/man/mudraw.1
index eec79f7b..83dfe907 100644
--- a/docs/man/mudraw.1
+++ b/docs/man/mudraw.1
@@ -1,12 +1,15 @@
-.TH MUDRAW 1 "March 28, 2012"
+.TH MUDRAW 1 "July 25, 2013"
.\" 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.
@@ -15,6 +18,7 @@ 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
@@ -81,9 +85,10 @@ 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).
+.BR mutool (1).
+
.SH AUTHOR
MuPDF is Copyright 2006-2013 Artifex Software, Inc.
diff --git a/docs/man/mupdf.1 b/docs/man/mupdf.1
index a4a268a5..83c9b40c 100644
--- a/docs/man/mupdf.1
+++ b/docs/man/mupdf.1
@@ -1,17 +1,22 @@
-.TH MUPDF 1 "June 12, 2012"
+.TH MUPDF 1 "July 25, 2013"
.\" 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.
@@ -20,25 +25,52 @@ The password is tried both as user and owner password.
.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 \-b bits
+Changes the anti-aliasing quality, specified as a number of bits between 0
+(off) and 8 (best). The default value is 8.
+
+.SH MOUSE BEHAVIOR
+
+.TP
+.B Left mouse button click
+A left click on a hyper link follows the link.
+.TP
+.B Left mouse button drag
+Pan the page. Panning beyond the bottom or top
+edge will go to the next or previous page.
+.TP
+.B Right mouse button drag
+Select text in an area. On X11, the selected text
+can be pasted in another application with a middle click.
+Press Ctl+C to copy the selected text to the clipboard.
+On windows, the selected text will automatically be copied
+to the clipboard.
+.TP
+.B Scroll wheel
+Pan page up or down. Does not change page
+when reaching the bottom or top edge.
+.TP
+.B Shift + Scroll wheel
+Pan page left or right.
+.TP
+.B Control + Scroll wheel
+Zoom in or out.
+
+.SH KEY BINDINGS
+
.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.
+Pan 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.
+Zoom page to exactly fit width or height of window.
.TP
.B w
Shrinkwrap window to fit the page.
@@ -56,7 +88,7 @@ Go to the previous page
Skip back/forth 10 pages at a time.
.TP
.B m
-Mark page for snap back.
+Mark current page for snap back. Up to 256 pages can be marked.
.TP
.B t
Pop back to the latest mark.
@@ -70,23 +102,40 @@ Go to the page saved in the numbered register.
.B 123g
Go to page 123.
.TP
-.B /
-Search for text.
+.B g, G
+Go to the first or last page.
+.TP
+.B /, ?
+Search for text forwards or backwards.
.TP
.B n, N
Find the next/previous search result.
.TP
+.B f
+Toggles fullscreen mode.
+.TP
+.B p
+Toggle presentation mode.
+.TP
.B c
Toggle between color and grayscale rendering.
.TP
.B i
Toggle between normal and inverted color rendering.
-.P
+.TP
+.B q
+Quit.
+
+.SH SIGNALS
+
+.TP
+.B SIGHUP
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).
+.BR mudraw (1),
+.BR mutool (1).
+
.SH AUTHOR
MuPDF is Copyright 2006-2013 Artifex Software, Inc.
diff --git a/docs/man/mutool.1 b/docs/man/mutool.1
index d1c7079b..e09ae326 100644
--- a/docs/man/mutool.1
+++ b/docs/man/mutool.1
@@ -1,16 +1,20 @@
-.TH "MUTOOL" "1" "Oct 02, 2012"
+.TH "MUTOOL" "1" "July 25, 2013"
.\" 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
@@ -33,14 +37,58 @@ Give it three times to merge and reuse duplicate objects.
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 \-l
+Linearize output. Create a "Web Optimized" output file.
+.TP
+.B \-i
+Toggle decompression of image streams. Use in conjunction with -d to leave
+image- compressed.
+.TP
+.B \-f
+Toggle decompression of font streams. Use in conjunction with -d to leave
+fonts compressed.
+.TP
+.B \-a
+ASCII Hex encode binary streams. Use in conjuction with -d and -i or -f to
+ensure that although the images and/or fonts are compressed, the resulting
+file can still be viewed and edited with a text editor.
+.TP
.B pages
Comma separated list of page ranges to include.
+
.SH EXTRACT
-TODO
+mutool extract [options] file.pdf [object numbers]
+.PP
+The extract command can be used to extract images and font files from a PDF.
+If no object numbers are given on the command line, all images and fonts
+will be extracted.
+.TP
+.B \-p password
+Use the specified password if the file is encrypted.
+.TP
+.B \-r
+Convert images to RGB when extracting them.
+
.SH INFO
TODO
+
.SH POSTER
-TODO
+mutool poster [options] input.pdf [output.pdf]
+.PP
+The poster command splits each page into tiles, and puts each tile on
+a page of its own. It's useful for printing a large page onto smaller
+pieces of paper that can then be glued together to create a large poster.
+.TP
+.B \-p password
+Use the specified password if the file is encrypted.
+.TP
+.B \-x factor
+Split the page into this many horizontal pieces.
+.TP
+.B \-y factor
+Split the page into this many vertical pieces.
+.PP
+The output will have x times y number of pages for each input page.
.SH SHOW
mutool show [options] file.pdf [object numbers ...]
.PP
@@ -70,8 +118,10 @@ 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).
+.BR mupdf (1),
+
.SH AUTHOR
MuPDF is Copyright 2006-2013 Artifex Software, Inc.