Organize documents and fix links.

This commit is contained in:
2021-08-18 04:57:38 +01:00
parent ef941c4cbc
commit b401e2f34a
78 changed files with 52 additions and 1142 deletions

16
faq/3rdparty.md Normal file
View File

@@ -0,0 +1,16 @@
Some software contains bugs that can make users think the problem resides with Aaru. This page contains a list of such
bugs.
### ImgBurn complains image is smaller than disc
![](../assets/img/ddAM1YS.png)
This seems to be a common bug, also appearing with images created with other software.
The problem comes because ImgBurn uses the `SCSI READ CAPACITY` command to decide the size of compact discs. Aaru
instead reads and interprets the TOC (Table of Contents), that describes the disc start and end. While that command
should indicate the same size as the TOC interpretation, seems to not be so in some conditions (drive firmware bug?).
A CompactDisc data area starts from the Track 1 pregap (MSF 00:00:00, LBA -150) to the last Lead-out start, and Aaru
dumps from the Track 1 start (MSF 00:02:00, LBA 0) unless you want it to try to read the pregap (not all drives can read
it).

73
faq/comparison.md Normal file
View File

@@ -0,0 +1,73 @@
In this page you can find a comparison between Aaru and other dump image managers or creators.
## Comparison of optical discs image managers
| | Aaru | DiscImageCreator | CDRWin | CloneCD | Alcohol 120% | IsoBuster | WinImage |
|-------------------------------------------------|--------------------------|------------------|----------|----------|--------------|-----------|-----------|
| Opensource | Yes | [Yes](https://github.com/saramibreak/DiscImageCreator) | No | No | No | No | No |
| Supported platforms | Windows, Linux, macOS¹ | Windows | Windows | Windows | Windows | Windows | Windows |
| Supported formats | [12](formats.md) | 3² | 1³ | 1⁴ | 1⁵ | 17⁶ | 1⁷ |
| Can dump Audio CD | Yes⁸ | Yes | Yes | Yes | Yes | Yes | No |
| Can dump Mode 0 tracks | Yes | No | No | No | No | No | No |
| Can dump Mode 1 tracks | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Can dump Mode 2 tracks | Yes⁸ | Yes | Yes | Yes | Yes | Yes | Yes |
| Can dump multisession discs | Yes | Yes | No | Yes | Yes | Yes | No |
| Can dump discs with errors | Yes⁹ | Yes¹⁰ | No¹¹ | Yes¹⁰ | Yes¹⁰ | Unknown | Unknown |
| Reads subchannel | Yes | Yes | No¹² | Yes | Yes | Unknown | No |
| Reads lead-in postgap | Yes | Yes | No | No | No | No | No |
| Supports illegal TOCs | Yes | Yes | No | Yes | Yes | Yes | No |
| Supports error based copy protections | Yes | Yes | No | Yes | Yes | Yes | No |
| Supports twin sectors based copy protections | Not yet¹³ | No | No | No | No | No | No |
| Supports position based copy protections | Not yet¹³ | No | No | No | Yes | No | No |
| Supports dumping DDCD | Yes | No¹⁴ | No¹⁴ | No¹⁴ | No¹⁴ | No¹⁴ | No¹⁴ |
| Supports dumping GD | Not yet¹⁵ | Yes | No | No | No | No | No |
| Supports dumping GameCube/Wii | Not yet¹⁵ | Yes | No | No | No | No | No |
| Supports dumping DVD¹⁶ ¹⁷ | Yes | Partial¹⁸ | No | No | Partial¹⁸ | Partial¹⁸ | Partial¹⁸ |
| Supports dumping HD DVD¹⁶ | Yes | Partial¹⁹ | No | No | Partial¹⁹ | Partial¹⁹ | Partial¹⁹ |
| Supports dumping Blu- ray¹⁶ ²⁰ | Yes | Yes | No | No | Yes | Yes | Yes |
| Supports dumping Xbox Game discs | Yes²¹ ²² | Yes²² | No | No | No | No | No |
1. macOS does not yet support dumping media, only managing existing images
2. CDRWin, CloneCD and raw
3. CDRWin
4. CloneCD
5. Alcohol 120%
6. Alcohol 120%, BlindWrite 5, BlindWrite 6, CD-i OptImage, CDRWin, CloneCD, DiscJuggler, Easy CD Creator, IsoBuster,
Nero, NTI, PlexTools, Prassi PrimoCD, Prassi PrimoDVD, raw, Virtual CD and WinOnCD
7. Raw
8. It can lose a few seconds from start of audio on some discs
9. Depending on the drive it can recover data from sectors with errors
10. Writes fake data in the place of sectors with errors
11. Ignores errors or stops on error
12. Only if it detects the disc is | No a CD+G
13. Pending format support
14. None of its supported formats support the DDCD media
15. Feature will be added in next release
16. Does not include encrypted video media
17. Includes PlayStation DVD
18. Customized PFI information, like PSN of start LBA in DVD-RAM will be lost
19. Customized PFI information, like PSN of start LBA in HD DVD-RAM will be lost
20. Includes PlayStation Blu-ray
21. XGD2 are untested
22. XGD3 are not supported

78
faq/filesystems.md Normal file
View File

@@ -0,0 +1,78 @@
Supported file systems for read-only operations
===============================================
* Apple DOS file system
* Apple Lisa file system
* Apple Macintosh File System (MFS)
* CP/M file system
* U.C.S.D Pascal file system
Supported file systems for identification and information only
==============================================================
* 3DO Opera file system
* Acorn Advanced Disc Filing System
* Alexander Osipov DOS (AO-DOS for Electronika BK-0011) file system
* Amiga Fast File System v2, untested
* Amiga Fast File System, with international characters, directory cache and multi-user patches
* Amiga Original File System, with international characters, directory cache and multi-user patches
* Apple File System (preliminary detection until on-disk layout is stable)
* Apple Hierarchical File System (HFS)
* Apple Hierarchical File System+ (HFS+)
* Apple ProDOS / SOS file system
* AtheOS file system
* B-tree file system (btrfs)
* BSD Fast File System (FFS) / Unix File System (UFS)
* BSD Unix File System 2 (UFS2)
* BeOS filesystem
* 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)
* 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)
* Fossil file system (from Plan9)
* HAMMER file system
* High Sierra Format
* HP Logical Interchange Format
* IBM Journaling File System (JFS)
* ISO9660
* Linux extended file system
* Linux extended file system 2
* Linux extended file system 3
* Linux extended file system 4
* Locus file system
* MicroDOS file system
* Microsoft 12-bit File Allocation Table (FAT12), including Atari ST extensions
* 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)
* Minix v2 file system
* Minix v3 file system
* NEC PC-Engine file system
* NILFS2
* OS-9 Random Block File
* Professional File System
* QNX4 and QNX6 filesystems
* Reiser file systems
* SGI Extent File System (EFS)
* SGI XFS
* SmartFileSystem
* SolarOS file system
* Squash file system
* UNICOS file system
* 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
* Xbox filesystems
* Xenix file system
* Xia filesystem
* Zettabyte File System (ZFS)

BIN
faq/formats.md Normal file

Binary file not shown.

68
faq/media-tags.md Normal file
View File

@@ -0,0 +1,68 @@
A media tag is data that accompany the media or the device, and is stored on the medium besides the user data, or
normally accessible. Media tags are usually used to store metadata about the medium, copy protection information, or
information about the device used to read the media.
# Compact Disc media tags
* Table of contents (cooked by drive)
* Full table of contents (cooked by drive)
* Session information
* Program Management Area
* Absolute Time In Pregroove
* CD-Text
* Media Catalogue Number
# DVD and HD DVD media tags
* Physical Format Information
* Lead-in Copyright Management Information
* CSS Disc Key
* Burst Cutting Area
* Lead-in Disc Manufacturer Information
* Media identifier
* CSS/CPPM Media Key Block
* Disc Description Structures
* Media status
* Spare Area Information
* RMD
* Pre-recorded information in Lead-in
* Pre-recorded Physical Format Information
* Layer capacity
* Middle zone start address
* Jump interval size
* Start LBA of the manual layer jump
* Pseudo-overwrite information
# Blu-ray media tags
* Disc Information
* Burst Cutting Area
* Disc Definition Structure
* Cartridge Status
* Spare Area Status
# AACS media tags for HD DVD and Blu-ray
* Volume identifier
* Pre-recorded media serial number
* Media identifier
* Media Key Block
* AACS Data Keys
* Encrypted LBA extents
* CPRM Media Key Block
# Media tags defined by MMC specifications
* Recognized hybrid layers
* Write protection status
* Disc standard information
* Disc track resources information
# Device tags defined by SCSI specifications
* Inquiry response
# Device tags defined by ATA/ATAPI specifications
* Ata Identify response
* Atapi Identify response

32
faq/more.md Normal file
View File

@@ -0,0 +1,32 @@
# Why the name, why Aaru?
Aaru is the Ancient Egyptian concept of paradise where your soul would be rebirthed after the preservation of your
physical body. That's why we chose this name, because of the paradise where data will reside after it's has been
preserved from its original physical media.
# Which operating systems does Aaru work under?
Any operating system with a .NET Core 2.0 runtime should work. Has been tested under Windows, Linux, Mac OS X and
FreeBSD.
# Will you support media dump image format XXXX?
If you can send me documentation, test images and/or the application that creates them, I will do my best to.
# Will you create a graphical interface for Aaru?
After all features are implemented (analyze, dump, browse), I will.
# Can I use any of your modules?
As long as you comply with the LGPL license, yes. I would thank you if you tell me where you're using them.
# Can I use the CICM XML metadata sidecar format in my project?
Of course, I invite you to use it extensively and provide me with as much feedback as you can.
# I have tried Aaru and found a bug, how can I tell you?
Please don't send me an email, it will simply fall in oblivion. Github has a pretty nice bug tracker, just
click [Issues](https://github.com/aaru-dps/Aaru/issues) and create a New Issue, that way the bug will not be forgotten
and you can follow progress on its solution.

24
faq/partitions.md Normal file
View File

@@ -0,0 +1,24 @@
* Acorn Linux and RISCiX partitions
* ACT Apricot partitions
* Amiga Rigid Disk Block (RDB)
* Apple Partition Map
* Atari AHDI and ICDPro
* BSD disklabels
* BSD slices inside MBR
* DEC disklabels
* DragonFly BSD 64-bit disklabel
* EFI GUID Partition Table (GPT)
* Human68k (Sharp X68000) partitions table
* Microsoft/IBM/Intel Master Boot Record (MBR)
* Minix subpartitions inside MBR
* NEC PC9800 partitions
* NeXT disklabel
* Plan9 partition table
* Rio Karma partitions
* SGI volume headers
* Solaris slices inside MBR
* Sun disklabel
* UNIX VTOC and disklabel
* UNIX VTOC inside MBR
* Xbox 360 hard coded partitions
* XENIX partition table

24
faq/sector-tags.md Normal file
View File

@@ -0,0 +1,24 @@
A sector tag is data that accompany the sector, but it's not part of the data written by the user, or normally
accessible. Sector tags can be used to contain metadata about that sector, such as error detection and correction,
filesystem recovery information, copy protection, etc...
# Floppy disk sector tags
* Apple GCR sector tags
# Compact Disc sector tags
* Data sector sync frame
* Data sector header
* Mode 2 data sector subheader
* Data sector EDC
* Data sector ECC P
* Data sector ECC Q
* Data sector ECC (P and Q)
* Data sector subchannels (P to W)
* Track ISRC
* Track flags
# DVD sector tags
* Copyright information

View File

@@ -0,0 +1,11 @@
* Adler-32
* CRC-16
* CRC-32
* CRC-64
* Fletcher-16
* Fletcher-32
* MD5
* RMD160
* SHA-1
* SHA-2 (256, 384 and 512 bits)
* SpamSum (fuzzy hashing)

25
faq/supported-devices.md Normal file
View File

@@ -0,0 +1,25 @@
The following physical devices are supported:
## Operating system support
| Device Type | FreeBSD | MacOS | Linux | Windows |
|--------------|----------|--------|--------|----------|
| SCSI Block device | Yes | No¹ | Yes | Yes |
| SCSI MultiMedia device | Yes | Not yet² | Yes | Yes |
| SCSI Streaming device | Yes | No¹ | Yes | Yes |
| Parallel ATA | No³ | No¹ | Yes | Yes |
| Serial ATA | Yes | No¹ | Yes | Yes |
| USB | Partial⁴ | Partial⁵ | Yes | Yes |
| FireWire | Partial⁶ | Partial⁵ | Yes | Partial⁶ |
| PCMCIA | Partial⁷ | Partial⁵ | Yes | Partial⁷ |
| SecureDigital / MultiMediaCard | Not yet⁸ | No¹ | Yes | Untested⁹ |
1. macOS only allows talking with MultiMedia devices.
2. Support for MultiMedia devices in macOS will be added if users require it
3. Not supported due to upstream bug
4. USB descriptors are not retrieved
5. Only MultiMedia devices can be supported and descriptors will not be retrieved
6. FireWire descriptors are not retrieved
7. PCMCIA CIS is not retrieved
8. Support will come with FreeBSD 12-RELEASE
9. Should work, untested due to not available hardware

8
faq/supported-filters.md Normal file
View File

@@ -0,0 +1,8 @@
* Apple PCExchange (FINDER.DAT & RESOURCE.FRK)
* AppleDouble
* AppleSingle
* BZip2
* GZip
* LZip
* MacBinary I, II, III
* XZ