zip: Some improvements to error reporting
[deark.git] / formats.txt
blob8db5d098460b8d132fc6c673c0ea5494f8fa79fd
1 Deark -- Information about supported formats
4 === Image format modules ===
6 (Images that are not "extracted" will be converted to PNG, except as noted.)
8 * Alias PIX, a.k.a. Vivid ray tracer bitmap (module="alias_pix")
9   - Truecolor only. Grayscale not supported.
11 * Alpha Microsystems BMP (module="alphabmp") (experimental)
13 * Amiga Workbench Icon (module="amigaicon")
14   - Original format: Mostly supported, but the format is not portable, and
15     there is not just one correct way to render the images.
16   - NewIcons: Fully supported.
17   - GlowIcons / OS3.5: Compressed images are supported. Uncompressed images are
18     not.
20 * AMOS Picture Bank (module="abk")
22 * AMOS Sprite Bank (AmSp) / AMOS Icon Bank (AmIc) (module="abk")
24 * ANI (Windows Animated Cursor) (part of module "riff")
25   - Extract individual CUR and ICO files.
27 * ANIM (Amiga IFF-ANIM) (module="anim")
28   - Supports most common formats.
29   - Extract the individual frames.
30   Options
31    -opt anim:includedups - Do not suppress duplicate frames.
33 * Animatic Film (module="animatic")
34   - Extract the individual frames.
35   Options
36    -opt atari:palbits=<n> (refer to readme.md)
38 * ANSI Art (module="ansiart")
39   - Autodetection usually works, but not always. You may have to use
40      "-m ansiart" or "-m ansi".
41   - Supports only the most common escape codes, which is usually good enough.
42   - Some features depend on the output format. "Blink" is not supported with
43      image output, for example.
44   Options
45    -opt char:output=image - Output to a bitmap instead of HTML
46    -opt char:width=<n> - Number of characters per row
47    -opt ansiart:no24bitcolor - Disable support for 24-bit color definitions
48    -opt ansiart:noblink - Disable blinking characters, enabling high-intensity
49      background colors. This is usually unnecessary, as well-formed files will
50      explicitly disable blink.
51    -opt ansiart:vt100 - Use VT100 mode
53 * Apple volume label image (module="applevol")
55 * ART - PFS: 1st Publisher clip art (module="fp_art")
57 * ArtWorx Data Format (ADF) (module="artworx_adf")
59 * AutoCAD Slide Library (.slb) (module="autocad_slb")
60   - Extracts the component AutoCAD Slide (.sld) files.
62 * Award BIOS logo (EPA, AWBM) (module="awbm")
63   - Supports version 1
64   - Supports 4-bit and 8-bit version 2
65   Options
66    -opt awbm:rgb=0 - (v2) Assume BGR sample order (default for 4-bit)
67    -opt awbm:rgb=1 - (v2) Assume RGB sample order (default for 8-bit)
69 * Binary Text (.BIN character graphics format) (module="bintext")
70   - Must use "-m bintext", unless the file has a SAUCE record.
71   Options
72    -opt char:width=<n> - Number of characters per row
74 * BLD (MegaPaint BLD) (module="bld")
76 * BMI (Zoner bitmap) (module="bmi") (experimental)
78 * BMP (Windows bitmap) (module="bmp")
80 * Bob ray tracer bitmap (module="bob")
82 * BPG (module="bpg") (experimental)
83   - Extract Exif, XMP, ICC Profiles, thumbnails
85 * BSAVE/BLOAD image (module="bsave")
86   Support (some) PC-style BSAVE files.
87   Options
88    -file2 <file.pal> - Use this palette file (BSAVE format)
89    -opt palfile=<file.pal> - Use this palette file (BSAVE format)
90    -opt bsave:width=<n>
91    -opt bsave:height=<n>
92    -opt bsave:fmt=char  - Character graphics
93    -opt bsave:fmt=cga2  - 640x200 2-color
94    -opt bsave:fmt=cga4  - 320x200 4-color
95    -opt bsave:fmt=cga16 - Very low (160x100) resolution
96    -opt bsave:fmt=mcga  - 320x200 256-color
97    -opt bsave:fmt=wh2   - 2-color, header includes width & height
98    -opt bsave:fmt=wh4   - 4 color, header includes width & height
99    -opt bsave:fmt=wh16  - 16 color, header includes width & height, inter-row
100      interlaced
101    -opt bsave:fmt=b265  - Special
102    -opt bsave:fmt=2col  - 2-color noninterlaced (experimental)
103    -opt bsave:fmt=4col  - 4-color noninterlaced (experimental)
105 * Calamus Raster Graphic (module="crg") (experimental)
107 * Cardfile (module="cardfile")
108   - Supports MGC and RRG formats.
109   - Extracts bitmaps.
110   - Extracts text (use -a).
111   - Extracts OLE objects.
112   Options
113    -opt ole1:extractall - Extract unidentified OLE objects
115 * COKE (Atari Falcon) (*.tg1) (module="coke")
117 * Compface intermediate format (module="compfacei")
118   This is an obscure text-based format related to X-Face, used by the Compface
119   software.
120   - Cannot be autodetected. You must use "-m compfacei".
122 * Corel CCX (module="corel_ccx")
123   - Decompresses and converts to CMX format.
125 * CorelDRAW CDR, old "WL" format (module="cdr_wl") (experimental)
126   - Extracts preview image.
128 * Corel Gallery BMF (module="corel_bmf") (experimental)
129   - Extracts preview image.
131 * DIB (module="dib")
132   - Adds a BMP file header to a raw Windows DIB file.
134 * DCX (module="dcx")
135   Multi-image PCX format.
136   - Extracts individual PCX files.
138 * DEGAS and DEGAS Elite (module="degas")
139   Options
140    -opt atari:palbits=<n> (refer to readme.md)
141    -opt atari:respectpal - Don't ignore a seemingly bad 2-color palette
143 * DeskMate Paint .PNT (module="deskmate_pnt")
145 * Doodle (Atari) (module="doodle")
146   - Supports high resolution (640x400) only
148 * Dr. Halo .CUT (module="drhalocut")
149   Options
150    -file2 <file.pal> - Read the palette from this file.
152 * EggPaint (*.trp) (module="eggpaint")
154 * Enhanced Windows Metafile (module=emf)
155   - Extract BMP and other images from some records.
157 * EPOC MBM/Sketch/AIF (module="epocimage")
158   - Supports most image types
159   - Supports most compression schemes
161 * EPS (Encapsulated PostScript) (module="eps")
162   - Extract EPS, TIFF, and WMF from "EPS DOS Binary" format.
163   - Supports preview images in EPSI format (1-, 2-, 4-, 8-bit grayscale)
165 * Falcon True Color (module="ftc")
167 * farbfeld (module="farbfeld")
169 * FLI/FLC (Autodesk Animator) (module="fli")
170   - Extract the (non-repeated) frames.
172 * GEM VDI Bit Image (GEM Raster) (module="gemras")
173   - Supports original bilevel format
174   - Supports paletted XIMG format
175   - Supports some non-XIMG 16-color images
176   Options
177    -opt atari:palbits=<n> (refer to readme.md)
179 * GIF (module="gif")
180   - Extract the image, or every frame from an animated or mult-image GIF.
181   - Plain text extensions are supported.
182   - Extract comments (use -a).
183   Options
184    -opt gif:raw - Extract the individual component images, instead of rendering
185      the frame in full. Plain text extensions might be extracted as text files,
186      instead of images of text.
187    -opt gif:dumpplaintext - Extract plain text extensions to text files (in
188      addition to rendering them to the image).
189    -opt gif:dumpscreen - Save a copy of the "screen" after the last image in
190      the file has been disposed of. Incompatible with gif:raw.
192 * GodPaint (Atari Falcon) (module="godpaint")
194 * Graphic Workshop thumbnail (.thn) (module="gws_thn")
196 * GRASP GL animation (module="graspgl")
197   - Extracts all files.
199 * GROB (HP calculator) (module="grob")
200   - Supports binary and text encodings.
201   - Some text GROB files can't be autodetected, and need "-m grob".
202   Options
203    -opt grob:planes=<n> - Treat image as grayscale. <n> should usually be 2.
204    -opt grob:planeorder=l - For grayscale, assume the least-significant
205      bitplane comes first.
207 * Hemera Photo-Object image (module="hpi")
208   - Extracts the color components to a JPEG file, and the alpha component (if
209    present) to a PNG file.
211 * HP 100LX / HP 200LX .ICN icon format (module="hpicn")
213 * HR (TRS-80 High Resolution graphics file) (module="hr")
215 * HS2 (module="hs2")
216   Obscure format associated with a program called "POSTERING"
218 * HSI Raw (module="hsiraw")
220 * icns (Apple Icon) (module="icns")
221   - Supports uncompressed 1-, 4-, and 8-bit images (with 1-bit mask).
222   - Supports RLE-compressed 24-bit images (with 8-bit mask).
223   - Extract embedded JP2 and PNG files.
225 * ICO/CUR (Windows icon/cursor) (module="ico")
226   - Supports most but not all formats.
227   - PNG-formatted icons will be extracted as-is, not decoded.
228   - Extract images of the (otherwise unused) masks for 32-bit images (use -a).
230 * ILBM and related IFF-based images (module="ilbm")
231   - Supports ILBM, ACBM, PBM
232   - Supports 1-8 bit paletted, 24-bit truecolor
233   - Supports HAM6, HAM8, Halfbrite
234   - Supports color-keyed and bitmask transparency
235   - Extract thumbnails from TINY chunks
236   - Extract text from ANNO chunks (use -a)
237   Options
238    -opt ilbm:notrans - Disable support for transparency
239    -opt ilbm:fixpal=<0|1> - Don't/Do try to correct palettes that seem to have
240      fewer than 8 bits of precision.
242 * IndyPaint (*.tru) (module="indypaint")
244 * Inset PIX (module="insetpix") (experimental)
245   - Bitmap images only. Character graphics files are not supported.
247 * InShape IIM (module="iim")
249 * Jovian Logic VI bitmap (module="jovianvi") (experimental)
251 * JPEG and JPEG-LS (module="jpeg")
252   - Extract ICC profiles.
253   - Extract JFXX JPEG-formatted thumbnails (rare).
254   - Extract JFIF uncompressed thumbnails (rare).
255   - Extract XMP data, including "extended XMP".
256   - Extract JPEG-HDR residual images.
257   - Process Exif data (or extract it: use -a)
258   - Process Photoshop-related data.
259   - Extract Multi-Picture Format (MPF/MPO) thumbnails and other images.
260   - Extract comments (use -a). Comment bytes are extracted as-is, or
261      interpreted based on the "-inenc" option.
262   - Extract Exif FPXR streams (use -a).
264 * JPEG 2000 (module="jpeg2000")
265   - Extract JPEG 2000 codestream from JP2/JPX/JPM formats.
266   - Extract XML data.
267   - Extract GeoTIFF data.
268   - Extract XMP data.
269   - Extract Exif data (use -a) (nonstandard; partial support)
270   - Process Photoshop-related data.
272 * JPEG 2000 codestream (module="j2c")
273   - Extract comments (use -a).
275 * JPEG XR (HD Photo) (part of module "tiff")
276   - Minimal support.
278 * LSS16 (SYSLINUX image) (module="lss16")
280 * Lumena CEL (module="lumena_cel")
281   - Single-image files only
283 * MacPaint (module="macpaint")
284   - Can also decode brush patterns (use -a)
285   Options
286    -opt macpaint:macbinary=<0|1>
288 * Magic Desk icon (module="mdesk_icn")
290 * MAKIchan graphics (module="makichan")
291   - Supports most 16- and 256-color .MAG images
292   - Supports most 16-color .MKI images
293   - Does not support .MAX
295 * MegaPaint Symbol Library (.lib) (module="megapaint_lib") (experimental)
297 * MegaPaint Patterns (.pat) (module="megapaint_pat") (experimental)
299 * MRW (Minolta RAW) (module="mrw")
300   - Process Exif data (or extract it: use -a)
302 * MSP (Microsoft Paint graphics) (module="msp")
303   - Version 1 and 2
305 * MS Word for DOS Screen Capture (module="mswordscr")
306   Supports the same options as the pcx module.
308 * NEOchrome (.NEO) (module="neochrome")
309   Options
310    -opt atari:palbits=<n> (refer to readme.md)
312 * NEOchrome Animation (module="neochrome_ani") (experimental)
314 * New Print Shop .POG format (module="newprintshop")
315   Options
316    -file2 <file.pnm> - Use this "name" file
317    -opt namefile=<file.pnm> - Use this "name" file
319 * NIE/NII/NIA (module="nie") (experimental)
320   The "Naive Image Formats" associated with the Wuffs project.
322 * NGG (Nokia Group Graphic) (module="ngg")
324 * NLM (Nokia Logo Manager bitmap) (module="nlm")
326 * NOL (Nokia Operator Logo) (module="nol")
328 * NPM (Nokia Picture Message) (module="npm")
330 * NSL (Nokia Startup Logo) (module="nsl")
332 * OLPC .565 firmware icon (module="olpc565")
334 * OS/2 Icon, Pointer, Bitmap Array formats (module="os2bmp")
335   - Converts icons & pointers to individual PNG files.
336   - Icon, pointer, and BMP image files are extracted from Bitmap Array files.
337     Reprocess icon and pointer files to convert to PNG.
339 * PaintShop Pro Browser Cache (module="jbf")
340   - Format v1.x: BMP files are reconstructed and extracted.
341   - Format v2.x: JPEG files are extracted.
343 * Palm BitmapType (module="palmbitmap")
344   - Cannot easily be autodetected. You must use "-m palmbitmap", except in most
345     cases when the file extension is ".palm".
346   - May be found inside some Palm files. See also the notes for the "Palm PRC"
347     and "Palm PDB/PQA" modules.
348   Options
349    -opt palm:le - Assume little-endian byte order
351 * Palm Database (PDB) ImageViewer/FireViewer (part of module "palmdb")
353 * PCPaint / Pictor (module="pcpaint")
354   - Supports PIC and CLP formats. Some files are not portable, because they use
355     a nonstandard palette that is not contained in the file.
356   - Supports most images with 8 or fewer bits/pixel.
357   - Supports character graphics (experimental).
358   Options
359    -opt pcpaint:fmt=pic
360    -opt pcpaint:fmt=clp
361    -file2 <file.pic> - PIC file to read the palette from
362    -opt palfile=<file.pic> - PIC file to read the palette from
364 * PCX (module="pcx")
365   - Supports most of the common varieties of PCX.
366   Options
367    -opt pcx:pal=<0|1> - The predefined palette to use, if there is no palette
368      in the file. Default is 0.
369    -opt pcx:resmode=<ignore|dpi|screen|auto> - How to interpret the
370      "resolution" field. "screen" means as the target screen mode's pixel
371      dimensions (assumes 4:3 screen). The default is "auto", which means to
372      guess.
373    -file2 <file.p13> - Read the palette from a separate file. Each entry is 3
374      bytes (R,G,B); samples range from 0-63.
376 * PGC (Portfolio graphics compressed) (module="pgc")
378 * PGF (Portfolio graphics) (module="pf_pgf")
380 * PGX (Portfolio graphics animation) (module="pgx")
381   - Extract embedded PGC images.
383 * PI4 (Atari Falcon 320x240) (module="fpaint_pi4")
385 * PI7 (Atari Falcon 640x480) (module="atari_pi7")
387 * PI9 (Atari Falcon 320x200) (module="fpaint_pi9")
389 * PICT (Macintosh image) (module="pict")
390   - Extract bitmap images.
392 * PM (module="pm_xv") (experimental/incomplete)
393   This is an obscure format supported by XV and XnView.
394   - Supports 24-bit truecolor, and 8-bit grayscale
396 * PNG / MNG / JNG (module="png")
397   - Extract XMP data.
398   - Extract ICC profiles.
399   - Extract or process various other metadata formats.
401 * PNM/PBM/PGM/PPM/PAM (module="pnm")
403 * PrintMaster .SHP format (module="printmaster")
404   Options
405    -file2 <file.sdr> - Use this "name" file
406    -opt namefile=<file.sdr> - Use this "name" file
408 * PrintPartner .GPH (module="pp_gph")
410 * Print Shop .DAT format (module="printshop")
411   - Not all files can be autodetected. You may need "-m printshop".
412   Options
413    -file2 <file.sdr> - Use this "name" file
414    -opt namefile=<file.nam> - Use this "name" file
416 * Prism Paint (module="prismpaint")
417   - Supports 1-, 2-, 4-, 8-, and 16-bits per pixel
419 * PSD / PSB (Photoshop) (module="psd")
420   - Basic support for RGB/grayscale/paletted 8/16-bit images
421   - Extract JPEG thumbnails. Some thumbnail images have the red and blue
422     channels swapped -- Deark warns about this, but does not correct it.
423   - Extract XMP data.
424   - Extract ICC profiles.
425   - Extract linked layer image data (could be PNG/JPG/PSD/etc. format).
426   - Process Exif data (or extract it: use -a)
427   - Extract IPTC-IIM data (use -a).
428   - Extract "text engine data" (use -a)
430 * Psion PIC (module="psionpic")
431   A Psion PIC file contains one or more 1-bpp bitmaps, some of which can be
432   combined to make grayscale images. Deark will try to guess which images
433   should be combined, but it may not always get it right.
434   - Supports 1- and 2-bit grayscale.
435   Options
436    -opt psionpic:bw - Do not try to detect grayscale images. Write each bitmap
437      as a separate image.
439 * QDV (Giffer) (module="qdv")
441 * QTIF (QuickTime image) (module="qtif")
442   - Extract embedded JPEG, TIFF, and other image files.
443   - Decode some "raw" (uncompressed) images.
445 * RIPscrip icon (.ICN) or BGI image (module="ripicon") (experimental)
446   - Not all files are autodetected. You may need "-m ripicon".
447   - Only 16-color images are supported.
449 * RISC OS / Acorn Sprite (module="rosprite")
450   - Autodetection may not always work. May need "-m rosprite".
451   - "Old" format is pretty well supported.
452   - "New" format is mostly supported, but not well-tested.
454 * RISC OS / Acorn Draw (module="rodraw") (experimental)
455   - Extract sprite image files.
457 * RSC (GEM resource) (module="rsc") (experimental)
458   - Supports both "old" and "new" formats.
459   - Extracts icons and bitmaps.
460   Options
461    -opt rsc:fmt=<atari|pc> - Use this byte order. Default is to autodetect.
463 * SHG and MRB (module="shg")
464   Segmented Hypergraphics and Multi-Resolution Bitmap formats are used in
465   Windows .HLP files.
466   - Converts bitmap graphics to BMP format.
467   - Extracts WMF files.
469 * Spectrum 512 Compressed (.spc) (module="spectrum512c")
470   Options
471    -opt spectrum512:tospu - Output to an .spu file
473 * Spectrum 512 Smooshed (.sps) (module="spectrum512s")
474   Options
475    -opt spectrum512:tospu - Output to an .spu file
477 * Spectrum 512 uncompressed (.spu) (module="spectrum512u")
478   Options
479    -opt atari:palbits=<n> (refer to readme.md)
481 * STOS Memory Bank (.mbk) (module="stos")
482   - Decode "sprite bank" images
483   - Decode "icon bank" images
484   Options
485    -opt atari:palbits=<n> (refer to readme.md)
487 * Sun Raster (module="sunras") (incomplete)
488   - Supports most common image types
489   Options
490    -opt sunras:fmt32=<xbgr|abgr|xrgb|argb|bgrx|bgra|rgbx|rgba> - Specify the
491      interpretation of a 32-bit pixel
493 * TGA (Targa) (module="tga")
495 * Thumbs.db (Windows thumbnail) (part of module "cfb")
496   - Extract thumbnail files (embedded JPEG or PNG files)
497   - Some thumbnails use a nonstandard RGBA format. These are not converted to
498     a portable format.
500 * TI calculator "variable" files (module="tivariable")
501   - TI73/TI82/TI83 pictures
502   - TI85/TI86 pictures
503   - TI89/TI92/TI92+ pictures
505 * TIFF and Exif (module="tiff")
506   - Decode most images, excluding lossy-compressed images.
507   - Extract JPEG-formatted Exif thumbnails, and some types of JPEG-compressed
508     images.
509   - Extract ICC profiles.
510   - Process Photoshop-related data.
511   - Extract IPTC-IIM data (use -a).
512   Options
513    -opt tiff:decode=0 - Do not decode images
515 * TIM (Playstation graphics) (module="tim") (experimental/incomplete)
517 * Tiny Stuff (.TNY, .TN1, .TN2, .TN3) (module="tinystuff")
518   Options
519    -opt atari:palbits=<n> (refer to readme.md)
520    -opt atari:respectpal - Don't ignore a seemingly bad 2-color palette
522 * VBM (VDC BitMap) (module="vbm")
523   - Version 2 only
525 * VITec image format (module="vitec) (experimental/incomplete)
527 * VORT ray tracer .pix image (module="vort") (experimental/incomplete)
529 * Windows 1.0 ICO/CUR (module="win1ico")
531 * Windows Metafile (module=wmf)
532   - Extract BMP images from some records.
533   - Extract embedded EMF documents.
535 * Winzle (module=winzle)
536   - Convert Winzle obfuscated BMP (.wzl) to BMP.
538 * WordPerfect Graphics (module=wpg)
539   - Extract bitmaps
541 * X11 puzzle (module="xpuzzle")
542   Format used by X-Windows "puzzle" program.
543   ftp://ftp.x.org/pub/unsupported/programs/puzzle/
544   Generated by Netpbm's ppmtopuzz utility.
546 * XBIN (module="xbin")
547   Renders XBIN character graphics to a bitmap (default) or HTML.
548   - Extract embedded fonts (use -a).
549   Options
550    -opt char:output=html - Use HTML output format
552 * X-Face (icon/avatar format) (module="xface")
553   - You may have to use "-m xface".
555 * XGA (Atari Falcon image) (module="falcon_xga")
557 * YBM (Bennet Yee face format) (module="ybm")
559 * ZBR ((Zoner) Zebra Metafile) (module="zbr")
560   - Extract the preview image.
562 === Font formats ===
564 * FNT (Windows font) (module="fnt")
565   Most FNT files have an extra "absolute space" character, which Deark
566   arbitrarily places at code point 256, or U+2002 (EN SPACE).
568 * GEM bitmap font (module="gemfont") (experimental)
569   - Autodetection may not always work. May need "-m gemfont".
571 * GRASP font (module="graspfont") (experimental)
572   .set/.fnt; may be found inside GRASP .gl files.
574 * PCF font (module="pcf") (experimental/incomplete)
576 * PC Screen Font (PSF) (module="psf")
577   Options
578    -opt font:noaliases - Restrict to one Unicode codepoint per glyph
580 * PFF2 font (module="pff2")
582 * PK font (Packed Font) (module="pkfont") (partial support)
584 * Unifont HEX (module="unifont_hex")
585   - Cannot be autodetected. You must use "-m unifont_hex".
587 === Compression, archive, installer, disk image modules ===
589 * ADF (Amiga disk image) (module="amiga_adf") (experimental)
591 * ARC archive (module="arc")
592   - Limited support.
594 * ArcFS (module="arcfs")
595   Options
596    -opt arcfs:appendtype - Append the file type to the filename
598 * ArcMac (module="arcmac") (experimental)
599   Variant of ARC.
601 * ARJ (module="arj") (experimental)
603 * AmBs (AMOS "Banks" aggregate format) (module="abk")
604   - Extract AmSp, AmIc, AmBk files.
606 * Apple Partition Map (module="apm") (experimental)
608 * AppleSingle/AppleDouble (module="applesd")
609   AppleDouble files often have names beginning with "._".
610   - Extract data fork.
611   - Extract (default for AppleSingle) or decode (default for AppleDouble)
612     resource fork.
613   Options
614    -opt applesd:extractrsrc=<0|1> - Specify whether the resource fork is
615      decoded (0), or extracted (1).
617 * ar (.a archive/library format) (module="ar") (experimental/incomplete)
618   - Supports System V long filenames
620 * ATR (Atari disk image) (module="atr") (experimental/incomplete)
622 * BinHex (.hqx) (module="binhex")
623   - Extract data and resource forks to separate files.
625 * CAB (Microsoft Cabinet) (module="cab")
626   - Files can be parsed, but there is usually nothing that can be extracted
627     from them.
629 * ARX (module="arx") (experimental/incomplete)
630   Variant of LHA. Deark tries to convert it to LHA.
632 * CAR (module="car_lha")
633   Variant of LHA by MylesHi! Software. Deark tries to convert it to LHA.
634   - File extension must be ".car" (or use "-m car").
636 * CD/raw (module="cd_raw")
637   - Extract .ISO and other filesystem data from some raw CD images, such as
638     the .BIN file in CUE/BIN format.
640 * compress (legacy Unix .Z format) (module="compress")
642 * cpio (module="cpio")
644 * CRUSH (.cru) (module="crush")
645   CRUSH is a DOS archive utility by PocketWare.
647 * D64 (Commodore 64 disk format) (module="d64") (experimental)
649 * DMS (Amiga disk image) (module="amiga_adf") (experimental, incomplete)
650   - Decompresses to ADF format.
652 * Doom WAD (module="wad")
653   - The extracted files are usually in specialized formats.
655 * FAT (module="fat") (experimental/incomplete)
656   - Limited support, mainly for floppy disk images.
658 * Gzip (module="gzip")
660 * HFS filesystem image (module="hfs") (experimental/incomplete)
661   - Incomplete support, but should be enough for most CD-ROM images.
663 * ISO 9660 CD-ROM image (module="iso9660")
664   Options
665    -opt iso9660:tolower - Convert filenames to lowercase. Does not affect Rock
666      Ridge or Joliet filenames.
667    -opt iso9660:voldesc=<n> - Use the volume descriptor at sector <n>. A
668      typical use is to set n=16 to ignore Joliet extensions.
670 * LBR (module="lbr")
671   LRB is an uncompressed CP/M archive format.
672   - These often contain files in compressed formats known as Squeeze, Crunch,
673   and CrLZH. Deark doesn't necessarily support all of those formats.
675 * LHA/LZH/PMA (module="lha")
676   - Not all the major compression methods are supported. Some are supported but
677     experimental.
678   Options
679    -opt lha:lhark - Assume "lh7" compression is LHARK format, instead of the
680      standard lh7 format. (Unfortunately, autodetecting LHARK is impractical.)
682 * MacBinary (module="macbinary")
683   - You may have to use "-m macbinary".
685 * Microsoft Compound File Binary (module="cfb")
686   - Streams are not extracted by default, but some streams contain images and
687     other objects that can be extracted.
688   Options
689    -opt cfb:extractstreams - Extract raw streams, instead of decoding.
690    -opt cfb:fmt=raw - Do not try to detect the document type.
691    -opt cfb:fmt=auto - Autodetect the document type (default).
692    -opt cfb:fmt=thumbsdb - Treat the file as a Thumbs.db file.
694 * Microsoft Installation Compression (module="mscompress")
696 * MSA (Magic Shadow Archiver) (module="msa") (experimental)
697   - Atari ST disk image format.
698   Options
699    -opt msa:toraw - Instead of decoding, extract to raw ".ST" format (this is
700      usually a FAT format).
701    -opt msa:touncmsa - Instead of decoding, convert to uncompressed MSA.
703 * NRG (module="nrg") (experimental)
704   Nero CD image format.
705   - Extract or decode ISO 9660 data.
707 * Pack (module="pack") (experimental)
708   Old Unix compressed file format (.z).
710 * PackDir (module="packdir") (experimental)
712 * Palm PDB/PQA (module="palmdb")
713   - You may have to use "-m palmdb".
714   - Use -a to extract the record blocks, but note that they are usually not in
715     well-known formats.
716   Options
717    -opt timestampfmt=<macbe|unixbe|macle> - The timestamp format to assume.
719 * Palm PRC (module="palmrc")
720   - You may have to use "-m palmrc".
721   - Use -a to extract the record blocks, but note that they are usually not in
722     well-known formats.
723   - Extracted ".palm" files are in Palm BitmapType format. Reprocess them to
724     convert to PNG.
726 * Pasti (.stx) (module="pasti") (experimental)
727   - Atari ST disk image format.
728   Options
729    -opt pasti:toraw - Instead of decoding, extract to raw ".ST" format (this is
730      usually a FAT format).
732 * RPM (package manager) (module="rpm")
733   - Extract compressed cpio file.
735 * SIS (EPOC/Symbian archive) (module="sis")
736   - EPOC release 3/4/5/6
738 * Spark archive (module="spark")
739   - Limited support.
740   Options
741    -opt spark:appendtype - Append the file type to the filename
742    -opt spark:recurse=0 - Extract subdirectories as Spark files
744 * Squash (module="squash")
745   A variant of "compress", used on RISC OS.
747 * Squeeze (module="squeeze")
748   An old compressed file format used mainly on CP/M.
749   - SQ2 variant is also supported (experimental).
751 * StuffIt (.sit) (module="stuffit")
752   - Limited support. Old format only.
754 * tar (module="tar")
755   - Rare files may need "-m tar", as tar is difficult to autodetect.
757 * WOZ (module="woz") (incomplete)
758   Apple II disk image format.
759   - Some metadata is parsed, but the disk contents are not extracted or listed.
761 * ZIP (module="zip")
762   - Supports most compression methods.
763   - Extract main ZIP file comment (use -a).
764   - Extract comments for individual files (use -a).
765   Options
766    -opt zip:scanmode - Attempt to read the file without using the ZIP "central
767      directory". Not recommended, but allows some damaged ZIP files to be read.
769 * zlib (module="zlib")
770   - Raw zlib files are uncompressed.
772 * Zoo (module="zoo")
773   - Extract comments (use -a).
774   Options
775    -opt zoo:undelete - Also extract deleted files.
777 * Zoo filter format (module="zoo_filter")
778   Format created by "zoo fc".
780 * Zoo Z format (module="zoo_z")
781   Format created by "zoo xz <foo.zoo> [...]". Not all Zoo programs support it.
782   - Will be translated to Zoo format.
784 == Transfer encoding modules ==
786 * Ascii85 (module="ascii85") (incomplete)
787   - Supports old and new btoa formats
788   - Supports data with "<~" / "~>" delimiters
790 * Base16 (module="base16" or "hex")
791   - Decode "hex encoded" data.
792   - Not autodetected; use "-m base16".
793   - Only supports raw data, such as that produced by "xxd -p". Does not
794     support full hex dumps.
796 * Base64 (module="base64")
797   - Not autodetected; use "-m base64".
799 * Uuencoded (module="uuencode")
801 * Xxencoded (module="xxencode")
803 === Other modules ===
805 * AMOS source code (module="amos_source")
806   - Extract AmBs resource file.
808 * ASF multimedia (module="asf")
809   - Files can be parsed, but there is usually nothing that can be extracted
810     from them.
812 * Byte frequency analysis (module="bytefreq")
813   Print a table showing how many times each byte value occurs.
814   - You must use "-m bytefreq".
816 * C64 BASIC (module="basic-c64") (experimental)
817   - Detokenize C64 BASIC programs
819 * Copy (module="copy")
820   - "Extract" the entire file. Use with -start and -size to extract part of
821     the file.
823 * CP437 (module="cp437")
824   Convert DOS Code Page 437 text to UTF-8.
825   - Not autodetected. Use "-m cp437".
826   - Note that code points below 0x20 are ambiguous. Deark tries to guess which
827     ones are control characters.
829 * CRC (module="crc")
830   Print various CRC hashes and checksums of the file, including the IEEE
831   CRC-32.
832   - You must use "-m crc".
834 * DS_Store (module="dsstore") (experimental)
835   Metadata format associated with MacOS Finder.
837 * EBML/Matroska/MKV/WebM (module="ebml")
838   Options
839    -opt ebml:encodedid - Also print element ID numbers in raw (encoded) form.
841 * EXE/PE/NE/etc. (module="exe")
842   EXE format can be complex. Not all varieties are correctly supported.
843   - Extract bitmaps, icons, and cursors from NE and PE (Windows .exe) files.
844   - Extract fonts.
845   - Extract embedded manifests (use -a).
846   - Extract code-signing certificates (use -a).
847   - Extract bitmaps from LX (Linear Executable) files. Note that some of these
848     may be in "Bitmap Array" format. Reprocess them with Deark to extract the
849     actual BMP file(s).
850   - Extract icons and cursors from LX files. Note that these will use OS/2
851     format. Reprocess them with Deark to convert to PNG.
853 * FLAC audio (module="flac")
855 * Hex dump (module="hexdump")
856   Print a hex dump of the file.
857   - You must use "-m hexdump".
859 * HLP (Windows Help) (module="hlp")
860   Options
861    -opt hlp:extracttext - Write the file's text (unformatted) to a file. This
862      feature is experimental and incomplete.
863    -opt hlp:extractstreams - Extract raw files, instead of decoding.
865 * ICC profile (module="iccprofile")
866   - Debug info only.
868 * IFF (Interchange File Format) (module="iff")
869   - IFF can be parsed, but in many cases nothing can be extracted from it.
870   Options
871    -opt iff:align=<n> - Assume chunks are padded to an n-byte boundary.
873 * IPTC-IIM metadata (module="iptc")
874   - Extract captions/abstracts (use -a).
875   - Extract raster caption bitmaps.
877 * ISO-BMFF (module="bmff") (incomplete)
878   - MP4, QuickTime .mov, HEIF, etc.
879   Options
880    -opt bmff:maxentries=<n> - Maximum number of sample table entries to print
881      when using -d. This applies to several boxes, such as 'stsz'.
883 * JPEG scan (module="jpegscan")
884   - This module tries to find and extract embedded JPEG and JPEG-LS files from
885     otherwise-unsupported formats. Use "-m jpegscan".
887 * Macintosh Resource Manager (module="macrsrc") (experimental/incomplete)
888   This is the format generally used by Mac resource forks.
889   Options
890    -opt macrsrc:extractraw - Extract all resources directly to files.
892 * MIDI (module="midi")
893   - Files can be parsed, but there is usually nothing that can be extracted
894     from them.
896 * Monkey's Audio (.ape) (module="monkeys_audio")
897   - Minimal support. Decodes APE tag metadata.
899 * MP3 / MPEG audio (module="mpegaudio" or "mp3")
900   - Not all files can be autodetected.
901   - Mainly for ID3 and APE metadata. The audio data is not converted.
903 * NULL (module="null")
904   - Do nothing.
906 * Ogg (Vorbis, Theora, etc.) (module="ogg")
907   - Files can be parsed, but there is usually nothing that can be extracted
908     from them.
909   Options
910    -opt ogg:hexdump - With -d, include a hex dump of more data than usual.
912 * Photoshop Action format (.atn) (module="ps_action")
913   - Files can be parsed, but there is usually nothing that can be extracted
914     from them.
916 * Photoshop Brush format (.abr) (module="ps_brush")
917   - Files can be parsed, but there is usually nothing that can be extracted
918     from them.
920 * Photoshop Custom Shapes format (.csh) (module="ps_csh")
921   - Files can be parsed, but there is usually nothing that can be extracted
922     from them.
924 * Photoshop Gradient format (.grd) (module="ps_gradient")
925   - Supports file version 5 only (Photoshop 6+)
926   - Files can be parsed, but there is usually nothing that can be extracted
927     from them.
929 * Photoshop Patterns format (.pat) (module="ps_pattern")
930   - Files can be parsed, but there is usually nothing that can be extracted
931     from them.
933 * Photoshop Styles format (.asl) (module="ps_styles")
934   - Files can be parsed, but there is usually nothing that can be extracted
935     from them.
937 * Plain text (module="plaintext")
938   Read a plain text file, and write it as UTF-8.
939   - Not autodetected. Use "-m plaintext".
940   - See also the "cp437" module, which works better on some files.
942 * .plist Property List (module="plist")
943   - Supports binary .plist format only
944   - Files can be parsed, but there is usually nothing that can be extracted
945     from them.
947 * Psion APP/IMG and OPA/OPO (module="psionapp")
948   - Extract Psion PIC icons.
949   - Extract other contents (use -a).
951 * RIFF (module="riff")
952   Metaformat used by WAV, AVI, WebP, etc.
953   - RIFF can be parsed, but in many cases nothing can be extracted from it.
955 * Split (module="split")
956   Split the file into equal-sized chunks.
957   Options
958    -opt split:size=<n> - The size of each chunk, in bytes.
959    -opt split:stride=<n> - The distance between the start of one chunk and the
960     start of the next chunk, in bytes.
962 * WRI - Microsoft Write (module="wri") (incomplete)
963   - Extract raw text to an HTML file. Very little formatting, etc.
964   - Extract most pictures.
965   Options
966    -opt wri:extracttext=0 - Do not extract text
967    -opt ole1:extractall - Extract unidentified OLE objects