diff mupdf-source/docs/tools/mutool-audit.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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mupdf-source/docs/tools/mutool-audit.rst	Mon Sep 15 11:43:07 2025 +0200
@@ -0,0 +1,33 @@
+mutool audit
+============
+
+The ``audit`` command prints a report of operator and space usage for a PDF file.
+
+.. code-block:: bash
+
+	mutool audit [options] file
+
+``[options]``
+	Options are as follows:
+
+	``-o`` output file
+		Use the specified filename for the produced HTML report.
+
+``file``
+	Input file name. The input must be a PDF file.
+
+The report takes the form of an HTML document. The report assumes a fair degree
+of familiarity with the PDF format.
+
+The first section of the file gives figures for the proportions of the file
+that are objects vs the overheads for storing those objects, for both objects
+inside and outside of ObjStms. It also lists the size of as a percentage of the
+whole file.
+
+The second section of the file gives figures for the usage of the different
+objects within the file. The classification of objects is simplistic, but works
+in most cases.
+
+The final section of the file gives figures for the frequency of use of
+different graphical operators within operator streams. These figures should be
+taken as being indicative, rather than 100% accurate.