diff options
Diffstat (limited to 'docs/source/tools')
-rw-r--r-- | docs/source/tools/castool.rst | 506 | ||||
-rw-r--r-- | docs/source/tools/imgtool.rst | 1676 | ||||
-rw-r--r-- | docs/source/tools/index.rst | 11 | ||||
-rw-r--r-- | docs/source/tools/othertools.rst | 56 |
4 files changed, 2249 insertions, 0 deletions
diff --git a/docs/source/tools/castool.rst b/docs/source/tools/castool.rst new file mode 100644 index 00000000000..f37f5519942 --- /dev/null +++ b/docs/source/tools/castool.rst @@ -0,0 +1,506 @@ +Castool - *A generic casette image manipulation tool for MAME* +============================================================== + + + +Castool is a tool for the maintenance and manipulation of cassette images that MAME users need to deal with. MAME directly supports .WAV audio formatted images, but many of the existing images out there may come in forms such as .TAP for Commodore 64 tapes, .CAS for Tandy Color Computer tapes, and so forth. Castool will convert these other formats to .WAV for use in MAME. + +Castool is part of the MAME project. It shares large portions of code with MAME, and its existence would not be if it were not for MAME. As such, the distribution terms are the same as MAME. Please read the MAME license thoroughly. + + +Using Castool +============= + +Castool is a command line program that contains a simple set of instructions. Commands are invoked in a manner along the lines of this: + + **castool convert <format> <image> <output>** + +* **<format>** is the format of the image +* **<image>** is the filename of the image you're converting from +* **<output>** is the filename of the output WAV file + +Example usage: + castool convert coco zaxxon.cas zaxxon.wav + + castool convert cbm arkanoid.tap arkanoid.wav + + castool convert ddp mybasicprogram.ddp mybasicprogram.wav + + + + +Castool Formats +=============== + +These are the formats supported by Castool for conversion to .WAV files. + +**A26** + + Atari 2600 SuperCharger image + + File extension: a26 + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + +**BBC** + + Acorn BBC & Electron + + File extensions: csw, uef + +**CBM** + + Commodore 8-bit series + + File extensions: tap + +**CDT** + + Amstrad CPC + + File extensions: cdt + +**CGENIE** + + EACA Colour Genie + + File extensions: cas + +**COCO** + + Tandy Radio Shack Color Computer + + File extensions: cas + +**CSW** + + Compressed Square Wave + + File extensions: csw + +**DDP** + + Coleco ADAM + + File extensions: ddp + +**FM7** + + Fujitsu FM-7 + + File extensions: t77 + + +**FMSX** + + MSX + + File extensions: tap, cas + + +**GTP** + + Elektronika inzenjering Galaksija + + File extensions: gtp + + +**HECTOR** + + Micronique Hector & Interact Family Computer + + File extensions: k7, cin, for + + +**JUPITER** + + Jupiter Cantab Jupiter Ace + + File extensions: tap + + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + kc85 - VEB Mikroelektronik KC 85 + kcc,kcb + tap,853,854,855,tp2,kcm + sss + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + kim1 - MOS KIM-1 + kim,kim1 + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + lviv - PK-01 Lviv + lvt,lvr,lv0,lv1,lv2,lv3 + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + mo5 - Thomson MO-series + k5,k7 + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + mz - Sharp MZ-700 + m12,mzf,mzt + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + orao - PEL Varazdin Orao + tap + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + oric - Tangerine Oric + tap + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + pc6001 - NEC PC-6001 + cas + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + phc25 - Sanyo PHC-25 + phc + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + pmd85 - Tesla PMD-85 + pmd,tap,ptp + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + primo - Microkey Primo + ptp + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + rku - UT-88 + rku + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + rk8 - Mikro-80 + rk8 + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + rks - Specialist + rks + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + rko - Orion + rko + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + rkr - Radio-86RK + rk,rkr + gam,g16,pki + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + rka - Zavod BRA Apogee BK-01 + rka + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + rkm - Mikrosha + rkm + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + rkp - SAM SKB VM Partner-01.01 + rkp + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + sc3000 - Sega SC-3000 + bit + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + sol20 - PTC SOL-20 + svt + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + sorcerer - Exidy Sorcerer + tape + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + sordm5 - Sord M5 + cas + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + spc1000 - Samsung SPC-1000 + tap + cas + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + svi - Spectravideo SVI-318 & SVI-328 + cas + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + to7 - Thomson TO-series + k7 + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + trs80l2 - TRS-80 Level 2 + cas + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + tvc64 - Videoton TVC 64 + cas + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + tzx - Sinclair ZX Spectrum + tzx + tap,blk + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + uef - Acorn Electron + uef + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + vg5k - Philips VG 5000 + k7 + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + vtech1 - Video Technology Laser 110-310 + cas + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + vtech2 - Video Technology Laser 350-700 + cas + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + x07 - Canon X-07 + k7,lst,cas + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + x1 - Sharp X1 + tap + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + zx80_o - Sinclair ZX80 + o,80 + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + + + zx81_p - Sinclair ZX81 + p,81 + +**APF** + + APF Imagination Machine + + File extensions: cas, cpf, apt + diff --git a/docs/source/tools/imgtool.rst b/docs/source/tools/imgtool.rst new file mode 100644 index 00000000000..3d2b693f6c3 --- /dev/null +++ b/docs/source/tools/imgtool.rst @@ -0,0 +1,1676 @@ +Imgtool - *A generic image manipulation tool for MAME* +====================================================== + + + +Imgtool is a tool for the maintenance and manipulation of disk and other types of images that MAME users need to deal with. Functions include retrieving and storing files and CRC checking/validation. + +Imgtool is part of the MAME project. It shares large portions of code with MAME, and its existence would not be if it were not for MAME. As such, the distribution terms are the same as MAME. Please read the MAME license thoroughly. + +**Some portions of Imgtool are Copyright (c) 1989, 1993 The Regents of the University of California. All rights reserved.** + +Using Imgtool +============= + +Imgtool is a command line program that contains several "subcommands" that actually do all of the work. Most commands are invoked in a manner along the lines of this: + + **imgtool <subcommand> <format> <image> ...** + +* **<subcommand>** is the name of the subcommand +* **<format>** is the format of the image +* **<image>** is the filename of the image + +Example usage: + imgtool dir coco_jvc_rsdos myimageinazip.zip + + imgtool get coco_jvc_rsdos myimage.dsk myfile.bin mynewfile.txt + + imgtool getall coco_jvc_rsdos myimage.dsk + + +Further details vary with each subcommand. Also note that not all subcommands are applicable or supported for different image formats. + + +Imgtool Subcommands +=================== + +**create** + + **imgtool create <format> <imagename> [--(createoption)=value]** + + * <format> is the image format, e.g. coco_jvc_rsdos + * <imagename> is the image filename; can specify a ZIP file for image name + + + Creates an image + +**dir** + + **imgtool dir <format> <imagename> [path]** + + * <format> is the image format, e.g. coco_jvc_rsdos + * <imagename> is the image filename; can specify a ZIP file for image name + + Lists the contents of an image + +**get** + + **imgtool get <format> <imagename> <filename> [newname] [--filter=filter] [--fork=fork]** + + * <format> is the image format, e.g. coco_jvc_rsdos + * <imagename> is the image filename; can specify a ZIP file for image name + + Gets a single file from an image + +**put** + + **imgtool put <format> <imagename> <filename>... <destname> [--(fileoption)==value] [--filter=filter] [--fork=fork]** + + * <format> is the image format, e.g. coco_jvc_rsdos + * <imagename> is the image filename; can specify a ZIP file for image name + + Puts a single file on an image (wildcards supported) + +**getall** + + **imgtool getall <format> <imagename> [path] [--filter=filter]** + + * <format> is the image format, e.g. coco_jvc_rsdos + * <imagename> is the image filename; can specify a ZIP file for image name + + Gets all files off an image + +**del** + + **imgtool del <format> <imagename> <filename>...** + + * <format> is the image format, e.g. coco_jvc_rsdos + * <imagename> is the image filename; can specify a ZIP file for image name + + Deletes a file on an image + +**mkdir** + + **imgtool mkdir <format> <imagename> <dirname>** + + * <format> is the image format, e.g. coco_jvc_rsdos + * <imagename> is the image filename; can specify a ZIP file for image name + + Creates a subdirectory on an image + +**rmdir** + + **imgtool rmdir <format> <imagename> <dirname>...** + + * <format> is the image format, e.g. coco_jvc_rsdos + * <imagename> is the image filename; can specify a ZIP file for image name + + Deletes a subdirectory on an image + +**readsector** + + **imgtool readsector <format> <imagename> <track> <head> <sector> <filename>** + + * <format> is the image format, e.g. coco_jvc_rsdos + * <imagename> is the image filename; can specify a ZIP file for image name + + Read a sector on an image and output it to specified <filename> + +**writesector** + + **imgtool writesector <format> <imagename> <track> <head> <sector> <filename>** + + * <format> is the image format, e.g. coco_jvc_rsdos + * <imagename> is the image filename; can specify a ZIP file for image name + + Write a sector to an image from specified <filename> + +**identify** + + * <format> is the image format, e.g. coco_jvc_rsdos + * <imagename> is the image filename; can specify a ZIP file for image name + + **imgtool identify <imagename>** + +**listformats** + + Lists all image file formats supported by imgtool + +**listfilters** + + Lists all filters supported by imgtool + +**listdriveroptions** + + **imgtool listdriveroptions <format>** + + * <format> is the image format, e.g. coco_jvc_rsdos + + Lists all format-specific options for the 'put' and 'create' commands + + + +Imgtool Filters +=============== + +Filters are a means to process data being written into or read out of an image in a certain way. Filters can be specified on the get, put, and getall commands by specifying --filter=xxxx on the command line. Currently, the following filters are supported: + +**ascii** + + Translates end-of-lines to the appropriate format + +**cocobas** + + Processes tokenized TRS-80 Color Computer (CoCo) BASIC programs + +**dragonbas** + + Processes tokenized Tano/Dragon Data Dragon 32/64 BASIC programs + +**macbinary** + + Processes Apple MacBinary-formatted (merged forks) files + +**vzsnapshot** + + [todo: VZ Snapshot? Find out what this is....] + +**vzbas** + + Processes Laser/VZ Tokenized Basic Files + +**thombas5** + + Thomson MO5 w/ BASIC 1.0, Tokenized Files (read-only, auto-decrypt) + +**thombas7** + + Thomson TO7 w/ BASIC 1.0, Tokenized Files (read-only, auto-decrypt) + +**thombas128** + + Thomson w/ BASIC 128/512, Tokenized Files (read-only, auto-decrypt) + +**thomcrypt** + + Thomson BASIC, Protected file encryption (no tokenization) + +**bm13bas** + + Basic Master Level 3 Tokenized Basic Files + +Imgtool Format Info +=================== + + + + + +Amiga floppy disk image (OFS/FFS format) - (*amiga_floppy*) +------------------------------------------------------------ + + +Driver specific options for module 'amiga_floppy': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--density dd/hd Density +--filesystem ofs/ffs File system +--mode none/intl/dirc File system options +================ ============================== ============================================================= + + +Apple ][ DOS order disk image (ProDOS format) - (*apple2_do_prodos_525*) +------------------------------------------------------------------------- + + +Driver specific options for module 'apple2_do_prodos_525': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1 Heads +--tracks 35 Tracks +--sectors 16 Sectors +--sectorlength 256 Sector Bytes +--firstsectorid 0 First Sector +================ ============================== ============================================================= + + +Apple ][ Nibble order disk image (ProDOS format) - (*apple2_nib_prodos_525*) +----------------------------------------------------------------------------- + + +Driver specific options for module 'apple2_nib_prodos_525': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1 Heads +--tracks 35 Tracks +--sectors 16 Sectors +--sectorlength 256 Sector Bytes +--firstsectorid 0 First Sector +================ ============================== ============================================================= + + +Apple ][ ProDOS order disk image (ProDOS format) - (*apple2_po_prodos_525*) +---------------------------------------------------------------------------- + + +Driver specific options for module 'apple2_po_prodos_525': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1 Heads +--tracks 35 Tracks +--sectors 16 Sectors +--sectorlength 256 Sector Bytes +--firstsectorid 0 First Sector +================ ============================== ============================================================= + + +Apple ][gs 2IMG disk image (ProDOS format) - (*apple35_2img_prodos_35*) +------------------------------------------------------------------------ + + +Driver specific options for module 'apple35_2img_prodos_35': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 80 Tracks +--sectorlength 512 Sector Bytes +--firstsectorid 0 First Sector +================ ============================== ============================================================= + + +Apple DiskCopy disk image (Mac HFS Floppy) - (*apple35_dc_mac_hfs*) +-------------------------------------------------------------------- + + +Driver specific options for module 'apple35_dc_mac_hfs': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 80 Tracks +--sectorlength 512 Sector Bytes +--firstsectorid 0 First Sector +================ ============================== ============================================================= + + +Apple DiskCopy disk image (Mac MFS Floppy) - (*apple35_dc_mac_mfs*) +-------------------------------------------------------------------- + + +Driver specific options for module 'apple35_dc_mac_mfs': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 80 Tracks +--sectorlength 512 Sector Bytes +--firstsectorid 0 First Sector +================ ============================== ============================================================= + + +Apple DiskCopy disk image (ProDOS format) - (*apple35_dc_prodos_35*) +--------------------------------------------------------------------- + + +Driver specific options for module 'apple35_dc_prodos_35': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 80 Tracks +--sectorlength 512 Sector Bytes +--firstsectorid 0 First Sector +================ ============================== ============================================================= + + +Apple raw 3.5" disk image (Mac HFS Floppy) - (*apple35_raw_mac_hfs*) +--------------------------------------------------------------------- + + +Driver specific options for module 'apple35_raw_mac_hfs': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 80 Tracks +--sectorlength 512 Sector Bytes +--firstsectorid 0 First Sector +================ ============================== ============================================================= + + +Apple raw 3.5" disk image (Mac MFS Floppy) - (*apple35_raw_mac_mfs*) +--------------------------------------------------------------------- + + +Driver specific options for module 'apple35_raw_mac_mfs': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 80 Tracks +--sectorlength 512 Sector Bytes +--firstsectorid 0 First Sector +================ ============================== ============================================================= + + +Apple raw 3.5" disk image (ProDOS format) - (*apple35_raw_prodos_35*) +--------------------------------------------------------------------- + + +Driver specific options for module 'apple35_raw_prodos_35': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 80 Tracks +--sectorlength 512 Sector Bytes +--firstsectorid 0 First Sector +================ ============================== ============================================================= + + +CoCo DMK disk image (OS-9 format) - (*coco_dmk_os9*) +----------------------------------------------------- + + +Driver specific options for module 'coco_dmk_os9': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ =============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------- ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 35-255 Tracks +--sectors 1-18 Sectors +--sectorlength 128/256/512/1024/2048/4096/8192 Sector Bytes +--interleave 0-17 Interleave +--firstsectorid 0-1 First Sector +================ =============================== ============================================================= + + +CoCo DMK disk image (RS-DOS format) - (*coco_dmk_rsdos*) +--------------------------------------------------------- + + +Driver specific options for module 'coco_dmk_rsdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + +Image specific creation options (usable on the 'create' command): + +================ =============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------- ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 35-255 Tracks +--sectors 1-18 Sectors +--sectorlength 128/256/512/1024/2048/4096/8192 Sector Bytes +--interleave 0-17 Interleave +--firstsectorid 0-1 First Sector +================ =============================== ============================================================= + + +CoCo JVC disk image (OS-9 format) - (*coco_jvc_os9*) +----------------------------------------------------- + + +Driver specific options for module 'coco_jvc_os9': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 35-255 Tracks +--sectors 1-255 Sectors +--sectorlength 128/256/512/1024 Sector Bytes +--firstsectorid 0-1 First Sector +================ ============================== ============================================================= + + +CoCo JVC disk image (RS-DOS format) - (*coco_jvc_rsdos*) +--------------------------------------------------------- + + +Driver specific options for module 'coco_jvc_rsdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 35-255 Tracks +--sectors 1-255 Sectors +--sectorlength 128/256/512/1024 Sector Bytes +--firstsectorid 0-1 First Sector +================ ============================== ============================================================= + + +CoCo OS-9 disk image (OS-9 format) - (*coco_os9_os9*) +------------------------------------------------------ + + +Driver specific options for module 'coco_os9_os9': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 35-255 Tracks +--sectors 1-255 Sectors +--sectorlength 128/256/512/1024 Sector Bytes +--firstsectorid 1 First Sector +================ ============================== ============================================================= + + +CoCo VDK disk image (OS-9 format) - (*coco_vdk_os9*) +----------------------------------------------------- + + +Driver specific options for module 'coco_vdk_os9': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 35-255 Tracks +--sectors 18 Sectors +--sectorlength 256 Sector Bytes +--firstsectorid 1 First Sector +================ ============================== ============================================================= + + +CoCo VDK disk image (RS-DOS format) - (*coco_vdk_rsdos*) +--------------------------------------------------------- + + +Driver specific options for module 'coco_vdk_rsdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 35-255 Tracks +--sectors 18 Sectors +--sectorlength 256 Sector Bytes +--firstsectorid 1 First Sector +================ ============================== ============================================================= + + +Concept floppy disk image - (*concept*) +---------------------------------------- + + +Driver specific options for module 'concept': + +No image specific file options + +No image specific creation options + + +CopyQM floppy disk image (Basic Master Level 3 format) - (*cqm_bml3*) +---------------------------------------------------------------------- + + +Driver specific options for module 'cqm_bml3': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + +No image specific creation options + + +CopyQM floppy disk image (FAT format) - (*cqm_fat*) +---------------------------------------------------- + + +Driver specific options for module 'cqm_fat': + +No image specific file options + +No image specific creation options + + +CopyQM floppy disk image (Mac HFS Floppy) - (*cqm_mac_hfs*) +------------------------------------------------------------ + + +Driver specific options for module 'cqm_mac_hfs': + +No image specific file options + +No image specific creation options + + +CopyQM floppy disk image (Mac MFS Floppy) - (*cqm_mac_mfs*) +------------------------------------------------------------ + + +Driver specific options for module 'cqm_mac_mfs': + +No image specific file options + +No image specific creation options + + +CopyQM floppy disk image (OS-9 format) - (*cqm_os9*) +----------------------------------------------------- + + +Driver specific options for module 'cqm_os9': + +No image specific file options + +No image specific creation options + + +CopyQM floppy disk image (ProDOS format) - (*cqm_prodos_35*) +------------------------------------------------------------- + + +Driver specific options for module 'cqm_prodos_35': + +No image specific file options + +No image specific creation options + + +CopyQM floppy disk image (ProDOS format) - (*cqm_prodos_525*) +-------------------------------------------------------------- + + +Driver specific options for module 'cqm_prodos_525': + +No image specific file options + +No image specific creation options + + +CopyQM floppy disk image (RS-DOS format) - (*cqm_rsdos*) +--------------------------------------------------------- + + +Driver specific options for module 'cqm_rsdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + +No image specific creation options + + +CopyQM floppy disk image (VZ-DOS format) - (*cqm_vzdos*) +--------------------------------------------------------- + + +Driver specific options for module 'cqm_vzdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/binary/data File type +--fname intern/extern Filename +================ ============================== ============================================================= + +No image specific creation options + + +Cybiko Classic File System - (*cybiko*) +---------------------------------------- + + +Driver specific options for module 'cybiko': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--flash AT45DB041/AT45DB081/AT45DB161 Flash Type +================ ============================== ============================================================= + + +Cybiko Xtreme File System - (*cybikoxt*) +----------------------------------------- + + +Driver specific options for module 'cybikoxt': + +No image specific file options + +No image specific creation options + + +D88 Floppy Disk image (Basic Master Level 3 format) - (*d88_bml3*) +------------------------------------------------------------------- + +Driver specific options for module 'd88_bml3': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + +No image specific creation options + + +D88 Floppy Disk image (FAT format) - (*d88_fat*) +------------------------------------------------- + + +Driver specific options for module 'd88_fat': + +No image specific file options + +No image specific creation options + + +D88 Floppy Disk image (Mac HFS Floppy) - (*d88_mac_hfs*) +--------------------------------------------------------- + + +Driver specific options for module 'd88_mac_hfs': + +No image specific file options + +No image specific creation options + + +D88 Floppy Disk image (Mac MFS Floppy) - (*d88_mac_mfs*) +--------------------------------------------------------- + + +Driver specific options for module 'd88_mac_mfs': + +No image specific file options + +No image specific creation options + + +D88 Floppy Disk image (OS-9 format) - (*d88_os9*) +-------------------------------------------------- + + +Driver specific options for module 'd88_os9': + +No image specific file options + +No image specific creation options + + +D88 Floppy Disk image (OS-9 format) - (*d88_os9*) +-------------------------------------------------- + + +Driver specific options for module 'd88_prodos_35': + +No image specific file options + +No image specific creation options + + +D88 Floppy Disk image (ProDOS format) - (*d88_prodos_525*) +----------------------------------------------------------- + + +Driver specific options for module 'd88_prodos_525': + +No image specific file options + +No image specific creation options + + +D88 Floppy Disk image (RS-DOS format) - (*d88_rsdos*) +------------------------------------------------------ + + +Driver specific options for module 'd88_rsdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + +No image specific creation options + + +D88 Floppy Disk image (VZ-DOS format) - (*d88_vzdos*) +------------------------------------------------------ + + +Driver specific options for module 'd88_vzdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/binary/data File type +--fname intern/extern Filename +================ ============================== ============================================================= + +No image specific creation options + + +DSK floppy disk image (Basic Master Level 3 format) - (*dsk_bml3*) +------------------------------------------------------------------- + + +Driver specific options for module 'dsk_bml3': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + +No image specific creation options + + +DSK floppy disk image (FAT format) - (*dsk_fat*) +------------------------------------------------- + + +Driver specific options for module 'dsk_fat': + +No image specific file options + +No image specific creation options + + +DSK floppy disk image (Mac HFS Floppy) - (*dsk_mac_hfs*) +--------------------------------------------------------- + + +Driver specific options for module 'dsk_mac_hfs': + +No image specific file options + +No image specific creation options + + +DSK floppy disk image (Mac MFS Floppy) - (*dsk_mac_mfs*) +--------------------------------------------------------- + + +Driver specific options for module 'dsk_mac_mfs': + +No image specific file options + +No image specific creation options + + +DSK floppy disk image (OS-9 format) - (*dsk_os9*) +-------------------------------------------------- + + +Driver specific options for module 'dsk_os9': + +No image specific file options + +No image specific creation options + + +DSK floppy disk image (ProDOS format) - (*dsk_prodos_35*) +---------------------------------------------------------- + + +Driver specific options for module 'dsk_prodos_35': + +No image specific file options + +No image specific creation options + + +DSK floppy disk image (ProDOS format) - (*dsk_prodos_525*) +----------------------------------------------------------- + + +Driver specific options for module 'dsk_prodos_525': + +No image specific file options + +No image specific creation options + + +DSK floppy disk image (RS-DOS format) - (*dsk_rsdos*) +------------------------------------------------------ + + +Driver specific options for module 'dsk_rsdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + +No image specific creation options + + +DSK floppy disk image (VZ-DOS format) - (*dsk_vzdos*) +------------------------------------------------------ + + +Driver specific options for module 'dsk_vzdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/binary/data File type +--fname intern/extern Filename +================ ============================== ============================================================= + +No image specific creation options + + +Formatted Disk Image (Basic Master Level 3 format) - (*fdi_bml3*) +------------------------------------------------------------------ + + +Driver specific options for module 'fdi_bml3': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + +No image specific creation options + + +Formatted Disk Image (FAT format) - (*fdi_fat*) +------------------------------------------------ + + +Driver specific options for module 'fdi_fat': + +No image specific file options + +No image specific creation options + + +Formatted Disk Image (Mac HFS Floppy) - (*fdi_mac_hfs*) +-------------------------------------------------------- + + +Driver specific options for module 'fdi_mac_hfs': + +No image specific file options + +No image specific creation options + + +Formatted Disk Image (Mac MFS Floppy) - (*fdi_mac_mfs*) +-------------------------------------------------------- + + +Driver specific options for module 'fdi_mac_mfs': + +No image specific file options + +No image specific creation options + + +Formatted Disk Image (OS-9 format) - (*fdi_os9*) +------------------------------------------------- + + +Driver specific options for module 'fdi_os9': + +No image specific file options + +No image specific creation options + + +Formatted Disk Image (ProDOS format) - (*fdi_prodos_35*) +--------------------------------------------------------- + + +Driver specific options for module 'fdi_prodos_35': + +No image specific file options + +No image specific creation options + + +Formatted Disk Image (ProDOS format) - (*fdi_prodos_525*) +---------------------------------------------------------- + + +Driver specific options for module 'fdi_prodos_525': + +No image specific file options + +No image specific creation options + + +Formatted Disk Image (RS-DOS format) - (*fdi_rsdos*) +----------------------------------------------------- + + +Driver specific options for module 'fdi_rsdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + +No image specific creation options + + +Formatted Disk Image (VZ-DOS format) - (*fdi_vzdos*) +----------------------------------------------------- + + +Driver specific options for module 'fdi_vzdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/binary/data File type +--fname intern/extern Filename +================ ============================== ============================================================= + +No image specific creation options + + +HP48 SX/GX memory card - (*hp48*) +---------------------------------- + + +Driver specific options for module 'hp48': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ================================ ============================================================= +Option Allowed values Description +---------------- -------------------------------- ------------------------------------------------------------- +--size 32/64/128/256/512/1024/2048/4096 Size in KB +================ ================================ ============================================================= + + +IMD floppy disk image (Basic Master Level 3 format) - (*imd_bml3*) +------------------------------------------------------------------- + + +Driver specific options for module 'imd_bml3': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + +No image specific creation options + + +IMD floppy disk image (FAT format) - (*imd_fat*) +------------------------------------------------- + + +Driver specific options for module 'imd_fat': + +No image specific file options + +No image specific creation options + + +IMD floppy disk image (Mac HFS Floppy) - (*imd_mac_hfs*) +--------------------------------------------------------- + + +Driver specific options for module 'imd_mac_hfs': + +No image specific file options + +No image specific creation options + + +IMD floppy disk image (Mac MFS Floppy) - (*imd_mac_mfs*) +--------------------------------------------------------- + + +Driver specific options for module 'imd_mac_mfs': + +No image specific file options + +No image specific creation options + + +IMD floppy disk image (OS-9 format) - (*imd_os9*) +-------------------------------------------------- + + +Driver specific options for module 'imd_os9': + +No image specific file options + +No image specific creation options + + +IMD floppy disk image (ProDOS format) - (*imd_prodos_35*) +---------------------------------------------------------- + + +Driver specific options for module 'imd_prodos_35': + +No image specific file options + +No image specific creation options + + +IMD floppy disk image (ProDOS format) - (*imd_prodos_525*) +----------------------------------------------------------- + + +Driver specific options for module 'imd_prodos_525': + +No image specific file options + +No image specific creation options + + +IMD floppy disk image (RS-DOS format) - (*imd_rsdos*) +------------------------------------------------------ + + +Driver specific options for module 'imd_rsdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + +No image specific creation options + + +IMD floppy disk image (VZ-DOS format) - (*imd_vzdos*) +------------------------------------------------------ + + +Driver specific options for module 'imd_vzdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/binary/data File type +--fname intern/extern Filename +================ ============================== ============================================================= + +No image specific creation options + + +MESS hard disk image - (*mess_hd*) +----------------------------------- + + +Driver specific options for module 'mess_hd': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ================================================= ============================================================= +Option Allowed values Description +---------------- ------------------------------------------------- ------------------------------------------------------------- +--blocksize 1-2048 Sectors Per Block +--cylinders 1-65536 Cylinders +--heads 1-64 Heads +--sectors 1-4096 Total Sectors +--seclen 128/256/512/1024/2048/4096/8192/16384/32768/65536 Sector Bytes +================ ================================================= ============================================================= + + +TI99 Diskette (PC99 FM format) - (*pc99fm*) +-------------------------------------------- + + +Driver specific options for module 'pc99fm': + +No image specific file options + +No image specific creation options + + +TI99 Diskette (PC99 MFM format) - (*pc99mfm*) +---------------------------------------------- + + +Driver specific options for module 'pc99mfm': + +No image specific file options + +No image specific creation options + + +PC CHD disk image - (*pc_chd*) +------------------------------- + + +Driver specific options for module 'pc_chd': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ====================================================================== ============================================================= +Option Allowed values Description +---------------- ---------------------------------------------------------------------- ------------------------------------------------------------- +--cylinders 10/20/30/40/50/60/70/80/90/100/110/120/130/140/150/160/170/180/190/200 Cylinders +--heads 1-16 Heads +--sectors 1-63 Sectors +================ ====================================================================== ============================================================= + + +PC floppy disk image (FAT format) - (*pc_dsk_fat*) +--------------------------------------------------- + + +Driver specific options for module 'pc_dsk_fat': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 40/80 Tracks +--sectors 8/9/10/15/18/36 Sectors +================ ============================== ============================================================= + + +Psion Organiser II Datapack - (*psionpack*) +-------------------------------------------- + + +Driver specific options for module 'psionpack': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--type OB3/OPL/ODB file type +--id 0/145-255 File ID +================ ============================== ============================================================= + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--size 8k/16k/32k/64k/128k datapack size +--ram 0/1 EPROM/RAM datapack +--paged 0/1 linear/paged datapack +--protect 0/1 write-protected datapack +--boot 0/1 bootable datapack +--copy 0/1 copyable datapack +================ ============================== ============================================================= + + +Teledisk floppy disk image (Basic Master Level 3 format) - (*td0_bml3*) +------------------------------------------------------------------------ + + +Driver specific options for module 'td0_bml3': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + + +No image specific creation options + + +Teledisk floppy disk image (FAT format) - (*td0_fat*) +------------------------------------------------------ + + +Driver specific options for module 'td0_fat': + +No image specific file options + +No image specific creation options + + +Teledisk floppy disk image (Mac HFS Floppy) - (*td0_mac_hfs*) +-------------------------------------------------------------- + + +Driver specific options for module 'td0_mac_hfs': + +No image specific file options + +No image specific creation options + + +Teledisk floppy disk image (Mac MFS Floppy) - (*td0_mac_mfs*) +-------------------------------------------------------------- + + +Driver specific options for module 'td0_mac_mfs': + +No image specific file options + +No image specific creation options + + +Teledisk floppy disk image (OS-9 format) - (*td0_os9*) +------------------------------------------------------- + + +Driver specific options for module 'td0_os9': + +No image specific file options + +No image specific creation options + + +Teledisk floppy disk image (ProDOS format) - (*td0_prodos_35*) +--------------------------------------------------------------- + + +Driver specific options for module 'td0_prodos_35': + +No image specific file options + +No image specific creation options + + +Teledisk floppy disk image (ProDOS format) - (*td0_prodos_525*) +---------------------------------------------------------------- + + +Driver specific options for module 'td0_prodos_525': + +No image specific file options + +No image specific creation options + + +Teledisk floppy disk image (RS-DOS format) - (*td0_rsdos*) +----------------------------------------------------------- + + +Driver specific options for module 'td0_rsdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/data/binary/assembler File type +--ascii ascii/binary Ascii flag +================ ============================== ============================================================= + +No image specific creation options + + +Teledisk floppy disk image (VZ-DOS format) - (*td0_vzdos*) +----------------------------------------------------------- + + +Driver specific options for module 'td0_vzdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/binary/data File type +--fname intern/extern Filename +================ ============================== ============================================================= + +No image specific creation options + + +Thomson .fd disk image, BASIC format - (*thom_fd*) +--------------------------------------------------- + + +Driver specific options for module 'thom_fd': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype auto/B/D/M/A File type +--format auto/B/A Format flag +--comment (string) Comment +================ ============================== ============================================================= + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 40/80 Tracks +--density SD/DD Density +--name (string) Floppy name +================ ============================== ============================================================= + + +Thomson .qd disk image, BASIC format - (*thom_qd*) +--------------------------------------------------- + + +Driver specific options for module 'thom_qd': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype auto/B/D/M/A File type +--format auto/B/A Format flag +--comment (string) Comment +================ ============================== ============================================================= + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1-2 Heads +--tracks 25 Tracks +--density SD/DD Density +--name (string) Floppy name +================ ============================== ============================================================= + + +Thomson .sap disk image, BASIC format - (*thom_sap*) +----------------------------------------------------- + + +Driver specific options for module 'thom_sap': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype auto/B/D/M/A File type +--format auto/B/A Format flag +--comment (string) Comment +================ ============================== ============================================================= + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1 Heads +--tracks 40/80 Tracks +--density SD/DD Density +--name (string) Floppy name +================ ============================== ============================================================= + + +TI990 Hard Disk - (*ti990hd*) +------------------------------ + + +Driver specific options for module 'ti990hd': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================== ============================== ============================================================= +Option Allowed values Description +------------------ ------------------------------ ------------------------------------------------------------- +--cylinders 1-2047 Cylinders +--heads 1-31 Heads +--sectors 1-256 Sectors +--bytes per sector (typically 25256-512 256-512 Bytes Per Sector [Todo: This section is glitched in imgtool] +================== ============================== ============================================================= + + +TI99 Diskette (old MESS format) - (*ti99_old*) +----------------------------------------------- + + +Driver specific options for module 'ti99_old': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--sides 1-2 Sides +--tracks 1-80 Tracks +--sectors 1-36 Sectors (1->9 for SD, 1->18 for DD, 1->36 for HD) +--protection 0-1 Protection (0 for normal, 1 for protected) +--density Auto/SD/DD/HD Density +================ ============================== ============================================================= + + +TI99 Harddisk - (*ti99hd*) +--------------------------- + + +Driver specific options for module 'ti99hd': + +No image specific file options + +No image specific creation options + + +TI99 Diskette (V9T9 format) - (*v9t9*) +--------------------------------------- + + +Driver specific options for module 'v9t9': + +No image specific file options + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--sides 1-2 Sides +--tracks 1-80 Tracks +--sectors 1-36 Sectors (1->9 for SD, 1->18 for DD, 1->36 for HD) +--protection 0-1 Protection (0 for normal, 1 for protected) +--density Auto/SD/DD/HD Density +================ ============================== ============================================================= + + + +Laser/VZ disk image (VZ-DOS format) - (*vtech1_vzdos*) +------------------------------------------------------- + + +Driver specific options for module 'vtech1_vzdos': + +Image specific file options (usable on the 'put' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--ftype basic/binary/data File type +--fname intern/extern Filename +================ ============================== ============================================================= + +Image specific creation options (usable on the 'create' command): + +================ ============================== ============================================================= +Option Allowed values Description +---------------- ------------------------------ ------------------------------------------------------------- +--heads 1 Heads +--tracks 40 Tracks +--sectors 16 Sectors +--sectorlength 154 Sector Bytes +--firstsectorid 0 First Sector +================ ============================== ============================================================= + + + + +[todo: fill out the command structures, describe commands better. These descriptions came from the imgtool.txt file and are barebones]
\ No newline at end of file diff --git a/docs/source/tools/index.rst b/docs/source/tools/index.rst new file mode 100644 index 00000000000..e4d588b6f9c --- /dev/null +++ b/docs/source/tools/index.rst @@ -0,0 +1,11 @@ +MAME External Tools +------------------- + +This section covers various extra tools that come with your MAME distribution (e.g. *imgtool*) + +.. toctree:: + :titlesonly: + + imgtool + castool + othertools diff --git a/docs/source/tools/othertools.rst b/docs/source/tools/othertools.rst new file mode 100644 index 00000000000..97abd598f4f --- /dev/null +++ b/docs/source/tools/othertools.rst @@ -0,0 +1,56 @@ +Other tools included with MAME +============================== + + +ledutil.exe/ledutil.sh +---------------------- + +On Microsoft Windows, ledutil.exe can take control of your keyboard LEDs to mirror those that were present on some early arcade games (e.g. Asteroids) + +Start **ledutil.exe** from the command line to enable LED handling. Run **ledutil.exe -kill** to stop the handler. + +On SDLMAME platforms such as Mac OS X and Linux, **ledutil.sh** can be used. Use **ledutil.sh -a** to have it automatically close when you exit SDLMAME. + + +Developer-focused tools included with MAME +========================================== + + +pngcmp +------ + +This tool is used in regression testing to compare PNG screenshot results with the runtest.cmd script found in the source archive. This script works only on Microsoft Windows. + + +nltool +------ + +Discrete component conversion tool. Most users will not need to work with this. + +nlwav +----- + +Discrete component conversion and testing tool. Most users will not need to work with this. + + +jedutil +------- + +PAL/PLA/PLD/GAL dump handling tool. It can convert between the industry-standard JED format and MAME's proprietary packed binary format and it can show logic equations for the types of devices it knows the internal logic of. Most users will not need to work with this. + + +ldresample +---------- + +This tool recompresses video data for laserdisc and VHS dumps. Most users will not need to work with this. + + +ldverify +-------- + +This tool is used for comparing laserdisc or VHS CHD images with the source AVI. Most users will not need to work with this. + +unidasm +------- + +Universal disassembler for many of the architectures supported in MAME. Most users will not need to work with this.
\ No newline at end of file |