diff mupdf-source/docs/man/mupdf.1 @ 3:2c135c81b16c

MERGE: upstream PyMuPDF 1.26.4 with MuPDF 1.26.7
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:44:09 +0200
parents b50eed0cc0ef
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mupdf-source/docs/man/mupdf.1	Mon Sep 15 11:44:09 2025 +0200
@@ -0,0 +1,285 @@
+.TH MUPDF 1 "Apr 9, 2025"
+.\" 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 ] " file" [ page_number ]
+
+.SH DESCRIPTION
+.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.
+
+.SH OPTIONS
+A description of each of the supported options is included below.
+
+.TP
+.B \-b box-name
+Use the given page box (MediaBox, CropBox, BleedBox, TrimBox, or ArtBox)
+.TP
+.B \-c profile-filename
+Set the display ICC profile to the one in the named file.
+.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.
+.TP
+.B \-A bits
+Changes the anti-aliasing quality, specified as a number of bits between 0
+(off) and 8 (best).
+The default value is 8.
+.TP
+.B \-B RRGGBB
+Sets the full-page black tint using hexadecimal color syntax.
+The default value is 303030.
+.TP
+.B \-C RRGGBB
+Sets the full-page white tint using hexadecimal color syntax.
+The default value is FFFFF0.
+.TP
+.B \-H height
+Page height in points for EPUB layout.
+.TP
+.B \-I
+Invert colors.
+.TP
+.B \-J
+Disable JavaScripts in PDF forms.
+.TP
+.B \-R extraction-options
+Enable reflow and set the text extraction options.
+.TP
+.B \-S size
+Font size in points for EPUB layout.
+.TP
+.B \-U CSS-file
+User style sheet for EPUB layout.
+.TP
+.B \-W width
+Page width in points for EPUB layout.
+.TP
+.B \-X
+Disable document styles fro EPUB layout.
+.TP
+.B \-Y factor
+Set the UI scaling factor.
+
+.SH MOUSE BEHAVIOR
+
+.TP
+.B Left mouse button click
+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
+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
+.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
+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
+
+.PP
+Page navigation:
+.TP
+.B . pgdn space
+Go to the next page.
+.TP
+.B , pgup b
+Go to the previous page.
+.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
+.B t
+Go backward one step in mark history.
+.TP
+.B T
+Go forward one step in mark history.
+.TP
+.B [0\(en9]m
+Save the current page number in the numbered register.
+.TP
+.B [0\(en9]t
+Go to the page saved in the numbered register.
+
+.PP
+Zooming and rotating:
+.TP
+.B +, \-
+Zoom in or out.
+.TP
+.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 z
+Reset zoom level.
+.TP
+.B [, ]
+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, left, j, k, l, right
+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
+Miscellaneous:
+.TP
+.B F1
+Show key bindings help.
+.TP
+.B Escape
+Stop searching and/or remove focus from annotation/widget.
+.TP
+.B <, >
+Increase/decrease EPUB/XHTML font size.
+.TP
+.B r
+Reload file.
+.TP
+.B p
+Toggle presentation mode. (mupdf-x11 only)
+.TP
+.B c
+Toggle between color and grayscale rendering. (mupdf-x11 only)
+.TP
+.B C
+Toggle full-page color tinting.
+.TP
+.B I
+Toggle between normal and inverted color rendering.
+.TP
+.B E
+Toggle ICC color mode.
+.TP
+.B e
+Toggle spot color mode.
+.TP
+.B A
+Set bit of anti-aliasing to use. The default is 8.
+0 means no anti-aliasing,
+9 means no anti-aliasing, centre-of-pixel rule,
+10 means no anti-aliasing, any-part-of-a-pixel rule.
+.TP
+.B P
+Show page number and total number of pages.
+.TP
+.B i
+Show dialog box with informationa about the openend document.
+.TP
+.B B
+Change used page box. (MediaBox, CropBox, BleedBox, TrimBox, or ArtBox)
+The active page box is mentioned in the information dialog box.
+.TP
+.B o
+Show/hide document outline panel.
+.TP
+.B a
+Show/hide annotation panel.
+.TP
+.B R
+Show/hide redaction panel.
+.TP
+.B u
+Show/hide undo/redo panel.
+.TP
+.B Y
+Show/hide layers list.
+.TP
+.B o
+Start/stop highlighting links.
+.TP
+.B F
+Start/stop highlighting form widgets.
+.TP
+.B ` F12
+Show JS console.
+.TP
+.B S
+Save updated document file.
+.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 mutool (1).
+
+.SH AUTHOR
+MuPDF is Copyright 2006\(en2025 Artifex Software, Inc.