summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSebastian Rasmussen <sebras@gmail.com>2016-01-12 16:24:26 +0100
committerTor Andersson <tor.andersson@artifex.com>2016-01-20 16:34:52 +0100
commit54b039c006c8f7eb0f6cd81800f2167c3ba228eb (patch)
tree352ad039271b0a00b8ba31bfb0a0edeeaf92e287 /docs
parent8fffb693819323722cd6f8cd94135546bfc39bca (diff)
downloadmupdf-54b039c006c8f7eb0f6cd81800f2167c3ba228eb.tar.xz
Update manpages.
Diffstat (limited to 'docs')
-rw-r--r--docs/man/mupdf.1117
-rw-r--r--docs/man/mutool.135
2 files changed, 108 insertions, 44 deletions
diff --git a/docs/man/mupdf.1 b/docs/man/mupdf.1
index 8d50f790..38a9cd08 100644
--- a/docs/man/mupdf.1
+++ b/docs/man/mupdf.1
@@ -1,17 +1,31 @@
-.TH MUPDF 1 "May 25, 2015"
+.TH MUPDF 1 "January 12, 2016"
.\" Please adjust this date whenever revising the manpage.
+.\" no hyphenation
+.nh
+.\" adjust left
+.ad l
.SH NAME
mupdf \- MuPDF is a lightweight PDF viewer written in portable C
.SH SYNOPSIS
.B mupdf
-.RI [ options ] " PDFfile"
+.RI [ options ] " file"
.SH DESCRIPTION
-This manual page briefly describes the
-.B mupdf
-command.
+.B MuPDF
+is a document viewer that can show
+.B PDF,
+.B XPS,
+.B EPUB,
+.B XHTML,
+.B CBZ,
+and various image formats such as
+.B PNG,
+.B JPEG,
+.B GIF,
+and
+.B TIFF.
.PP
.SH OPTIONS
@@ -42,12 +56,19 @@ Page height in points for EPUB layout.
.TP
.B \-S size
Font size in points for EPUB layout.
+.TP
+.B \-U CSS-file
+User style sheet for EPUB layout.
.SH MOUSE BEHAVIOR
.TP
.B Left mouse button click
-A left click on a hyper link follows the link.
+A left click on a hyper link follows the link. In presentation mode
+advances to the next page.
+.TP
+.B Right mouse button click
+In presentation mode goes back to the previous page.
.TP
.B Left mouse button drag
Pan the page. Panning beyond the bottom or top
@@ -56,8 +77,10 @@ edge will go to the next or previous page.
.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
+Press
+.B Ctrl+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
@@ -72,34 +95,24 @@ Zoom in or out.
.SH KEY BINDINGS
-.TP
-.B L, R
-Rotate page left (counter-clockwise) or right (clockwise).
-.TP
-.B h, j, k, l
-Pan page left, down, up, or right.
-.TP
-.B \+, \-
-Zoom in or out.
-.TP
-.B W, H
-Zoom page to exactly fit width or height of window.
-.TP
-.B w
-Shrinkwrap window to fit the page.
-.TP
-.B r
-Reload file.
+.PP
+Page navigation:
.TP
.B . pgdn right space
-Go to the next page
+Go to the next page.
.TP
.B , pgup left b backspace
-Go to the previous page
+Go to the previous page.
.TP
.B <, >
Skip back/forth 10 pages at a time.
.TP
+.B 123g
+Go to page 123.
+.TP
+.B g, G
+Go to the first or last page.
+.TP
.B m
Mark current page for snap back. Up to 256 pages can be marked.
.TP
@@ -111,21 +124,51 @@ Save the current page number in the numbered register.
.TP
.B [0-9]t
Go to the page saved in the numbered register.
+
+.PP
+Zooming and rotating:
.TP
-.B 123g
-Go to page 123.
+.B \+, \-
+Zoom in or out.
.TP
-.B g, G
-Go to the first or last page.
+.B W, H
+Zoom page to exactly fit width/height of window.
+.TP
+.B Z
+Zoom page to fit either to width or height of window.
+.TP
+.B L, R
+Rotate page left (counter-clockwise) or right (clockwise).
+.TP
+.B w
+Shrinkwrap window to fit the page.
+.TP
+.B f
+Toggles fullscreen mode.
+
+.PP
+Panning:
+.TP
+.B h, j, k, l
+Pan page left, down, up, or right.
+
+.PP
+Searching:
.TP
.B /, ?
Search for text forwards or backwards.
.TP
.B n, N
Find the next/previous search result.
+
+.PP
+Miscellanous:
.TP
-.B f
-Toggles fullscreen mode.
+.B [, ]
+Increase/decrease EPUB/XHTML font size.
+.TP
+.B r
+Reload file.
.TP
.B p
Toggle presentation mode.
@@ -135,9 +178,13 @@ Toggle between color and grayscale rendering.
.TP
.B C
Toggle full-page color tinting.
+.TP
.B i
Toggle between normal and inverted color rendering.
.TP
+.B S
+Save updated document file.
+.TP
.B q
Quit.
@@ -152,4 +199,4 @@ file to be reloaded automatically, for use in e.g. build scripts.
.BR mutool (1).
.SH AUTHOR
-MuPDF is Copyright 2006-2014 Artifex Software, Inc.
+MuPDF is Copyright 2006-2016 Artifex Software, Inc.
diff --git a/docs/man/mutool.1 b/docs/man/mutool.1
index bbed7c6f..4d2c0914 100644
--- a/docs/man/mutool.1
+++ b/docs/man/mutool.1
@@ -1,4 +1,4 @@
-.TH "MUTOOL" "1" "May 25, 2015"
+.TH "MUTOOL" "1" "January 12, 2016"
.\" Please adjust this date whenever revising the manpage.
.\" no hyphenation
.nh
@@ -12,7 +12,7 @@ mutool \- all purpose tool for dealing with PDF files
mutool <sub-command> [options]
.SH DESCRIPTION
-mutool is a tool based on MuPDF for dealing with PDF files in various manners.
+mutool is a tool based on MuPDF for dealing with document files in various manners.
There are several sub commands available, as described below.
.SH DRAW
@@ -32,13 +32,14 @@ The supported output text formats are: plain text, html, and structured text (as
Use the specified password if the file is encrypted.
.TP
.B \-o output
-The output format is inferred from the output file name.
+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.
.TP
.B \-F format
-Enforce a specific output format. Use this when outputting to stdout.
+Enforce a specific output format. Only necessary when outputting to stdout
+since normally the output filename is used to infer the output format.
.TP
.B \-R angle
Rotate clockwise by given number of degrees.
@@ -58,6 +59,12 @@ render with a maximum height).
.B \-f
Fit exactly; ignore the aspect ratio when matching specified width/heights.
.TP
+.B \-B bandheight
+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.
+.TP
.B \-W width
Page width in points for EPUB layout.
.TP
@@ -85,10 +92,15 @@ Invert colors.
.TP
.B \-s [mft5]
Show various bits of information:
-memory use,
-features,
-timings, and/or
-md5 checksum.
+.B m
+for glyph cache and total memory usage,
+.B f
+for page features such as whether the page is grayscale or color,
+.B t
+for per page rendering times as well statistics, and
+.B 5
+for md5 checksums of rendered images that can be used to check if rendering has
+changed.
.TP
.B \-A bits
Specify how many bits of anti-aliasing to use. The default is 8.
@@ -96,6 +108,7 @@ Specify how many bits of anti-aliasing to use. The default is 8.
.B \-D
Disable use of display lists. May cause slowdowns, but should reduce
the amount of memory used.
+.TP
.B \-i
Ignore errors.
.TP
@@ -225,6 +238,7 @@ Split the page into this many horizontal pieces.
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
@@ -252,6 +266,9 @@ Print the cross reference table.
.B 'trailer' or 't'
Print the trailer dictionary.
.TP
+.B 'encrypt' or 'e'
+Print the encryption dictionary.
+.TP
.B 'pagetree' or 'p'
List the object numbers for every page.
.TP
@@ -265,4 +282,4 @@ Print the outline (table of contents).
.BR mupdf (1),
.SH AUTHOR
-MuPDF is Copyright 2006-2015 Artifex Software, Inc.
+MuPDF is Copyright 2006-2016 Artifex Software, Inc.