mutool convert¶
The convert
command converts an input file into another format.
mutool convert [options] file [pages]
Note
Command line parameters within square brackets []
are optional.
[options]
Options are as follows:
-p
passwordUse the specified password if the file is encrypted.
-o
outputThe output file name. The output format is inferred from the output filename. Embed
%d
in the name to indicate the page number (for example: “page%d.png”). Printf modifiers are supported, for example “%03d”. If no output is specified, the output will go tostdout
.-F
output format (default inferred from output file name)raster:
cbz
,png
,pnm
,pgm
,ppm
,pam
,pbm
,pkm
.print-raster:
pcl
,pclm
,ps
,pwg
.vector:
pdf
,svg
.text:
html
,xhtml
,text
,stext
.
-b
boxUse named page box (
MediaBox
,CropBox
,BleedBox
,TrimBox
, orArtBox
), see defined boxes.-A
bitsSpecify how many bits of anti-aliasing to use. The default is
8
.-W
widthPage width in points for EPUB layout.
-H
heightPage height in points for EPUB layout.
-S
sizeFont size in points for EPUB layout.
-U
filenameUser CSS stylesheet for EPUB layout.
-X
Disable document styles for EPUB layout.
-O
comma separated list of options for output format.- Raster output options:
rotate=N
Rotate rendered pages N degrees counterclockwise.resolution=N
Set both X and Y resolution in pixels per inch.x-resolution=N
X resolution of rendered pages in pixels per inch.y-resolution=N
Y resolution of rendered pages in pixels per inch.width=N
Render pages to fit N pixels wide (ignore resolution option).height=N
Render pages to fit N pixels tall (ignore resolution option).colorspace=(gray|rgb|cmyk)
Render using specified colorspace.alpha
Render pages with alpha channel and transparent background.graphics=(aaN|cop|app)
Set the rasterizer to use for graphics.aaN
Antialias with N bits (0 to 8).cop
Center of pixel.app
Any part of pixel.
text=(aaN|cop|app)
Set the rasterizer to use for text.aaN
Antialias with N bits (0 to 8).cop
Center of pixel.app
Any part of pixel.
- PCL output options:
colorspace=mono
Render 1-bit black and white page.colorspace=rgb
Render full color page.preset=generic|ljet4|dj500|fs600|lj|lj2|lj3|lj3d|lj4|lj4pl|lj4d|lp2563b|oce9050
.spacing=0
No vertical spacing capability.spacing=1
PCL 3 spacing (<ESC>*p+<n>Y).spacing=2
PCL 4 spacing (<ESC>*b<n>Y).spacing=3
PCL 5 spacing (<ESC>*b<n>Y and clear seed row).mode2
Enable mode 2 graphics compression.mode3
Enable mode 3 graphics compression.eog_reset
End of graphics (<ESC>*rB) resets all parameters.has_duplex
Duplex supported (<ESC>&l<duplex>S).has_papersize
Papersize setting supported (<ESC>&l<sizecode>A).has_copies
Number of copies supported (<ESC>&l<copies>X).is_ljet4pjl
Disable/Enable HP 4PJL model-specific output.is_oce9050
Disable/Enable Oce 9050 model-specific output.
- PCLm output options:
compression=none
No compression (default).compression=flate
Flate compression.strip-height=N
Strip height (default 16).
- PWG output options:
media_class=
Set the media_class field.media_color=
Set the media_color field.media_type=
Set the media_type field.output_type=
Set the output_type field.rendering_intent=
Set the rendering_intent field.page_size_name=
Set the page_size_name field.advance_distance=
Set the advance_distance field.advance_media=
Set the advance_media field.collate=
Set the collate field.cut_media=
Set the cut_media field.duplex=
Set the duplex field.insert_sheet=
Set the insert_sheet field.jog=
Set the jog field.leading_edge=
Set the leading_edge field.manual_feed=
Set the manual_feed field.media_position=
Set the media_position field.media_weight=
Set the media_weight field.mirror_print=
Set the mirror_print field.negative_print=
Set the negative_print field.num_copies=
Set the num_copies field.orientation=
Set the orientation field.output_face_up=
Set the output_face_up field.page_size_x=
Set the page_size_x field.page_size_y=
Set the page_size_y field.separations=
Set the separations field.tray_switch=
Set the tray_switch field.tumble=
Set the tumble field.media_type_num=
Set the media_type_num field.compression=
Set the compression field.row_count=
Set the row_count field.row_feed=
Set the row_feed field.row_step=
Set the row_step field.
- Text output options:
preserve-images
keep images in outputpreserve-ligatures
do not expand ligatures into constituent characterspreserve-spans
do not merge spans on the same linepreserve-whitespace
do not convert all whitespace into space charactersinhibit-spaces
don’t add spaces between gaps in the textparagraph-break
break blocks at paragraph boundariesdehyphenate
attempt to join up hyphenated wordsignore-actualtext
do not apply ActualText replacementsuse-cid-for-unknown-unicode
use character code if unicode mapping failsuse-gid-for-unknown-unicode
use glyph index if unicode mapping failsaccurate-bboxes
calculate char bboxes from the outlinesaccurate-ascenders
calculate ascender/descender from font glyphsaccurate-side-bearings
expand character bboxes to completely include width of glyphscollect-styles
attempt to detect text features (fake bold, strikeout, underlined etc)clip
do not include text that is completely clippedclip-rect=x0:y0:x1:y1
specify clipping rectangle within which to collect contentstructured
collect structure markupvectors
include vector bboxes in outputsegment
attempt to segment the pagetable-hunt
hunt for tables within a (segmented) page
- PDF output options:
decompress
Decompress all streams (except compress-fonts/images).compress
Compress all streams, and is identical tocompress=flate
.or
compress=flate
which compresses all streams using Flate or CCITT Fax compression methods.or
compress=brotli
which compresses all streams using Brotli or CCITT Fax compression methods.compress-fonts
Compress embedded fonts.compress-images
Compress images.compression-effort=NUMBER
Desired effort in percent to spend compressing streams.0
is default effort level, or a number from1
, the minimum, and100
, the maximum effort.labels
Print labels for how to reach each object as comments in the output PDF.ascii
ASCII hex encode binary streams.pretty
Pretty-print objects with indentation.linearize
Optimize for web browsers. No longer supported!clean
Pretty-print graphics commands in content streams.sanitize
Sanitize graphics commands in content streams.incremental
Write changes as incremental update.objstms
Use object and cross-reference streams when creating PDF.appearance=yes
Create appearance streams for annotations that miss appearance streams.appearance=all
Recreate appearance streams for all annotations.continue-on-error
Continue saving the document even if there is an error.garbage
Garbage collect unused objects.or
garbage=compact
… and compact cross reference table.or
garbage=deduplicate
… and remove duplicate objects.decrypt
Write unencrypted document.encrypt=none|keep|rc4-40|rc4-128|aes-128|aes-256
Write encrypted document with specified algorithm.permissions=NUMBER
Document permissions to grant when encrypting.user-password=PASSWORD
Password required to read document.owner-password=PASSWORD
Password required to edit document.regenerate-id
Regenerate document id (default yes).
- SVG output options:
text=text
Emit text as <text> elements (inaccurate fonts).text=path
Emit text as <path> elements (accurate fonts).no-reuse-images
Do not reuse images using <symbol> definitions.
file
Input file name. The input can be any of the document formats supported by MuPDF.
[pages]
Comma separated list of page ranges. The first page is “1”, and the last page is “N”. The default is “1-N”.