Mercurial > hgrepos > Python2 > PyMuPDF

comparison mupdf-source/docs/tools/mutool-audit.rst @ 3:2c135c81b16c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
0:6015a75abc2d 3:2c135c81b16c
1 mutool audit
2 ============
3
4 The ``audit`` command prints a report of operator and space usage for a PDF file.
5
6 .. code-block:: bash
7
8 mutool audit [options] file
9
10 ``[options]``
11 Options are as follows:
12
13 ``-o`` output file
14 Use the specified filename for the produced HTML report.
15
16 ``file``
17 Input file name. The input must be a PDF file.
18
19 The report takes the form of an HTML document. The report assumes a fair degree
20 of familiarity with the PDF format.
21
22 The first section of the file gives figures for the proportions of the file
23 that are objects vs the overheads for storing those objects, for both objects
24 inside and outside of ObjStms. It also lists the size of as a percentage of the
25 whole file.
26
27 The second section of the file gives figures for the usage of the different
28 objects within the file. The classification of objects is simplistic, but works
29 in most cases.
30
31 The final section of the file gives figures for the frequency of use of
32 different graphical operators within operator streams. These figures should be
33 taken as being indicative, rather than 100% accurate.