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

Nitpicks, cleanups, and spellcheck

Browse Source
This commit is contained in:
Matt Nadareski
2021-08-19 11:08:54 -07:00
parent 5da40e3293
commit 68c816a8c8
38 changed files with 107 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -17,7 +17,7 @@ not) and to extract the files from those images.
## Key features of Aaru: ## Key features of Aaru:
- Aaru Image Format, the format that stores the most amount of data for any given format, and supports media of almost - Aaru Image Format, the format that stores the most amount of data for any given format and supports media of almost
any type. any type.
- Dumps almost any kind of storage media, with more types of media being added whenever possible. - Dumps almost any kind of storage media, with more types of media being added whenever possible.
- Able to read information and extract files from many different formats, as well as easily convert from any format to - Able to read information and extract files from many different formats, as well as easily convert from any format to

2
_coverpage.md
View File

@@ -2,7 +2,7 @@
# Aaru Data Preservation Suite # Aaru Data Preservation Suite
> A fully featured media dump management solution > A fully-featured media dump management solution
[GitHub](https://github.com/aaru-dps/aaru/) [GitHub](https://github.com/aaru-dps/aaru/)
[Statistics](https://aaru.app/Stats) [Statistics](https://aaru.app/Stats)

4
_sidebar.md
View File

@@ -19,13 +19,13 @@
- [Check readability of the media](media/scan.md) - [Check readability of the media](media/scan.md)
- [Create a media dump](media/dump.md) - [Create a media dump](media/dump.md)
- [Get info about an inserted media](media/info.md) - [Get info about inserted media](media/info.md)
- Media images - Media images
- [Convert a media dump](image/convert.md) - [Convert a media dump](image/convert.md)
- [Create metadata sidecar](image/create-sidecar.md) - [Create a metadata sidecar](image/create-sidecar.md)
- [Decode and print media tags](image/decode.md) - [Decode and print media tags](image/decode.md)
- [Supported media tags](faq/media-tags.md) - [Supported media tags](faq/media-tags.md)
- [Supported sector tags](faq/sector-tags.md) - [Supported sector tags](faq/sector-tags.md)

11
configure.md
View File

@@ -9,7 +9,7 @@
This command will ask you which statistics to gather and if you want to share them anonymously. When sharing, no 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 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 operating system where Aaru is run. This information is not, and will never be, sold to any third party. Collected information is publicly
available at [https://www.aaru.app](https://www.aaru.app) available at [https://www.aaru.app](https://www.aaru.app)
## Command usage ## Command usage
@@ -31,9 +31,6 @@ Aaru configure
## Operating system support ## Operating system support
| OS | Supported | | FreeBSD | macOS | Linux | Windows |
|----|-----------| | ------- | ----- | ----- | ------- |
| FreeBSD | Yes | | Yes | Yes | Yes | Yes |
| macOS | Yes |
| Linux | Yes |
| Windows | Yes |

6
database/stats.md
View File

@@ -7,7 +7,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 in your environment.
## Command usage ## Command usage
@@ -28,6 +28,6 @@ Aaru -d [true/false] -v [true/false] database stats -h [true/false]
## Operating system support ## Operating system support
| FreeBSD | macOS | Linux | Windows | | FreeBSD | macOS | Linux | Windows |
|---|---|---|---| | ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes | | Yes | Yes | Yes | Yes |

6
database/update.md
View File

@@ -7,7 +7,7 @@
## Command description ## Command description
This operation will update the master database, and can optionally clear the master and local database. This operation will update the master database and optionally clear the master and local databases.
## Command usage ## Command usage
@@ -32,5 +32,5 @@ Aaru -d [true/false] -v [true/false] database update -h [true/false]
## Operating system support ## Operating system support
| FreeBSD | macOS | Linux | Windows | | FreeBSD | macOS | Linux | Windows |
|---|---|---|---| | ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes | | Yes | Yes | Yes | Yes |

2
device/info.md
View File

@@ -49,4 +49,4 @@ Windows: `Aaru device info D:`
6. FireWire descriptors are not retrieved 6. FireWire descriptors are not retrieved
7. PCMCIA CIS is not retrieved 7. PCMCIA CIS is not retrieved
8. Support will come with FreeBSD 12-RELEASE 8. Support will come with FreeBSD 12-RELEASE
9. Should work, untested due to not available hardware 9. Should work, untested due to no available hardware

6
device/list.md
View File

@@ -27,6 +27,6 @@ This operation will show all known attached devices on your system and if they a
## Operating system support ## Operating system support
|FreeBSD|macOS|Linux|Windows| | FreeBSD | macOS | Linux | Windows |
|---|---|---|---| | ------- | ----- | ----- | ------- |
|Yes|Yes|Yes|Yes| | Yes | Yes | Yes | Yes |

BIN
device/report.md
View File

Binary file not shown.

6
faq/3rdparty.md
View File

@@ -1,5 +1,5 @@
Some software contains bugs that can make users think the problem resides with Aaru. This page contains a list of such Some software contains bugs that can make users think the problem resides with Aaru. This page contains a list of such
bugs. known bugs.
### ImgBurn complains image is smaller than disc ### ImgBurn complains image is smaller than disc
@@ -7,6 +7,6 @@ bugs.
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. Aaru instead reads and interprets the TOC (Table of Contents), that describes the disc start and end. While that command should indicate the same size as the TOC interpretation, seems to not be so in some conditions (drive firmware bug?). The problem comes because ImgBurn uses the `SCSI READ CAPACITY` command to decide the size of compact discs. Aaru instead reads and interprets the TOC (Table of Contents) that describes the disc start and end. While that command should indicate the same size as the TOC interpretation, seems not to be the case in some conditions (possibly a 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).

39
faq/comparison.md
View File

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

6
faq/filesystems.md
View File

@@ -1,5 +1,4 @@
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
@@ -7,8 +6,7 @@ Supported file systems for read-only operations
* CP/M file system * CP/M file system
* U.C.S.D Pascal file system * U.C.S.D Pascal file system
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

BIN
faq/formats.md
View File

Binary file not shown.

16
faq/media-tags.md
View File

@@ -1,6 +1,6 @@
A media tag is data that accompanies 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 accompanies 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)
@@ -10,7 +10,7 @@ A media tag is data that accompanies the media or the device, and is stored on t
* CD-Text * CD-Text
* 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
@@ -31,7 +31,7 @@ A media tag is data that accompanies the media or the device, and is stored on t
* Start LBA of the manual layer jump * Start LBA of the manual layer jump
* Pseudo-overwrite information * Pseudo-overwrite information
# Blu-ray media tags ## Blu-ray media tags
* Disc Information * Disc Information
* Burst Cutting Area * Burst Cutting Area
@@ -39,7 +39,7 @@ A media tag is data that accompanies the media or the device, and is stored on t
* Cartridge Status * Cartridge Status
* 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
@@ -49,18 +49,18 @@ A media tag is data that accompanies the media or the device, and is stored on t
* Encrypted LBA extents * Encrypted LBA extents
* 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

2
faq/more.md
View File

@@ -4,7 +4,7 @@ Aaru is the Ancient Egyptian concept of paradise where your soul would be rebirt
# Which operating systems does Aaru work under? # Which operating systems does Aaru work under?
Any operating system with a .NET Core 2.0 runtime should work. Has been tested under Windows, Linux, Mac OS X and FreeBSD. Any operating system with a .NET Core 3.1 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?

2
faq/partitions.md
View File

@@ -1,3 +1,5 @@
## Partitions
* Acorn Linux and RISCiX partitions * Acorn Linux and RISCiX partitions
* ACT Apricot partitions * ACT Apricot partitions
* Amiga Rigid Disk Block (RDB) * Amiga Rigid Disk Block (RDB)

2
faq/sector-tags.md
View File

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

2
faq/supported-checksums.md
View File

@@ -1,3 +1,5 @@
## Supported Checksums
* Adler-32 * Adler-32
* CRC-16 * CRC-16
* CRC-32 * CRC-32

2
faq/supported-devices.md
View File

@@ -22,4 +22,4 @@ The following physical devices are supported:
6. FireWire descriptors are not retrieved 6. FireWire descriptors are not retrieved
7. PCMCIA CIS is not retrieved 7. PCMCIA CIS is not retrieved
8. Support will come with FreeBSD 12-RELEASE 8. Support will come with FreeBSD 12-RELEASE
9. Should work, untested due to not available hardware 9. Should work, untested due to no available hardware

2
faq/supported-filters.md
View File

@@ -1,3 +1,5 @@
## Supported Filters
* Apple PCExchange (FINDER.DAT & RESOURCE.FRK) * Apple PCExchange (FINDER.DAT & RESOURCE.FRK)
* AppleDouble * AppleDouble
* AppleSingle * AppleSingle

2
filesystem/extract.md
View File

@@ -7,7 +7,7 @@
## Command description ## Command description
This operation will analyze and find all filesystems in a media dump and extract the files that are contained in [supported filesystems.](../faq/filesystems.md) This operation will analyze and find all filesystems in a media dump, then extract the files that are contained in [supported filesystems.](../faq/filesystems.md)
## Command usage ## Command usage

2
filesystem/info.md
View File

@@ -1,6 +1,6 @@
# Analyzing a media dump # Analyzing a media dump
This operation will analyze a media dump, and if the format is recognized and you choose so, it will search This operation will analyze a media dump and if the format is recognized (and you choose so), it will search
for [supported partitioning schemes](../faq/partitions.md) for [supported partitioning schemes](../faq/partitions.md)
and [supported filesystems](../faq/filesystems.md) on the dump, showing information about them. and [supported filesystems](../faq/filesystems.md) on the dump, showing information about them.

9
filesystem/ls.md
View File

@@ -1,6 +1,6 @@
## Command description ## Command description
This operation will analyze and find all filesystems in a media dump and list all the files that are contained in [supported filesystems](../faq/filesystems.md). This operation will analyze and find all filesystems in a media dump, then list all the files that are contained in [supported filesystems](../faq/filesystems.md).
## Command usage ## Command usage
@@ -26,7 +26,6 @@ This operation will analyze and find all filesystems in a media dump and list al
## Operating system support ## Operating system support
|FreeBSD|macOS|Linux|Windows| | FreeBSD | macOS | Linux | Windows |
|---|---|---|---| | ------- | ----- | ----- | ------- |
|Yes|Yes|Yes|Yes| | Yes | Yes | Yes | Yes |

7
filesystem/options.md
View File

@@ -18,7 +18,6 @@ Lists all options supported by read-only filesystems.
## Operating system support ## Operating system support
|FreeBSD|macOS|Linux|Windows| | FreeBSD | macOS | Linux | Windows |
|---|---|---|---| | ------- | ----- | ----- | ------- |
|Yes|Yes|Yes|Yes| | Yes | Yes | Yes | Yes |

8
formats.md
View File

@@ -1,6 +1,6 @@
## Command description ## Command description
This operation will list all filters, dump media formats, partitioning schemes and filesystems supported by your version This operation will list all filters, dumpable media formats, partitioning schemes, and filesystems supported by your version
of Aaru. of Aaru.
## Command usage ## Command usage
@@ -20,6 +20,6 @@ default false)*
## Operating system support ## Operating system support
|FreeBSD|macOS|Linux|Windows| | FreeBSD | macOS | Linux | Windows |
|---|---|---|---| | ------- | ----- | ----- | ------- |
|Yes|Yes|Yes|Yes| | Yes | Yes | Yes | Yes |

2
image/create-sidecar.md
View File

@@ -7,7 +7,7 @@
## Command Description ## 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.](../faq/supported-checksums.md) 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 retrieved from it, as well as all [supported checksum algorithms.](../faq/supported-checksums.md)
## Command usage ## Command usage

2
image/decode.md
View File

@@ -7,7 +7,7 @@
## Command Description ## Command Description
This operation will decode all [sector tags](../faq/sector-tags.md) and [media tags](../faq/media-tags.md) on a media dump image. This operation will decode all [sector tags](../faq/sector-tags.md) and [media tags](../faq/media-tags.md) in a media dump image.
## Command usage ## Command usage

2
image/entropy.md
View File

@@ -7,7 +7,7 @@
## Command Description ## 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. 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 ## Command usage

6
image/options.md
View File

@@ -25,6 +25,6 @@ Lists all options supported by writable media images.
## Operating system support ## Operating system support
|FreeBSD|macOS|Linux|Windows| | FreeBSD | macOS | Linux | Windows |
|---|---|---|---| | ------- | ----- | ----- | ------- |
|Yes|Yes|Yes|Yes| | Yes | Yes | Yes | Yes |

2
image/print.md
View File

@@ -7,7 +7,7 @@
## Command Description ## Command Description
This operation will print a hexadecimal dump in the console of the chosen sector/block of the indicated media dump image. This operation will print a hexadecimal dump of the chosen sector/block from the indicated media dump image to the console.
## Command usage ## Command usage

8
image/verify.md
View File

@@ -1,6 +1,6 @@
## Command description ## Command description
This operation will verify a media dump. If the media dump format includes a hash or checksum, it will calculate and compare it. If the media sectors/blocks format include a hash, checksum or error recovery system, it will calculate and compare them. This operation will verify a media dump. If the media dump format includes a hash or checksum, it will calculate and compare it. If the media sector/block format include a hash, checksum, or error recovery system, it will calculate and compare them.
## Command usage ## Command usage
@@ -28,10 +28,8 @@ dump *(default true)*
Aaru image verify mydisc.cue Aaru image verify mydisc.cue
``` ```
## Operating system support ## Operating system support
| FreeBSD | macOS | Linux | Windows | | FreeBSD | macOS | Linux | Windows |
|---|---|---|---| | ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes | | Yes | Yes | Yes | Yes |

8
list-encodings.md
View File

@@ -1,6 +1,6 @@
## Command description ## Command description
This operation will list all your character set encodings supported in your environment. This list depends on libraries This operation will list all character set encodings supported in your environment. This list depends on the libraries
installed on your system, so if an encoding is available in one environment there are no guarantees it will be available installed on your system, so if an encoding is available in one environment there are no guarantees it will be available
in another one. in another one.
@@ -21,6 +21,6 @@ default false)*
## Operating system support ## Operating system support
|FreeBSD|macOS|Linux|Windows| | FreeBSD | macOS | Linux | Windows |
|---|---|---|---| | ------- | ----- | ----- | ------- |
|Yes|Yes|Yes|Yes| | Yes | Yes | Yes | Yes |

8
list-namespaces.md
View File

@@ -1,6 +1,6 @@
## Command description ## Command description
This operation will list all the supported namespaces of the [[Filesystems-recognized-by-Aaru|supported filesystems]]. This operation will list all the supported namespaces of the [Filesystems recognized by Aaru](faq/filesystems.md).
## Command usage ## Command usage
@@ -19,6 +19,6 @@ default false)*
## Operating system support ## Operating system support
|FreeBSD|macOS|Linux|Windows| | FreeBSD | macOS | Linux | Windows |
|---|---|---|---| | ------- | ----- | ----- | ------- |
|Yes|Yes|Yes|Yes| | Yes | Yes | Yes | Yes |

4
media/dump.md
View File

@@ -7,7 +7,7 @@
## Command Description ## 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. 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 with supported formats, even from a different device.
## Command usage ## Command usage
@@ -90,4 +90,4 @@ Windows: `Aaru media dump -f -p 0 --resume false \\.\PhysicalDrive3 mydisk.aaruf
6. FireWire descriptors are not retrieved 6. FireWire descriptors are not retrieved
7. PCMCIA CIS is not retrieved 7. PCMCIA CIS is not retrieved
8. Support will come with FreeBSD 12-RELEASE 8. Support will come with FreeBSD 12-RELEASE
9. Should work, untested due to not available hardware 9. Should work, untested due to no available hardware

2
media/info.md
View File

@@ -7,7 +7,7 @@
## Command Description ## 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.](../faq/supported-devices.md) This operation will request and show all information about the inserted media from a physical device. For information about supported physical devices check [the list of supported physical devices.](../faq/supported-devices.md)
## Command usage ## Command usage

6
media/scan.md
View File

@@ -7,9 +7,9 @@
## Command Description ## Command Description
This operation will read the media inserted in the physical device, and measure how fast it can be read sequentially. 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 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. finished it will check how fast can the device seek and report speed statistics.
## Command usage ## Command usage
@@ -53,4 +53,4 @@ Windows: `Aaru media scan \\.\PhysicalDrive3`
6. FireWire descriptors are not retrieved 6. FireWire descriptors are not retrieved
7. PCMCIA CIS is not retrieved 7. PCMCIA CIS is not retrieved
8. Support will come with FreeBSD 12-RELEASE 8. Support will come with FreeBSD 12-RELEASE
9. Should work, untested due to not available hardware 9. Should work, untested due to no available hardware

4
remote.md
View File

@@ -22,5 +22,5 @@ default false)*
## Operating system support ## Operating system support
| FreeBSD | macOS | Linux | Windows | | FreeBSD | macOS | Linux | Windows |
|---|---|---|---| | ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes | | Yes | Yes | Yes | Yes |

39
remote/readme.md
View File

@@ -1,36 +1,35 @@
Aaru Remote # Aaru Remote
====================
The Aaru Remote is a slim miniature application designed to receive device commands from a remote [Aaru](https://github.com/aaru-dps/Aaru) The Aaru Remote is a slim, miniature application designed to receive device commands from a remote [Aaru](https://github.com/aaru-dps/Aaru)
instance, sends it to a local device, and returns the data to the instance. instance, send it to a local device, and return the data to the instance.
The main motivation for this is the desire to update Aaru to the latest and greatest features of .NET and C#. The main motivation for this is the desire to update Aaru to the latest and greatest features of .NET and C#.
This creates a problem, as some people have old devices that do not work in modern Linux distributions. This creates a problem, as some people have old devices that do not work in modern Linux distributions.
This remote will be supported in older versions of Linux, and will in future versions be supported in FreeBSD, Windows, and possibly This remote will support older versions of Linux and will, in future versions, be supported in FreeBSD, Windows, and possibly
network-enabled game consoles (like PSP, Wii, etc.). network-enabled game consoles (like PSP, Wii, etc.).
While some people will suggest porting the whole Aaru to C or C++, that won't happen, and for the only situation that While some people will suggest porting the whole Aaru to C or C++, that won't happen. For the only situation that
would be needed (accessing devices where C# does not run) this slim is more than enough. would be needed (accessing devices where C# does not run) this application is more than enough.
The usage is very simple, just run the remote, and it will listen for a connection over TCP/IP in port 6666, and print you The usage is very simple, just run the remote and it will listen for a connection over TCP/IP in port 6666 then print out
the available IPs. Running as non-root user only works with some SCSI devices, so better run as root. the available IPs. Running as non-root user only works with some SCSI devices, so it is better to run as root.
On the other side, you can use the Aaru with the *remote* command and one of those IP addresses to test the On the other side, you can use the Aaru with the [remote](../remote.md) command and one of those IP addresses to test the
connection. Similarly, using the IP address as an argument for the *list-devices* command will list the devices available connection. Similarly, using the IP address as an argument for the *list-devices* command will list the devices available
remotely. remotely.
All commands that support devices are supported, with a URI with the following schema: All commands that support devices are supported, with a URI with the following schema:
`aaru://<IP ADDRESS>/<DEVICE PATH>`. `aaru://<IP ADDRESS>/<DEVICE PATH>`.
Feature matrix ## Feature matrix
==============
| |Minimum OS<sup>*1</sup>| SCSI |CHS ATA |28-bit LBA ATA |48-bit LBA ATA |Secure Digital|MultiMediaCard|USB |FireWire |PCMCIA |Special<sup>*2</sup>| | | Minimum OS¹ | SCSI | CHS ATA | 28-bit LBA ATA | 48-bit LBA ATA | Secure Digital | MultiMediaCard | USB | FireWire | PCMCIA | Special² |
|------------|-----------------------|---------------|---------------|---------------|---------------|--------------|--------------|--------------------|--------------------|----------------|-------| |--------------|-------------|------|---------|----------------|----------------|----------------|----------------|----------|----------|--------|----------|
|FreeBSD | 12 |Yes |Yes |Yes |Yes |Not yet |Not yet |Not yet<sup>*4</sup>|Not yet<sup>*4</sup>|No<sup>*5</sup> || | FreeBSD | 12 | Yes | Yes | Yes | Yes | Not yet | Not yet | Not yet⁴ | Not yet⁴ | No⁵ | |
|Linux |2.6 |Yes |Yes |Yes |Yes |Yes |Yes |Yes |Yes |Yes<sup>*6</sup>|| | Linux | 2.6 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes⁶ | |
|Nintendo Wii|4.3 |No<sup>*3</sup>|No<sup>*3</sup>|No<sup>*3</sup>|No<sup>*3</sup>|Not yet |Not yet |Not yet |No<sup>*3</sup> |No<sup>*3</sup> |Not yet| | Nintendo Wii | 4.3 | No³ | No³ | No³ | No³ | Not yet | Not yet | Not yet | No³ | No³ | Not yet |
|Windows NT | XP |Yes |Yes |Yes |Yes |Yes |Yes |Yes |Not yet<sup>*4</sup>|No<sup>*5</sup> || | Windows NT | XP | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Not yet⁴ | No⁵ | |
1. Minimum operating system version where aaruremote has been tested. May work on early version. 1. Minimum operating system version where aaruremote has been tested. May work on early version.
2. Special storage media only available on that environment. 2. Special storage media only available on that environment.
@@ -39,8 +38,8 @@ Feature matrix
5. As ATA device, not possible to retrieve special data. 5. As ATA device, not possible to retrieve special data.
6. Only ATA devices, not linear memory devices. 6. Only ATA devices, not linear memory devices.
TODO ## TODO
====
- More buffer overflow guards - More buffer overflow guards
- Support PSP - Support PSP
- Support Wii - Support Wii