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

More refactor.

Browse Source
This commit is contained in:
Natalia Portillo
2021-08-18 04:24:58 +01:00
parent 013614a4f0
commit ef941c4cbc
35 changed files with 324 additions and 848 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
5.0/List-supported-namespaces.md
View File

@@ -1,7 +1,6 @@
## Command description ## Command description
This operation will list all the supported namespaces of This operation will list all the supported namespaces of the [[Filesystems-recognized-by-Aaru|supported filesystems]].
the [[Filesystems-recognized-by-Aaru|supported filesystems]].
## Command usage ## Command usage

1
5.0/_Footer.md
View File

@@ -1 +0,0 @@
Aaru © 2011-2020 Natalia Portillo

13
5.3/Bugs-in-other-dumping-software.md
View File

@@ -1,11 +1,16 @@
Some software contains bugs that can make users think the problem resides with Aaru. This page contains a list of such bugs. 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 ### ImgBurn complains image is smaller than disc
![](https://i.imgur.com/ddAM1YS.png) ![](https://i.imgur.com/ddAM1YS.png)
This seems to be a common bug, also appearing with images created with other software. 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. The problem comes because ImgBurn uses the `SCSI READ CAPACITY` command to decide the size of compact discs. Aaru
Aaru 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?). 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 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). 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).

27
5.3/Calculate-dump-contents-entropy.md
View File

@@ -1,30 +1,19 @@
==Command description== ==Command description== This operation will calculate uniqueness and entropy of the media represented by a media dump
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. image. It's not affected my the image format compression if applicable.
==Command usage== ==Command usage==
<code>Aaru entropy -d [true/false] -i <dump> -p [true/false] -t [true/false] -v [true/false] -w [true/false]</code> <code>Aaru 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>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-i, --input=<dump></code> path to the media dump image<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>-p, --duplicated-sectors=[true/false]</code> besides entropy also calculates how many sectors have the exact same
<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 /> 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>-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)'' <code>-w, --whole-disc=[true/false]</code> calculates the entropy for the whole media ''(default true)''
==Example== ==Example==
<code>Aaru entropy -i mydisc.cue</code> <code>Aaru entropy -i mydisc.cue</code>
==Operating system support== ==Operating system support== {| | FreeBSD | Yes |- | macOS | Yes |- | Linux | Yes |- | Windows | Yes |}
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

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

@@ -1,5 +1,6 @@
==Command description== ==Command description== This operation will read the media inserted in the physical device, and measure how fast it can
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. 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== ==Command usage==
<code>Aaru media-scan -b [ibglog] -d [true/false] -i <device> -m [mhddlog] -v [true/false]</code> <code>Aaru media-scan -b [ibglog] -d [true/false] -i <device> -m [mhddlog] -v [true/false]</code>
@@ -10,72 +11,34 @@ This operation will read the media inserted in the physical device, and measure
<code>-m, --mhdd-log=[mhddlog]</code> writes a log in the format used by MHDD<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 /> <code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
==Example== ==Example== FreeBSD: <code>Aaru media-scan -i /dev/cd0</code><br />
FreeBSD: <code>Aaru media-scan -i /dev/cd0</code><br />
Linux: <code>Aaru media-scan -i /dev/sdb</code><br /> Linux: <code>Aaru media-scan -i /dev/sdb</code><br />
Windows: <code>Aaru media-scan -i \\.\PhysicalDrive3</code><br /> Windows: <code>Aaru media-scan -i \\.\PhysicalDrive3</code><br />
==Operating system support== ==Operating system support== {|
{|
! Device type ! Device type
! FreeBSD ! FreeBSD
! macOS ! macOS
! Linux ! Linux
! Windows ! Windows |- | SCSI Block device | Yes | No <ref name="macOS permissions">macOS only allows talking with MultiMedia
|- devices</ref>
| SCSI Block device | Yes | Yes |- | SCSI MultiMedia device | Yes | Not yet <ref name="macOS users">Support for MultiMedia devices in macOS
| Yes will be added if users require it</ref>
| No <ref name="macOS permissions">macOS only allows talking with MultiMedia devices</ref> | Yes | Yes |- | SCSI Streaming device | Yes | No <ref name="macOS permissions"/>
| Yes | Yes | Yes |- | Parallel ATA | No <ref name="FreeBSD bug">Not supported due to upstream bug</ref>
| 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"/> | No <ref name="macOS permissions"/>
| Yes | Yes | Yes |- | Serial ATA | Yes | No <ref name="macOS permissions"/>
| Yes | Yes | Yes |- | USB | Partial <ref name="usb">USB descriptors are not retrieved</ref>
|-
| 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> | Partial <ref name="macOS">Only MultiMedia devices can be supported and descriptors will not be retrieved</ref>
| Yes | Yes | Yes |- | FireWire | Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Yes
|-
| FireWire
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Partial <ref name="macOS"/> | Partial <ref name="macOS"/>
| Yes | Yes | Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref> |- | PCMCIA | Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
|-
| PCMCIA
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
| Partial <ref name="macOS"/> | Partial <ref name="macOS"/>
| Yes | Yes | Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
| 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>
|-
| SecureDigital / MultiMediaCard
| Not yet <ref name="FreeBSD sd">Support will come with FreeBSD 12-RELEASE</ref>
| No <ref name="macOS permissions"/> | No <ref name="macOS permissions"/>
| Yes | Yes | Untested <ref name="Windows sd">Should work, untested due to not available hardware</ref>
| Untested <ref name="Windows sd">Should work, untested due to not available hardware</ref>
|} |}
<references/> <references/>

19
5.3/Comparing-two-media-dumps.md
View File

@@ -1,5 +1,5 @@
==Command description== ==Command description== This operation will compare two media dumps and print all differences between them. Dumps can be
This operation will compare two media dumps and print all differences between them. Dumps can be in different formats. in different formats.
==Command usage== ==Command usage==
<code>Aaru image compare [options] <image-path1> <image-path2></code> <code>Aaru image compare [options] <image-path1> <image-path2></code>
@@ -17,17 +17,4 @@ This operation will compare two media dumps and print all differences between th
==Example== ==Example==
<code>Aaru image compare mydisc.cue anotherdisc.mds</code> <code>Aaru image compare mydisc.cue anotherdisc.mds</code>
==Operating system support== ==Operating system support== {| | FreeBSD | Yes |- | macOS | Yes |- | Linux | Yes |- | Windows | Yes |}
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

220
5.3/Comparison.md
View File

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

21
5.3/Configure-Aaru-statistics.md
View File

@@ -1,5 +1,7 @@
==Command description== ==Command description== This command will ask you which statistics to gather and if you want to share them anonymously.
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 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== ==Command usage==
<code>Aaru configure [options]</code> <code>Aaru configure [options]</code>
@@ -13,17 +15,4 @@ This command will ask you which statistics to gather and if you want to share th
==Example== ==Example==
<code>Aaru configure</code> <code>Aaru configure</code>
==Operating system support== ==Operating system support== {| | FreeBSD | Yes |- | macOS | Yes |- | Linux | Yes |- | Windows | Yes |}
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

32
5.3/Convert-image.md
View File

@@ -1,5 +1,4 @@
==Command description== ==Command description== This operating will convert a dump from one image format to another.
This operating will convert a dump from one image format to another.
==Command usage== ==Command usage==
<code>Aaru image convert [options] <input-path> <output-path></code> <code>Aaru image convert [options] <input-path> <output-path></code>
@@ -13,28 +12,39 @@ This operating will convert a dump from one image format to another.
<code>--comments=<comments></code> image comments<br /> <code>--comments=<comments></code> image comments<br />
<code>-c, --count=<count></code> how many sectors to convert at once ''(default 64)''<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>--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-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-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-revision=<drive-revision></code> firmware revision of the drive used to read the media represented by the
<code>--drive-serial=<drive-serial></code> serial number of the drive used to read the media represented by the image<br /> 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>--drive-serial=<drive-serial></code> serial number of the drive used to read the media represented by the
<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 /> 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-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-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-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-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-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-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-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>--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>-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>-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-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=[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>--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>--generate-subchannels=[true/false]</code> generates missing subchannels.<br />
<code>-d, --debug=[true/false]</code> shows debug output from plugins ''(default false)''<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 /> <code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
==Example== ==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> <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>

85
5.3/Creating-a-dump-from-physical-media.md
View File

@@ -1,15 +1,19 @@
==Command description== ==Command description== This operating will create a dump image from real media using a physical device. It will retry
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. 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== ==Command usage==
<code>Aaru 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>Aaru 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>-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>-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>-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>-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>-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>--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>-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-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>--no-trim=[true/false]</code> disables trimming errores from skipped sectors ''(default false)''<br />
@@ -18,76 +22,39 @@ This operating will create a dump image from real media using a physical device.
<code>--persistent=[true/false]</code> try to recover partial or incorrect data ''(default false)''<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>-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>-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>-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>-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 /> <code>-x, --cicm-xml=<xml sidecar></code> take metadata from existing CICM XML sidecar<br />
==Example== ==Example== FreeBSD: <code>Aaru dump-media -i /dev/cd0 -f --persistent=true --separate-subchannel -w mydisc</code><br />
FreeBSD: <code>Aaru dump-media -i /dev/cd0 -f --persistent=true --separate-subchannel -w mydisc</code><br />
Linux: <code>Aaru dump-media -i /dev/sdb -r -f -p 15 -w myusbfloppy</code><br /> Linux: <code>Aaru dump-media -i /dev/sdb -r -f -p 15 -w myusbfloppy</code><br />
Windows: <code>Aaru dump-media -i \\.\PhysicalDrive3 -f -p 0 --resume=false mydisk</code><br /> Windows: <code>Aaru dump-media -i \\.\PhysicalDrive3 -f -p 0 --resume=false mydisk</code><br />
==Operating system support== ==Operating system support== {|
{|
! Device type ! Device type
! FreeBSD ! FreeBSD
! macOS ! macOS
! Linux ! Linux
! Windows ! Windows |- | SCSI Block device | Yes | No <ref name="macOS permissions">macOS only allows talking with MultiMedia
|- devices</ref>
| SCSI Block device | Yes | Yes |- | SCSI MultiMedia device | Yes | Not yet <ref name="macOS users">Support for MultiMedia devices in macOS
| Yes will be added if users require it</ref>
| No <ref name="macOS permissions">macOS only allows talking with MultiMedia devices</ref> | Yes | Yes |- | SCSI Streaming device | Yes | No <ref name="macOS permissions"/>
| Yes | Yes | Yes |- | Parallel ATA | No <ref name="FreeBSD bug">Not supported due to upstream bug</ref>
| 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"/> | No <ref name="macOS permissions"/>
| Yes | Yes | Yes |- | Serial ATA | Yes | No <ref name="macOS permissions"/>
| Yes | Yes | Yes |- | USB | Partial <ref name="usb">USB descriptors are not retrieved</ref>
|-
| 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> | Partial <ref name="macOS">Only MultiMedia devices can be supported and descriptors will not be retrieved</ref>
| Yes | Yes | Yes |- | FireWire | Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Yes
|-
| FireWire
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Partial <ref name="macOS"/> | Partial <ref name="macOS"/>
| Yes | Yes | Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref> |- | PCMCIA | Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
|-
| PCMCIA
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
| Partial <ref name="macOS"/> | Partial <ref name="macOS"/>
| Yes | Yes | Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
| 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>
|-
| SecureDigital / MultiMediaCard
| Not yet <ref name="FreeBSD sd">Support will come with FreeBSD 12-RELEASE</ref>
| No <ref name="macOS permissions"/> | No <ref name="macOS permissions"/>
| Yes | Yes | Untested <ref name="Windows sd">Should work, untested due to not available hardware</ref>
| Untested <ref name="Windows sd">Should work, untested due to not available hardware</ref>
|} |}
<references/> <references/>

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

@@ -1,14 +1,19 @@
==Command description== ==Command description== This operation will analyze a media dump, and if the format is recognized, create a CICM XML
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]]. metadata sidecar with all information that can be automatically get about it, as well as
all [[Supported-checksums|supported checksum algorithms]].
==Command usage== ==Command usage==
<code>Aaru create-sidecar -b [block size] -d [true/false] -e [encoding] -i <dump> -t tape [true/false] -v [true/false]</code> <code>Aaru 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>-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>-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>-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>-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>-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 /> <code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
==Examples== ==Examples==
@@ -16,17 +21,4 @@ This operation will analyze a media dump, and if the format is recognized, creat
<code>Aaru create-sidecar -i mytapedir -t -b 1024</code><br /> <code>Aaru create-sidecar -i mytapedir -t -b 1024</code><br />
<code>Aaru create-sidecar -i "My japanese software.img" -e shift_jis</code><br /> <code>Aaru create-sidecar -i "My japanese software.img" -e shift_jis</code><br />
==Operating system support== ==Operating system support== {| | FreeBSD | Yes |- | macOS | Yes |- | Linux | Yes |- | Windows | Yes |}
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

22
5.3/Decoding-and-printing-media-tags.md
View File

@@ -1,8 +1,9 @@
==Command description== ==Command description== This operation will decode all [[Sector-tags|sector tags]] and [[Media-tags|media tags]] on a
This operation will decode all [[Sector-tags|sector tags]] and [[Media-tags|media tags]] on a media dump image. media dump image.
==Command usage== ==Command usage==
<code>Aaru decode -d [true/false] -i <dump> -k [true/false] -l [sectors] -t [true/false] -s [start sector] -v [true/false]</code> <code>Aaru 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>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-i, --input=<dump></code> path to the media dump image<br /> <code>-i, --input=<dump></code> path to the media dump image<br />
@@ -15,17 +16,4 @@ This operation will decode all [[Sector-tags|sector tags]] and [[Media-tags|medi
==Example== ==Example==
<code>Aaru decode -i mydisc.cue -s 1000 -l 15 -t false</code> <code>Aaru decode -i mydisc.cue -s 1000 -l 15 -t false</code>
==Operating system support== ==Operating system support== {| | FreeBSD | Yes |- | macOS | Yes |- | Linux | Yes |- | Windows | Yes |}
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

24
5.3/Extracting-files-from-a-media-dump.md
View File

@@ -1,15 +1,16 @@
==Command description== ==Command description== This operation will analyze and find all filesystems in a media dump and extract the files that
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]]. are contained in [[Filesystems-recognized-by-Aaru|supported filesystems]].
==Command usage== ==Command usage==
<code>Aaru filesystem extract [options] <image-path> <output-dir></code> <code>Aaru filesystem extract [options] <image-path> <output-dir></code>
==Arguments== ==Arguments==
<code><image-path></code> Media image path<br /> <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 /> <code><output-dir></code> Directory where extracted files will be created. Will abort if it exists<br />
==Options== ==Options==
<code>-e, --encoding=[encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br /> <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>-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>-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>-n, --namespace=[namespace]</code> namespace to use for filenames<br />
@@ -21,17 +22,4 @@ This operation will analyze and find all filesystems in a media dump and extract
==Example== ==Example==
<code>Aaru filesystem extract -x -e iso8859-15 mydisc.cue contents</code> <code>Aaru filesystem extract -x -e iso8859-15 mydisc.cue contents</code>
==Operating system support== ==Operating system support== {| | FreeBSD | Yes |- | macOS | Yes |- | Linux | Yes |- | Windows | Yes |}
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

2
5.3/Filesystems-recognized-by-Aaru.md
View File

@@ -1,5 +1,6 @@
Supported file systems for read-only operations Supported file systems for read-only operations
=============================================== ===============================================
* Apple DOS file system * Apple DOS file system
* Apple Lisa file system * Apple Lisa file system
* Apple Macintosh File System (MFS) * Apple Macintosh File System (MFS)
@@ -8,6 +9,7 @@ Supported file systems for read-only operations
Supported file systems for identification and information only Supported file systems for identification and information only
============================================================== ==============================================================
* 3DO Opera file system * 3DO Opera file system
* Acorn Advanced Disc Filing System * Acorn Advanced Disc Filing System
* Alexander Osipov DOS (AO-DOS for Electronika BK-0011) file system * Alexander Osipov DOS (AO-DOS for Electronika BK-0011) file system

14
5.3/Frequently-Asked-Questions.md
View File

@@ -1,20 +1,30 @@
# Why the name, why Aaru? # Why the name, why Aaru?
Because a chef is someone that takes raw ingredients and according to a recipe makes magic with them, and so does Aaru with media dump images.
Because a chef is someone that takes raw ingredients and according to a recipe makes magic with them, and so does Aaru
with media dump images.
# Which operating systems does Aaru work under? # Which operating systems does Aaru work under?
Any operating system with a .NET runtime should work. Has been tested under Windows, Linux, Mac OS X and FreeBSD. 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? # 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. 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? # Will you create a graphical interface for Aaru?
After all features are implemented (analyze, dump, browse), I will. After all features are implemented (analyze, dump, browse), I will.
# Can I use any of your modules? # 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. 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? # 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. 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? # 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/claunia/Aaru/issues) and create a New Issue, that way the bug will not be forgotten and you can follow progress on its solution.
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/Aaru/issues) and create a New Issue, that way the bug will not be forgotten
and you can follow progress on its solution.

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

@@ -1,31 +1,21 @@
==Command description== ==Command description== This operation will print in console a hexadecimal dump of the chosen sector/block of the
This operation will print in console a hexadecimal dump of the chosen sector/block of the indicated media dump image. indicated media dump image.
==Command usage== ==Command usage==
<code>Aaru printhex -d [true/false] -i <dump> -l [sectors] -r [true/false] -s <starting sector> -v [true/false] -w [width]</code> <code>Aaru 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>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-i, --input=<dump></code> path to the media dump image<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>-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>-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>-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>-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)'' <code>-w, --width=[width]</code> how width, in characters, should the print be before creating a new line ''(default
32)''
==Example== ==Example==
<code>Aaru printhex -i mydisc.cue -s 15 -l 30 -r -w 64</code> <code>Aaru printhex -i mydisc.cue -s 15 -l 30 -r -w 64</code>
==Operating system support== ==Operating system support== {| | FreeBSD | Yes |- | macOS | Yes |- | Linux | Yes |- | Windows | Yes |}
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

18
5.3/Getting-hashes-and-checksums-from-a-media-dump.md
View File

@@ -1,5 +1,4 @@
==Command description== ==Command description== This operation will calculate the checksums for the media represented by a media dump image.
This operation will calculate the checksums for the media represented by a media dump image.
==Command usage== ==Command usage==
<code>Aaru image checksum [options] <image-path></code> <code>Aaru image checksum [options] <image-path></code>
@@ -31,17 +30,4 @@ This operation will calculate the checksums for the media represented by a media
==Example== ==Example==
<code>Aaru image checksum -a false --sha512=true mydisc.cue</code> <code>Aaru image checksum -a false --sha512=true mydisc.cue</code>
==Operating system support== ==Operating system support== {| | FreeBSD | Yes |- | macOS | Yes |- | Linux | Yes |- | Windows | Yes |}
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

75
5.3/Getting-information-from-a-physical-device.md
View File

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

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

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

28
5.3/List-files.md
View File

@@ -1,15 +1,17 @@
==Command description== ==Command description== This operation will analyze and find all filesystems in a media dump and list all the files that
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]] are contained in [[Filesystems-recognized-by-Aaru|supported filesystems]]
==Command usage== ==Command usage==
<code>Aaru filesystem list [options] <image-path></code> <code>Aaru filesystem list [options] <image-path></code>
==Arguments== ==Arguments==
<code><image-path></code> Media image path<br /> <code><image-path></code> Media image path<br />
==Options== ==Options==
<code>-e, --encoding=[encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br /> <code>-e, --encoding=[encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies
<code>-l, --long-format=[true/false]</code> use a long listing format, showing sizes and extended attributes ''(default false)''<br /> 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>-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>-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>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
@@ -17,21 +19,7 @@ This operation will analyze and find all filesystems in a media dump and list al
<code>--pause=[true/false]</code> pauses before exiting. ''(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 /> <code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Example== ==Example==
<code>Aaru filesystem list -l -e x-mac-icelandic mydisc.cue</code> <code>Aaru filesystem list -l -e x-mac-icelandic mydisc.cue</code>
==Operating system support== ==Operating system support== {| | FreeBSD | Yes |- | macOS | Yes |- | Linux | Yes |- | Windows | Yes |}
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

20
5.3/List-namespaces.md
View File

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

23
5.3/List-supported-devices.md
View File

@@ -1,8 +1,8 @@
==Command description== ==Command description== This operation will show all known attached devices on your system and if they are supported for
This operation will show all known attached devices on your system and if they are supported for device dependent operations. device dependent operations.
==Command usage== ==Command usage==
<code>Aaru device list [options] [<aaru-remote-host>]</code> <code>Aaru device list [options] [<aaru-remote-host>]</code>
==Arguments== ==Arguments==
<code><aaru-remote-host></code> aaruremote host<br /> <code><aaru-remote-host></code> aaruremote host<br />
@@ -13,19 +13,8 @@ This operation will show all known attached devices on your system and if they a
<code>--pause=[true/false]</code> pauses before exiting. ''(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 /> <code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Operating system support== ==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>
| FreeBSD |- | Linux | Yes |- | Windows | Yes |}
| 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/> <references/>

22
5.3/List-supported-encodings.md
View File

@@ -1,20 +1,8 @@
==Command description== ==Command description== This operation will list all your character set encodings supported in your environment. This
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. 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== ==Command usage==
<code>Aaru list-encodings</code> <code>Aaru list-encodings</code>
==Operating system support== ==Operating system support== {| | FreeBSD | Yes |- | macOS | Yes |- | Linux | Yes |- | Windows | Yes |}
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

21
5.3/List-supported-formats.md
View File

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

5
5.3/Media-dump-formats-supported-by-Aaru.md
View File

@@ -1,6 +1,8 @@
== Disk images that can be read only == == Disk images that can be read only ==
* Apple Disk Archival/Retrieval Tool<ref name="nocompress">Compressed images are not supported yet</ref> * 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 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 * Apple NIB
* BlindWrite 4 * BlindWrite 4
* BlindWrite 5 * BlindWrite 5
@@ -25,6 +27,7 @@
* Sydex TeleDisk * Sydex TeleDisk
== Disk images that can be read and written == == Disk images that can be read and written ==
* ACT Apricot Disk Image * ACT Apricot Disk Image
* Alcohol 120% Media Descriptor Structure * Alcohol 120% Media Descriptor Structure
* Anex86 Disk Image * Anex86 Disk Image

11
5.3/Media-tags.md
View File

@@ -1,6 +1,9 @@
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. 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 # Compact Disc media tags
* Table of contents (cooked by drive) * Table of contents (cooked by drive)
* Full table of contents (cooked by drive) * Full table of contents (cooked by drive)
* Session information * Session information
@@ -10,6 +13,7 @@ A media tag is data that accompany the media or the device, and is stored on the
* Media Catalogue Number * Media Catalogue Number
# DVD and HD DVD media tags # DVD and HD DVD media tags
* Physical Format Information * Physical Format Information
* Lead-in Copyright Management Information * Lead-in Copyright Management Information
* CSS Disc Key * CSS Disc Key
@@ -30,6 +34,7 @@ A media tag is data that accompany the media or the device, and is stored on the
* Pseudo-overwrite information * Pseudo-overwrite information
# Blu-ray media tags # Blu-ray media tags
* Disc Information * Disc Information
* Burst Cutting Area * Burst Cutting Area
* Disc Definition Structure * Disc Definition Structure
@@ -37,6 +42,7 @@ A media tag is data that accompany the media or the device, and is stored on the
* Spare Area Status * Spare Area Status
# AACS media tags for HD DVD and Blu-ray # AACS media tags for HD DVD and Blu-ray
* Volume identifier * Volume identifier
* Pre-recorded media serial number * Pre-recorded media serial number
* Media identifier * Media identifier
@@ -46,14 +52,17 @@ A media tag is data that accompany the media or the device, and is stored on the
* CPRM Media Key Block * CPRM Media Key Block
# Media tags defined by MMC specifications # Media tags defined by MMC specifications
* Recognized hybrid layers * Recognized hybrid layers
* Write protection status * Write protection status
* Disc standard information * Disc standard information
* Disc track resources information * Disc track resources information
# Device tags defined by SCSI specifications # Device tags defined by SCSI specifications
* Inquiry response * Inquiry response
# Device tags defined by ATA/ATAPI specifications # Device tags defined by ATA/ATAPI specifications
* Ata Identify response * Ata Identify response
* Atapi Identify response * Atapi Identify response

19
5.3/README.md
View File

@@ -1,28 +1,34 @@
Welcome to the Aaru wiki. 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. 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?''' '''What do you want to do?'''
* [[Configure-Aaru-statistics|Set which information will Aaru send to you]] * [[Configure-Aaru-statistics|Set which information will Aaru send to you]]
* [[List-supported-formats|Get a list of all formats supported]] * [[List-supported-formats|Get a list of all formats supported]]
* [[List-supported-encodings|Get a list of all supported character set encodings]] * [[List-supported-encodings|Get a list of all supported character set encodings]]
* [[List-namespaces|Lists all namespaces supported by read-only filesystems.]] * [[List-namespaces|Lists all namespaces supported by read-only filesystems.]]
Database commands: Database commands:
* [[Show-statistics|See my own usage statistics]] * [[Show-statistics|See my own usage statistics]]
* [[Update-database|Update the main Aaru database]] * [[Update-database|Update the main Aaru database]]
Device commands: Device commands:
* [[Getting-information-from-a-physical-device|Get information from a physical device]] * [[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]] * [[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]] * [[List-supported-devices|Get a list of all supported physical devices]]
Filesystem commands: Filesystem commands:
* [[Show-information-about-the-partitions-and-filesystems-in-a-media-dump|Show information about the partitions and filesystems in a media dump|]] * [[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]] * [[Extracting-files-from-a-media-dump|Extract all files contained in a media dump]]
* [[List-files|List all files contained in a media dump]] * [[List-files|List all files contained in a media dump]]
Image commands: Image commands:
* [[Getting-hashes-and-checksums-from-a-media-dump|Get checksums or hashes from a dump]] * [[Getting-hashes-and-checksums-from-a-media-dump|Get checksums or hashes from a dump]]
* [[Comparing-two-media-dumps|Compare two media dumps]] * [[Comparing-two-media-dumps|Compare two media dumps]]
* [[Convert-image|Convert a media dump from one format to another]] * [[Convert-image|Convert a media dump from one format to another]]
@@ -32,13 +38,14 @@ Image commands:
* [[Verifying-media-dump-integrity|Verify integrity of a media dump or its contents]] * [[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]] * [[Creating-a-dump-from-physical-media|Calculate entropy of a media dump]]
Media commands: Media commands:
* [[Creating a dump from physical media|Create a media dump from a physical device]] * [[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]] * [[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]] * [[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?''' '''What is supported by Aaru?'''
* [[Supported filters|Filters]] * [[Supported filters|Filters]]
* [[Media dump formats supported by Aaru|Media dump formats]] * [[Media dump formats supported by Aaru|Media dump formats]]
* [[Partitioning schemes recognized by Aaru|Partitioning schemes]] * [[Partitioning schemes recognized by Aaru|Partitioning schemes]]

75
5.3/Reporting-physical-device-capabilities.md
View File

@@ -1,5 +1,6 @@
==Command description== ==Command description== This operation will test a physical device for its read capabilities. If the media is removable,
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 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== ==Command usage==
<code>Aaru device report [options] <device-path></code> <code>Aaru device report [options] <device-path></code>
@@ -14,72 +15,34 @@ This operation will test a physical device for its read capabilities. If the med
<code>--pause=[true/false]</code> pauses before exiting. ''(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 /> <code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Example== ==Example== FreeBSD: <code>Aaru device report /dev/cd0</code><br />
FreeBSD: <code>Aaru device report /dev/cd0</code><br />
Linux: <code>Aaru device-report /dev/sdb</code><br /> Linux: <code>Aaru device-report /dev/sdb</code><br />
Windows: <code>Aaru device-report \\.\PhysicalDrive3</code><br /> Windows: <code>Aaru device-report \\.\PhysicalDrive3</code><br />
==Operating system support== ==Operating system support== {|
{|
! Device type ! Device type
! FreeBSD ! FreeBSD
! macOS ! macOS
! Linux ! Linux
! Windows ! Windows |- | SCSI Block device | Yes | No <ref name="macOS permissions">macOS only allows talking with MultiMedia
|- devices</ref>
| SCSI Block device | Yes | Yes |- | SCSI MultiMedia device | Yes | Not yet <ref name="macOS users">Support for MultiMedia devices in macOS
| Yes will be added if users require it</ref>
| No <ref name="macOS permissions">macOS only allows talking with MultiMedia devices</ref> | Yes | Yes |- | SCSI Streaming device | Yes | No <ref name="macOS permissions"/>
| Yes | Yes | Yes |- | Parallel ATA | No <ref name="FreeBSD bug">Not supported due to upstream bug</ref>
| 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"/> | No <ref name="macOS permissions"/>
| Yes | Yes | Yes |- | Serial ATA | Yes | No <ref name="macOS permissions"/>
| Yes | Yes | Yes |- | USB | Partial <ref name="usb">USB descriptors are not retrieved</ref>
|-
| 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> | Partial <ref name="macOS">Only MultiMedia devices can be supported and descriptors will not be retrieved</ref>
| Yes | Yes | Yes |- | FireWire | Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Yes
|-
| FireWire
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Partial <ref name="macOS"/> | Partial <ref name="macOS"/>
| Yes | Yes | Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref> |- | PCMCIA | Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
|-
| PCMCIA
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
| Partial <ref name="macOS"/> | Partial <ref name="macOS"/>
| Yes | Yes | Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
| 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>
|-
| SecureDigital / MultiMediaCard
| Not yet <ref name="FreeBSD sd">Support will come with FreeBSD 12-RELEASE</ref>
| No <ref name="macOS permissions"/> | No <ref name="macOS permissions"/>
| Yes | Yes | Untested <ref name="Windows sd">Should work, untested due to not available hardware</ref>
| Untested <ref name="Windows sd">Should work, untested due to not available hardware</ref>
|} |}
<references/> <references/>

7
5.3/Sector-Tags.md
View File

@@ -1,9 +1,13 @@
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... 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 # Floppy disk sector tags
* Apple GCR sector tags * Apple GCR sector tags
# Compact Disc sector tags # Compact Disc sector tags
* Data sector sync frame * Data sector sync frame
* Data sector header * Data sector header
* Mode 2 data sector subheader * Mode 2 data sector subheader
@@ -16,4 +20,5 @@ A sector tag is data that accompany the sector, but it's not part of the data wr
* Track flags * Track flags
# DVD sector tags # DVD sector tags
* Copyright information * Copyright information

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

@@ -1,5 +1,6 @@
==Command description== ==Command description== This command will analyze a media dump, and if the format is recognized and you choose so, it
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. 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== ==Command usage==
<code>Aaru filesystem info [options] <image-path></code> <code>Aaru filesystem info [options] <image-path></code>
@@ -8,7 +9,8 @@ This command will analyze a media dump, and if the format is recognized and you
<code><image-path></code> Media image path<br /> <code><image-path></code> Media image path<br />
==Options== ==Options==
<code>-e, --encoding=[encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br /> <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>-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>-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>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
@@ -19,17 +21,4 @@ This command will analyze a media dump, and if the format is recognized and you
==Example== ==Example==
<code>Aaru filesystem info mydisc.cue</code> <code>Aaru filesystem info mydisc.cue</code>
==Operating system support== ==Operating system support== {| | FreeBSD | Yes |- | macOS | Yes |- | Linux | Yes |- | Windows | Yes |}
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

20
5.3/Show-statistics.md
View File

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

67
5.3/Supported-devices.md
View File

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

20
5.3/Update-database.md
View File

@@ -1,8 +1,7 @@
==Command description== ==Command description== Updates the main Aaru database.
Updates the main Aaru database.
==Command usage== ==Command usage==
<code>Aaru database update [options]</code> <code>Aaru database update [options]</code>
==Options== ==Options==
<code>--clear</code> clear existing main database ''(default false)''<br /> <code>--clear</code> clear existing main database ''(default false)''<br />
@@ -12,17 +11,4 @@ Updates the main Aaru database.
<code>--pause=[true/false]</code> pauses before exiting. ''(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 /> <code>-?, -h, --help=[true/false]</code> show help and usage information ''(default false)''<br />
==Operating system support== ==Operating system support== {| | FreeBSD | Yes |- | macOS | Yes |- | Linux | Yes |- | Windows | Yes |}
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

28
5.3/Verifying-media-dump-integrity.md
View File

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

4
docs/Changelog.md
View File

@@ -838,8 +838,8 @@
# [5.0.0.2879] - 2020-03-15 # [5.0.0.2879] - 2020-03-15
- First and most importantly, we got a rename. We're now Aaru, part of the Aaru Data Preservation Suite, that - First and most importantly, we got a rename. We're now Aaru, part of the Aaru Data Preservation Suite, that
encompasses Aaru (previously Aaru), Aaru.Server (previously Aaru.Server), aaruformat (previously encompasses Aaru (previously Aaru), Aaru.Server (previously Aaru.Server), aaruformat (previously dicformat) and
dicformat) and aaruremote. aaruremote.
- This release is dedicated to the loving memory of Facunda "Tata" Suárez Domínguez, R.I.P. 2019/07/24. - This release is dedicated to the loving memory of Facunda "Tata" Suárez Domínguez, R.I.P. 2019/07/24.
## Added ## Added