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

Merge pull request #3 from Senn1/master

Browse Source 
add in .md files
This commit is contained in:
Natalia Portillo
2020-03-06 22:00:09 +00:00
committed by GitHub
parent de5b826f2c 02f391718a
commit 4221110ca6
32 changed files with 727 additions and 930 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
5.0/Calculate-dump-contents-entropy.md Normal file
View File

@@ -0,0 +1,39 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
This operation will calculate uniqueness and entropy of the media represented by a media dump image. It's not affected by the image format compression if applicable.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image entropy -h [true/false] -p [true/false] -t [true/false] -w [true/false] <image-path>
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-p, --duplicated-sectors [true/false]` besides entropy also calculates how many sectors have the exact same data in their user area *(default true)*
`-t, --separated-tracks true/false]` 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)*
`-w, --whole-disc [true/false]` calculates the entropy for the whole media *(default true)*
## Example
```bash
Aaru image entropy mydisc.cue
```
## Operating system support
| OS | Supported |
|----|-----------|
| FreeBSD | Yes |
| macOS | Yes |
| Linux | Yes |
| Windows | Yes |

30
5.0/Calculate-dump-contents-entropy.mediawiki
View File

@@ -1,30 +0,0 @@
==Command description==
This operation will calculate uniqueness and entropy of the media represented by a media dump image. It's not affected by the image format compression if applicable.
==Command usage==
<code>Aaru -d [true/false] -v [true/false] image entropy -h [true/false] -p [true/false] -t [true/false] -w [true/false] <image-path></code>
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<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>-w, --whole-disc [true/false]</code> calculates the entropy for the whole media ''(default true)''
==Example==
<code>Aaru image entropy mydisc.cue</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

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

@@ -0,0 +1,54 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## 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
```bash
Aaru -d [true/false] -v [true/false] media scan -h [true/false] -b [ibglog] -m [mhddlog] <device-path/aaru-remote-host>
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-b, --ibg-log [ibglog]` writes a log in the format used by ImgBurn
`-m, --mhdd-log [mhddlog]` writes a log in the format used by MHDD
`<aaru-remote-host>` connects to an Aaru Remote Host with aaru:///
## Example
FreeBSD: `Aaru media scan /dev/cd0`
Linux: `Aaru media scan /dev/sdb`
Windows: `Aaru media scan \\.\PhysicalDrive3`
## Operating system support
| Device Type | FreeBSD | MacOS | Linux | Windows |
|--------------|----------|--------|--------|----------|
| SCSI Block device | Yes | No¹ | Yes | Yes |
| SCSI MultiMedia device | Yes | Not yet² | Yes | Yes |
| SCSI Streaming device | Yes | No¹ | Yes | Yes |
| Parallel ATA | No³ | No¹ | Yes | Yes |
| Serial ATA | Yes | No¹ | Yes | Yes |
| USB | Partial⁴ | Partial⁵ | Yes | Yes |
| FireWire | Partial⁶ | Partial⁵ | Yes | Partial⁶ |
| PCMCIA | Partial⁷ | Partial⁵ | Yes | Partial⁷ |
| SecureDigital / MultiMediaCard | Not yet⁸ | No¹ | Yes | Untested⁹ |
1. macOS only allows talking with MultiMedia devices.
2. Support for MultiMedia devices in macOS will be added if users require it
3. Not supported due to upstream bug
4. USB descriptors are not retrieved
5. Only MultiMedia devices can be supported and descriptors will not be retrieved
6. FireWire descriptors are not retrieved
7. PCMCIA CIS is not retrieved
8. Support will come with FreeBSD 12-RELEASE
9. Should work, untested due to not available hardware

82
5.0/Check-readability-of-the-media-inserted-in-a-physical-device.mediawiki
View File

@@ -1,82 +0,0 @@
==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>Aaru -d [true/false] -v [true/false] media scan -h [true/false] -b [ibglog] -m [mhddlog] <device-path/aaru-remote-host></code>
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
<code>-b, --ibg-log [ibglog]</code> writes a log in the format used by ImgBurn<br />
<code>-m, --mhdd-log [mhddlog]</code> writes a log in the format used by MHDD<br />
<code><aaru-remote-host></code> connects to an Aaru Remote Host with aaru://<IP ADDRESS>/<DEVICE PATH><br />
==Example==
FreeBSD: <code>Aaru media scan /dev/cd0</code><br />
Linux: <code>Aaru media scan /dev/sdb</code><br />
Windows: <code>Aaru media scan \\.\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/>

36
5.0/Comparing-two-media-dumps.md Normal file
View File

@@ -0,0 +1,36 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
This operation will compare two media dumps and print all differences between them. Dumps can be in different formats.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image compare -h [true/false] <image-path1> <image-path2>
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
## Example
```bash
Aaru image compare mydisc.cue anotherdisc.mds
```
## Operating system support
| OS | Supported |
|----|-----------|
| FreeBSD | Yes |
| macOS | Yes |
| Linux | Yes |
| Windows | Yes |

27
5.0/Comparing-two-media-dumps.mediawiki
View File

@@ -1,27 +0,0 @@
==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 -d [true/false] -v [true/false] image compare -h [true/false] <image-path1> <image-path2></code>
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
==Example==
<code>Aaru image compare mydisc.cue anotherdisc.mds</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

73
5.0/Comparison.md Normal file
View File

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

214
5.0/Comparison.mediawiki
View File

@@ -1,214 +0,0 @@
In this page you can find a comparison between Aaru and other dump image managers or creators.
==Comparison of optical discs image managers==
{|
!
! Aaru
! DiscImageCreator
! CDRWin
! CloneCD
! Alcohol 120%
! IsoBuster
! WinImage
|-
| Opensource
| Yes
| [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]
| 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>

36
5.0/Configure-Aaru-statistics.md Normal file
View File

@@ -0,0 +1,36 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## 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 [https://www.aaru.app](https://www.aaru.app)
## Command usage
```bash
Aaru -d [true/false] -v [true/false] configure -h [true/false]
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
## Example
```bash
Aaru configure
```
## Operating system support
| OS | Supported |
|----|-----------|
| FreeBSD | Yes |
| macOS | Yes |
| Linux | Yes |
| Windows | Yes |

27
5.0/Configure-Aaru-statistics.mediawiki
View File

@@ -1,27 +0,0 @@
==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 https://www.aaru.app
==Command usage==
<code>Aaru -d [true/false] -v [true/false] configure -h [true/false]</code>
<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>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
==Example==
<code>Aaru configure</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

47
5.0/Convert-image.md Normal file
View File

@@ -0,0 +1,47 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
## Command Description
This operation will convert a dump from one image format to another.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image convert -h [true/false] -c <count> --comments <comments> --creator <creator> --drive-manufacturer manufacturer> --drive-model <model> --drive-revision <revision> --drive-serial <serial> -f [true/false] --media-barcode <barcode> --media-lastsequence <number> --media-manufacturer <manufacturer> --media-model <model> --media-partnumber <partnumber> --media-sequence <sequence> --media-serial <serial> --media-title <title> -O <options> -p <format> -r <resume file> -x <xml sidecar> <input-path> <output-path>
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-c, --count <count>` specifies how many sectors to convert at once *(default 64)*
`--comments <comments>` specifies image comments
`--creator <creator>` specifies who (person) created the image?
`--drive-manufacturer manufacturer>` specifies manufacturer of the drive used to read the media represented by the image
`--drive-model <model>` specifies model of the drive used to read the media represented by the image
`--drive-revision <revision>` specifies firmware revision of the drive used to read the media represented by the image
`--drive-serial serial>` specifies serial number of the drive used to read the media represented by the image
`-f, --force true/false]` continues conversion even if sector or media tags will be lost in the process *(default false)*
`--media-barcode <barcode>` specifies barcode of the media represented by the image
`--media-lastsequence <number>` specifies last media of the sequence the media represented by the image corresponds to *(default 0)*
`--media-manufacturer manufacturer>` specifies manufacturer of the media represented by the image
`--media-model <model>` specifies model of the media represented by the image
`--media-partnumber <partnumber>` specifies part number of the media represented by the image
`--media-sequence <sequence>` specifies number in sequence for the media represented by the image *(default 0)*
`--media-serial <serial>` specifies serial number of the media represented by the image
`--media-title <title>` specifies title of the media represented by the image
`-O, --options <options>` specifies comma separated name=value pairs of options to pass to output image plugin
`-p, --format <format>` specifies format of the output image, as plugin name or plugin id. If not present, will try to detect it from output image extension
`-r, --resume-file <resume file>` takes list of dump hardware from existing resume file
`-x, --cicm-xml <xml sidecar>` takes metadata from existing CICM XML sidecar
## Example
```bash
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.dicf
```

32
5.0/Convert-image.mediawiki
View File

@@ -1,32 +0,0 @@
==Command description==
This operation will convert a dump from one image format to another.
==Command usage==
<code>Aaru -d [true/false] -v [true/false] image convert -h [true/false] -c <count> --comments <comments> --creator <creator> --drive-manufacturer manufacturer> --drive-model <model> --drive-revision <revision> --drive-serial <serial> -f [true/false] --media-barcode <barcode> --media-lastsequence <number> --media-manufacturer <manufacturer> --media-model <model> --media-partnumber <partnumber> --media-sequence <sequence> --media-serial <serial> --media-title <title> -O <options> -p <format> -r <resume file> -x <xml sidecar> <input-path> <output-path></code>
<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>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
<code>-c, --count <count></code> specifies how many sectors to convert at once ''(default 64)''<br />
<code>--comments <comments></code> specifies image comments<br />
<code>--creator <creator></code> specifies who (person) created the image?<br />
<code>--drive-manufacturer manufacturer></code> specifies manufacturer of the drive used to read the media represented by the image<br />
<code>--drive-model <model></code> specifies model of the drive used to read the media represented by the image<br />
<code>--drive-revision <revision></code> specifies firmware revision of the drive used to read the media represented by the image<br />
<code>--drive-serial serial></code> specifies serial number of the drive used to read the media represented by the image<br />
<code>-f, --force true/false]</code> continues conversion even if sector or media tags will be lost in the process ''(default false)''<br />
<code>--media-barcode <barcode></code> specifies barcode of the media represented by the image<br />
<code>--media-lastsequence <number></code> specifies last media of the sequence the media represented by the image corresponds to ''(default 0)''<br />
<code>--media-manufacturer manufacturer></code> specifies manufacturer of the media represented by the image<br />
<code>--media-model <model></code> specifies model of the media represented by the image<br />
<code>--media-partnumber <partnumber></code> specifies part number of the media represented by the image<br />
<code>--media-sequence <sequence></code> specifies number in sequence for the media represented by the image ''(default 0)''<br />
<code>--media-serial <serial></code> specifies serial number of the media represented by the image<br />
<code>--media-title <title></code> specifies title of the media represented by the image<br />
<code>-O, --options <options></code> specifies comma separated name=value pairs of options to pass to output image plugin<br />
<code>-p, --format <format></code> specifies 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>-r, --resume-file <resume file></code> takes list of dump hardware from existing resume file<br />
<code>-x, --cicm-xml <xml sidecar></code> takes metadata from existing CICM XML sidecar<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.dicf</code>

68
5.0/Creating-a-dump-from-physical-media.md Normal file
View File

@@ -0,0 +1,68 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
This operation will create a media dump from real media using a physical device. It will retry errors and when finished create an XML metadata sidecar. The dumping operation can be interrupted and continued later, even with a different device.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] media dump -h [true/false] -e <encoding> -f [true/false] -k <sectors> --first-pregap [true/false] --fix-offset [true/false] -m [true/false] --metadata [true/false] --trim [true/false] -O <options> --persistent [true/false] -p <passes> -s [true/false] -t <plugin> -x <xml sidecar> --subchannel <subchannel> --speed <speed> <device-path/aaru-remote-host> <output-path>
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-e, --encoding <encoding>` specifies character encoding to use when creating dump sidecar
`-f, --force [true/false]` continues dumping whatever happens *(default false)*
`-k, --skip <sectors>` skips this many sectors when an unreadable sector is found *(default 512)*
`--first-pregap [true/false]` tries to dump first track pregap. Only applicable to CD, DDCD or GD media *(default false)*
`--fix-offset [true/false]` fixes audio tracks offset. Only applicable to CD or GD media. *(default false)*
`-m, --resume [true/false]` creates and/or use resume mapfile *(default true)*
`--metadata [true/false]` enables creating CICM XML sidecar *(default true)*
`--trim [true/false]` enables trimming errores from skipped sectors *(default true)*
`-O, --options <options>` specifies comma separated name=value pairs of options to pass to output image plugin
`--persistent [true/false]` tries to recover partial or incorrect data *(default false)*
`-p, --retry-passes <passes>` specifies how many times to retry reading a sector *(default 5)*
`-s, --stop-on-error [true/false]` stops dumping on first error *(default false)*
`-t, --format <plugin>` specifies format for the output image, as plugin name or plugin id. If not present, will try to detect it from output image extension
`-x, --cicm-xml <xml sidecar>` takes metadata from existing CICM XML sidecar
`--subchannel <subchannel>` specifies which subchannel to dump. Only applicable to CD/GD. Values: any, rw, rw-or-pq, pq, none *(default any)*
`--speed <speed>` specifies at what speed to dump. Only applicable to optical drives, 0 for maximum *(default 0)*
`<aaru-remote-host>` connects to an Aaru Remote Host with aaru:///
## Example
FreeBSD: `Aaru media dump -f --persistent true --separate-subchannel /dev/cd0 mydisc.cue`
Linux: `Aaru media dump -r -f -p 15 /dev/sdb myusbfloppy.img`
Windows: `Aaru media dump -f -p 0 --resume false \\.\PhysicalDrive3 mydisk.dicf`
## Operating system support
| Device Type | FreeBSD | MacOS | Linux | Windows |
|--------------|----------|--------|--------|----------|
| SCSI Block device | Yes | No¹ | Yes | Yes |
| SCSI MultiMedia device | Yes | Not yet² | Yes | Yes |
| SCSI Streaming device | Yes | No¹ | Yes | Yes |
| Parallel ATA | No³ | No¹ | Yes | Yes |
| Serial ATA | Yes | No¹ | Yes | Yes |
| USB | Partial⁴ | Partial⁵ | Yes | Yes |
| FireWire | Partial⁶ | Partial⁵ | Yes | Partial⁶ |
| PCMCIA | Partial⁷ | Partial⁵ | Yes | Partial⁷ |
| SecureDigital / MultiMediaCard | Not yet⁸ | No¹ | Yes | Untested⁹ |
1. macOS only allows talking with MultiMedia devices.
2. Support for MultiMedia devices in macOS will be added if users require it
3. Not supported due to upstream bug
4. USB descriptors are not retrieved
5. Only MultiMedia devices can be supported and descriptors will not be retrieved
6. FireWire descriptors are not retrieved
7. PCMCIA CIS is not retrieved
8. Support will come with FreeBSD 12-RELEASE
9. Should work, untested due to not available hardware

96
5.0/Creating-a-dump-from-physical-media.mediawiki
View File

@@ -1,96 +0,0 @@
==Command description==
This operation will create a media dump from real media using a physical device. It will retry errors and when finished create an XML metadata sidecar. The dumping operation can be interrupted and continued later, even with a different device.
==Command usage==
<code>Aaru -d [true/false] -v [true/false] media dump -h [true/false] -e <encoding> -f [true/false] -k <sectors> --first-pregap [true/false] --fix-offset [true/false] -m [true/false] --metadata [true/false] --trim [true/false] -O <options> --persistent [true/false] -p <passes> -s [true/false] -t <plugin> -x <xml sidecar> --subchannel <subchannel> --speed <speed> <device-path/aaru-remote-host> <output-path></code>
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
<code>-e, --encoding <encoding></code> specifies character encoding to use when creating dump sidecar<br />
<code>-f, --force [true/false]</code> continues dumping whatever happens ''(default false)''<br />
<code>-k, --skip <sectors></code> skips this many sectors when an unreadable sector is found ''(default 512)''<br />
<code>--first-pregap [true/false]</code> tries to dump first track pregap. Only applicable to CD, DDCD or GD media ''(default false)''<br />
<code>--fix-offset [true/false]</code> fixes audio tracks offset. Only applicable to CD or GD media. ''(default false)''<br />
<code>-m, --resume [true/false]</code> creates and/or use resume mapfile ''(default true)''<br />
<code>--metadata [true/false]</code> enables creating CICM XML sidecar ''(default true)''<br />
<code>--trim [true/false]</code> enables trimming errores from skipped sectors ''(default true)''<br />
<code>-O, --options <options></code> specifies comma separated name=value pairs of options to pass to output image plugin<br />
<code>--persistent [true/false]</code> tries to recover partial or incorrect data ''(default false)''<br />
<code>-p, --retry-passes <passes></code> specifies 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> specifies 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>-x, --cicm-xml <xml sidecar></code> takes metadata from existing CICM XML sidecar<br />
<code>--subchannel <subchannel></code> specifies which subchannel to dump. Only applicable to CD/GD. Values: any, rw, rw-or-pq, pq, none ''(default any)''<br />
<code>--speed <speed></code> specifies at what speed to dump. Only applicable to optical drives, 0 for maximum ''(default 0)''<br />
<code><aaru-remote-host></code> connects to an Aaru Remote Host with aaru://<IP ADDRESS>/<DEVICE PATH><br />
==Example==
FreeBSD: <code>Aaru media dump -f --persistent true --separate-subchannel /dev/cd0 mydisc.cue</code><br />
Linux: <code>Aaru media dump -r -f -p 15 /dev/sdb myusbfloppy.img</code><br />
Windows: <code>Aaru media dump -f -p 0 --resume false \\.\PhysicalDrive3 mydisk.dicf</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/>

41
5.0/Creating-metadata-sidecar-XML.md Normal file
View File

@@ -0,0 +1,41 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## 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 gotten about it, as well as all [supported checksum algorithms.](https://github.com/aaru-dps/Aaru.Documentation/blob/master/5.0/Supported-checksums.md)
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image create-sidecar -h [true/false] -b [block size] -e [encoding] -t tape [true/false] <image-path>
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-b, --block-size [block size]` used only for tapes, indicates fixed block size in bytes. File in dump folder not multiple of this value will be ignored *(default 512)*
`-e, --encoding [encoding]` sets which encoding is used by the contents of the media dump *(default varies by filesystem)*
`-t, --tape [true/false]` 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)*
## Example
```bash
Aaru image create-sidecar mydisc.cue
Aaru image create-sidecar -t -b 1024 mytapedir
Aaru image create-sidecar -e shift_jis "My japanese software.img"
```
## Operating system support
| OS | Supported |
|----|-----------|
| FreeBSD | Yes |
| macOS | Yes |
| Linux | Yes |
| Windows | Yes |

32
5.0/Creating-metadata-sidecar-XML.mediawiki
View File

@@ -1,32 +0,0 @@
==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 gotten about it, as well as all [[Supported-checksums.md|supported checksum algorithms]].
==Command usage==
<code>Aaru -d [true/false] -v [true/false] image create-sidecar -h [true/false] -b [block size] -e [encoding] -t tape [true/false] <image-path></code>
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<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>-e, --encoding [encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<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 />
==Examples==
<code>Aaru image create-sidecar mydisc.cue</code><br />
<code>Aaru image create-sidecar -t -b 1024 mytapedir</code><br />
<code>Aaru image create-sidecar -e shift_jis "My japanese software.img"</code><br />
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

40
5.0/Decoding-and-printing-media-tags.md Normal file
View File

@@ -0,0 +1,40 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
This operation will decode all [sector tags](https://github.com/aaru-dps/Aaru.Documentation/blob/master/5.0/Sector-tags.md) and [media tags](https://github.com/aaru-dps/Aaru.Documentation/blob/master/5.0/Media-tags.md) on a media dump image.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image decode -h [true/false] -f [true/false] -l [sectors] -p [true/false] -s [start sector] <image-path>
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-f, --disk-tags [true/false]` decodes all media tags *(default true)*
`-l, --length [sectors]` how many sectors to decode or all to decode all *(default all)*
`-p, --sector-tags [true/false]` decodes all sector tags *(default true)*
`-s, --start [start-sector]` starting sector *(default 0)*
## Example
```bash
Aaru image decode -s 1000 -l 15 -p false mydisc.cue
```
## Operating system support
| OS | Supported |
|----|-----------|
| FreeBSD | Yes |
| macOS | Yes |
| Linux | Yes |
| Windows | Yes |

31
5.0/Decoding-and-printing-media-tags.mediawiki
View File

@@ -1,31 +0,0 @@
==Command description==
This operation will decode all [[Sector-tags.md|sector tags]] and [[Media-tags.md|media tags]] on a media dump image.
==Command usage==
<code>Aaru -d [true/false] -v [true/false] image decode -h [true/false] -f [true/false] -l [sectors] -p [true/false] -s [start sector] <image-path></code>
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
<code>-f, --disk-tags [true/false]</code> decodes all [[Media-tags.md|media tags]] ''(default true)''<br />
<code>-l, --length [sectors]</code> how many sectors to decode or ''all'' to decode all ''(default all)''<br />
<code>-p, --sector-tags [true/false]</code> decodes all [[Sector-tags.md|sector tags]] ''(default true)''<br />
<code>-s, --start [start-sector]</code> starting sector ''(default 0)''<br />
==Example==
<code>Aaru image decode -s 1000 -l 15 -p false mydisc.cue</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

39
5.0/Extracting-files-from-a-media-dump.md Normal file
View File

@@ -0,0 +1,39 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
This operation will analyze and find all filesystems in a media dump and extract the files that are contained in [supported filesystems.](https://github.com/aaru-dps/Aaru.Documentation/blob/master/5.0/Filesystems-recognized-by-Aaru.md)
## Command usage
```bash
Aaru -d [true/false] -v [true/false] filesystem extract -h [true/false] -e [encoding] -O <options> -x [true/false] -n <namespace>
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-e, --encoding [encoding]` sets which encoding is used by the contents of the media dump *(default varies by filesystem)*
`-O, --options <options>` specifies comma separated name=value pairs of options to pass to output filesystem plugin
`-x, --xattrs [true/false]` extracts extended attributes if present *(default false)*
`-n, --namespace <namespace>` specifies namespace to use for filenames
## Example
```bash
Aaru extract-files -x -e iso8859-15 mydisc.cue contents
```
## Operating system support
| OS | Supported |
|----|-----------|
| FreeBSD | Yes |
| macOS | Yes |
| Linux | Yes |
| Windows | Yes |

31
5.0/Extracting-files-from-a-media-dump.mediawiki
View File

@@ -1,31 +0,0 @@
==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.md|supported filesystems]].
==Command usage==
<code>Aaru -d [true/false] -v [true/false] filesystem extract -h [true/false] -e [encoding] -O <options> -x [true/false] -n <namespace></code>
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(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>-O, --options <options></code> specifies comma separated name=value pairs of options to pass to output filesystem plugin<br />
<code>-x, --xattrs [true/false]</code> extracts extended attributes if present ''(default false)''<br />
<code>-n, --namespace <namespace></code> specifies namespace to use for filenames<br />
==Example==
<code>Aaru extract-files -x -e iso8859-15 mydisc.cue contents</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

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

@@ -0,0 +1,40 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
This operation will print a hexadecimal dump in the console of the chosen sector/block of the indicated media dump image.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image print -h [true/false] -l [sectors] -r [true/false] -s <starting sector> -w [width] <image-path>
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-l, --length [sectors]` specifies how many sectors to print *(default 1)*
`-r, --long-sectors [true/false]` specifies if hex print should include all sector tags stored in the media dump *(default false)*
`-s, --start <starting sector>` starts the hexadecimal printing from this sector
`-w, --width [width]` specifies how long the width, in characters, should the print be before creating a new line *(default 32)*
## Example
```bash
Aaru image print -s 15 -l 30 -r -w 64 mydisc.cue
```
## Operating system support
| OS | Supported |
|----|-----------|
| FreeBSD | Yes |
| macOS | Yes |
| Linux | Yes |
| Windows | Yes |

31
5.0/Get-a-hexadecimal-print-of-a-media-dump-sector-or-block.mediawiki
View File

@@ -1,31 +0,0 @@
==Command description==
This operation will print a hexadecimal dump in the console of the chosen sector/block of the indicated media dump image.
==Command usage==
<code>Aaru -d [true/false] -v [true/false] image print -h [true/false] -l [sectors] -r [true/false] -s <starting sector> -w [width] <image-path></code>
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
<code>-l, --length [sectors]</code> specifies how many sectors to print ''(default 1)''<br />
<code>-r, --long-sectors [true/false]</code> specifies if hex print should include all [[Sector-tags.md|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>-w, --width [width]</code> specifies how long the width, in characters, should the print be before creating a new line ''(default 32)''
==Example==
<code>Aaru image print -s 15 -l 30 -r -w 64 mydisc.cue</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

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

@@ -0,0 +1,51 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
This operation will calculate the checksums for the media represented by a media dump image.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image checksum -h [true/false] -a [true/false] --crc16 [true/false] -c [true/false] --crc64 [true/false] -f [true/false] --fletcher16 [true/false] --fletcher32 [true/false] -m [true/false] --ripemd160 [true/false] -s [true/false] --sha256 [true/false] --sha384 [true/false] --sha512 [true/false] -t [true/false] -w [true/false] <image-path>
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-a, --adler32 [true/false]` calculates the Adler-32 checksum *(default true)*
`--crc16 [true/false]` calculates the CRC16 checksum *(default true)*
`-c, --crc32 [true/false]` calculates the CRC32 checksum *(default true)*
`--crc64 [true/false]` calculates the ECMA CRC64 checksum *(default false)*
`-f, --spamsum [true/false]` calculates the SpamSum fuzzy hash *(default true)*
`--fletcher16 [true/false]` calculates the Fletcher-16 checksum *(default false)*
`--fletcher32 [true/false]` calculates the Fletcher-32 checksum *(default false)*
`-m, --md5 [true/false]` calculates the MD5 hash *(default true)*
`--ripemd160 [true/false]` calculates the RIPEMD160 hash *(default false)*
`-s, --sha1 [true/false]` calculates the SHA1 hash *(default true)*
`--sha256 [true/false]` calculates the SHA2 hash with 256-bit *(default false)*
`--sha384 [†rue/false]` calculates the SHA2 hash with 384-bit *(default false)*
`--sha512 [true/false]` calculates the SHA2 hash with 512-bit *(default false)*
`-t, --separated-tracks [true/false]` calculates each track checksum separately *(default true)*
`-w, --whole-discs [true/false]` calculates the whole media checksum *(default true)*
## Example
```bash
Aaru image checksum -a false --sha512 true mydisc.cue
```
## Operating system support
| OS | Supported |
|----|-----------|
| FreeBSD | Yes |
| macOS | Yes |
| Linux | Yes |
| Windows | Yes |

42
5.0/Getting-hashes-and-checksums-from-a-media-dump.mediawiki
View File

@@ -1,42 +0,0 @@
==Command description==
This operation will calculate the checksums for the media represented by a media dump image.
==Command usage==
<code>Aaru -d [true/false] -v [true/false] image checksum -h [true/false] -a [true/false] --crc16 [true/false] -c [true/false] --crc64 [true/false] -f [true/false] --fletcher16 [true/false] --fletcher32 [true/false] -m [true/false] --ripemd160 [true/false] -s [true/false] --sha256 [true/false] --sha384 [true/false] --sha512 [true/false] -t [true/false] -w [true/false] <image-path></code>
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
<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>-f, --spamsum [true/false]</code> calculates the SpamSum fuzzy hash ''(default true)''
<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>--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>-t, --separated-tracks [true/false]</code> calculates each track checksum separately ''(default true)''<br />
<code>-w, --whole-discs [true/false]</code> calculates the whole media checksum ''(default true)''<br />
==Example==
<code>Aaru image checksum -a false --sha512 true mydisc.cue</code>
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

36
5.0/Getting-information-from-a-media-dump.md Normal file
View File

@@ -0,0 +1,36 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
This operation will request and show all information about the selected media dump.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image info -h [true/false] <image-path>
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
## Example
```bash
Aaru image info mydisc.cue
```
## Operating system support
| OS | Supported |
|----|-----------|
| FreeBSD | Yes |
| macOS | Yes |
| Linux | Yes |
| Windows | Yes |

27
5.0/Getting-information-from-a-media-dump.mediawiki
View File

@@ -1,27 +0,0 @@
==Command description==
This operation will request and show all information about the selected media dump.
==Command usage==
<code>Aaru -d [true/false] -v [true/false] image info -h [true/false] <image-path></code>
<code>-d, --debug [true/false]</code> shows debug output ''(default false'')<br />
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false'')<br />
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
==Example==
<code>Aaru image info mydisc.cue</code><br />
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}

54
5.0/Getting-information-from-a-physical-device.md Normal file
View File

@@ -0,0 +1,54 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
This operation will request and show all information about a physical device. For information about supported physical devices check [the list of supported physical devices.](https://github.com/Senn1/Aaru.Documentation/blob/master/5.0/Supported-devices.md)
## Command usage
```bash
Aaru -d [true/false] -v [true/false] device info -h [true/false] -w [prefix] <device-path/aaru-remote-host>
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-w, --output-prefix [prefix]` writes binary responses from device to that prefix
`<aaru-remote-host>` connects to an Aaru Remote Host with aaru:///
## Example
FreeBSD: `Aaru device info /dev/cd0`
Linux: `Aaru device info /dev/sda`
Windows: `Aaru device info D:`
## Operating system support
| Device Type | FreeBSD | MacOS | Linux | Windows |
|--------------|----------|--------|--------|----------|
| SCSI Block device | Yes | No¹ | Yes | Yes |
| SCSI MultiMedia device | Yes | Not yet² | Yes | Yes |
| SCSI Streaming device | Yes | No¹ | Yes | Yes |
| Parallel ATA | No³ | No¹ | Yes | Yes |
| Serial ATA | Yes | No¹ | Yes | Yes |
| USB | Partial⁴ | Partial⁵ | Yes | Yes |
| FireWire | Partial⁶ | Partial⁵ | Yes | Partial⁶ |
| PCMCIA | Partial⁷ | Partial⁵ | Yes | Partial⁷ |
| SecureDigital / MultiMediaCard | Not yet⁸ | No¹ | Yes | Untested⁹ |
1. macOS only allows talking with MultiMedia devices.
2. Support for MultiMedia devices in macOS will be added if users require it
3. Not supported due to upstream bug
4. USB descriptors are not retrieved
5. Only MultiMedia devices can be supported and descriptors will not be retrieved
6. FireWire descriptors are not retrieved
7. PCMCIA CIS is not retrieved
8. Support will come with FreeBSD 12-RELEASE
9. Should work, untested due to not available hardware

81
5.0/Getting-information-from-a-physical-device.mediawiki
View File

@@ -1,81 +0,0 @@
==Command description==
This operation will request and show all information about a physical device. For information about supported physical devices check [[Supported-devices.mediawiki|the list of supported physical devices]].
==Command usage==
<code>Aaru -d [true/false] -v [true/false] device info -h [true/false] -w [prefix] <device-path/aaru-remote-host></code>
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
<code>-w, --output-prefix [prefix]</code> writes binary responses from device to that prefix<br />
<code><aaru-remote-host></code> connects to an Aaru Remote Host with aaru://<IP ADDRESS>/<DEVICE PATH><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/>

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

@@ -0,0 +1,48 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## 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 [the list of supported physical devices.](https://github.com/Senn1/Aaru.Documentation/blob/master/5.0/Supported-devices.md)
## Command usage
```bash
Aaru -d [true/false] -v [true/false] media info -h [true/false] -w [prefix] <device-path/aaru-remote-host>
```
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-w, --output-prefix [prefix]` writes binary responses from device to that prefix
`<aaru-remote-host>` connects to an Aaru Remote Host with aaru:///
## Example
FreeBSD: `Aaru media info /dev/cd0`
Linux: `Aaru media info /dev/sdb`
Windows: `Aaru media info \\.\PhysicalDrive3`
## Operating system support
| Device Type | FreeBSD | MacOS | Linux | Windows |
|--------------|----------|--------|--------|----------|
| SCSI Block device | Yes | No¹ | Yes | Yes |
| SCSI MultiMedia device | Yes | Not yet² | Yes | Yes |
| SCSI Streaming device | Yes | No¹ | Yes | Yes |
| Parallel ATA | No³ | No³ | Yes³ | Yes³ |
| Serial ATA | Yes³ | No³ | Yes³ | Yes³ |
| USB | Partial | Partial | Yes | Yes |
| FireWire | Partial | Partial | Yes | Partial |
| PCMCIA | Partial | Partial | Yes | Partial |
| SecureDigital / MultiMediaCard | Not yet³ | No³ | Yes³ | Untested³ |
1. macOS only allows talking with MultiMedia devices.
2. Support for MultiMedia devices in macOS will be added if users require it
3. Use device-info command

81
5.0/Getting-information-from-media-inserted-in-a-physical-device.mediawiki
View File

@@ -1,81 +0,0 @@
==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.mediawiki|the list of supported physical devices]].
==Command usage==
<code>Aaru -d [true/false] -v [true/false] media info -h [true/false] -w [prefix] <device-path/aaru-remote-host></code>
<code>-d, --debug [true/false]</code> shows debug output ''(default false'')<br />
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false'')<br />
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
<code>-w, --output-prefix [prefix]</code> writes binary responses from device to that prefix<br />
<code><aaru-remote-host></code> connects to an Aaru Remote Host with aaru://<IP ADDRESS>/<DEVICE PATH><br />
==Example==
FreeBSD: <code>Aaru media info /dev/cd0</code><br />
Linux: <code>Aaru media info /dev/sdb</code><br />
Windows: <code>Aaru media info \\.\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/>

25
5.0/Supported-devices.md Normal file
View File

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

66
5.0/Supported-devices.mediawiki
View File

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