Mercurial > hgrepos > Python2 > PyMuPDF

comparison mupdf-source/docs/man/mupdf.1 @ 2:b50eed0cc0ef upstream

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
1 .TH MUPDF 1 "Apr 9, 2025"
2 .\" Please adjust this date whenever revising the manpage.
3 .\" no hyphenation
4 .nh
5 .\" adjust left
6 .ad l
7
8 .SH NAME
9 mupdf \- MuPDF is a lightweight PDF viewer written in portable C
10
11 .SH SYNOPSIS
12 .B mupdf
13 .RI [ options ] " file" [ page_number ]
14
15 .SH DESCRIPTION
16 .B MuPDF
17 is a document viewer that can show
18 .B PDF,
19 .B XPS,
20 .B EPUB,
21 .B XHTML,
22 .B CBZ,
23 and various image formats such as
24 .B PNG,
25 .B JPEG,
26 .B GIF,
27 and
28 .B TIFF.
29
30 .SH OPTIONS
31 A description of each of the supported options is included below.
32
33 .TP
34 .B \-b box-name
35 Use the given page box (MediaBox, CropBox, BleedBox, TrimBox, or ArtBox)
36 .TP
37 .B \-c profile-filename
38 Set the display ICC profile to the one in the named file.
39 .TP
40 .B \-p password
41 Uses the given password to open an encrypted PDF file.
42 The password is tried both as user and owner password.
43 .TP
44 .B \-r resolution
45 Changes the initial zoom level, specified as the resolution in dpi.
46 The default value is 72.
47 .TP
48 .B \-A bits
49 Changes the anti-aliasing quality, specified as a number of bits between 0
50 (off) and 8 (best).
51 The default value is 8.
52 .TP
53 .B \-B RRGGBB
54 Sets the full-page black tint using hexadecimal color syntax.
55 The default value is 303030.
56 .TP
57 .B \-C RRGGBB
58 Sets the full-page white tint using hexadecimal color syntax.
59 The default value is FFFFF0.
60 .TP
61 .B \-H height
62 Page height in points for EPUB layout.
63 .TP
64 .B \-I
65 Invert colors.
66 .TP
67 .B \-J
68 Disable JavaScripts in PDF forms.
69 .TP
70 .B \-R extraction-options
71 Enable reflow and set the text extraction options.
72 .TP
73 .B \-S size
74 Font size in points for EPUB layout.
75 .TP
76 .B \-U CSS-file
77 User style sheet for EPUB layout.
78 .TP
79 .B \-W width
80 Page width in points for EPUB layout.
81 .TP
82 .B \-X
83 Disable document styles fro EPUB layout.
84 .TP
85 .B \-Y factor
86 Set the UI scaling factor.
87
88 .SH MOUSE BEHAVIOR
89
90 .TP
91 .B Left mouse button click
92 A left click on a hyper link follows the link.
93 In presentation mode advances to the next page.
94 .TP
95 .B Right mouse button click
96 In presentation mode goes back to the previous page.
97 .TP
98 .B Left mouse button drag
99 Pan the page.
100 Panning beyond the bottom or top
101 edge will go to the next or previous page.
102 .TP
103 .B Right mouse button drag
104 Select text in an area.
105 On X11, the selected text
106 can be pasted in another application with a middle click.
107 Press
108 .B Ctrl+C
109 to copy the selected text to the clipboard.
110 On Windows, the selected text will automatically be copied
111 to the clipboard.
112 .TP
113 .B Scroll wheel
114 Pan page up or down.
115 Does not change page when reaching the bottom or top edge.
116 .TP
117 .B Shift + Scroll wheel
118 Pan page left or right.
119 .TP
120 .B Control + Scroll wheel
121 Zoom in or out.
122
123 .SH KEY BINDINGS
124
125 .PP
126 Page navigation:
127 .TP
128 .B . pgdn space
129 Go to the next page.
130 .TP
131 .B , pgup b
132 Go to the previous page.
133 .TP
134 .B 123g
135 Go to page 123.
136 .TP
137 .B g, G
138 Go to the first or last page.
139 .TP
140 .B m
141 Mark current page for snap back.
142 Up to 256 pages can be marked.
143 .TP
144 .B t
145 Go backward one step in mark history.
146 .TP
147 .B T
148 Go forward one step in mark history.
149 .TP
150 .B [0\(en9]m
151 Save the current page number in the numbered register.
152 .TP
153 .B [0\(en9]t
154 Go to the page saved in the numbered register.
155
156 .PP
157 Zooming and rotating:
158 .TP
159 .B +, \-
160 Zoom in or out.
161 .TP
162 .B W, H
163 Zoom page to exactly fit width/height of window.
164 .TP
165 .B Z
166 Zoom page to fit either to width or height of window.
167 .TP
168 .B z
169 Reset zoom level.
170 .TP
171 .B [, ]
172 Rotate page left (counter-clockwise) or right (clockwise).
173 .TP
174 .B w
175 Shrinkwrap window to fit the page.
176 .TP
177 .B f
178 Toggles fullscreen mode.
179
180 .PP
181 Panning:
182 .TP
183 .B h, left, j, k, l, right
184 Pan page left, down, up, or right.
185
186 .PP
187 Searching:
188 .TP
189 .B /, ?
190 Search for text forwards or backwards.
191 .TP
192 .B n, N
193 Find the next/previous search result.
194
195 .PP
196 Miscellaneous:
197 .TP
198 .B F1
199 Show key bindings help.
200 .TP
201 .B Escape
202 Stop searching and/or remove focus from annotation/widget.
203 .TP
204 .B <, >
205 Increase/decrease EPUB/XHTML font size.
206 .TP
207 .B r
208 Reload file.
209 .TP
210 .B p
211 Toggle presentation mode. (mupdf-x11 only)
212 .TP
213 .B c
214 Toggle between color and grayscale rendering. (mupdf-x11 only)
215 .TP
216 .B C
217 Toggle full-page color tinting.
218 .TP
219 .B I
220 Toggle between normal and inverted color rendering.
221 .TP
222 .B E
223 Toggle ICC color mode.
224 .TP
225 .B e
226 Toggle spot color mode.
227 .TP
228 .B A
229 Set bit of anti-aliasing to use. The default is 8.
230 0 means no anti-aliasing,
231 9 means no anti-aliasing, centre-of-pixel rule,
232 10 means no anti-aliasing, any-part-of-a-pixel rule.
233 .TP
234 .B P
235 Show page number and total number of pages.
236 .TP
237 .B i
238 Show dialog box with informationa about the openend document.
239 .TP
240 .B B
241 Change used page box. (MediaBox, CropBox, BleedBox, TrimBox, or ArtBox)
242 The active page box is mentioned in the information dialog box.
243 .TP
244 .B o
245 Show/hide document outline panel.
246 .TP
247 .B a
248 Show/hide annotation panel.
249 .TP
250 .B R
251 Show/hide redaction panel.
252 .TP
253 .B u
254 Show/hide undo/redo panel.
255 .TP
256 .B Y
257 Show/hide layers list.
258 .TP
259 .B o
260 Start/stop highlighting links.
261 .TP
262 .B F
263 Start/stop highlighting form widgets.
264 .TP
265 .B ` F12
266 Show JS console.
267 .TP
268 .B S
269 Save updated document file.
270 .TP
271 .B q
272 Quit.
273
274 .SH SIGNALS
275
276 .TP
277 .B SIGHUP
278 Sending a \fBSIGHUP\fR signal to the mupdf process will also cause the viewed
279 file to be reloaded automatically, for use in e.g.\& build scripts.
280
281 .SH SEE ALSO
282 .BR mutool (1).
283
284 .SH AUTHOR
285 MuPDF is Copyright 2006\(en2025 Artifex Software, Inc.