From 13b75ab76a920c9d6652b21f1bb9006bb586827b Mon Sep 17 00:00:00 2001 From: Nigel Barnes Date: Thu, 11 Jan 2018 20:51:37 +0000 Subject: Updated documentation for castool and added floptool (nw) --- docs/source/tools/castool.rst | 502 ++++++++++++++--------------------------- docs/source/tools/floptool.rst | 206 +++++++++++++++++ docs/source/tools/index.rst | 1 + 3 files changed, 376 insertions(+), 333 deletions(-) create mode 100644 docs/source/tools/floptool.rst diff --git a/docs/source/tools/castool.rst b/docs/source/tools/castool.rst index f37f5519942..a84742f96e8 100644 --- a/docs/source/tools/castool.rst +++ b/docs/source/tools/castool.rst @@ -5,7 +5,7 @@ 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. +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 @@ -13,17 +13,17 @@ 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 ** + **castool convert ** * **** is the format of the image -* **** is the filename of the image you're converting from -* **** is the filename of the output WAV file +* **** is the filename of the image you're converting from +* **** 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 @@ -37,470 +37,306 @@ 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 - + +**ATOM** + + Acorn Atom + + File extensions: tap, csw, uef + **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 + File extensions: t77 **FMSX** MSX - - File extensions: tap, cas + File extensions: tap, cas **GTP** Elektronika inzenjering Galaksija - - File extensions: gtp + File extensions: gtp **HECTOR** Micronique Hector & Interact Family Computer - + File extensions: k7, cin, for - **JUPITER** Jupiter Cantab Jupiter Ace - + File extensions: tap - -**APF** +**KC85** - APF Imagination Machine - - File extensions: cas, cpf, apt - + VEB Mikroelektronik KC 85 - kc85 - VEB Mikroelektronik KC 85 - kcc,kcb - tap,853,854,855,tp2,kcm - sss - -**APF** + File extensions: kcc, kcb, tap, 853, 854, 855, tp2, kcm, sss - APF Imagination Machine - - File extensions: cas, cpf, apt - +**KIM1** - kim1 - MOS KIM-1 - kim,kim1 - -**APF** + MOS KIM-1 - APF Imagination Machine - - File extensions: cas, cpf, apt - + File extensions: kim, kim1 - lviv - PK-01 Lviv - lvt,lvr,lv0,lv1,lv2,lv3 - -**APF** +**LVIV** - APF Imagination Machine - - File extensions: cas, cpf, apt - + PK-01 Lviv - mo5 - Thomson MO-series - k5,k7 - -**APF** + File extensions: lvt, lvr, lv0, lv1, lv2, lv3 - APF Imagination Machine - - File extensions: cas, cpf, apt - +**MO5** - mz - Sharp MZ-700 - m12,mzf,mzt - -**APF** + Thomson MO-series - APF Imagination Machine - - File extensions: cas, cpf, apt - + File extensions: k5, k7 - orao - PEL Varazdin Orao - tap - -**APF** +**MZ** - APF Imagination Machine - - File extensions: cas, cpf, apt - + Sharp MZ-700 - oric - Tangerine Oric - tap - -**APF** + File extensions: m12, mzf, mzt - APF Imagination Machine - - File extensions: cas, cpf, apt - +**ORAO** - pc6001 - NEC PC-6001 - cas - -**APF** + PEL Varazdin Orao - APF Imagination Machine - - File extensions: cas, cpf, apt - + File extensions: tap - phc25 - Sanyo PHC-25 - phc - -**APF** +**ORIC** - APF Imagination Machine - - File extensions: cas, cpf, apt - + Tangerine Oric - pmd85 - Tesla PMD-85 - pmd,tap,ptp - -**APF** + File extensions: tap - APF Imagination Machine - - File extensions: cas, cpf, apt - +**PC6001** - primo - Microkey Primo - ptp - -**APF** + NEC PC-6001 - APF Imagination Machine - - File extensions: cas, cpf, apt - + File extensions: cas - rku - UT-88 - rku - -**APF** +**PHC25** - APF Imagination Machine - - File extensions: cas, cpf, apt - + Sanyo PHC-25 - rk8 - Mikro-80 - rk8 - -**APF** + File extensions: phc - APF Imagination Machine - - File extensions: cas, cpf, apt - +**PMD85** - rks - Specialist - rks - -**APF** + Tesla PMD-85 - APF Imagination Machine - - File extensions: cas, cpf, apt - + File extensions: pmd, tap, ptp - rko - Orion - rko - -**APF** +**PRIMO** - APF Imagination Machine - - File extensions: cas, cpf, apt - + Microkey Primo - rkr - Radio-86RK - rk,rkr - gam,g16,pki - -**APF** + File extensions: ptp - APF Imagination Machine - - File extensions: cas, cpf, apt - +**RKU** - rka - Zavod BRA Apogee BK-01 - rka - -**APF** + UT-88 - APF Imagination Machine - - File extensions: cas, cpf, apt - + File extensions: rku - rkm - Mikrosha - rkm - -**APF** +**RK8** - APF Imagination Machine - - File extensions: cas, cpf, apt - + Mikro-80 - rkp - SAM SKB VM Partner-01.01 - rkp - -**APF** + File extensions: rk8 - APF Imagination Machine - - File extensions: cas, cpf, apt - +**RKS** - sc3000 - Sega SC-3000 - bit - -**APF** + Specialist - APF Imagination Machine - - File extensions: cas, cpf, apt - + File extensions: rks - sol20 - PTC SOL-20 - svt - -**APF** +**RKO** - APF Imagination Machine - - File extensions: cas, cpf, apt - + Orion - sorcerer - Exidy Sorcerer - tape - -**APF** + File extensions: rko - APF Imagination Machine - - File extensions: cas, cpf, apt - +**RKR** - sordm5 - Sord M5 - cas - -**APF** + Radio-86RK - APF Imagination Machine - - File extensions: cas, cpf, apt - + File extensions: rk, rkr, gam, g16, pki - spc1000 - Samsung SPC-1000 - tap - cas - -**APF** +**RKA** - APF Imagination Machine - - File extensions: cas, cpf, apt - + Zavod BRA Apogee BK-01 - svi - Spectravideo SVI-318 & SVI-328 - cas - -**APF** + File extensions: rka - APF Imagination Machine - - File extensions: cas, cpf, apt - +**RKM** - to7 - Thomson TO-series - k7 - -**APF** + Mikrosha - APF Imagination Machine - - File extensions: cas, cpf, apt - + File extensions: rkm - trs80l2 - TRS-80 Level 2 - cas - -**APF** +**RKP** - APF Imagination Machine - - File extensions: cas, cpf, apt - + SAM SKB VM Partner-01.01 - tvc64 - Videoton TVC 64 - cas - -**APF** + File extensions: rkp - APF Imagination Machine - - File extensions: cas, cpf, apt - +**SC3000** - tzx - Sinclair ZX Spectrum - tzx - tap,blk - -**APF** + Sega SC-3000 - APF Imagination Machine - - File extensions: cas, cpf, apt - + File extensions: bit - uef - Acorn Electron - uef - -**APF** +**SOL20** - APF Imagination Machine - - File extensions: cas, cpf, apt - + PTC SOL-20 - vg5k - Philips VG 5000 - k7 - -**APF** + File extensions: svt - APF Imagination Machine - - File extensions: cas, cpf, apt - +**SORCERER** - vtech1 - Video Technology Laser 110-310 - cas - -**APF** + Exidy Sorcerer - APF Imagination Machine - - File extensions: cas, cpf, apt - + File extensions: tape - vtech2 - Video Technology Laser 350-700 - cas - -**APF** +**SORDM5** - APF Imagination Machine - - File extensions: cas, cpf, apt - + Sord M5 - x07 - Canon X-07 - k7,lst,cas - -**APF** + File extensions: cas - APF Imagination Machine - - File extensions: cas, cpf, apt - +**SPC1000** - x1 - Sharp X1 - tap - -**APF** + Samsung SPC-1000 - APF Imagination Machine - - File extensions: cas, cpf, apt - + File extensions: tap, cas - zx80_o - Sinclair ZX80 - o,80 - -**APF** +**SVI** - APF Imagination Machine - - File extensions: cas, cpf, apt - + Spectravideo SVI-318 & SVI-328 - zx81_p - Sinclair ZX81 - p,81 - -**APF** + File extensions: cas + +**TO7** + + Thomson TO-series + + File extensions: k7 + +**TRS8012** + + TRS-80 Level 2 + + File extensions: cas + +**TVC64** + + Videoton TVC 64 + + File extensions: cas + +**TZX** + + Sinclair ZX Spectrum + + File extensions: tzx, tap, blk + +**VG5K** + + Philips VG 5000 + + File extensions: k7 + +**VTECH1** + + Video Technology Laser 110-310 + + File extensions: cas + +**VTECH2** + + Video Technology Laser 350-700 + + File extensions: cas + +**X07** + + Canon X-07 + + File extensions: k7, lst, cas + +**X1** + + Sharp X1 + + File extensions: tap + +**ZX80_O** + + Sinclair ZX80 + + File extensions: o, 80 + +**ZX81_P** + + Sinclair ZX81 + + File extensions: p, 81 - APF Imagination Machine - - File extensions: cas, cpf, apt - diff --git a/docs/source/tools/floptool.rst b/docs/source/tools/floptool.rst new file mode 100644 index 00000000000..f2e24eac56f --- /dev/null +++ b/docs/source/tools/floptool.rst @@ -0,0 +1,206 @@ +Floptool - *A generic floppy image manipulation tool for MAME* +============================================================== + + + +Floptool is a tool for the maintenance and manipulation of floppy 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. + +Floptool 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 Floptool +============== + +Floptool is a command line program that contains a simple set of instructions. Commands are invoked in a manner along the lines of this: + + **floptool identify [ ...]** + **floptool convert [input_format|auto] output_format ** + +* **** is the format of the image +* **** is the format of the inputfile, use auto if not known +* **** is the format of the converted file +* **** is the filename of the image you're identifying/converting from +* **** is the filename of the converted file + +Example usage: + floptool convert coco zaxxon.cas zaxxon.wav + + floptool convert cbm arkanoid.tap arkanoid.wav + + floptool convert ddp mybasicprogram.ddp mybasicprogram.wav + + + + +Floptool Formats +================ + +These are the formats supported by Floptool for conversion to other formats. + +**MFI** + + MAME floppy image + + File extension: mfi + +**DFI** + + DiscFerret flux dump format + + File extensions: dfi + +**IPF** + + SPS floppy disk image + + File extensions: ipf + +**MFM** + + HxC Floppy Emulator floppy disk image + + File extensions: mfm + +**ADF** + + Amiga ADF floppy disk image + + File extensions: adf + +**ST** + + Atari ST floppy disk image + + File extensions: st + +**MSA** + + Atari MSA floppy disk image + + File extensions: msa + +**PASTI** + + Atari PASTI floppy disk image + + File extensions: stx + +**DSK** + + CPC DSK format + + File extensions: dsk + +**D88** + + D88 disk image + + File extensions: d77, d88, 1dd + +**IMD** + + IMD disk image + + File extensions: imd + +**TD0** + + Teledisk disk image + + File extensions: td0 + +**CQM** + + CopyQM disk image + + File extensions: cqm, cqi, dsk + +**PC** + + PC floppy disk image + + File extensions: dsk, ima, img, ufi, 360 + +**NASLITE** + + NASLite disk image + + File extensions: img + +**DC42** + + DiskCopy 4.2 image + + File extensions: dc42 + +**A2_16SECT** + + Apple II 16-sector disk image + + File extensions: dsk, do, po + +**A2_RWTS18** + + Apple II RWTS18-type image + + File extensions: rti + +**A2_EDD** + + Apple II EDD image + + File extensions: edd + +**ATOM** + + Acorn Atom disk image + + File extensions: 40t, dsk + +**SSD** + + Acorn SSD disk image + + File extensions: ssd, bbc, img + +**DSD** + + Acorn DSD disk image + + File extensions: dsd + +**DOS** + + Acorn DOS disk image + + File extensions: img + +**ADFS_O** + + Acorn ADFS (OldMap) disk image + + File extensions: adf, ads, adm, adl + +**ADFS_N** + + Acorn ADFS (NewMap) disk image + + File extensions: adf + +**ORIC_DSK** + + Oric disk image + + File extensions: dsk + +**APPLIX** + + Applix disk image + + File extensions: raw + +**HPI** + + HP9845A floppy disk image + + File extensions: hpi diff --git a/docs/source/tools/index.rst b/docs/source/tools/index.rst index e4d588b6f9c..6d0551bf1d1 100644 --- a/docs/source/tools/index.rst +++ b/docs/source/tools/index.rst @@ -8,4 +8,5 @@ This section covers various extra tools that come with your MAME distribution (e imgtool castool + floptool othertools -- cgit v1.2.3