aaru-dps/Aaru.Documentation
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.Documentation.git synced 2025-12-16 19:24:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Start adding 5.3 docs from wiki

Browse Source
This commit is contained in:
SilasLaspada
2021-08-17 21:13:51 -06:00
parent ecd22955cb
commit 716b335d47
35 changed files with 1615 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
5.3/Bugs-in-other-dumping-software.md Normal file
View File

@@ -0,0 +1,11 @@
Some software contains bugs that can make users think the problem resides with DiscImageChef. This page contains a list of such bugs.
### ImgBurn complains image is smaller than disc
![](https://i.imgur.com/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.
DiscImageChef instead reads and interprets the 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 DiscImageChef 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).

30
5.3/Calculate-dump-contents-entropy.md Normal file
View File

@@ -0,0 +1,30 @@
==Command description==
This operation will calculate uniqueness and entropy of the media represented by a media dump image. It's not affected my the image format compression if applicable.
==Command usage==
<code>DiscImageChef entropy -d [true/false] -i <dump> -p [true/false] -t [true/false] -v [true/false] -w [true/false]</code>
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-i, --input=<dump></code> path to the media dump image<br />
<code>-p, --duplicated-sectors=[true/false]</code> besides entropy also calculates how many sectors have the exact same data in their user area ''(default true)''<br />
<code>-t, --separated-tracks=[true/false]</code> separately calculates the entropy for each track dividing the media. Only applicable to certain kind of media (optical discs and digital tapes mostly) ''(default true)''<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-w, --whole-disc=[true/false]</code> calculates the entropy for the whole media ''(default true)''
==Example==
<code>DiscImageChef entropy -i mydisc.cue</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

81
5.3/Check-readability-of-the-media-inserted-in-a-physical-device.md Normal file
View File

@@ -0,0 +1,81 @@
==Command description==
This operation will read the media inserted in the physical device, and measure how fast it can be read sequentially. It's not intended as a benchmark, but as a detector of damaged sectors, sectors that are losing readability, etc. When finished it will check how fast can the device seek, and report speed statistics.
==Command usage==
<code>DiscImageChef media-scan -b [ibglog] -d [true/false] -i <device> -m [mhddlog] -v [true/false]</code>
<code>-b, --ibg-log=[ibglog]</code> writes a log in the format used by ImgBurn<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-i, --input=<dump></code> path to the physical device<br />
<code>-m, --mhdd-log=[mhddlog]</code> writes a log in the format used by MHDD<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
==Example==
FreeBSD: <code>DiscImageChef media-scan -i /dev/cd0</code><br />
Linux: <code>DiscImageChef media-scan -i /dev/sdb</code><br />
Windows: <code>DiscImageChef media-scan -i \\.\PhysicalDrive3</code><br />
==Operating system support==
{|
! Device type
! FreeBSD
! macOS
! Linux
! Windows
|-
| SCSI Block device
| Yes
| No <ref name="macOS permissions">macOS only allows talking with MultiMedia devices</ref>
| Yes
| Yes
|-
| SCSI MultiMedia device
| Yes
| Not yet <ref name="macOS users">Support for MultiMedia devices in macOS will be added if users require it</ref>
| Yes
| Yes
|-
| SCSI Streaming device
| Yes
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| Parallel ATA
| No <ref name="FreeBSD bug">Not supported due to upstream bug</ref>
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| Serial ATA
| Yes
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| USB
| Partial <ref name="usb">USB descriptors are not retrieved</ref>
| Partial <ref name="macOS">Only MultiMedia devices can be supported and descriptors will not be retrieved</ref>
| Yes
| Yes
|-
| FireWire
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Partial <ref name="macOS"/>
| Yes
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
|-
| PCMCIA
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
| Partial <ref name="macOS"/>
| Yes
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
|-
| SecureDigital / MultiMediaCard
| Not yet <ref name="FreeBSD sd">Support will come with FreeBSD 12-RELEASE</ref>
| No <ref name="macOS permissions"/>
| Yes
| Untested <ref name="Windows sd">Should work, untested due to not available hardware</ref>
|}
<references/>

33
5.3/Comparing-two-media-dumps.md Normal file
View File

@@ -0,0 +1,33 @@
==Command description==
This operation will compare two media dumps and print all differences between them. Dumps can be in different formats.
==Command usage==
<code>Aaru image compare [options] <image-path1> <image-path2></code>
==Arguments==
<code><image-path1></code> First media image path<br />
<code><image-path2></code> Second media image path<br />
==Options==
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>--pause=[true/false]</code> pauses before exiting. ''(default false)''<br />
<code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Example==
<code>Aaru image compare mydisc.cue anotherdisc.mds</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

219
5.3/Comparison.md Normal file
View File

@@ -0,0 +1,219 @@
In this page you can find a comparison between DiscImageChef and other dump image managers or creators.
You can see a [[Comparison#comparison of optical discs image managers|comparison of optical discs image managers]],
a [[Comparison#comparison of floppy disk image managers|comparison of floppy disk image managers]], a
[[Comparison#comparison of hard disk image managers|comparison of hard disk image managers]] and a
[[Comparison#comparison of digital tape image managers|comparison of digital tape image managers]].
==Comparison of optical discs image managers==
{|
!
! DiscImageChef
! DiscImageCreator
! CDRWin
! CloneCD
! Alcohol 120%
! IsoBuster
! WinImage
|-
| Opensource
| Yes
| [https://github.com/saramibreak/DiscImageCreator Yes]
| No
| No
| No
| No
| No
|-
| Supported platforms
| Windows, Linux, macOS<ref name="notyetmacos">macOS does not yet support dumping media, only managing existing images</ref>
| Windows
| Windows
| Windows
| Windows
| Windows
| Windows
|-
| Supported formats
| [https://github.com/claunia/DiscImageChef/blob/master/README.md#supported-disk-image-formats-read-and-write 12]
| 3<ref name="discimagecreator">CDRWin, CloneCD and raw</ref>
| 1<ref name="cdrwin">CDRWin</ref>
| 1<ref name="clonecd">CloneCD</ref>
| 1<ref name="alcohol">Alcohol 120%</ref>
| 17<ref name="isobuster">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</ref>
| 1<ref name="winimage">Raw</ref>
|-
| Can dump Audio CD
| Yes<ref name="audiocd">It can lose a few seconds from start of audio on some discs</ref>
| 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<ref name="audiocd">It can lose a few seconds from start of audio on some discs</ref>
| Yes
| Yes
| Yes
| Yes
| Yes
| Yes
|-
| Can dump multisession discs
| Yes
| Yes
| No
| Yes
| Yes
| Yes
| No
|-
| Can dump discs with errors
| Yes<ref name="partialdata">Depending on the drive it can recover data from sectors with errors</ref>
| Yes<ref name="fakedata">Writes fake data in the place of sectors with errors</ref>
| No<ref name="ignoreerrors">Ignores errors or stops on error</ref>
| Yes<ref name="fakedata"/>
| Yes<ref name="fakedata"/>
| Unknown
| Unknown
|-
| Reads subchannel
| Yes
| Yes
| No<ref name="cdg">Only if it detects the disc is | No
a CD+G</ref>
| 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<ref name="pendingformat">Pending format support</ref>
| No
| No
| No
| No
| No
| No
|-
| Supports position based copy protections
| Not yet<ref name="pendingformat"/>
| No
| No
| No
| Yes
| No
| No
|-
| Supports dumping DDCD
| Yes
| No<ref name="noddcd">None of its supported formats support the DDCD media</ref>
| No<ref name="noddcd"/>
| No<ref name="noddcd"/>
| No<ref name="noddcd"/>
| No<ref name="noddcd"/>
| No<ref name="noddcd"/>
|-
| Supports dumping GD
| Not yet<ref name="nextrelease">Feature will be added in next release</ref>
| Yes
| No
| No
| No
| No
| No
|-
| Supports dumping GameCube/Wii
| Not yet<ref name="nextrelease"/>
| Yes
| No
| No
| No
| No
| No
|-
| Supports dumping DVD<ref name="nocrypt">Does not include encrypted video media</ref><ref name="includedvd">Includes PlayStation DVD</ref>
| Yes
| Partial<ref name="losspfi">Customized PFI information, like PSN of start LBA in DVD-RAM will be lost</ref>
| No
| No
| Partial<ref name="losspfi"/>
| Partial<ref name="losspfi"/>
| Partial<ref name="losspfi"/>
|-
| Supports dumping HD DVD<ref name="nocrypt"/>
| Yes
| Partial<ref name="losshdpfi">Customized PFI information, like PSN of start LBA in HD DVD-RAM will be lost</ref>
| No
| No
| Partial<ref name="losshdpfi"/>
| Partial<ref name="losshdpfi"/>
| Partial<ref name="losshdpfi"/>
|-
| Supports dumping Blu-ray<ref name="nocrypt"/><ref name="includebd">Includes PlayStation Blu-ray</ref>
| Yes
| Yes
| No
| No
| Yes
| Yes
| Yes
|-
| Supports dumping Xbox Game discs
| Yes<ref name="xgd2untested">XGD2 are untested</ref><ref name="noxgd3">XGD3 are not supported</ref>
| Yes<ref name="noxgd3"/>
| No
| No
| No
| No
| No
|}
<references>

29
5.3/Configure-Aaru-statistics.md Normal file
View File

@@ -0,0 +1,29 @@
==Command description==
This command will ask you which statistics to gather and if you want to share them anonymously. When sharing, no information about you or your computer will be sent or stored, only the number of times a command have been used and the operating system where Aaru is run. This information is not, and will never be, sold to any third party, and is publicly available at http://aaru.app
==Command usage==
<code>Aaru configure [options]</code>
==Options==
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>--pause=[true/false]</code> pauses before exiting. ''(default false)''<br />
<code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Example==
<code>Aaru configure</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

40
5.3/Convert-image.md Normal file
View File

@@ -0,0 +1,40 @@
==Command description==
This operating will convert a dump from one image format to another.
==Command usage==
<code>Aaru image convert [options] <input-path> <output-path></code>
==Arguments==
<code><input-path></code> Input image path<br />
<code><output-path>></code> Output image path<br />
==Options==
<code>--cicm-xml, -x=<xml sidecar></code> take metadata from existing CICM XML sidecar<br />
<code>--comments=<comments></code> image comments<br />
<code>-c, --count=<count></code> how many sectors to convert at once ''(default 64)''<br />
<code>--creator=<creator></code> who (person) created the image?<br />
<code>--drive-manufacturer=<drive-manufacturer></code> manufacturer of the drive used to read the media represented by the image<br />
<code>--drive-model=<drive-model></code> model of the drive used to read the media represented by the image<br />
<code>--drive-revision=<drive-revision></code> firmware revision of the drive used to read the media represented by the image<br />
<code>--drive-serial=<drive-serial></code> serial number of the drive used to read the media represented by the image<br />
<code>-f, --force=[true/false]</code> continue conversion even if sector or media tags will be lost in the process ''(default false)''<br />
<code>--format, -p=<format></code> format of the output image, as plugin name or plugin id. If not present, will try to detect it from output image extension.<br />
<code>--media-barcode=<media-barcode></code> barcode of the media represented by the image<br />
<code>--media-lastsequence=<media-lastsequence></code> last media of the sequence the media represented by the image corresponds to ''(default 0)''<br />
<code>--media-manufacturer=<media-manufacturer></code> manufacturer of the media represented by the image<br />
<code>--media-model=<media-model></code> model of the media represented by the image<br />
<code>--media-partnumber=<media-partnumber></code> part number of the media represented by the image<br />
<code>--media-sequence=<media-sequence></code> number in sequence for the media represented by the image ''(default 0)''<br />
<code>--media-serial=<media-serial></code> serial number of the media represented by the image<br />
<code>--media-title=<media-title></code> title of the media represented by the image<br />
<code>-O, --options=<options></code> comma separated name=value pairs of options to pass to output image plugin<br />
<code>-r, --resume-file=<resume-file></code> take list of dump hardware from existing resume file<br />
<code>--fix-subchannel-position=[true/false]</code> store subchannel according to the sector they describe.<br />
<code>--fix-subchannel=[true/false]</code> try to fix subchannel. Implies fixing subchannel position.<br />
<code>--fix-subchannel-crc=[true/false]</code> if subchannel looks OK but CRC fails, rewrite it. Implies fixing subchannel.<br />
<code>--generate-subchannels=[true/false]</code> generates missing subchannels.<br />
<code>-d, --debug=[true/false]</code> shows debug output from plugins ''(default false)''<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
==Example==
<code>Aaru image convert -c 32 --comments="My converted image" --creator="Jane Doe" --drive-manufacturer="LG" --drive-model="CD-RW 1234" --drive-revision="1.0" --drive-serial="AABBCCDDEEFF01" --media-lastsequence=2 --media-sequence=1 --media-title="Important software" -O "deduplicate=true,nocompress=false" -r dd_dump.resume.xml -x dd_dump.cicm.xml dd_dump.iso dump.aaruf</code>

93
5.3/Creating-a-dump-from-physical-media.md Normal file
View File

@@ -0,0 +1,93 @@
==Command description==
This operating will create a dump image from real media using a physical device. It will retry errors and when finished create an XML metadata sidecar and an Alcohol 120% media descriptor for optical media. The dumping operation can be interrupted and continued later, even with a different device.
==Command usage==
<code>DiscImageChef dump-media -d [true/false] -e <encoding> -f [true/false] -i <device path> -k <sectors> --lead-in [true/false] -m [true/false] --no-metadata [true/false] --no-trim [true/false] -O <options> -o <filename> --persistent [true/false] -p <passes> -s [true/false] -t <plugin> -v [true/false] -x <xml sidecar></code>
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-e, --encoding=<encoding></code> character encoding to use when creating dump sidecar<br />
<code>-f, --force=[true/false]</code> continuing dumping whatever happens ''(default false)''<br />
<code>-i, --input=<device path></code> path to the physical device<br />
<code>-k, --skip=<sectors></code> skip this many sectors when an unreadable sector is found ''(default 512)''<br />
<code>--lead-in=[true/false]</code> try to dump Lead-in. Only applicable to CD, DDCD or GD media ''(default false)''<br />
<code>-m, --resume=[true/false]</code> create and/or use resume mapfile ''(default true)''<br />
<code>--no-metadata=[true/false]</code> disables creating CICM XML sidecar ''(default false)''<br />
<code>--no-trim=[true/false]</code> disables trimming errores from skipped sectors ''(default false)''<br />
<code>-O, --options=<options></code> comma separated name=value pairs of options to pass to output image plugin<br />
<code>-o, --output=<filename></code> output image filename<br />
<code>--persistent=[true/false]</code> try to recover partial or incorrect data ''(default false)''<br />
<code>-p, --retry-passes=<passes></code> how many times to retry reading a sector ''(default 5)''<br />
<code>-s, --stop-on-error=[true/false]</code> stops dumping on first error ''(default false)''<br />
<code>-t, --format=<plugin></code> format for the output image, as plugin name or plugin id. If not present, will try to detect it from output image extension<br/>
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-x, --cicm-xml=<xml sidecar></code> take metadata from existing CICM XML sidecar<br />
==Example==
FreeBSD: <code>DiscImageChef dump-media -i /dev/cd0 -f --persistent=true --separate-subchannel -w mydisc</code><br />
Linux: <code>DiscImageChef dump-media -i /dev/sdb -r -f -p 15 -w myusbfloppy</code><br />
Windows: <code>DiscImageChef dump-media -i \\.\PhysicalDrive3 -f -p 0 --resume=false mydisk</code><br />
==Operating system support==
{|
! Device type
! FreeBSD
! macOS
! Linux
! Windows
|-
| SCSI Block device
| Yes
| No <ref name="macOS permissions">macOS only allows talking with MultiMedia devices</ref>
| Yes
| Yes
|-
| SCSI MultiMedia device
| Yes
| Not yet <ref name="macOS users">Support for MultiMedia devices in macOS will be added if users require it</ref>
| Yes
| Yes
|-
| SCSI Streaming device
| Yes
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| Parallel ATA
| No <ref name="FreeBSD bug">Not supported due to upstream bug</ref>
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| Serial ATA
| Yes
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| USB
| Partial <ref name="usb">USB descriptors are not retrieved</ref>
| Partial <ref name="macOS">Only MultiMedia devices can be supported and descriptors will not be retrieved</ref>
| Yes
| Yes
|-
| FireWire
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Partial <ref name="macOS"/>
| Yes
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
|-
| PCMCIA
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
| Partial <ref name="macOS"/>
| Yes
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
|-
| SecureDigital / MultiMediaCard
| Not yet <ref name="FreeBSD sd">Support will come with FreeBSD 12-RELEASE</ref>
| No <ref name="macOS permissions"/>
| Yes
| Untested <ref name="Windows sd">Should work, untested due to not available hardware</ref>
|}
<references/>

32
5.3/Creating-metadata-sidecar-XML.md Normal file
View File

@@ -0,0 +1,32 @@
==Command description==
This operation will analyze a media dump, and if the format is recognized, create a CICM XML metadata sidecar with all information that can be automatically get about it, as well as all [[Supported-checksums|supported checksum algorithms]].
==Command usage==
<code>DiscImageChef create-sidecar -b [block size] -d [true/false] -e [encoding] -i <dump> -t tape [true/false] -v [true/false]</code>
<code>-b, --block-size=[block size]</code> used only for tapes, indicates fixed block size in bytes. File in dump folder not multiple of this value will be ignored ''(default 512)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-e, --encoding=[encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br />
<code>-i, --input=<dump></code> path to the media dump image<br />
<code>-t, --tape=[true/false]</code> indicates that dump points to a folder containing alphabetically sorted files extracted from a linear block-based tape with fixed block size (e.g. a SCSI streaming device) ''(default false)''<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
==Examples==
<code>DiscImageChef create-sidecar -i mydisc.cue</code><br />
<code>DiscImageChef create-sidecar -i mytapedir -t -b 1024</code><br />
<code>DiscImageChef create-sidecar -i "My japanese software.img" -e shift_jis</code><br />
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

31
5.3/Decoding-and-printing-media-tags.md Normal file
View File

@@ -0,0 +1,31 @@
==Command description==
This operation will decode all [[Sector-tags|sector tags]] and [[Media-tags|media tags]] on a media dump image.
==Command usage==
<code>DiscImageChef decode -d [true/false] -i <dump> -k [true/false] -l [sectors] -t [true/false] -s [start sector] -v [true/false]</code>
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-i, --input=<dump></code> path to the media dump image<br />
<code>-k, --disk-tags=[true/false]</code> decodes all [[Media-tags|media tags]] ''(default true)''<br />
<code>-l, --length=[sectors]</code> how many sectors to decode or ''all'' to decode all ''(default all)''<br />
<code>-t, --sector-tags=[true/false]</code> decodes all [[Sector-tags|sector tags]] ''(default true)''<br />
<code>-s, --start=[start-sector]</code> starting sector ''(default 0)''<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
==Example==
<code>DiscImageChef decode -i mydisc.cue -s 1000 -l 15 -t false</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

37
5.3/Extracting-files-from-a-media-dump.md Normal file
View File

@@ -0,0 +1,37 @@
==Command description==
This operation will analyze and find all filesystems in a media dump and extract the files that are contained in [[Filesystems-recognized-by-Aaru|supported filesystems]].
==Command usage==
<code>Aaru filesystem extract [options] <image-path> <output-dir></code>
==Arguments==
<code><image-path></code> Media image path<br />
<code><output-dir></code> Directory where extracted files will be created. Will abort if it exists<br />
==Options==
<code>-e, --encoding=[encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br />
<code>-O, --options=[options]</code> comma separated name=value pairs of options to pass to filesystem plugin<br />
<code>-x, --xattrs=[true/false]</code> extract extended attributes if present ''(default false)''<br />
<code>-n, --namespace=[namespace]</code> namespace to use for filenames<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>--pause=[true/false]</code> pauses before exiting. ''(default false)''<br />
<code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Example==
<code>Aaru filesystem extract -x -e iso8859-15 mydisc.cue contents</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

76
5.3/Filesystems-recognized-by-Aaru.md Normal file
View File

@@ -0,0 +1,76 @@
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)

20
5.3/Frequently-Asked-Questions.md Normal file
View File

@@ -0,0 +1,20 @@
# Why the name, why DiscImageChef?
Because a chef is someone that takes raw ingredients and according to a recipe makes magic with them, and so does DiscImageChef with media dump images.
# Which operating systems does DiscImageChef work under?
Any operating system with a .NET 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 DiscImageChef?
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 DiscImageChef 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/claunia/DiscImageChef/issues) and create a New Issue, that way the bug will not be forgotten and you can follow progress on its solution.

31
5.3/Get-a-hexadecimal-print-of-a-media-dump-sector-or-block.md Normal file
View File

@@ -0,0 +1,31 @@
==Command description==
This operation will print in console a hexadecimal dump of the chosen sector/block of the indicated media dump image.
==Command usage==
<code>DiscImageChef printhex -d [true/false] -i <dump> -l [sectors] -r [true/false] -s <starting sector> -v [true/false] -w [width]</code>
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-i, --input=<dump></code> path to the media dump image<br />
<code>-l, --length=[sectors]</code> how many sectors to print ''(default 1)''<br />
<code>-r, --long-sectors=[true/false]</code> if hex print should include all [[Sector-Tags|sector tags]] stored in the media dump ''(default false)''<br />
<code>-s, --start=<starting sector></code> starts the hexadecimal printing from this sector<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-w, --width=[width]</code> how width, in characters, should the print be before creating a new line ''(default 32)''
==Example==
<code>DiscImageChef printhex -i mydisc.cue -s 15 -l 30 -r -w 64</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

47
5.3/Getting-hashes-and-checksums-from-a-media-dump.md Normal file
View File

@@ -0,0 +1,47 @@
==Command description==
This operation will calculate the checksums for the media represented by a media dump image.
==Command usage==
<code>Aaru image checksum [options] <image-path></code>
==Arguments==
<code><image-path></code> Media image path<br />
==Options==
<code>-a, --adler32=[true/false]</code> calculates the Adler-32 checksum ''(default true)''<br />
<code>--crc16=[true/false]</code> calculates the CRC16 checksum ''(default true)''<br />
<code>-c, --crc32=[true/false]</code> calculates the CRC32 checksum ''(default true)''<br />
<code>--crc64=[true/false]</code> calculates the ECMA CRC64 checksum ''(default false)''<br />
<code>--fletcher16=[true/false]</code> calculates the Fletcher-16 checksum ''(default false)''<br />
<code>--fletcher32=[true/false]</code> calculates the Fletcher-32 checksum ''(default false)''<br />
<code>-m, --md5=[true/false]</code> calculates the MD5 hash ''(default true)''<br />
<code>-t, --separated-tracks=[true/false]</code> calculates each track checksum separately ''(default true)''<br />
<code>--ripemd160=[true/false]</code> calculates the RIPEMD160 hash ''(default false)''<br />
<code>-s, --sha1=[true/false]</code> calculates the SHA1 hash ''(default true)''<br />
<code>--sha256=[true/false]</code> calculates the SHA2 hash with 256-bit ''(default false)''<br />
<code>--sha384=[†rue/false]</code> calculates the SHA2 hash with 384-bit ''(default false)''<br />
<code>--sha512=[true/false]</code> calculates the SHA2 hash with 512-bit ''(default false)''<br />
<code>-f, --spamsum=[true/false]</code> calculates the SpamSum fuzzy hash ''(default true)''<br />
<code>-w, --whole-disc=[true/false]</code> calculates the whole media checksum ''(default true)''<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>--pause=[true/false]</code> pauses before exiting. ''(default false)''<br />
<code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Example==
<code>Aaru image checksum -a false --sha512=true mydisc.cue</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

86
5.3/Getting-information-from-a-physical-device.md Normal file
View File

@@ -0,0 +1,86 @@
==Command description==
This operation will request and show all information about a physical device. For information about supported physical devices check [[Supported-devices|the list of supported physical devices]]
==Command usage==
<code>Aaru device info [options] <device-path></code>
==Arguments==
<code><device-path></code> Device path<br />
==Options==
<code>--output-prefix, -w=[prefix]</code> writes binary responses from device to that prefix <br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>--pause=[true/false]</code> pauses before exiting. ''(default false)''<br />
<code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Example==
FreeBSD: <code>Aaru device info /dev/cd0</code><br />
Linux: <code>Aaru device info /dev/sda</code><br />
Windows: <code>Aaru device info D:</code><br />
==Operating system support==
{|
! Device type
! FreeBSD
! macOS
! Linux
! Windows
|-
| SCSI Block device
| Yes
| No <ref name="macOS permissions">macOS only allows talking with MultiMedia devices</ref>
| Yes
| Yes
|-
| SCSI MultiMedia device
| Yes
| Not yet <ref name="macOS users">Support for MultiMedia devices in macOS will be added if users require it</ref>
| Yes
| Yes
|-
| SCSI Streaming device
| Yes
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| Parallel ATA
| No <ref name="FreeBSD bug">Not supported due to upstream bug</ref>
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| Serial ATA
| Yes
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| USB
| Partial <ref name="usb">USB descriptors are not retrieved</ref>
| Partial <ref name="macOS">Only MultiMedia devices can be supported and descriptors will not be retrieved</ref>
| Yes
| Yes
|-
| FireWire
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Partial <ref name="macOS"/>
| Yes
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
|-
| PCMCIA
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
| Partial <ref name="macOS"/>
| Yes
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
|-
| SecureDigital / MultiMediaCard
| Not yet <ref name="FreeBSD sd">Support will come with FreeBSD 12-RELEASE</ref>
| No <ref name="macOS permissions"/>
| Yes
| Untested <ref name="Windows sd">Should work, untested due to not available hardware</ref>
|}
<references/>

80
5.3/Getting-information-from-media-inserted-in-a-physical-device.md Normal file
View File

@@ -0,0 +1,80 @@
==Command description==
This operation will request and show all information about the inserted media in a physical device. For information about supported physical devices check [[Supported-devices|the list of supported physical devices]]
==Command usage==
<code>DiscImageChef media-info -d [true/false] -i <device> -v [true/false] -w [prefix]</code>
<code>-d, --debug=[true/false]</code> shows debug output ''(default false'')<br />
<code>-i, --input=<device></code> path to the physical device<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false'')<br />
<code>-w, --output-prefix=[prefix]</code> writes binary responses from device to that prefix
==Example==
FreeBSD: <code>DiscImageChef media-info -i /dev/cd0</code><br />
Linux: <code>DiscImageChef media-info -i /dev/sdb</code><br />
Windows: <code>DiscImageChef media-info -i \\.\PhysicalDrive3</code><br />
==Operating system support==
{|
! Device type
! FreeBSD
! macOS
! Linux
! Windows
|-
| SCSI Block device
| Yes
| No <ref name="macOS permissions">macOS only allows talking with MultiMedia devices</ref>
| Yes
| Yes
|-
| SCSI MultiMedia device
| Yes
| Not yet <ref name="macOS users">Support for MultiMedia devices in macOS will be added if users require it</ref>
| Yes
| Yes
|-
| SCSI Streaming device
| Yes
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| Parallel ATA
| No <ref name="atamedia">Use device-info command</ref>
| No <ref name="atamedia"/>
| No <ref name="atamedia"/>
| No <ref name="atamedia"/>
|-
| Serial ATA
| No <ref name="atamedia"/>
| No <ref name="atamedia"/>
| No <ref name="atamedia"/>
| No <ref name="atamedia"/>
|-
| USB
| Yes
| Yes
| Yes
| Yes
|-
| FireWire
| Yes
| Yes
| Yes
| Yes
|-
| PCMCIA
| Yes
| Yes
| Yes
| Yes
|-
| SecureDigital / MultiMediaCard
| No <ref name="atamedia"/>
| No <ref name="atamedia"/>
| No <ref name="atamedia"/>
| No <ref name="atamedia"/>
|}
<references/>

37
5.3/List-files.md Normal file
View File

@@ -0,0 +1,37 @@
==Command description==
This operation will analyze and find all filesystems in a media dump and list all the files that are contained in [[Filesystems-recognized-by-Aaru|supported filesystems]]
==Command usage==
<code>Aaru filesystem list [options] <image-path></code>
==Arguments==
<code><image-path></code> Media image path<br />
==Options==
<code>-e, --encoding=[encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br />
<code>-l, --long-format=[true/false]</code> use a long listing format, showing sizes and extended attributes ''(default false)''<br />
<code>-O, --options=[options]</code> comma separated name=value pairs of options to pass to filesystem plugin<br />
<code>-n, --namespace=[namespace]</code> namespace to use for filenames ''(default varies by filesystem)''<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>--pause=[true/false]</code> pauses before exiting. ''(default false)''<br />
<code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Example==
<code>Aaru filesystem list -l -e x-mac-icelandic mydisc.cue</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

26
5.3/List-namespaces.md Normal file
View File

@@ -0,0 +1,26 @@
==Command description==
Lists all namespaces supported by read-only filesystems.
==Command usage==
<code>Aaru list-namespaces [options]</code>
==Options==
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>--pause=[true/false]</code> pauses before exiting. ''(default false)''<br />
<code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

31
5.3/List-supported-devices.md Normal file
View File

@@ -0,0 +1,31 @@
==Command description==
This operation will show all known attached devices on your system and if they are supported for device dependent operations.
==Command usage==
<code>Aaru device list [options] [<aaru-remote-host>]</code>
==Arguments==
<code><aaru-remote-host></code> aaruremote host<br />
==Options==
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>--pause=[true/false]</code> pauses before exiting. ''(default false)''<br />
<code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Not yet <ref name="macOS users">Support for MultiMedia devices in macOS will be added if users require it</ref>
|-
| Linux
| Yes
|-
| Windows
| Yes
|}
<references/>

20
5.3/List-supported-encodings.md Normal file
View File

@@ -0,0 +1,20 @@
==Command description==
This operation will list all your character set encodings supported in your environment. This list depends on libraries installed on your system, so if an encoding is available in one environment there are no guarantees it will be available in another one.
==Command usage==
<code>Aaru list-encodings</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

20
5.3/List-supported-formats.md Normal file
View File

@@ -0,0 +1,20 @@
==Command description==
This operation will list all filters, dump media formats, partitioning schemes and filesystems supported by your version of Aaru.
==Command usage==
<code>Aaru formats</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

58
5.3/Media-dump-formats-supported-by-Aaru.md Normal file
View File

@@ -0,0 +1,58 @@
== Disk images that can be read only ==
* Apple Disk Archival/Retrieval Tool<ref name="nocompress">Compressed images are not supported yet</ref>
* Apple New Disk Image Format<ref>Requires resource fork to be presented by any filter</ref><ref>Only supports images compressed with ADC algorithm</ref>
* Apple NIB
* BlindWrite 4
* BlindWrite 5
* CPCEMU Disk-File and Extended CPC Disk-File
* D88 Disk Image
* DataPackRat's d2f/f2d disk image format ("WC DISK IMAGE")
* DIM Disk Image
* DiscFerret<ref name="flux">Only supported for sidecar creation. No data is read from its contents</ref>
* DiscJuggler
* Dreamcast GDI image
* Dunfield's IMD
* HD-Copy disk image
* KryoFlux STREAM<ref name="flux"/>
* MAME Compressed Hunks of Data<ref name="nocompress"/>
* Microsoft VHDX
* Nero Burning ROM image
* PartClone disk image
* Partimage disk image
* Spectrum Floppy Disk Image
* SuperCardPro<ref name="flux"/>
* Sydex CopyQM
* Sydex TeleDisk
== Disk images that can be read and written ==
* ACT Apricot Disk Image
* Alcohol 120% Media Descriptor Structure
* Anex86 Disk Image
* Apple 2IMG
* Apple &#93;&#91; Interleaved Disk Image
* Apple DiskCopy 4.2
* Apple Universal Disk Image Format<ref>Only supports images compressed with ADC, bzip2 or zlib algorithms</ref>
* Basic Lisa Utility
* CDRDAO tocfile
* CDRWin cuesheet
* CisCopy Disk Image (DC-File)
* CloneCD
* Digital Research DiskCopy
* Aaru format
* IBM SaveDskF
* MAXI Disk image
* Parallels disk image
* QEMU Copy-On-Write disk image
* QEMU Copy-On-Write disk image v2
* QEMU Enhanced Disk image
* Raw Disk Image
* Ray Arachelian's Disk IMage
* RS-IDE Hard Disk Image
* T98 Hard Disk Image
* T98-Next NHD r0 Disk Image
* Virtual98 Disk Image
* VirtualBox Disk Image
* VirtualPC
* VMware disk image<ref name="nocompress"/>
<references/>

59
5.3/Media-tags.md Normal file
View File

@@ -0,0 +1,59 @@
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

24
5.3/Partitioning-schemes-recognized-by-Aaru.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

55
5.3/README.md Normal file
View File

@@ -0,0 +1,55 @@
Welcome to the Aaru wiki.
Aaru is a tool designed to handle different media dump formats (also called disc or disk images) and do common operations with them.
'''What do you want to do?'''
* [[Configure-Aaru-statistics|Set which information will Aaru send to you]]
* [[List-supported-formats|Get a list of all formats supported]]
* [[List-supported-encodings|Get a list of all supported character set encodings]]
* [[List-namespaces|Lists all namespaces supported by read-only filesystems.]]
Database commands:
* [[Show-statistics|See my own usage statistics]]
* [[Update-database|Update the main Aaru database]]
Device commands:
* [[Getting-information-from-a-physical-device|Get information from a physical device]]
* [[Reporting-physical-device-capabilities|Test physical device capabilities and create an XML report of them]]
* [[List-supported-devices|Get a list of all supported physical devices]]
Filesystem commands:
* [[Show-information-about-the-partitions-and-filesystems-in-a-media-dump|Show information about the partitions and filesystems in a media dump|]]
* [[Extracting-files-from-a-media-dump|Extract all files contained in a media dump]]
* [[List-files|List all files contained in a media dump]]
Image commands:
* [[Getting-hashes-and-checksums-from-a-media-dump|Get checksums or hashes from a dump]]
* [[Comparing-two-media-dumps|Compare two media dumps]]
* [[Convert-image|Convert a media dump from one format to another]]
* [[Creating-metadata-sidecar-XML|Create XML sidecar with metadata of a dump]]
* [[Decoding-and-printing-media-tags|Decode media tags and print them]]
* [[Get-a-hexadecimal-print-of-a-media-dump-sector-or-block|Get a hexadecimal print of a media dump sector or block]]
* [[Verifying-media-dump-integrity|Verify integrity of a media dump or its contents]]
* [[Creating-a-dump-from-physical-media|Calculate entropy of a media dump]]
Media commands:
* [[Creating a dump from physical media|Create a media dump from a physical device]]
* [[Getting-information-from-media-inserted-in-a-physical-device|Show information about media inserted in a physical device]]
* [[Check-readability-of-the-media-inserted-in-a-physical-device|Check readability of the media inserted in a physical device]]
'''What is supported by Aaru?'''
* [[Supported filters|Filters]]
* [[Media dump formats supported by Aaru|Media dump formats]]
* [[Partitioning schemes recognized by Aaru|Partitioning schemes]]
* [[Filesystems-recognized-by-Aaru|Filesystems]]
* [[Supported devices|Physical devices]]
* [[Supported-checksums|Checksum and hashes]]
* [[Media-tags|Known media tags|]]
* [[Sector-Tags|Known sector/block tags]]
'''[[Comparison|Comparing Aaru to similar software]]'''
'''[[Frequently Asked Questions]]'''
'''[[Bugs in other dumping software]]'''

85
5.3/Reporting-physical-device-capabilities.md Normal file
View File

@@ -0,0 +1,85 @@
==Command description==
This operation will test a physical device for its read capabilities. If the media is removable, it will ask you to insert different media on it, as read capabilities vary with different media. The report will be saved in the executing directory, and sent to us. Shared reports can be seen in http://aaru.app
==Command usage==
<code>Aaru device report [options] <device-path></code>
==Arguments==
<code><device-path></code> Device path<br />
==Options==
<code>-t, --trap-disc=[true/false]</code> does a device report using a trap disc ''(default false)''<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>--pause=[true/false]</code> pauses before exiting. ''(default false)''<br />
<code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Example==
FreeBSD: <code>Aaru device report /dev/cd0</code><br />
Linux: <code>Aaru device-report /dev/sdb</code><br />
Windows: <code>Aaru device-report \\.\PhysicalDrive3</code><br />
==Operating system support==
{|
! Device type
! FreeBSD
! macOS
! Linux
! Windows
|-
| SCSI Block device
| Yes
| No <ref name="macOS permissions">macOS only allows talking with MultiMedia devices</ref>
| Yes
| Yes
|-
| SCSI MultiMedia device
| Yes
| Not yet <ref name="macOS users">Support for MultiMedia devices in macOS will be added if users require it</ref>
| Yes
| Yes
|-
| SCSI Streaming device
| Yes
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| Parallel ATA
| No <ref name="FreeBSD bug">Not supported due to upstream bug</ref>
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| Serial ATA
| Yes
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| USB
| Partial <ref name="usb">USB descriptors are not retrieved</ref>
| Partial <ref name="macOS">Only MultiMedia devices can be supported and descriptors will not be retrieved</ref>
| Yes
| Yes
|-
| FireWire
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Partial <ref name="macOS"/>
| Yes
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
|-
| PCMCIA
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
| Partial <ref name="macOS"/>
| Yes
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
|-
| SecureDigital / MultiMediaCard
| Not yet <ref name="FreeBSD sd">Support will come with FreeBSD 12-RELEASE</ref>
| No <ref name="macOS permissions"/>
| Yes
| Untested <ref name="Windows sd">Should work, untested due to not available hardware</ref>
|}
<references/>

19
5.3/Sector-Tags.md Normal file
View File

@@ -0,0 +1,19 @@
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

35
5.3/Show-information-about-the-partitions-and-filesystems-in-a-media-dump.md Normal file
View File

@@ -0,0 +1,35 @@
==Command description==
This command will analyze a media dump, and if the format is recognized and you choose so, it will search for [[Partitioning-schemes-recognized-by-Aaru|supported partitioning schemes]] and [[Filesystems-recognized-by-Aaru|supported filesystems]] on the dump, showing information about them.
==Command usage==
<code>Aaru filesystem info [options] <image-path></code>
==Arguments==
<code><image-path></code> Media image path<br />
==Options==
<code>-e, --encoding=[encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br />
<code>-f, --filesystems=[true/false]</code> searches and interprets filesystems ''(default true)''<br />
<code>-p, --partitions=[true/false]</code> searches and interprets partitions ''(default true)''<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>--pause=[true/false]</code> pauses before exiting. ''(default false)''<br />
<code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Example==
<code>Aaru filesystem info mydisc.cue</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

26
5.3/Show-statistics.md Normal file
View File

@@ -0,0 +1,26 @@
==Command description==
This operation will show the statistics that have been stored locally on your environment.
==Command usage==
<code>Aaru database stats [options]</code>
==Options==
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>--pause=[true/false]</code> pauses before exiting. ''(default false)''<br />
<code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

11
5.3/Supported-checksums.md Normal file
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)

66
5.3/Supported-devices.md Normal file
View File

@@ -0,0 +1,66 @@
The following physical devices are supported:
==Operating system support==
{|
! Device type
! FreeBSD
! macOS
! Linux
! Windows
|-
| SCSI Block device
| Yes
| No <ref name="macOS permissions">macOS only allows talking with MultiMedia devices</ref>
| Yes
| Yes
|-
| SCSI MultiMedia device
| Yes
| Not yet <ref name="macOS users">Support for MultiMedia devices in macOS will be added if users require it</ref>
| Yes
| Yes
|-
| SCSI Streaming device
| Yes
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| Parallel ATA
| No <ref name="FreeBSD bug">Not supported due to upstream bug</ref>
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| Serial ATA
| Yes
| No <ref name="macOS permissions"/>
| Yes
| Yes
|-
| USB
| Partial <ref name="usb">USB descriptors are not retrieved</ref>
| Partial <ref name="macOS">Only MultiMedia devices can be supported and descriptors will not be retrieved</ref>
| Yes
| Yes
|-
| FireWire
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Partial <ref name="macOS"/>
| Yes
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
|-
| PCMCIA
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
| Partial <ref name="macOS"/>
| Yes
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
|-
| SecureDigital / MultiMediaCard
| Not yet <ref name="FreeBSD sd">Support will come with FreeBSD 12-RELEASE</ref>
| No <ref name="macOS permissions"/>
| Yes
| Untested <ref name="Windows sd">Should work, untested due to not available hardware</ref>
|}
<references/>

8
5.3/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

28
5.3/Update-database.md Normal file
View File

@@ -0,0 +1,28 @@
==Command description==
Updates the main Aaru database.
==Command usage==
<code>Aaru database update [options]</code>
==Options==
<code>--clear</code> clear existing main database ''(default false)''<br />
<code>--clear-all</code> clear existing main and local database ''(default false)''<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>--pause=[true/false]</code> pauses before exiting. ''(default false)''<br />
<code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

31
5.3/Verifying-media-dump-integrity.md Normal file
View File

@@ -0,0 +1,31 @@
==Command description==
This operation will verify a media dump.
If the media dump format includes a hash or checksum, it will calculate and compare it.
If the media sectors/blocks format include a hash, checksum or error recovery system, it will calculate and compare them.
==Command usage==
<code>DiscImageChef verify -d [true/false] -i <dump> -s [true/false] -v [true/false] -w [true/false]</code>
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-i, --input=<dump></code> path to the media dump image<br />
<code>-s, --verify-sectors=[true/false]</code> calculates and verifies the hash/checksum/ecc of every sector/block in the media dump ''(default true)''<br />
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
<code>-w, --verify-disc=[true/false]</code> calculates and verifies a media dump format checksum/hash ''(default true)''<br />
==Example==
<code>DiscImageChef verify -i mydisc.cue</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}