From 68c816a8c8e54eb257e6a54a9fd80848b6423f82 Mon Sep 17 00:00:00 2001 From: Matt Nadareski Date: Thu, 19 Aug 2021 11:08:54 -0700 Subject: [PATCH] Nitpicks, cleanups, and spellcheck --- README.md | 2 +- _coverpage.md | 2 +- _sidebar.md | 4 ++-- configure.md | 11 ++++------- database/stats.md | 6 +++--- database/update.md | 6 +++--- device/info.md | 2 +- device/list.md | 6 +++--- device/report.md | Bin 4536 -> 4750 bytes faq/3rdparty.md | 6 +++--- faq/comparison.md | 39 +++++++++---------------------------- faq/filesystems.md | 6 ++---- faq/formats.md | Bin 3434 -> 3380 bytes faq/media-tags.md | 16 +++++++-------- faq/more.md | 2 +- faq/partitions.md | 2 ++ faq/sector-tags.md | 2 +- faq/supported-checksums.md | 2 ++ faq/supported-devices.md | 2 +- faq/supported-filters.md | 2 ++ filesystem/extract.md | 2 +- filesystem/info.md | 2 +- filesystem/ls.md | 9 ++++----- filesystem/options.md | 7 +++---- formats.md | 8 ++++---- image/create-sidecar.md | 2 +- image/decode.md | 2 +- image/entropy.md | 2 +- image/options.md | 6 +++--- image/print.md | 2 +- image/verify.md | 8 +++----- list-encodings.md | 8 ++++---- list-namespaces.md | 8 ++++---- media/dump.md | 4 ++-- media/info.md | 2 +- media/scan.md | 6 +++--- remote.md | 4 ++-- remote/readme.md | 39 ++++++++++++++++++------------------- 38 files changed, 107 insertions(+), 132 deletions(-) diff --git a/README.md b/README.md index 108165a..301a3a1 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ not) and to extract the files from those images. ## 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. - 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 diff --git a/_coverpage.md b/_coverpage.md index 5903330..e4d97db 100644 --- a/_coverpage.md +++ b/_coverpage.md @@ -2,7 +2,7 @@ # 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/) [Statistics](https://aaru.app/Stats) diff --git a/_sidebar.md b/_sidebar.md index 7b455de..d7b21a9 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -19,13 +19,13 @@ - [Check readability of the media](media/scan.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 - [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) - [Supported media tags](faq/media-tags.md) - [Supported sector tags](faq/sector-tags.md) diff --git a/configure.md b/configure.md index 7845d02..5a9fb36 100644 --- a/configure.md +++ b/configure.md @@ -9,7 +9,7 @@ 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 +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) ## Command usage @@ -31,9 +31,6 @@ Aaru configure ## Operating system support -| OS | Supported | -|----|-----------| -| FreeBSD | Yes | -| macOS | Yes | -| Linux | Yes | -| Windows | Yes | +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | diff --git a/database/stats.md b/database/stats.md index 411c377..476c7fe 100644 --- a/database/stats.md +++ b/database/stats.md @@ -7,7 +7,7 @@ ## 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 @@ -28,6 +28,6 @@ Aaru -d [true/false] -v [true/false] database stats -h [true/false] ## Operating system support | FreeBSD | macOS | Linux | Windows | -|---|---|---|---| -| Yes | Yes | Yes | Yes | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | diff --git a/database/update.md b/database/update.md index 1e4f1a8..57f5027 100644 --- a/database/update.md +++ b/database/update.md @@ -7,7 +7,7 @@ ## 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 @@ -32,5 +32,5 @@ Aaru -d [true/false] -v [true/false] database update -h [true/false] ## Operating system support | FreeBSD | macOS | Linux | Windows | -|---|---|---|---| -| Yes | Yes | Yes | Yes | \ No newline at end of file +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | \ No newline at end of file diff --git a/device/info.md b/device/info.md index 726f24d..1bf2d81 100644 --- a/device/info.md +++ b/device/info.md @@ -49,4 +49,4 @@ Windows: `Aaru device info D:` 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 +9. Should work, untested due to no available hardware diff --git a/device/list.md b/device/list.md index 6efc6bb..e084d12 100644 --- a/device/list.md +++ b/device/list.md @@ -27,6 +27,6 @@ This operation will show all known attached devices on your system and if they a ## Operating system support -|FreeBSD|macOS|Linux|Windows| -|---|---|---|---| -|Yes|Yes|Yes|Yes| \ No newline at end of file +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | \ No newline at end of file diff --git a/device/report.md b/device/report.md index cfd948883d1771d4d0d6d76607cb403a5358e37e..a2b4445bd3c7b96695078b47e60d6bdd472791c4 100644 GIT binary patch delta 1003 zcmdm?+^4$X5EFYQLmop3L;mKYOpDp;6&PF?QW?q^G8vK?QW+E&LKrF;3cxG{h8hM1 z1~-NxhE#@B1}BDK1{Vee28gIHLn1>mgFizsT*QX~WNaxz1zaQ?ERw>I&rr@#3>D>N z;9{s@&_%#{1QW_ak%o%tqG|$*VyeRw0a;YT0I^hoA(+9LA(+9FL4m=EA%`KKA(Q!WM1RHARWJ_*cSM2&r7!(*P8B!Ta7&Z}Q(rj*R zid^!MTe2SF5|HaRL+u2yiSh|UFheRs5kn?JB0~;?0)rz%2!kWk41}*081R}`57qz; z8ir7YUFLkZOQ5(S7uQAJCkqR7@E*f3Mw7&5^r5|p|?DHGYGdYA=e zP@@Q2fT{wb4`x*WgENCKgENCCJS0$6m!sQa0uDTE{=lXYYR%+kUR!sFFF=8dNH!Hv i<3Xa>qA(PkjX{aFgdvq7g`rYGVKXCNJM-i&K|KIW-KTi~ delta 760 zcmeBE-J!hU5EFAgL*C|-OpDp;T^Lds$`~>kk{MDN6c|bvDj5nGQWAqr@)$}PDi~@Q!olnmhJ1!{hGK>q23`g(h8hN4 zFeFU#vVfFN4&_!hu3?B|NCg|=$B@sU!C=Us$$$`p$w7<{W^iT*X7HRmQ9#ucp$4R{ zgh7F!k|C9$gh7MB2)7B7Re7|vQFY?AadJ10q<#$p$Oa7tW3agpHXc__zRx3CPl6o` zp$x$cP7E~+0St)@MGPejnGA^xISd*MCSd!}MNPq?uyBFVknnM1$OK1Ucs-PXX{Z@k zJAOmaWg&VXRs=9OGx#z%Gk7vMVsWxL)O2%HpP;%K-FS#5uq`CK#ivW diff --git a/faq/3rdparty.md b/faq/3rdparty.md index c1a54b5..d3968f0 100644 --- a/faq/3rdparty.md +++ b/faq/3rdparty.md @@ -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 -bugs. +known bugs. ### 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. -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). diff --git a/faq/comparison.md b/faq/comparison.md index c14202f..a6463f8 100644 --- a/faq/comparison.md +++ b/faq/comparison.md @@ -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 | |-------------------------------------------------|--------------------------|------------------|----------|----------|--------------|-----------|-----------| | Opensource | Yes | [Yes](https://github.com/saramibreak/DiscImageCreator) | No | No | No | No | No | -| Supported platforms | Windows, Linux, macOS¹ | Windows | Windows | Windows | Windows | Windows | Windows | -| Supported formats | [12](formats.md) | 3² | 1³ | 1⁴ | 1⁵ | 17⁶ | 1⁷ | +| Supported platforms | Windows, Linux, macOS¹ | Windows | Windows | Windows | Windows | Windows | Windows | +| Supported formats | [12](formats.md) | 3² | 1³ | 1⁴ | 1⁵ | 17⁶ | 1⁷ | | Can dump Audio CD | Yes⁸ | Yes | Yes | Yes | Yes | Yes | No | | Can dump Mode 0 tracks | Yes | No | No | No | No | No | No | | Can dump Mode 1 tracks | Yes | Yes | Yes | Yes | Yes | Yes | Yes | | Can dump Mode 2 tracks | Yes⁸ | Yes | Yes | Yes | Yes | Yes | Yes | -| Can dump multisession discs | Yes | Yes | No | Yes | Yes | Yes | No | -| Can dump discs with errors | Yes⁹ | Yes¹⁰ | No¹¹ | Yes¹⁰ | Yes¹⁰ | Unknown | Unknown | +| 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 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 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 | +| 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 \ No newline at end of file diff --git a/faq/filesystems.md b/faq/filesystems.md index ae9a081..e34beb2 100644 --- a/faq/filesystems.md +++ b/faq/filesystems.md @@ -1,5 +1,4 @@ -Supported file systems for read-only operations -=============================================== +## Supported file systems for read-only operations * Apple DOS file system * Apple Lisa file system @@ -7,8 +6,7 @@ Supported file systems for read-only operations * CP/M 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 * Acorn Advanced Disc Filing System diff --git a/faq/formats.md b/faq/formats.md index 01ee00088df9876b3e98339c51468b6fbc432eb8..2bc05770680c200503793ce4c9de6da69edea585 100644 GIT binary patch delta 67 zcmaDQwMA;eEXJJ^7uqv#V%R)!q4;Jt#s)^F5{1cqOou>J1hW(4&dm#%ML~j__pt;p UF_kK87Gr diff --git a/faq/media-tags.md b/faq/media-tags.md index cf972ee..509fc28 100644 --- a/faq/media-tags.md +++ b/faq/media-tags.md @@ -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) * 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 * Media Catalogue Number -# DVD and HD DVD media tags +## DVD and HD DVD media tags * Physical Format 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 * Pseudo-overwrite information -# Blu-ray media tags +## Blu-ray media tags * Disc Information * 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 * Spare Area Status -# AACS media tags for HD DVD and Blu-ray +## AACS media tags for HD DVD and Blu-ray * Volume identifier * 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 * CPRM Media Key Block -# Media tags defined by MMC specifications +## Media tags defined by MMC specifications * Recognized hybrid layers * Write protection status * Disc standard information * Disc track resources information -# Device tags defined by SCSI specifications +## Device tags defined by SCSI specifications * Inquiry response -# Device tags defined by ATA/ATAPI specifications +## Device tags defined by ATA/ATAPI specifications * Ata Identify response * Atapi Identify response \ No newline at end of file diff --git a/faq/more.md b/faq/more.md index a719fb4..09efdce 100644 --- a/faq/more.md +++ b/faq/more.md @@ -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? -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? diff --git a/faq/partitions.md b/faq/partitions.md index a39d6a9..c19e368 100644 --- a/faq/partitions.md +++ b/faq/partitions.md @@ -1,3 +1,5 @@ +## Partitions + * Acorn Linux and RISCiX partitions * ACT Apricot partitions * Amiga Rigid Disk Block (RDB) diff --git a/faq/sector-tags.md b/faq/sector-tags.md index dc539b3..bd6a451 100644 --- a/faq/sector-tags.md +++ b/faq/sector-tags.md @@ -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 diff --git a/faq/supported-checksums.md b/faq/supported-checksums.md index 1f2b5a8..159335f 100644 --- a/faq/supported-checksums.md +++ b/faq/supported-checksums.md @@ -1,3 +1,5 @@ +## Supported Checksums + * Adler-32 * CRC-16 * CRC-32 diff --git a/faq/supported-devices.md b/faq/supported-devices.md index a126786..554e4b2 100644 --- a/faq/supported-devices.md +++ b/faq/supported-devices.md @@ -22,4 +22,4 @@ The following physical devices are supported: 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 \ No newline at end of file +9. Should work, untested due to no available hardware \ No newline at end of file diff --git a/faq/supported-filters.md b/faq/supported-filters.md index b56ade8..d8eb51e 100644 --- a/faq/supported-filters.md +++ b/faq/supported-filters.md @@ -1,3 +1,5 @@ +## Supported Filters + * Apple PCExchange (FINDER.DAT & RESOURCE.FRK) * AppleDouble * AppleSingle diff --git a/filesystem/extract.md b/filesystem/extract.md index eb262fc..18ccf71 100644 --- a/filesystem/extract.md +++ b/filesystem/extract.md @@ -7,7 +7,7 @@ ## 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 diff --git a/filesystem/info.md b/filesystem/info.md index 2ebbeaf..5459f9e 100644 --- a/filesystem/info.md +++ b/filesystem/info.md @@ -1,6 +1,6 @@ # 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) and [supported filesystems](../faq/filesystems.md) on the dump, showing information about them. diff --git a/filesystem/ls.md b/filesystem/ls.md index 79d6a0a..d00dd93 100644 --- a/filesystem/ls.md +++ b/filesystem/ls.md @@ -1,6 +1,6 @@ ## 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 @@ -26,7 +26,6 @@ This operation will analyze and find all filesystems in a media dump and list al ## Operating system support -|FreeBSD|macOS|Linux|Windows| -|---|---|---|---| -|Yes|Yes|Yes|Yes| - +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | diff --git a/filesystem/options.md b/filesystem/options.md index 54f1c20..987e539 100644 --- a/filesystem/options.md +++ b/filesystem/options.md @@ -18,7 +18,6 @@ Lists all options supported by read-only filesystems. ## Operating system support -|FreeBSD|macOS|Linux|Windows| -|---|---|---|---| -|Yes|Yes|Yes|Yes| - +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | diff --git a/formats.md b/formats.md index 57bc428..2691653 100644 --- a/formats.md +++ b/formats.md @@ -1,6 +1,6 @@ ## 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. ## Command usage @@ -20,6 +20,6 @@ default false)* ## Operating system support -|FreeBSD|macOS|Linux|Windows| -|---|---|---|---| -|Yes|Yes|Yes|Yes| +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | \ No newline at end of file diff --git a/image/create-sidecar.md b/image/create-sidecar.md index 4463139..9b2b1b3 100644 --- a/image/create-sidecar.md +++ b/image/create-sidecar.md @@ -7,7 +7,7 @@ ## 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 diff --git a/image/decode.md b/image/decode.md index 02c0613..4e355a8 100644 --- a/image/decode.md +++ b/image/decode.md @@ -7,7 +7,7 @@ ## 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 diff --git a/image/entropy.md b/image/entropy.md index 33b4563..5cf5b8d 100644 --- a/image/entropy.md +++ b/image/entropy.md @@ -7,7 +7,7 @@ ## 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 diff --git a/image/options.md b/image/options.md index b1fe7e2..3874148 100644 --- a/image/options.md +++ b/image/options.md @@ -25,6 +25,6 @@ Lists all options supported by writable media images. ## Operating system support -|FreeBSD|macOS|Linux|Windows| -|---|---|---|---| -|Yes|Yes|Yes|Yes| +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | diff --git a/image/print.md b/image/print.md index 7668dab..55ff255 100644 --- a/image/print.md +++ b/image/print.md @@ -7,7 +7,7 @@ ## 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 diff --git a/image/verify.md b/image/verify.md index fe8e962..230289c 100644 --- a/image/verify.md +++ b/image/verify.md @@ -1,6 +1,6 @@ ## 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 @@ -28,10 +28,8 @@ dump *(default true)* Aaru image verify mydisc.cue ``` - - ## Operating system support | FreeBSD | macOS | Linux | Windows | -|---|---|---|---| -| Yes | Yes | Yes | Yes | \ No newline at end of file +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | \ No newline at end of file diff --git a/list-encodings.md b/list-encodings.md index 50b8c6e..8aae382 100644 --- a/list-encodings.md +++ b/list-encodings.md @@ -1,6 +1,6 @@ ## 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 in another one. @@ -21,6 +21,6 @@ default false)* ## Operating system support -|FreeBSD|macOS|Linux|Windows| -|---|---|---|---| -|Yes|Yes|Yes|Yes| +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | \ No newline at end of file diff --git a/list-namespaces.md b/list-namespaces.md index e10a61a..abc8b11 100644 --- a/list-namespaces.md +++ b/list-namespaces.md @@ -1,6 +1,6 @@ ## 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 @@ -19,6 +19,6 @@ default false)* ## Operating system support -|FreeBSD|macOS|Linux|Windows| -|---|---|---|---| -|Yes|Yes|Yes|Yes| +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | \ No newline at end of file diff --git a/media/dump.md b/media/dump.md index 966cebc..18b34f1 100644 --- a/media/dump.md +++ b/media/dump.md @@ -7,7 +7,7 @@ ## 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 @@ -90,4 +90,4 @@ Windows: `Aaru media dump -f -p 0 --resume false \\.\PhysicalDrive3 mydisk.aaruf 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 \ No newline at end of file +9. Should work, untested due to no available hardware \ No newline at end of file diff --git a/media/info.md b/media/info.md index aed07e9..a151408 100644 --- a/media/info.md +++ b/media/info.md @@ -7,7 +7,7 @@ ## 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 diff --git a/media/scan.md b/media/scan.md index f8f7201..81ca9da 100644 --- a/media/scan.md +++ b/media/scan.md @@ -7,9 +7,9 @@ ## 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 -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 @@ -53,4 +53,4 @@ Windows: `Aaru media scan \\.\PhysicalDrive3` 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 \ No newline at end of file +9. Should work, untested due to no available hardware \ No newline at end of file diff --git a/remote.md b/remote.md index 4d664fa..8283a02 100644 --- a/remote.md +++ b/remote.md @@ -22,5 +22,5 @@ default false)* ## Operating system support | FreeBSD | macOS | Linux | Windows | -|---|---|---|---| -| Yes | Yes | Yes | Yes | \ No newline at end of file +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | \ No newline at end of file diff --git a/remote/readme.md b/remote/readme.md index 528164f..a49e18f 100644 --- a/remote/readme.md +++ b/remote/readme.md @@ -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) -instance, sends it to a local device, and returns the data to the instance. +The Aaru Remote is a slim, miniature application designed to receive device commands from a remote [Aaru](https://github.com/aaru-dps/Aaru) +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#. 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.). -While some people will suggest porting the whole Aaru to C or C++, that won't happen, and for the only situation that -would be needed (accessing devices where C# does not run) this slim is more than enough. +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 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 available IPs. Running as non-root user only works with some SCSI devices, so better run as root. +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 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 remotely. All commands that support devices are supported, with a URI with the following schema: `aaru:///`. -Feature matrix -============== -| |Minimum OS*1| SCSI |CHS ATA |28-bit LBA ATA |48-bit LBA ATA |Secure Digital|MultiMediaCard|USB |FireWire |PCMCIA |Special*2| -|------------|-----------------------|---------------|---------------|---------------|---------------|--------------|--------------|--------------------|--------------------|----------------|-------| -|FreeBSD | 12 |Yes |Yes |Yes |Yes |Not yet |Not yet |Not yet*4|Not yet*4|No*5 || -|Linux |2.6 |Yes |Yes |Yes |Yes |Yes |Yes |Yes |Yes |Yes*6|| -|Nintendo Wii|4.3 |No*3|No*3|No*3|No*3|Not yet |Not yet |Not yet |No*3 |No*3 |Not yet| -|Windows NT | XP |Yes |Yes |Yes |Yes |Yes |Yes |Yes |Not yet*4|No*5 || +## Feature matrix + +| | 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⁴ | Not yet⁴ | No⁵ | | +| Linux | 2.6 | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes⁶ | | +| 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⁴ | No⁵ | | 1. Minimum operating system version where aaruremote has been tested. May work on early version. 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. 6. Only ATA devices, not linear memory devices. -TODO -==== +## TODO + - More buffer overflow guards - Support PSP - Support Wii