comparison mupdf-source/docs/tools/mupdf-gl.rst @ 2:b50eed0cc0ef upstream

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 mupdf-gl
2 ========
3
4 The mupdf-gl viewer can show PDF, XPS, CBZ, EPUB, & FB2 documents as well as typical image formats including SVG.
5
6 Command Line Options
7 --------------------
8
9 .. code-block::
10
11 mupdf-gl [options] document [page]
12
13 ``[options]``
14 The options are:
15
16 ``-p`` password
17 The password needed to open a password protected PDF file.
18 ``-c`` profile.cc
19 Load an ICC profile to use for display (default is sRGB).
20 ``-r`` resolution
21 Set the initial zoom level, specified as DPI. The default value is ``72``.
22 ``-W`` width
23 Set the page width in points for EPUB layout.
24 ``-H`` height
25 Set the page height in points for EPUB layout.
26 ``-S`` size
27 Set the default font size in points for EPUB layout.
28 ``-U`` stylesheet
29 Specify a CSS file containing user styles to load for EPUB layout.
30 ``-X``
31 Ignore publisher styles for EPUB layout.
32 ``-J``
33 Disable Javascript in PDF forms.
34 ``-A`` level
35 Set anti-aliasing level or pixel rendering rule.
36 - ``0``: off.
37 - ``2``: 4 levels.
38 - ``4``: 16 levels.
39 - ``8``: 256 levels.
40 - ``9``: using centre of pixel rule.
41 - ``10``: using any part of a pixel rule.
42
43 ``-I``
44 Start in inverted color mode.
45 ``-B`` hex-color
46 Set black tint color (default ``303030``).
47 ``-C`` hex-color
48 Set white tint color (default ``FFFFF0``).
49 ``-Y`` factor
50 Set UI scaling factor (default calculated from screen DPI).
51
52 ``[page]``
53 The initial page number to show.
54
55 Examples
56 --------
57
58 To open the viewer with a file browser, just start it:
59
60 .. code-block:: bash
61
62 mupdf-gl
63
64 To open a specific file, in inverted color mode, on page 10:
65
66 .. code-block:: bash
67
68 mupdf-gl -I mupdf_explored.pdf 10
69
70 Mouse Bindings
71 --------------
72
73 The middle mouse button (scroll wheel button) pans the document view.
74
75 The right mouse button selects a region and copies the marked text to the clipboard.
76
77 Key Bindings
78 ------------
79
80 Several key bindings can take a number argument entered before the key, to modify the command.
81 For example, to zoom to 150 dpi, type "150z".
82
83 .. list-table::
84 :header-rows: 0
85 :align: left
86 :width: 80%
87 :widths: auto
88
89 * - **F1**
90 - Display help.
91 * - **i**
92 - Show document information.
93 * - **o**
94 - Show document outline.
95 * - **L**
96 - Highlight links.
97 * - **F**
98 - Highlight form fields.
99 * - **a**
100 - Show annotation editor.
101 * - **r**
102 - Reload document.
103 * - **S**
104 - Save document (only for PDF).
105 * - **q**
106 - Quit viewer.
107
108 .. list-table::
109 :header-rows: 0
110 :align: left
111 :width: 80%
112 :widths: auto
113
114 * - **<**
115 - Decrease E-book font size.
116 * - **>**
117 - Increase E-book font size.
118 * - **I**
119 - Toggle inverted color mode.
120 * - **C**
121 - Toggle tinted color mode.
122 * - **E**
123 - Toggle ICC color management.
124 * - **e**
125 - Toggle spot color emulation.
126 * - **A**
127 - Toggle anti-aliasing.
128
129 .. list-table::
130 :header-rows: 0
131 :align: left
132 :width: 80%
133 :widths: auto
134
135 * - **f**
136 - Toggle fullscreen.
137 * - **w**
138 - Shrinkwrap window to fit page.
139 * - **W**
140 - Fit page width to window.
141 * - **H**
142 - Fit page height to window.
143 * - **Z**
144 - Fit page size to window.
145 * - **[number] z**
146 - Set zoom resolution in DPI.
147 * - **+**
148 - Zoom in.
149 * - **-**
150 - Zoom out.
151 * - **[**
152 - Rotate counter-clockwise.
153 * - **]**
154 - Rotate clockwise.
155 * - **⬅️➡️⬆️⬇️** or **h**, **j**, **k**, **l**
156 - Pan page in small increments.
157
158 .. list-table::
159 :header-rows: 0
160 :align: left
161 :width: 80%
162 :widths: auto
163
164 * - **b**
165 - Smart move one screenful backward.
166 * - **[space]**
167 - Smart move one screenful forward.
168 * - **[comma]** or **[page up]**
169 - Go one page backward.
170 * - **[period]** or **[page down]**
171 - Go one page forward.
172 * - **[number] g**
173 - Go to page number.
174 * - **G**
175 - Go to last page.
176
177 .. list-table::
178 :header-rows: 0
179 :align: left
180 :width: 80%
181 :widths: auto
182
183 * - **m**
184 - Save current page to navigation history.
185 * - **t**
186 - Go back in navigation history.
187 * - **T**
188 - Go forward in navigation history.
189 * - **[number] m**
190 - Save current page in numbered bookmark.
191 * - **[number] t**
192 - Go to numbered bookmark.
193
194 .. list-table::
195 :header-rows: 0
196 :align: left
197 :width: 80%
198 :widths: auto
199
200 * - **/**
201 - Start searching forward.
202 * - **?**
203 - Start searching backward.
204 * - **n**
205 - Continue searching forward.
206 * - **N**
207 - Continue searching backward.