From 1a96f75ae17f7c89a35d4b519bd46fd5b3bb4c13 Mon Sep 17 00:00:00 2001 From: Natalia Portillo Date: Sun, 24 Jun 2018 00:48:50 +0100 Subject: [PATCH] Documentation update --- Changelog.md | 258 ++++++++++++++++++++++++++++++++++++++++++++++++++- README.md | 79 +++++++++------- TODO.md | 8 -- 3 files changed, 301 insertions(+), 44 deletions(-) diff --git a/Changelog.md b/Changelog.md index 26b0f4242..877e16aae 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,3 +1,251 @@ +# [4.5.0.0] - 2018-06-24 +## Added +### - Alcohol 120% disc image +- 010editor template. +- Support for creating images. + +### - Apple New Disk Image Format +- Support RLE compressed images. + +### - Blindwrite 4 disc image +- 010editor template. +- Information about why this format cannot support writing. + +### - Blindwrite 5 disc image +- 010editor template. +- Information about why this format cannot support writing. + +### - DART disk image +- Support RLE compressed images. + +### - Decoders +- Added Blu-ray DI decoders. +- Support decoding 2048 bytes PFI. + +### - Devices +- On Linux try to open in read/write and exclusive mode, if not retry in readonly. +- On Linux use direct SG_IO. +- Workaround some Blu-ray drives not reporting correct size on READ DISC STRUCTURE. + +### - DiscJuggler disc image +- Information about why this format cannot support writing. + +### - Dumping +- Added support for CD drives that don't return a TOC. +- Added support for CD drives that don't support READ CD command. +- Added support for Compact Disc that don't report tracks. +- Add support for dumping media in any of the now supported writable formats. +- Dump ISRC. +- Dump MCN. +- Fix reading PW subchannels. +- Separate trimming from error retry. +- When dumping CDs in persistent mode, try disabling L-EC check if drive doesn't support TB bit, or doesn't return data with TB bit enabled. +- When dumping, print bad sectors to dump log. + +### - FAT filesystem +- Add list of known boot sector hashes. +- Support Human68k FAT16 BPB. + +### - Filesystems +- Detecting High Performance Optical File System (HPOFS). +- Detecting Microsoft Resilient filesystem (ReFS). +- Detecting PC-FX executable tracks. +- Detecting Xia filesystem. + +### - Apple 2IMG disk image +- Support for creating images. + +### - Anex86 disk image +- Support for creating images. + +### - Apple II interleaved disk image +- Support for creating images. + +### - Apple Universal Disk Image Format +- Support for creating images. +- Support RLE compressed images. + +### - Apridisk disk image +- Support for creating images. + +### - Basic Lisa Utility disk image +- Support for creating images. + +### - cdrdao disc image +- Support for creating images. + +### - CDRWin cuesheet disc image +- Support for creating images. + +### - CisCopy disk image +- Support for creating images. + +### - CloneCD disc image +- Support for creating images. + +### - Digital Research DISKCOPY disk image +- Support for creating images. + +### - DiskCopy 4.2 disk image +- Support for creating images. + +### - IBM SaveDskF disk image +- Support for creating images. + +### - MaxiDisk disk image +- Support for creating images. + +### - NHDr0 disk image +- Support for creating images. + +### - Parallels disk image +- Support for creating images. + +### - QEMU Copy-On-Write disk image +- Support for creating images. + +### - QEMU Copy-On-Write v2 disk image +- Support for creating images. + +### - QEMU Enhanced Disk image +- Support for creating images. + +### - RAW (sector by sector) disk image +- Added geometry and size for ZIP100 and ZIP250. +- Support 2448 bytes/sector and 2352 bytes/sector CD images. +- Support media tags. + +### - Ray Arachelian's disk image +- Support for creating images. + +### - RS-IDE disk image +- Support for creating images. + +### - T98 Hard Disk Image +- Support for creating images. + +### - Virtual98 disk image +- Support for creating images. + +### - VirtualBox disk image +- Added image type and flags. +- Support for creating images. + +### - VirtualPC disk image +- Support for creating images. + +### - VMware disk image +- Support for creating images. + +## Fixes +### - Apple DOS filesystem +- Use Apple II character set encoding. + +### - Apple ProDOS filesystem +- Use Apple IIc character set encoding. + +### - BlindWrite 4 disc image +- Fix incorrect pregap calculation preventing images from showing correct data. + +### - CICM metadata +- Can now get dump hardware information from images. + +### - cdrdao disc image +- Fix audio track endian. +- Fix when disc catalog number uses whole ASCII and not only numeric digits. + +### - CDRWin disc image +- Fix when disc catalog number uses whole ASCII and not only numeric digits. + +### - CloneCD disc image +- Fix when disc catalog number uses whole ASCII and not only numeric digits. + +### - Checksums +- Correct CD ECC. +- Correct CD EDC. +- Fix CRC16 returning a 32-bit value. +- Fix CRC64 endian. +- Fix Fletcher-16. +- Fix Fletcher-32. + +### - Create sidecar +- Add filesystems only to the appropriate partition and track. +- Fix CD Lead-in, TOC and XGD tags. +- Fix diameter setting. +- Fix SCSI MODE SENSE. +- Fix USB descriptors. + +### - DART disk image +- Fixed endian. + +### - Devices +- Fix sending READ LONG commands to ATA devices. +- Fixed crashing with some rogue SCSI MMC firmwares. + +### - Dumping +- Correctly detect CD-i, CD+ and CD-ROM XA. +- Do not retry when retry passes are zero. +- Do not try to read multisession lead-out/lead-in as they result in errors that are not really there. +- Get correct track flags. +- Retry only the number of times requested. +- Return drive to previous error correction status. +- Send error recovery MODE before retrying sectors. + +### - HDCopy disk image +- Fix sector calculation. + +### - Image comparison +- Fix when sessions are null. + +### - Image verification +- Corrected status printing. + +### - ISO9660 filesystem +- Do not try to read past partition if El Torito indicates image goes beyond limits. +- Fix when root directory is outside of device. +- Skip null terminated strings in ISO9660 fields. + +### - Lisa filesystem +- Corrected character set encoding. + +### - Macintosh filesystem +- Corrected character set encoding. + +### - PC-98 Partition Table +- Prevent some FAT BPBs to false positive as PC-98 partition tables. + +### - RT-11 filesystem +- Use Radix-50 character set encoding. + +### - System V filesystem +- Fix partition bounds. + +### - VirtualPC disk image +- Corrected reading non-allocated blocks. + +## Changes +- Added command to convert disc images. +- Added command to get information about an image and its contents. +- Added D/CAS-25, D/CAS-85 and D/CAS-103 formats. +- Added IRC notifications for Travis CI. +- Added measured dimensions from an UMD. +- Added media types for NEO GEO CD, PC-FX. +- Added new image format designed to store as much information about media as a drive returns: dicformat. +- Added numeric values to media types. +- Added project to create test filesystems on 16-bit OS/2. +- Added project to create test filesystems on 32-bit OS/2. +- Added project to create test filesystems on DOS. +- Added project to create test filesystems on Mac OS. +- Added size of 640MiB magneto-optical disk. +- Added support for writing disc images. +- Compliant with GDPR. +- Corrected floptical geometry to data according to IRIX. +- Do not assume pointers are 32-bit in several Windows device calls. +- Fixed when statistics settings are null. +- Minimum .NET Framework version is now 4.6.1. +- Sort verbs list. +- Support newest XDG Base Directory Specification for Linux. + # [4.0.1.0] - 2018-01-06 ## Fixes ### Apple DOS and ProDOS interleaved disk images @@ -587,4 +835,12 @@ ### - Partitions - Apple Partition Map (aka APM). - Master Boot Record (aka MBR). -- NeXT disklabels. \ No newline at end of file +- NeXT disklabels. + +[4.5.0.0]: https://github.com/claunia/DiscImageChef/releases/tag/v4.5.0.0 +[4.0.1.0]: https://github.com/claunia/DiscImageChef/releases/tag/v4.0.1.0 +[4.0.0.0]: https://github.com/claunia/DiscImageChef/releases/tag/v4.0.0.0 +[3.0.0.0]: https://github.com/claunia/DiscImageChef/releases/tag/v3.0.0.0 +[2.20]: https://github.com/claunia/DiscImageChef/releases/tag/v2.2 +[2.10]: https://github.com/claunia/DiscImageChef/releases/tag/v2.1 +[2.0]: https://github.com/claunia/DiscImageChef/releases/tag/v2.0 diff --git a/README.md b/README.md index 6d422bd58..b4f5be0ea 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -DiscImageChef v4.0.99.0 +DiscImageChef v4.5.0.0 Disc Image Chef (because "swiss-army-knife" is used too much) @@ -25,8 +25,8 @@ System requirements =================== DiscImageChef should work under any operating system where there is [Mono](http://www.mono-project.com/) or [.NET Framework](https://www.microsoft.com/net/download). -It has been tested using Mono 3.0 and .NET Framework 4.0. However recommended versions are -Mono 5.0 and .NET Framework 4.6. .NET Core is untested. +It has been tested using Mono 5.0 and .NET Framework 4.6.1. However recommended versions are +Mono 5.8 and .NET Framework 4.7.1. .NET Core is unsupported. Usage ===== @@ -48,55 +48,62 @@ Features * Can read standard sector by sector copies for optical and magnetic discs with constant bytes per sector. * Can verify sectors or disk images if supported by the underlying format -Supported disk image formats -============================ -* Alcohol 120% Media Descriptor Structure (.MDS/.MDF) -* Any 512 bytes/sector disk image format (sector by sector copy, aka raw) -* Apple 2IMG (used with Apple // emulators) +Supported disk image formats (read-only) +======================================== +* Apple Disk Archival/Retrieval Tool (DART) * Apple Disk Archival/Retrieval Tool (DART) -* Apple DiskCopy 4.2 * Apple II nibble images (NIB) -* Apple New Disk Image Format (NDIF, requires Resource Fork) -* Apple Universal Disk Image Format (UDIF), including obsolete (previous than DiskCopy 6) versions -* Apridisk disk image formats (for ACT Apricot disks) -* Anex86 disk images (.FDI for floppies, .HDI for hard disks) * BlindWrite 4 TOC files (.BWT/.BWI/.BWS) * BlindWrite 5/6 TOC files (.B5T/.B5I and .B6T/.B6I) -* CDRDAO TOC sheets -* CDRWin cue/bin cuesheets, including ones with ISOBuster extensions -* CisCopy disk image (aka DC-File, .DCF) -* CPCEMU Disk file and Extended Disk File * CopyQM +* CPCEMU Disk file and Extended Disk File * Dave Dunfield IMD -* Digital Research DiskCopy * DiscJuggler images * Dreamcast GDI * HD-Copy disk images -* IBM SaveDskF * MAME Compressed Hunks of Data (CHD) -* MAXI Disk disk images (HDK) * Microsoft VHDX -* Most known sector by sector copies of floppies with 128, 256, 319 and 1024 bytes/sector. -* Most known sector by sector copies with different bytes/sector on track 0. * Nero Burning ROM (both image formats) -* Parallels Hard Disk Image (HDD) version 2 * Partclone disk images * Partimage disk images +* Quasi88 disk images (.D77/.D88) +* Spectrum floppy disk image (.FDI) +* TeleDisk +* X68k DIM disk image files (.DIM) + +Supported disk image formats (read and write) +============================================= +* Alcohol 120% Media Descriptor Structure (.MDS/.MDF) +* Anex86 disk images (.FDI for floppies, .HDI for hard disks) +* Any 512 bytes/sector disk image format (sector by sector copy, aka raw) +* Apple 2IMG (used with Apple // emulators) +* Apple DiskCopy 4.2 +* Apple ][ Interleaved Disk Image +* Apple Universal Disk Image Format (UDIF), including obsolete (previous than DiskCopy 6) versions +* Apridisk disk image formats (for ACT Apricot disks) +* Basic Lisa Utility +* CDRDAO TOC sheets +* CDRWin cue/bin cuesheets, including ones with ISOBuster extensions +* CisCopy disk image (aka DC-File, .DCF) +* CloneCD +* Digital Research DiskCopy +* DiscImageChef format +* IBM SaveDskF +* MAXI Disk disk images (HDK) +* Most known sector by sector copies of floppies with 128, 256, 319 and 1024 bytes/sector. +* Most known sector by sector copies with different bytes/sector on track 0. +* Parallels Hard Disk Image (HDD) version 2 * QEMU Copy-On-Write versions 1, 2 and 3 (QCOW and QCOW2) * QEMU Enhanced Disk (QED) -* Quasi88 disk images (.D77/.D88) * Ray Arachelian's Disk IMage (.DIM) * RS-IDE hard disk images * Sector by sector copies of Microsoft's DMF floppies -* Spectrum floppy disk image (.FDI) * T98 hard disk images (.THD) * T98-Next hard disk images (.NHD) -* TeleDisk -* VMware VMDK and COWD images * Virtual98 disk images -* Virtual PC fixed size, dynamic size and differencing (undo) disk images * VirtualBox Disk Image (VDI) -* X68k DIM disk image files (.DIM) +* Virtual PC fixed size, dynamic size and differencing (undo) disk images +* VMware VMDK and COWD images * XDF disk images (as created by IBM's XDFCOPY) Supported partitioning schemes @@ -147,16 +154,16 @@ Supported file systems for identification and information only * Apple Hierarchical File System+ (HFS+) * Apple ProDOS / SOS file system * AtheOS file system -* B-tree file system (btrfs) +* BeOS filesystem * BSD Fast File System (FFS) / Unix File System (UFS) * BSD Unix File System 2 (UFS2) -* BeOS filesystem +* B-tree file system (btrfs) * CD-i file system * Coherent UNIX file system * Commodore 1540/1541/1571/1581 filesystems * Cram file system -* DEC RT-11 file system * DEC Files-11 (only checked with On Disk Structure 2, ODS-2) +* DEC RT-11 file system * dump(8) (Old historic BSD, AIX, UFS and UFS2 types) * ECMA-67: 130mm Flexible Disk Cartridge Labelling and File Structure for Information Interchange * Flash-Friendly File System (F2FS) @@ -177,13 +184,15 @@ Supported file systems for identification and information only * Microsoft 16-bit File Allocation Table (FAT16) * Microsoft 32-bit File Allocation Table (FAT32), including FAT+ extension * Microsoft Extended File Allocation Table (exFAT) -* Microsoft New Technology File System (NTFS) * Microsoft/IBM High Performance File System (HPFS) +* Microsoft New Technology File System (NTFS) +* Microsoft Resilient File System (ReFS) * Minix v2 file system * Minix v3 file system * NEC PC-Engine executable * NEC PC-FX executable * NILFS2 +* Nintendo optical filesystems (GameCube and Wii) * OS-9 Random Block File * Professional File System * QNX4 and QNX6 filesystems @@ -194,12 +203,12 @@ Supported file systems for identification and information only * SolarOS file system * Squash file system * UNICOS file system +* Universal Disk Format (UDF) * UNIX System V file system * UNIX Version 7 file system -* Universal Disk Format (UDF) * UnixWare boot file system -* VMware file system (VMFS) * Veritas file system +* VMware file system (VMFS) * Xbox filesystems * Xenix file system * Xia filesystem diff --git a/TODO.md b/TODO.md index 780788c2b..1a4f4fb34 100644 --- a/TODO.md +++ b/TODO.md @@ -12,7 +12,6 @@ * Add raw dump for Plextor recorders. (https://github.com/claunia/DiscImageChef/issues/100) * Add support for 82077 floppy controllers. (https://github.com/claunia/DiscImageChef/issues/101) * Add support for AIX partitioning scheme. (https://github.com/claunia/DiscImageChef/issues/7) -* Add support for Apple 2 character encoding. (https://github.com/claunia/DiscImageChef/issues/102) * Add support for CD-Text in Nero images. (https://github.com/claunia/DiscImageChef/issues/104) * Add support for compressed Ciscopy images. (https://github.com/claunia/DiscImageChef/issues/127) * Add support for compressed DART images. (https://github.com/claunia/DiscImageChef/issues/68) @@ -42,7 +41,6 @@ * Add support for KryoFlux devices. (https://github.com/claunia/DiscImageChef/issues/141) * Add support for Linear Media PCMCIA devices. (https://github.com/claunia/DiscImageChef/issues/148) * Add support for MAME CHD images of PCMCIA devices. (https://github.com/claunia/DiscImageChef/issues/150) -* Add support for Microsoft Resilient filesystem (ReFS). (https://github.com/claunia/DiscImageChef/issues/13) * Add support for NetApp WAFL filesystem. (https://github.com/claunia/DiscImageChef/issues/61) * Add support for NetWare 286 filesystem. (https://github.com/claunia/DiscImageChef/issues/117) * Add support for NetWare 386 filesystem. (https://github.com/claunia/DiscImageChef/issues/118) @@ -54,14 +52,11 @@ * Add support for Parallel ATA devices in FreeBSD. (https://github.com/claunia/DiscImageChef/issues/114) * Add support for PCMCIA devices in FreeBSD. (https://github.com/claunia/DiscImageChef/issues/115) * Add support for PCMCIA devices in Windows. (https://github.com/claunia/DiscImageChef/issues/126) -* Add support for Radix-50 character encoding. (https://github.com/claunia/DiscImageChef/issues/103) * Add support for reading resource fork in macOS. (https://github.com/claunia/DiscImageChef/issues/156) * Add support for reading resource fork in Windows. (https://github.com/claunia/DiscImageChef/issues/157) * Add support for SecureDigital and MultiMediaCard devices in FreeBSD. (https://github.com/claunia/DiscImageChef/issues/116) -* Add support for Sharp X68000 FAT filesystem variation. (https://github.com/claunia/DiscImageChef/issues/158) * Add support for SuperCardPro devices. (https://github.com/claunia/DiscImageChef/issues/139) * Add support for XPACK images. (https://github.com/claunia/DiscImageChef/issues/45) -* Check CompactDisc read capabilities on dumping. (https://github.com/claunia/DiscImageChef/issues/138) * Checksum disk tags * Checksum long sectors * Checksum sector tags @@ -72,16 +67,13 @@ * Implement Apple KenCode compression algorithm. (https://github.com/claunia/DiscImageChef/issues/122) * Implement Apple LZFSE compression algorithm. (https://github.com/claunia/DiscImageChef/issues/124) * Implement Apple LZH compression algorithm. (https://github.com/claunia/DiscImageChef/issues/121) -* Implement Apple RLE compression algorithm. (https://github.com/claunia/DiscImageChef/issues/120) * Implement COLUMBIA ordering in CP/M filesystem. (https://github.com/claunia/DiscImageChef/issues/133) -* Implement conversion of dump formats. (https://github.com/claunia/DiscImageChef/issues/134) * Implement CYLINDERS ordering in CP/M filesystem. (https://github.com/claunia/DiscImageChef/issues/132) * Implement dumping GameCube discs. (https://github.com/claunia/DiscImageChef/issues/135) * Implement dumping Wii discs. (https://github.com/claunia/DiscImageChef/issues/136) * Implement EAGLE ordering in CP/M filesystem. (https://github.com/claunia/DiscImageChef/issues/131) * Implement ODS checksum. (https://github.com/claunia/DiscImageChef/issues/130) * Implement StuffIt compression algorithm. (https://github.com/claunia/DiscImageChef/issues/123) -* Implement writing support for dump formats. (https://github.com/claunia/DiscImageChef/issues/129) * Offer the option to see differing values * Optimize and multithread image comparison * Optimize current checksum multithreading