view mupdf-source/docs/tools/mutool-audit.rst @ 16:bd5bb0742cc3

A "check" target that checks for all venv and host prerequisites
author Franz Glasner <fzglas.hg@dom66.de>
date Wed, 17 Sep 2025 21:11:25 +0200
parents b50eed0cc0ef
children
line wrap: on
line source

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.