diff --git a/database/stats.md b/database/stats.md index 2887e9d..411c377 100644 --- a/database/stats.md +++ b/database/stats.md @@ -1,24 +1,33 @@ +# Table of Contents + +- [Command Description](#command-description) +- [Command usage](#command-usage) +- [Example](#example) +- [Operating system support](#operating-system-support) + ## Command description This operation will show the statistics that have been stored locally on your environment. ## Command usage -```aaru -d [true/false] -v [true/false] database stats -h [true/false]``` +``` +Aaru -d [true/false] -v [true/false] database stats -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)* +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* ## Example -```aaru database stats``` +```Aaru database stats``` ## Operating system support | FreeBSD | macOS | Linux | Windows | |---|---|---|---| -| Yes | Yes | Yes | Yes | \ No newline at end of file +| Yes | Yes | Yes | Yes | + diff --git a/database/update.md b/database/update.md index d777577..1e4f1a8 100644 --- a/database/update.md +++ b/database/update.md @@ -1,17 +1,25 @@ +# Table of Contents + +- [Command Description](#command-description) +- [Command usage](#command-usage) +- [Example](#example) +- [Operating system support](#operating-system-support) + ## Command description -This operation will update the master database, and can optionalyl clear the master and local database. +This operation will update the master database, and can optionally clear the master and local database. ## Command usage -```aaru -d [true/false] -v [true/false] database update -h [true/false]``` +```bash +Aaru -d [true/false] -v [true/false] database update -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)* +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches*(default false)* ```--clear [true/false]``` clears existing master database before updating *(default false)* @@ -19,7 +27,7 @@ default false)* ## Example -```aaru database update --clear-all``` +```Aaru database update --clear-all``` ## Operating system support diff --git a/device/info.md b/device/info.md index 4703a1b..726f24d 100644 --- a/device/info.md +++ b/device/info.md @@ -7,9 +7,7 @@ ## 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.](../faq/supported-devices.md) +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.](../faq/supported-devices.md) ## Command usage @@ -19,10 +17,9 @@ Aaru -d [true/false] -v [true/false] device info -h [true/false] -w [prefix] ` connects to an Aaru Remote Host with aaru:/// +`````` connects to an Aaru Remote Host with ```aaru://``` ## Example diff --git a/device/list.md b/device/list.md index b27cec0..6efc6bb 100644 --- a/device/list.md +++ b/device/list.md @@ -1,18 +1,23 @@ +# Table of Contents + +- [Command Description](#command-description) +- [Command usage](#command-usage) +- [Example](#example) +- [Operating system support](#operating-system-support) + ## Command description -This operation will show all known attached devices on your system and if they are supported for device dependent -operations. +This operation will show all known attached devices on your system and if they are supported for device dependent operations. ## Command usage -```aaru -d [true/false] -v [true/false] device list -h [true/false] ``` +```Aaru -d [true/false] -v [true/false] device list -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)* +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* `````` connects to an Aaru Remote Host with ```aaru://``` diff --git a/device/report.md b/device/report.md index 9fc1a72..cfd9488 100644 Binary files a/device/report.md and b/device/report.md differ diff --git a/faq/3rdparty.md b/faq/3rdparty.md index c2aef31..c1a54b5 100644 --- a/faq/3rdparty.md +++ b/faq/3rdparty.md @@ -7,10 +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 to not be so in some conditions (drive firmware bug?). -A CompactDisc data area starts from the Track 1 pregap (MSF 00:00:00, LBA -150) to the last Lead-out start, and Aaru -dumps from the Track 1 start (MSF 00:02:00, LBA 0) unless you want it to try to read the pregap (not all drives can read -it). +A CompactDisc data area starts from the Track 1 pregap (MSF 00:00:00, LBA -150) to the last Lead-out start, and Aaru dumps from the Track 1 start (MSF 00:02:00, LBA 0) unless you want it to try to read the pregap (not all drives can read it). diff --git a/faq/formats.md b/faq/formats.md index 799f2de..01ee000 100644 Binary files a/faq/formats.md and b/faq/formats.md differ diff --git a/faq/media-tags.md b/faq/media-tags.md index a72c384..cf972ee 100644 --- a/faq/media-tags.md +++ b/faq/media-tags.md @@ -1,6 +1,4 @@ -A media tag is data that accompany the media or the device, and is stored on the medium besides the user data, or -normally accessible. Media tags are usually used to store metadata about the medium, copy protection information, or -information about the device used to read the media. +A media tag is data that 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 diff --git a/faq/more.md b/faq/more.md index 267e5f4..a719fb4 100644 --- a/faq/more.md +++ b/faq/more.md @@ -1,13 +1,10 @@ # Why the name, why Aaru? -Aaru is the Ancient Egyptian concept of paradise where your soul would be rebirthed after the preservation of your -physical body. That's why we chose this name, because of the paradise where data will reside after it's has been -preserved from its original physical media. +Aaru is the Ancient Egyptian concept of paradise where your soul would be rebirthed after the preservation of your physical body. That's why we chose this name, because of the paradise where data will reside after it's has been preserved from its original physical media. # 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 2.0 runtime should work. Has been tested under Windows, Linux, Mac OS X and FreeBSD. # Will you support media dump image format XXXX? @@ -27,6 +24,5 @@ Of course, I invite you to use it extensively and provide me with as much feedba # I have tried Aaru and found a bug, how can I tell you? -Please don't send me an email, it will simply fall in oblivion. Github has a pretty nice bug tracker, just -click [Issues](https://github.com/aaru-dps/Aaru/issues) and create a New Issue, that way the bug will not be forgotten +Please don't send me an email, it will simply fall in oblivion. Github has a pretty nice bug tracker, just click [Issues](https://github.com/aaru-dps/Aaru/issues) and create a New Issue, that way the bug will not be forgotten and you can follow progress on its solution. diff --git a/faq/sector-tags.md b/faq/sector-tags.md index 9efaa17..dc539b3 100644 --- a/faq/sector-tags.md +++ b/faq/sector-tags.md @@ -1,6 +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/filesystem/extract.md b/filesystem/extract.md index 5823fe1..eb262fc 100644 --- a/filesystem/extract.md +++ b/filesystem/extract.md @@ -5,10 +5,9 @@ - [Example](#example) - [Operating system support](#operating-system-support) -## 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 and extract the files that are contained in [supported filesystems.](../faq/filesystems.md) ## Command usage @@ -18,14 +17,11 @@ Aaru -d [true/false] -v [true/false] filesystem extract -h [true/false] -e [enco `-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 ` specifies comma separated name=value pairs of options to pass to output filesystem -plugin +`-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 ` 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 ` specifies namespace to use for filenames +`-n, --namespace ` specifies namespace to use for filenames *(default varies by filesystem)* ## Example @@ -35,9 +31,7 @@ Aaru filesystem extract -x -e iso8859-15 mydisc.cue contents ## Operating system support -| OS | Supported | -|----|-----------| -| FreeBSD | Yes | -| macOS | Yes | -| Linux | Yes | -| Windows | Yes | +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | + diff --git a/filesystem/info.md b/filesystem/info.md index 7681ae6..2ebbeaf 100644 --- a/filesystem/info.md +++ b/filesystem/info.md @@ -10,14 +10,12 @@ and [supported filesystems](../faq/filesystems.md) on the dump, showing informat Aaru -d [true/false] -v [true/false] image analyze -h [true/false] -e [encoding] -f [true/false] -p [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) -`-e, --encoding [encoding]` sets which encoding is used by the contents of the media dump (default varies by -filesystem) -`-f, --filesystems [true/false]` searches and interprets filesystems (default true) -`-p, --partitions [true/false]` searches and interprets partitions (default true) +`-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)* +`-f, --filesystems [true/false]` searches and interprets filesystems *(default true)* +`-p, --partitions [true/false]` searches and interprets partitions *(default true)* ## Example @@ -27,9 +25,6 @@ Aaru image analyze mydisc.cue ## Operating system support -| OS | Supported | -|----|-----------| -| FreeBSD | Yes | -| macOS | Yes | -| Linux | Yes | -| Windows | Yes | +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | diff --git a/filesystem/ls.md b/filesystem/ls.md index 71d09aa..79d6a0a 100644 --- a/filesystem/ls.md +++ b/filesystem/ls.md @@ -1,30 +1,32 @@ ## 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 and list all the files that are contained in [supported filesystems](../faq/filesystems.md). ## Command usage -```aaru -d [true/false] -v [true/false] filesystem list -h [true/false] -e [encoding] -l [true/false]``` +```Aaru -d [true/false] -v [true/false] filesystem list -h [true/false] -e [encoding] -l [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)* +```-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)* +```-e, --encoding [encoding]``` sets which encoding is used by the contents of the media dump *(default varies by filesystem)* ```-l, --long [true/false]``` uses a long listing format, showing sizes and extended attributes *(default false)* +```-O, --options [options]``` comma separated name=value pairs of options to pass to filesystem plugin + +```-n, --namespace [namespace]``` namespace to use for filenames *(default varies by filesystem)* + ## Example -```aaru filesystem list -l -e x-mac-icelandic mydisc.cue``` +```Aaru filesystem list -l -e x-mac-icelandic mydisc.cue``` ## Operating system support |FreeBSD|macOS|Linux|Windows| |---|---|---|---| |Yes|Yes|Yes|Yes| + diff --git a/filesystem/options.md b/filesystem/options.md index 869b3dc..54f1c20 100644 --- a/filesystem/options.md +++ b/filesystem/options.md @@ -4,18 +4,17 @@ Lists all options supported by read-only filesystems. ## Command usage -```aaru -d [true/false] -v [true/false] filesystem options -h [true/false]``` +```Aaru -d [true/false] -v [true/false] filesystem options -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)* +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* ## Example -```aaru filesystem options``` +```Aaru filesystem options``` ## Operating system support diff --git a/image/checksum.md b/image/checksum.md index 835e3cd..0e0eba2 100644 --- a/image/checksum.md +++ b/image/checksum.md @@ -17,8 +17,7 @@ Aaru -d [true/false] -v [true/false] image checksum -h [true/false] -a [true/fal `-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)* +`-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)* @@ -38,14 +37,11 @@ false)* ## Example ```bash -Aaru image checksum -a false --sha512 true mydisc.cue +Aaru image checksum -f false --sha512 true mydisc.cue ``` ## Operating system support -| OS | Supported | -|----|-----------| -| FreeBSD | Yes | -| macOS | Yes | -| Linux | Yes | -| Windows | Yes | +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | diff --git a/image/compare.md b/image/compare.md index f0bc9f8..476af79 100644 --- a/image/compare.md +++ b/image/compare.md @@ -17,8 +17,7 @@ Aaru -d [true/false] -v [true/false] image compare -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)* +`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)* ## Example @@ -28,9 +27,6 @@ Aaru image compare mydisc.cue anotherdisc.mds ## Operating system support -| OS | Supported | -|----|-----------| -| FreeBSD | Yes | -| macOS | Yes | -| Linux | Yes | -| Windows | Yes | +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | diff --git a/image/convert.md b/image/convert.md index 04bb44a..fe88a1e 100644 --- a/image/convert.md +++ b/image/convert.md @@ -16,23 +16,18 @@ Aaru -d [true/false] -v [true/false] image convert -h [true/false] -c -- `-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)* +`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)* `-c, --count ` specifies how many sectors to convert at once *(default 64)* `--comments ` specifies image comments `--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-manufacturer ` specifies manufacturer of the drive used to read the media represented by the image `--drive-model ` specifies model of the drive used to read the media represented by the image -`--drive-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)* +`--drive-revision ` specifies firmware revision of the drive used to read the media represented by the image +`--drive-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 ` specifies barcode of the media represented by the image -`--media-lastsequence ` 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-lastsequence ` specifies last media of the sequence the media represented by the image corresponds to *(default 0)* +`--media-manufacturer ` specifies manufacturer of the media represented by the image `--media-model ` specifies model of the media represented by the image `--media-partnumber ` specifies part number of the media represented by the image `--media-sequence ` specifies number in sequence for the media represented by the image *(default 0)* @@ -42,11 +37,27 @@ to *(default 0)* `-p, --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 ` takes list of dump hardware from existing resume file + +`-g, --geometry ` force geometry, only supported in not tape block media. Specify as C/H/S + +`--fix-subchannel-position` store subchannel according to the sector they describe + +`--fix-subchannel` try to fix subchannel. Implies fixing subchannel position + +`--fix-subchannel-crc` If subchannel looks OK but CRC fails, rewrite it. Implies fixing subchannel + +`--generate-subchannels` generates missing subchannels + `-x, --cicm-xml ` 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 +Aaru image convert -c 32 --comments "My converted image" --creator "Jane Doe" --drive-manufacturer "LG" --drive-model "CD-RW 1234" --drive-revision "1.0" --drive-serial "AABBCCDDEEFF01" --media-lastsequence 2 --media-sequence 1 --media-title "Important software" -O "deduplicate=true,nocompress=false" -r dd_dump.resume.xml -x dd_dump.cicm.xml dd_dump.iso dump.aaruf ``` +## Operating system support + +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | diff --git a/image/create-sidecar.md b/image/create-sidecar.md index c823a92..4463139 100644 --- a/image/create-sidecar.md +++ b/image/create-sidecar.md @@ -7,9 +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 gotten about it, as well as all [supported checksum algorithms.](../faq/supported-checksums.md) ## Command usage @@ -19,14 +17,10 @@ Aaru -d [true/false] -v [true/false] image create-sidecar -h [true/false] -b [bl `-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)* +`-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 @@ -38,9 +32,7 @@ Aaru image create-sidecar -e shift_jis "My japanese software.img" ## Operating system support -| OS | Supported | -|----|-----------| -| FreeBSD | Yes | -| macOS | Yes | -| Linux | Yes | -| Windows | Yes | +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | + diff --git a/image/decode.md b/image/decode.md index 7823360..02c0613 100644 --- a/image/decode.md +++ b/image/decode.md @@ -7,9 +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) on a media dump image. ## Command usage @@ -19,8 +17,7 @@ Aaru -d [true/false] -v [true/false] image decode -h [true/false] -f [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)* +`-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)* @@ -34,9 +31,6 @@ Aaru image decode -s 1000 -l 15 -p false mydisc.cue ## Operating system support -| OS | Supported | -|----|-----------| -| FreeBSD | Yes | -| macOS | Yes | -| Linux | Yes | -| Windows | Yes | +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | diff --git a/image/entropy.md b/image/entropy.md index e4a746e..33b4563 100644 --- a/image/entropy.md +++ b/image/entropy.md @@ -7,8 +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 @@ -18,12 +17,9 @@ Aaru -d [true/false] -v [true/false] image entropy -h [true/false] -p [true/fals `-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)* +`-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 @@ -34,9 +30,6 @@ Aaru image entropy mydisc.cue ## Operating system support -| OS | Supported | -|----|-----------| -| FreeBSD | Yes | -| macOS | Yes | -| Linux | Yes | -| Windows | Yes | +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | diff --git a/image/info.md b/image/info.md index 5ba56cb..3486ed4 100644 --- a/image/info.md +++ b/image/info.md @@ -17,8 +17,7 @@ Aaru -d [true/false] -v [true/false] image info -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)* +`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)* ## Example @@ -28,9 +27,7 @@ Aaru image info mydisc.cue ## Operating system support -| OS | Supported | -|----|-----------| -| FreeBSD | Yes | -| macOS | Yes | -| Linux | Yes | -| Windows | Yes | +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | + diff --git a/image/options.md b/image/options.md index 531ead2..b1fe7e2 100644 --- a/image/options.md +++ b/image/options.md @@ -1,21 +1,27 @@ +# Table of Contents + +- [Command Description](#command-description) +- [Command usage](#command-usage) +- [Example](#example) +- [Operating system support](#operating-system-support) + ## Command description Lists all options supported by writable media images. ## Command usage -```aaru -d [true/false] -v [true/false] image options -h [true/false]``` +```Aaru -d [true/false] -v [true/false] image options -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)* +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* ## Example -```aaru image options``` +```Aaru image options``` ## Operating system support diff --git a/image/print.md b/image/print.md index 112bbd1..7668dab 100644 --- a/image/print.md +++ b/image/print.md @@ -7,8 +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 in the console of the chosen sector/block of the indicated media dump image. ## Command usage @@ -18,14 +17,11 @@ Aaru -d [true/false] -v [true/false] image print -h [true/false] -l [sectors] -r `-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)* +`-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)* +`-r, --long-sectors [true/false]` specifies if hex print should include all sector tags stored in the media dump *(default false)* `-s, --start ` 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)* +`-w, --width ` specifies how long the width, in characters, should the print be before creating a new line *(default 32)* ## Example @@ -35,9 +31,6 @@ 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 | +| FreeBSD | macOS | Linux | Windows | +| ------- | ----- | ----- | ------- | +| Yes | Yes | Yes | Yes | diff --git a/image/verify.md b/image/verify.md index c33f34d..fe8e962 100644 --- a/image/verify.md +++ b/image/verify.md @@ -1,12 +1,14 @@ ## 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 sectors/blocks format include a hash, checksum or error recovery system, it will calculate and compare them. ## Command usage -```aaru -d [true/false] -v [true/false] image verify -h [true/false] -s [true/false] -w [true/false] ``` +```bash +Aaru -d [true/false] -v [true/false] image verify -h [true/false] -s [true/false] -w [true/false] +``` + + ```-d, --debug [true/false]``` shows debug output *(default false)* @@ -22,7 +24,11 @@ dump *(default true)* ## Example -```aaru image verify mydisc.cue``` +```bash +Aaru image verify mydisc.cue +``` + + ## Operating system support diff --git a/media/dump.md b/media/dump.md index c549ca2..966cebc 100644 --- a/media/dump.md +++ b/media/dump.md @@ -7,9 +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, even with a different device. ## Command usage @@ -19,35 +17,56 @@ Aaru -d [true/false] -v [true/false] media dump -h [true/false] -e -f `-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)* +`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)* `-e, --encoding ` specifies character encoding to use when creating dump sidecar `-f, --force [true/false]` continues dumping whatever happens *(default false)* `-k, --skip ` 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)* + 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)* +`-r, --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 ` 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 ` 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 ` specifies format for the output image, as plugin name or plugin id. If not present, will try to -detect it from output image extension +`-t, --format ` 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 ` takes metadata from existing CICM XML sidecar -`--subchannel ` specifies which subchannel to dump. Only applicable to CD/GD. Values: any, rw, rw-or-pq, pq, -none *(default any)* -`--speed ` specifies at what speed to dump. Only applicable to optical drives, 0 for maximum *(default -0)* -`` connects to an Aaru Remote Host with aaru:/// +`--subchannel ` specifies which subchannel to dump. Only applicable to CD/GD. Values: any, rw, rw-or-pq, pq, none *(default any)* +`--speed ` specifies at what speed to dump. Only applicable to optical drives, 0 for maximum *(default 0)* + +```--private [true/false]``` do not store paths and serial numbers in log or metadata *(default false)* + +```--fix-subchannel-position [true/false]``` store subchannel according to the sector they describe *(default true*) + +```--retry-subchannel [true/false]``` retry subchannel. Implies fixing subchannel position *(default true)* + +```--fix-subchannel [true/false]``` try to fix subchannel. Implies fixing subchannel position *(default false)* + +```--fix-subchannel-crc [true/false]``` if subchannel looks OK but CRC fails, rewrite it. Implies fixing subchannel *(default false)* + +```--generate-subchannels [true/false]``` generates missing subchannels (they don't count as dumped in resume file). *(default false)* + +```--skip-cdiready-hole [true/false]``` skip the hole between data and audio in a CD-i Ready disc *(default ???)* + +```--eject [true/false]``` eject media after dump finishes *(default false)* + +```--max-blocks ``` maximum number of blocks to read at once *(default ???)* + +```--use-buffered-reads [true/false]``` for MMC/SD, use OS buffered reads if CMD23 is not supported *(default ???)* + +```--store-encrypted [true/false]``` store encrypted data as is *(default ???)* + +```--title-keys [true/false]``` try to read the title keys from CSS encrypted DVDs (very slow) *(default ???)* + +`` 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` +Windows: `Aaru media dump -f -p 0 --resume false \\.\PhysicalDrive3 mydisk.aaruf` ## Operating system support diff --git a/media/info.md b/media/info.md index e659345..aed07e9 100644 --- a/media/info.md +++ b/media/info.md @@ -7,9 +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 in a physical device. For information about supported physical devices check [the list of supported physical devices.](../faq/supported-devices.md) ## Command usage @@ -19,10 +17,9 @@ Aaru -d [true/false] -v [true/false] media info -h [true/false] -w [prefix] ` connects to an Aaru Remote Host with aaru:/// +`` connects to an Aaru Remote Host with ```aaru://``` ## Example