mirror of
https://github.com/aaru-dps/Aaru.Documentation.git
synced 2025-12-16 19:24:33 +00:00
Update documentation for existing commands and add documentation for new commands
This commit is contained in:
SilasLaspada
@@ -2,17 +2,17 @@
|
||||
This operation will analyze a media dump, and if the format is recognized and you choose so, it will search for [[Partitioning-schemes-recognized-by-Aaru.md|supported partitioning schemes]] and [[Filesystems-recognized-by-Aaru.md|supported filesystems]] on the dump, showing information about them.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru analyze -d [true/false] -e [encoding] -f [true/false] -i <dump> -p [true/false] -v [true/false]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] image analyze -h [true/false] -e [encoding] -f [true/false] -p [true/false] <image-path></code>
|
||||
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-e, --encoding=[encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br />
|
||||
<code>-f, --filesystems=[true/false]</code> searches and interprets filesystems ''(default true)''
|
||||
<code>-i, --input=<dump></code> path to the media dump image<br />
|
||||
<code>-p, --partitions=[true/false]</code> searches and interprets partitions ''(default true)''<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-e, --encoding [encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br />
|
||||
<code>-f, --filesystems [true/false]</code> searches and interprets filesystems ''(default true)''
|
||||
<code>-p, --partitions [true/false]</code> searches and interprets partitions ''(default true)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru analyze -i mydisc.cue</code>
|
||||
<code>Aaru image analyze mydisc.cue</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,17 +2,17 @@
|
||||
This operation will calculate uniqueness and entropy of the media represented by a media dump image. It's not affected by the image format compression if applicable.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru entropy -d [true/false] -i <dump> -p [true/false] -t [true/false] -v [true/false] -w [true/false]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] image entropy -h [true/false] -p [true/false] -t [true/false] -w [true/false] <image-path></code>
|
||||
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-i, --input=<dump></code> path to the media dump image<br />
|
||||
<code>-p, --duplicated-sectors=[true/false]</code> besides entropy also calculates how many sectors have the exact same data in their user area ''(default true)''<br />
|
||||
<code>-t, --separated-tracks=[true/false]</code> separately calculates the entropy for each track dividing the media. Only applicable to certain kind of media (optical discs and digital tapes mostly) ''(default true)''<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-w, --whole-disc=[true/false]</code> calculates the entropy for the whole media ''(default true)''
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-p, --duplicated-sectors [true/false]</code> besides entropy also calculates how many sectors have the exact same data in their user area ''(default true)''<br />
|
||||
<code>-t, --separated-tracks true/false]</code> separately calculates the entropy for each track dividing the media. Only applicable to certain kind of media (optical discs and digital tapes mostly) ''(default true)''<br />
|
||||
<code>-w, --whole-disc [true/false]</code> calculates the entropy for the whole media ''(default true)''
|
||||
|
||||
==Example==
|
||||
<code>Aaru entropy -i mydisc.cue</code>
|
||||
<code>Aaru image entropy mydisc.cue</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,18 +2,18 @@
|
||||
This operation will read the media inserted in the physical device, and measure how fast it can be read sequentially. It's not intended as a benchmark, but as a detector of damaged sectors, sectors that are losing readability, etc. When finished it will check how fast can the device seek, and report speed statistics.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru media-scan -b [ibglog] -d [true/false] -i <device> -m [mhddlog] -v [true/false]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] media scan -h [true/false] -b [ibglog] -m [mhddlog] <device-path></code>
|
||||
|
||||
<code>-b, --ibg-log=[ibglog]</code> writes a log in the format used by ImgBurn<br />
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-i, --input=<dump></code> path to the physical device<br />
|
||||
<code>-m, --mhdd-log=[mhddlog]</code> writes a log in the format used by MHDD<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-b, --ibg-log [ibglog]</code> writes a log in the format used by ImgBurn<br />
|
||||
<code>-m, --mhdd-log [mhddlog]</code> writes a log in the format used by MHDD<br />
|
||||
|
||||
==Example==
|
||||
FreeBSD: <code>Aaru media-scan -i /dev/cd0</code><br />
|
||||
Linux: <code>Aaru media-scan -i /dev/sdb</code><br />
|
||||
Windows: <code>Aaru media-scan -i \\.\PhysicalDrive3</code><br />
|
||||
FreeBSD: <code>Aaru media scan /dev/cd0</code><br />
|
||||
Linux: <code>Aaru media scan /dev/sdb</code><br />
|
||||
Windows: <code>Aaru media scan \\.\PhysicalDrive3</code><br />
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,15 +2,14 @@
|
||||
This operation will compare two media dumps and print all differences between them. Dumps can be in different formats.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru verify -d [true/false] --input1=<dump1> --input2=<dump2> -v [true/false]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] image compare -h [true/false] <image-path1> <image-path2></code>
|
||||
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''
|
||||
<code>--input1=<dump1></code> path to the first media dump image<br />
|
||||
<code>--input2=<dump2></code> path to the second media dump image<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru compare --input1=mydisc.cue --input2=anotherdisc.mds</code>
|
||||
<code>Aaru image compare mydisc.cue anotherdisc.mds</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,7 +2,11 @@
|
||||
This command will ask you which statistics to gather and if you want to share them anonymously. When sharing, no information about you or your computer will be sent or stored, only the number of times a command have been used and the operating system where Aaru is run. This information is not, and will never be, sold to any third party, and is publicly available at www.aaru.app
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru configure</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] configure -h [true/false]</code>
|
||||
|
||||
<code>-d, --debug [true/false]</code> shows debug output from plugins ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru configure</code>
|
||||
|
||||
@@ -2,32 +2,31 @@
|
||||
This operation will convert a dump from one image format to another.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru convert-image -c <count> --comments=<comments> --creator=<creator> -d [true/false] --drive-manufacturer=<manufacturer> --drive-model=<model> --drive-revision=<revision> --drive-serial=<serial> -f [true/false] -i <source> --media-barcode=<barcode> --media-lastsequence=<number> --media-manufacturer=<manufacturer> --media-model=<model> --media-partnumber=<partnumber> --media-sequence=<sequence> --media-serial=<serial> --media-title=<title> -O <options> -o <target> -p <format> -r <resume file> -v [true/false] -x <xml sidecar></code>
|
||||
<code>Aaru -d [true/false] -v [true/false] image convert -h [true/false] -c <count> --comments <comments> --creator <creator> --drive-manufacturer manufacturer> --drive-model <model> --drive-revision <revision> --drive-serial <serial> -f [true/false] --media-barcode <barcode> --media-lastsequence <number> --media-manufacturer <manufacturer> --media-model <model> --media-partnumber <partnumber> --media-sequence <sequence> --media-serial <serial> --media-title <title> -O <options> -p <format> -r <resume file> -x <xml sidecar> <input-path> <output-path></code>
|
||||
|
||||
<code>-c, --count=<count></code> how many sectors to convert at once ''(default 64)''<br />
|
||||
<code>--comments=<comments></code> image comments<br />
|
||||
<code>--creator=<creator></code> who (person) created the image?<br />
|
||||
<code>-d, --debug=[true/false]</code> shows debug output from plugins ''(default false)''<br />
|
||||
<code>--drive-manufacturer=<manufacturer></code> manufacturer of the drive used to read the media represented by the image<br />
|
||||
<code>--drive-model=<model></code> model of the drive used to read the media represented by the image<br />
|
||||
<code>--drive-revision=<revision></code> firmware revision of the drive used to read the media represented by the image<br />
|
||||
<code>--drive-serial=<serial></code> serial number of the drive used to read the media represented by the image<br />
|
||||
<code>-f, --force=[true/false]</code> continue conversion even if sector or media tags will be lost in the process ''(default false)''<br />
|
||||
<code>-i, --input=<source></code> input image<br />
|
||||
<code>--media-barcode=<barcode></code> barcode of the media represented by the image<br />
|
||||
<code>--media-lastsequence=<number></code> last media of the sequence the media represented by the image corresponds to ''(default 0)''<br />
|
||||
<code>--media-manufacturer=<manufacturer></code> manufacturer of the media represented by the image<br />
|
||||
<code>--media-model=<model></code> model of the media represented by the image<br />
|
||||
<code>--media-partnumber=<partnumber></code> part number of the media represented by the image<br />
|
||||
<code>--media-sequence=<sequence></code> number in sequence for the media represented by the image ''(default 0)''<br />
|
||||
<code>--media-serial=<serial></code> serial number of the media represented by the image<br />
|
||||
<code>--media-title=<title></code> title of the media represented by the image<br />
|
||||
<code>-O, --options=<options></code> comma separated name=value pairs of options to pass to output image plugin<br />
|
||||
<code>-o, --output=<target></code> output image<br />
|
||||
<code>-p, --format=<format></code> format of the output image, as plugin name or plugin id. If not present, will try to detect it from output image extension<br />
|
||||
<code>-r, --resume-file=<resume file></code> take list of dump hardware from existing resume file<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-x, --cicm-xml=<xml sidecar></code> take metadata from existing CICM XML sidecar<br />
|
||||
<code>-d, --debug [true/false]</code> shows debug output from plugins ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-c, --count <count></code> specifies how many sectors to convert at once ''(default 64)''<br />
|
||||
<code>--comments <comments></code> specifies image comments<br />
|
||||
<code>--creator <creator></code> specifies who (person) created the image?<br />
|
||||
<code>--drive-manufacturer manufacturer></code> specifies manufacturer of the drive used to read the media represented by the image<br />
|
||||
<code>--drive-model <model></code> specifies model of the drive used to read the media represented by the image<br />
|
||||
<code>--drive-revision <revision></code> specifies firmware revision of the drive used to read the media represented by the image<br />
|
||||
<code>--drive-serial serial></code> specifies serial number of the drive used to read the media represented by the image<br />
|
||||
<code>-f, --force true/false]</code> continues conversion even if sector or media tags will be lost in the process ''(default false)''<br />
|
||||
<code>--media-barcode <barcode></code> specifies barcode of the media represented by the image<br />
|
||||
<code>--media-lastsequence <number></code> specifies last media of the sequence the media represented by the image corresponds to ''(default 0)''<br />
|
||||
<code>--media-manufacturer manufacturer></code> specifies manufacturer of the media represented by the image<br />
|
||||
<code>--media-model <model></code> specifies model of the media represented by the image<br />
|
||||
<code>--media-partnumber <partnumber></code> specifies part number of the media represented by the image<br />
|
||||
<code>--media-sequence <sequence></code> specifies number in sequence for the media represented by the image ''(default 0)''<br />
|
||||
<code>--media-serial <serial></code> specifies serial number of the media represented by the image<br />
|
||||
<code>--media-title <title></code> specifies title of the media represented by the image<br />
|
||||
<code>-O, --options <options></code> specifies comma separated name=value pairs of options to pass to output image plugin<br />
|
||||
<code>-p, --format <format></code> specifies format of the output image, as plugin name or plugin id. If not present, will try to detect it from output image extension<br />
|
||||
<code>-r, --resume-file <resume file></code> takes list of dump hardware from existing resume file<br />
|
||||
<code>-x, --cicm-xml <xml sidecar></code> takes metadata from existing CICM XML sidecar<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru convert-image -c 32 --comments="My converted image" --creator="Jane Doe" --drive-manufacturer="LG" --drive-model="CD-RW 1234" --drive-revision="1.0" --drive-serial="AABBCCDDEEFF01" -i dd_dump.iso --media-lastsequence=2 --media-sequence=1 --media-title="Important software" -O "deduplicate=true,nocompress=false" -o dump.dicf -r dd_dump.resume.xml -x dd_dump.cicm.xml</code>
|
||||
<code>Aaru image convert -c 32 --comments "My converted image" --creator "Jane Doe" --drive-manufacturer "LG" --drive-model "CD-RW 1234" --drive-revision "1.0" --drive-serial "AABBCCDDEEFF01" --media-lastsequence 2 --media-sequence 1 --media-title "Important software" -O "deduplicate=true,nocompress=false" -r dd_dump.resume.xml -x dd_dump.cicm.xml dd_dump.iso dump.dicf</code>
|
||||
|
||||
@@ -1,31 +1,33 @@
|
||||
==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 and an Alcohol 120% media descriptor for optical media. 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==
|
||||
<code>Aaru dump-media -d [true/false] -e <encoding> -f [true/false] -i <device path> -k <sectors> --lead-in [true/false] -m [true/false] --no-metadata [true/false] --no-trim [true/false] -O <options> -o <filename> --persistent [true/false] -p <passes> -s [true/false] -t <plugin> -v [true/false] -x <xml sidecar></code>
|
||||
<code>Aaru -d [true/false] -v [true/false] media dump -h [true/false] -e <encoding> -f [true/false] -k <sectors> --first-pregap [true/false] --fix-offset [true/false] -m [true/false] --metadata [true/false] --trim [true/false] -O <options> --persistent [true/false] -p <passes> -s [true/false] -t <plugin> -x <xml sidecar> --subchannel <subchannel> --speed <speed> <device-path> <output-path></code>
|
||||
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-e, --encoding=<encoding></code> character encoding to use when creating dump sidecar<br />
|
||||
<code>-f, --force=[true/false]</code> continuing dumping whatever happens ''(default false)''<br />
|
||||
<code>-i, --input=<device path></code> path to the physical device<br />
|
||||
<code>-k, --skip=<sectors></code> skip this many sectors when an unreadable sector is found ''(default 512)''<br />
|
||||
<code>--lead-in=[true/false]</code> try to dump Lead-in. Only applicable to CD, DDCD or GD media ''(default false)''<br />
|
||||
<code>-m, --resume=[true/false]</code> create and/or use resume mapfile ''(default true)''<br />
|
||||
<code>--no-metadata=[true/false]</code> disables creating CICM XML sidecar ''(default false)''<br />
|
||||
<code>--no-trim=[true/false]</code> disables trimming errores from skipped sectors ''(default false)''<br />
|
||||
<code>-O, --options=<options></code> comma separated name=value pairs of options to pass to output image plugin<br />
|
||||
<code>-o, --output=<filename></code> output image filename<br />
|
||||
<code>--persistent=[true/false]</code> try to recover partial or incorrect data ''(default false)''<br />
|
||||
<code>-p, --retry-passes=<passes></code> how many times to retry reading a sector ''(default 5)''<br />
|
||||
<code>-s, --stop-on-error=[true/false]</code> stops dumping on first error ''(default false)''<br />
|
||||
<code>-t, --format=<plugin></code> format for the output image, as plugin name or plugin id. If not present, will try to detect it from output image extension<br/>
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-x, --cicm-xml=<xml sidecar></code> take metadata from existing CICM XML sidecar<br />
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-e, --encoding <encoding></code> specifies character encoding to use when creating dump sidecar<br />
|
||||
<code>-f, --force [true/false]</code> continues dumping whatever happens ''(default false)''<br />
|
||||
<code>-k, --skip <sectors></code> skips this many sectors when an unreadable sector is found ''(default 512)''<br />
|
||||
<code>--first-pregap [true/false]</code> tries to dump first track pregap. Only applicable to CD, DDCD or GD media ''(default false)''<br />
|
||||
<code>--fix-offset [true/false]</code> fixes audio tracks offset. Only applicable to CD or GD media. ''(default false)''<br />
|
||||
<code>-m, --resume [true/false]</code> creates and/or use resume mapfile ''(default true)''<br />
|
||||
<code>--metadata [true/false]</code> enables creating CICM XML sidecar ''(default true)''<br />
|
||||
<code>--trim [true/false]</code> enables trimming errores from skipped sectors ''(default true)''<br />
|
||||
<code>-O, --options <options></code> specifies comma separated name=value pairs of options to pass to output image plugin<br />
|
||||
<code>--persistent [true/false]</code> tries to recover partial or incorrect data ''(default false)''<br />
|
||||
<code>-p, --retry-passes <passes></code> specifies how many times to retry reading a sector ''(default 5)''<br />
|
||||
<code>-s, --stop-on-error [true/false]</code> stops dumping on first error ''(default false)''<br />
|
||||
<code>-t, --format <plugin></code> specifies format for the output image, as plugin name or plugin id. If not present, will try to detect it from output image extension<br/>
|
||||
<code>-x, --cicm-xml <xml sidecar></code> takes metadata from existing CICM XML sidecar<br />
|
||||
<code>--subchannel <subchannel></code> specifies which subchannel to dump. Only applicable to CD/GD. Values: any, rw, rw-or-pq, pq, none ''(default any)''<br />
|
||||
<code>--speed <speed></code> specifies at what speed to dump. Only applicable to optical drives, 0 for maximum ''(default 0)''<br />
|
||||
|
||||
==Example==
|
||||
FreeBSD: <code>Aaru dump-media -i /dev/cd0 -f --persistent=true --separate-subchannel -w mydisc</code><br />
|
||||
Linux: <code>Aaru dump-media -i /dev/sdb -r -f -p 15 -w myusbfloppy</code><br />
|
||||
Windows: <code>Aaru dump-media -i \\.\PhysicalDrive3 -f -p 0 --resume=false mydisk</code><br />
|
||||
FreeBSD: <code>Aaru media dump -f --persistent true --separate-subchannel /dev/cd0 mydisc.cue</code><br />
|
||||
Linux: <code>Aaru media dump -r -f -p 15 /dev/sdb myusbfloppy.img</code><br />
|
||||
Windows: <code>Aaru media dump -f -p 0 --resume false \\.\PhysicalDrive3 mydisk.dicf</code><br />
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,19 +2,19 @@
|
||||
This operation will analyze a media dump, and if the format is recognized, create a CICM XML metadata sidecar with all information that can be automatically gotten about it, as well as all [[Supported-checksums.md|supported checksum algorithms]].
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru create-sidecar -b [block size] -d [true/false] -e [encoding] -i <dump> -t tape [true/false] -v [true/false]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] image create-sidecar -h [true/false] -b [block size] -e [encoding] -t tape [true/false] <image-path></code>
|
||||
|
||||
<code>-b, --block-size=[block size]</code> used only for tapes, indicates fixed block size in bytes. File in dump folder not multiple of this value will be ignored ''(default 512)''<br />
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-e, --encoding=[encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br />
|
||||
<code>-i, --input=<dump></code> path to the media dump image<br />
|
||||
<code>-t, --tape=[true/false]</code> indicates that dump points to a folder containing alphabetically sorted files extracted from a linear block-based tape with fixed block size (e.g. a SCSI streaming device) ''(default false)''<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-b, --block-size [block size]</code> used only for tapes, indicates fixed block size in bytes. File in dump folder not multiple of this value will be ignored ''(default 512)''<br />
|
||||
<code>-e, --encoding [encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br />
|
||||
<code>-t, --tape [true/false]</code> indicates that dump points to a folder containing alphabetically sorted files extracted from a linear block-based tape with fixed block size (e.g. a SCSI streaming device) ''(default false)''<br />
|
||||
|
||||
==Examples==
|
||||
<code>Aaru create-sidecar -i mydisc.cue</code><br />
|
||||
<code>Aaru create-sidecar -i mytapedir -t -b 1024</code><br />
|
||||
<code>Aaru create-sidecar -i "My japanese software.img" -e shift_jis</code><br />
|
||||
<code>Aaru image create-sidecar mydisc.cue</code><br />
|
||||
<code>Aaru image create-sidecar -t -b 1024 mytapedir</code><br />
|
||||
<code>Aaru image create-sidecar -e shift_jis "My japanese software.img"</code><br />
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,18 +2,18 @@
|
||||
This operation will decode all [[Sector-tags.md|sector tags]] and [[Media-tags.md|media tags]] on a media dump image.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru decode -d [true/false] -i <dump> -k [true/false] -l [sectors] -t [true/false] -s [start sector] -v [true/false]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] image decode -h [true/false] -f [true/false] -l [sectors] -p [true/false] -s [start sector] <image-path></code>
|
||||
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-i, --input=<dump></code> path to the media dump image<br />
|
||||
<code>-k, --disk-tags=[true/false]</code> decodes all [[Media-tags.md|media tags]] ''(default true)''<br />
|
||||
<code>-l, --length=[sectors]</code> how many sectors to decode or ''all'' to decode all ''(default all)''<br />
|
||||
<code>-t, --sector-tags=[true/false]</code> decodes all [[Sector-tags.md|sector tags]] ''(default true)''<br />
|
||||
<code>-s, --start=[start-sector]</code> starting sector ''(default 0)''<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-f, --disk-tags [true/false]</code> decodes all [[Media-tags.md|media tags]] ''(default true)''<br />
|
||||
<code>-l, --length [sectors]</code> how many sectors to decode or ''all'' to decode all ''(default all)''<br />
|
||||
<code>-p, --sector-tags [true/false]</code> decodes all [[Sector-tags.md|sector tags]] ''(default true)''<br />
|
||||
<code>-s, --start [start-sector]</code> starting sector ''(default 0)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru decode -i mydisc.cue -s 1000 -l 15 -t false</code>
|
||||
<code>Aaru image decode -s 1000 -l 15 -p false mydisc.cue</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,17 +2,18 @@
|
||||
This operation will analyze and find all filesystems in a media dump and extract the files that are contained in [[Filesystems-recognized-by-Aaru.md|supported filesystems]].
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru extract-files -d [true/false] -e [encoding] -i <dump> -o <output> -v [true/false] -x [true/false]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] filesystem extract -h [true/false] -e [encoding] -O <options> -x [true/false] -n <namespace></code>
|
||||
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-e, --encoding=[encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br />
|
||||
<code>-i, --input=<dump></code> path to the media dump image<br />
|
||||
<code>-o, --output=<output></code> directory where extracted file will be created. Must NOT exist.<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-x, --xattrs=[true/false]</code> extract extended attributes if present ''(default false)''<br />
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-e, --encoding [encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br />
|
||||
<code>-O, --options <options></code> specifies comma separated name=value pairs of options to pass to output filesystem plugin<br />
|
||||
<code>-x, --xattrs [true/false]</code> extracts extended attributes if present ''(default false)''<br />
|
||||
<code>-n, --namespace <namespace></code> specifies namespace to use for filenames<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru extract-files -i mydisc.cue -o contents -x -e iso8859-15</code>
|
||||
<code>Aaru extract-files -x -e iso8859-15 mydisc.cue contents</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,18 +2,18 @@
|
||||
This operation will print a hexadecimal dump in the console of the chosen sector/block of the indicated media dump image.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru printhex -d [true/false] -i <dump> -l [sectors] -r [true/false] -s <starting sector> -v [true/false] -w [width]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] image print -h [true/false] -l [sectors] -r [true/false] -s <starting sector> -w [width] <image-path></code>
|
||||
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-i, --input=<dump></code> path to the media dump image<br />
|
||||
<code>-l, --length=[sectors]</code> how many sectors to print ''(default 1)''<br />
|
||||
<code>-r, --long-sectors=[true/false]</code> if hex print should include all [[Sector-tags.md|sector tags]] stored in the media dump ''(default false)''<br />
|
||||
<code>-s, --start=<starting sector></code> starts the hexadecimal printing from this sector<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-w, --width=[width]</code> how width, in characters, should the print be before creating a new line ''(default 32)''
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-l, --length [sectors]</code> specifies how many sectors to print ''(default 1)''<br />
|
||||
<code>-r, --long-sectors [true/false]</code> specifies if hex print should include all [[Sector-tags.md|sector tags]] stored in the media dump ''(default false)''<br />
|
||||
<code>-s, --start <starting sector></code> starts the hexadecimal printing from this sector<br />
|
||||
<code>-w, --width [width]</code> specifies how long the width, in characters, should the print be before creating a new line ''(default 32)''
|
||||
|
||||
==Example==
|
||||
<code>Aaru printhex -i mydisc.cue -s 15 -l 30 -r -w 64</code>
|
||||
<code>Aaru image print -s 15 -l 30 -r -w 64 mydisc.cue</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,29 +2,29 @@
|
||||
This operation will calculate the checksums for the media represented by a media dump image.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru verify -a [true/false] -c [true/false] --crc16 [true/false] --crc64 [true/false] -d [true/false] -f [true/false] --fletcher16 [true/false] --fletcher32 [true/false] -i <dump> -m [true/false] --ripemd160 [true/false] -s [true/false] --sha256 [true/false] --sha384 [true/false] --sha512 [true/false] -t [true/false] -v [true/false] -w [true/false]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] image checksum -h [true/false] -a [true/false] --crc16 [true/false] -c [true/false] --crc64 [true/false] -f [true/false] --fletcher16 [true/false] --fletcher32 [true/false] -m [true/false] --ripemd160 [true/false] -s [true/false] --sha256 [true/false] --sha384 [true/false] --sha512 [true/false] -t [true/false] -w [true/false] <image-path></code>
|
||||
|
||||
<code>-a, --adler32=[true/false]</code> calculates the Adler-32 checksum ''(default true)''<br />
|
||||
<code>-c, --crc32=[true/false]</code> calculates the CRC32 checksum ''(default true)''<br />
|
||||
<code>--crc16=[true/false]</code> calculates the CRC16 checksum ''(default true)''<br />
|
||||
<code>--crc64=[true/false]</code> calculates the ECMA CRC64 checksum ''(default false)''<br />
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-f, --spamsum=[true/false]</code> calculates the SpamSum fuzzy hash ''(default true)''
|
||||
<code>--fletcher16=[true/false]</code> calculates the Fletcher-16 checksum ''(default false)''<br />
|
||||
<code>--fletcher32=[true/false]</code> calculates the Fletcher-32 checksum ''(default false)''<br />
|
||||
<code>-i, --input=<dump></code> path to the media dump image<br />
|
||||
<code>-m, --md5=[true/false]</code> calculates the MD5 hash ''(default true)''<br />
|
||||
<code>--ripemd160=[true/false]</code> calculates the RIPEMD160 hash ''(default false)''<br />
|
||||
<code>-s, --sha1=[true/false]</code> calculates the SHA1 hash ''(default true)''<br />
|
||||
<code>--sha256=[true/false]</code> calculates the SHA2 hash with 256-bit ''(default false)''<br />
|
||||
<code>--sha384=[†rue/false]</code> calculates the SHA2 hash with 384-bit ''(default false)''<br />
|
||||
<code>--sha512=[true/false]</code> calculates the SHA2 hash with 512-bit ''(default false)''<br />
|
||||
<code>-t, --separated-tracks=[true/false]</code> calculates each track checksum separately ''(default true)''<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-w, --whole-discs=[true/false]</code> calculates the whole media checksum ''(default true)''<br />
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-a, --adler32 [true/false]</code> calculates the Adler-32 checksum ''(default true)''<br />
|
||||
<code>--crc16 [true/false]</code> calculates the CRC16 checksum ''(default true)''<br />
|
||||
<code>-c, --crc32 [true/false]</code> calculates the CRC32 checksum ''(default true)''<br />
|
||||
<code>--crc64 [true/false]</code> calculates the ECMA CRC64 checksum ''(default false)''<br />
|
||||
<code>-f, --spamsum [true/false]</code> calculates the SpamSum fuzzy hash ''(default true)''
|
||||
<code>--fletcher16 [true/false]</code> calculates the Fletcher-16 checksum ''(default false)''<br />
|
||||
<code>--fletcher32 [true/false]</code> calculates the Fletcher-32 checksum ''(default false)''<br />
|
||||
<code>-m, --md5 [true/false]</code> calculates the MD5 hash ''(default true)''<br />
|
||||
<code>--ripemd160 [true/false]</code> calculates the RIPEMD160 hash ''(default false)''<br />
|
||||
<code>-s, --sha1 [true/false]</code> calculates the SHA1 hash ''(default true)''<br />
|
||||
<code>--sha256 [true/false]</code> calculates the SHA2 hash with 256-bit ''(default false)''<br />
|
||||
<code>--sha384 [†rue/false]</code> calculates the SHA2 hash with 384-bit ''(default false)''<br />
|
||||
<code>--sha512 [true/false]</code> calculates the SHA2 hash with 512-bit ''(default false)''<br />
|
||||
<code>-t, --separated-tracks [true/false]</code> calculates each track checksum separately ''(default true)''<br />
|
||||
<code>-w, --whole-discs [true/false]</code> calculates the whole media checksum ''(default true)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru checksum -i mydisc.cue -a false --sha512=true</code>
|
||||
<code>Aaru image checksum -a false --sha512 true mydisc.cue</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
27
Getting-information-from-a-media-dump.mediawiki
Normal file
27
Getting-information-from-a-media-dump.mediawiki
Normal file
@@ -0,0 +1,27 @@
|
||||
==Command description==
|
||||
This operation will request and show all information about the selected media dump.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru -d [true/false] -v [true/false] image info -h [true/false] <image-path></code>
|
||||
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false'')<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false'')<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru image info mydisc.cue</code><br />
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Yes
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
@@ -2,17 +2,17 @@
|
||||
This operation will request and show all information about a physical device. For information about supported physical devices check [[Supported-devices.mediawiki|the list of supported physical devices]].
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru device-info -d [true/false] -i <device> -v [true/false] -w [prefix]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] device info -h [true/false] -w [prefix] <device-path></code>
|
||||
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-i, --input=<dump></code> path to the physical device<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-w, --output-prefix=[prefix]</code> writes binary responses from device to that prefix
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-w, --output-prefix [prefix]</code> writes binary responses from device to that prefix<br />
|
||||
|
||||
==Example==
|
||||
FreeBSD: <code>Aaru device-info -i /dev/cd0</code><br />
|
||||
Linux: <code>Aaru device-info -i /dev/sda</code><br />
|
||||
Windows: <code>Aaru device-info -i D:</code><br />
|
||||
FreeBSD: <code>Aaru device info /dev/cd0</code><br />
|
||||
Linux: <code>Aaru device info /dev/sda</code><br />
|
||||
Windows: <code>Aaru device info D:</code><br />
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,17 +2,17 @@
|
||||
This operation will request and show all information about the inserted media in a physical device. For information about supported physical devices check [[Supported-devices.mediawiki|the list of supported physical devices]].
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru media-info -d [true/false] -i <device> -v [true/false] -w [prefix]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] media info -h [true/false] -w [prefix] <device-path></code>
|
||||
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false'')<br />
|
||||
<code>-i, --input=<device></code> path to the physical device<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false'')<br />
|
||||
<code>-w, --output-prefix=[prefix]</code> writes binary responses from device to that prefix
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false'')<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false'')<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-w, --output-prefix [prefix]</code> writes binary responses from device to that prefix<br />
|
||||
|
||||
==Example==
|
||||
FreeBSD: <code>Aaru media-info -i /dev/cd0</code><br />
|
||||
Linux: <code>Aaru media-info -i /dev/sdb</code><br />
|
||||
Windows: <code>Aaru media-info -i \\.\PhysicalDrive3</code><br />
|
||||
FreeBSD: <code>Aaru media info /dev/cd0</code><br />
|
||||
Linux: <code>Aaru media info /dev/sdb</code><br />
|
||||
Windows: <code>Aaru media info \\.\PhysicalDrive3</code><br />
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,16 +2,16 @@
|
||||
This operation will analyze and find all filesystems in a media dump and list all the files that are contained in [[Filesystems-recognized-by-Aaru.md|supported filesystems]].
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru ls -d [true/false] -e [encoding] -i <dump> -l [true/false] -v [true/false]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] filesystem list -h [true/false] -e [encoding] -l [true/false]</code>
|
||||
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-e, --encoding=[encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br />
|
||||
<code>-i, --input=<dump></code> path to the media dump image<br />
|
||||
<code>-l, --long=[true/false]</code> use a long listing format, showing sizes and extended attributes ''(default false)''<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-e, --encoding [encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br />
|
||||
<code>-l, --long [true/false]</code> uses a long listing format, showing sizes and extended attributes ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru ls -i mydisc.cue -l -e x-mac-icelandic</code>
|
||||
<code>Aaru filesystem list -l -e x-mac-icelandic mydisc.cue</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
27
List-filesystem-options.mediawiki
Normal file
27
List-filesystem-options.mediawiki
Normal file
@@ -0,0 +1,27 @@
|
||||
==Command description==
|
||||
Lists all options supported by read-only filesystems.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru -d [true/false] -v [true/false] filesystem options -h [true/false]</code>
|
||||
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru filesystem options</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Yes
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
27
List-image-options.mediawiki
Normal file
27
List-image-options.mediawiki
Normal file
@@ -0,0 +1,27 @@
|
||||
==Command description==
|
||||
Lists all options supported by writable media images.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru -d [true/false] -v [true/false] image options -h [true/false]</code>
|
||||
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru image options</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Yes
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
@@ -1,20 +0,0 @@
|
||||
==Command description==
|
||||
Lists all options supported by read-only filesystems and writable media images.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru list-options</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Yes
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
@@ -2,7 +2,14 @@
|
||||
This operation will show all known attached devices on your system and if they are supported for device dependent operations.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru list-devices</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] device list -h [true/false]<aaru-remote-host></code>
|
||||
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru device list "IP address of host running Aaru Remote"</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,7 +2,14 @@
|
||||
This operation will list all your character set encodings supported in your environment. This list depends on libraries installed on your system, so if an encoding is available in one environment there are no guarantees it will be available in another one.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru list-encodings</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] list-encodings -h [true/false]</code>
|
||||
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru list-encodings</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,7 +2,14 @@
|
||||
This operation will list all filters, dump media formats, partinioning schemes and filesystems supported by your version of Aaru.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru formats</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] formats -h [true/false]</code>
|
||||
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru formats</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
27
List-supported-namespaces.mediawiki
Normal file
27
List-supported-namespaces.mediawiki
Normal file
@@ -0,0 +1,27 @@
|
||||
==Command description==
|
||||
This operation will list all the supported namespaces of the [[Filesystems-recognized-by-DiscImageChef|supported filesystems]].
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru -d [true/false] -v [true/false] list-namespaces -h [true/false]</code>
|
||||
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru list-namespaces</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Yes
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
@@ -6,6 +6,7 @@ Aaru is a tool designed to handle different media dump formats (also called disc
|
||||
* [[Analyzing-a-media-dump.mediawiki|Analyze a media dump|]]
|
||||
* [[Getting-hashes-and-checksums-from-a-media-dump.mediawiki|Get checksums or hashes from a dump]]
|
||||
* [[Comparing-two-media-dumps.mediawiki|Compare two media dumps]]
|
||||
* [[Getting-information-from-a-media-dump.mediawiki|Get information from a media dump]]
|
||||
* [[Configure-Aaru-statistics.mediawiki|Set which information will Aaru send to you]]
|
||||
* [[Convert-image.mediawiki|Convert a media dump from one format to another]]
|
||||
* [[Creating-metadata-sidecar-XML.mediawiki|Create XML sidecar with metadata of a dump]]
|
||||
@@ -19,12 +20,15 @@ Aaru is a tool designed to handle different media dump formats (also called disc
|
||||
* [[List-supported-devices.mediawiki|Get a list of all supported physical devices]]
|
||||
* [[List-supported-encodings.mediawiki|Get a list of all supported character set encodings]]
|
||||
* [[List-files.mediawiki|List all files contained in a media dump]]
|
||||
* [[List-options.mediawiki|Lists all options supported by read-only filesystems and writable media images]]
|
||||
* [[List-filesystem-options.mediawiki|Lists all options supported by read-only filesystems]]
|
||||
* [[List-image-options.mediawiki|Lists all options supported by writable media images]]
|
||||
* [[Getting-information-from-media-inserted-in-a-physical-device.mediawiki|Show information about media inserted in a physical device]]
|
||||
* [[Check-readability-of-the-media-inserted-in-a-physical-device.mediawiki|Check readability of the media inserted in a physical device]]
|
||||
* [[Get-a-hexadecimal-print-of-a-media-dump-sector-or-block.mediawiki|Get a hexadecimal print of a media dump sector or block]]
|
||||
* [[Show-statistics.mediawiki|See my own usage statistics]]
|
||||
* [[Update-database.mediawiki|Update the master database]]
|
||||
* [[Verifying-media-dump-integrity.mediawiki|Verify integrity of a media dump or its contents]]
|
||||
* [[Testing-connection-to-remote-server.mediawiki| Test the connection to an Aaru Remote Server]]
|
||||
|
||||
'''What is supported by Aaru?'''
|
||||
* [[Supported-filters.md|Filters]]
|
||||
|
||||
@@ -2,16 +2,16 @@
|
||||
This operation will test a physical device for its read capabilities. If the media is removable, it will ask you to insert different media on it, as read capabilities vary with different media. The report will be saved in the executing directory, and sent to us. Shared reports can be seen in www.aaru.app.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru device-report -d [true/false] -i <device> -v [true/false]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] device-report -h [true/false] <device-path></code>
|
||||
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-i, --input=<dump></code> path to the physical device<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
FreeBSD: <code>Aaru device-report -i /dev/cd0</code><br />
|
||||
Linux: <code>Aaru device-report -i /dev/sdb</code><br />
|
||||
Windows: <code>Aaru device-report -i \\.\PhysicalDrive3</code><br />
|
||||
FreeBSD: <code>Aaru device-report /dev/cd0</code><br />
|
||||
Linux: <code>Aaru device-report /dev/sdb</code><br />
|
||||
Windows: <code>Aaru device-report \\.\PhysicalDrive3</code><br />
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
@@ -2,7 +2,14 @@
|
||||
This operation will show the statistics that have been stored locally on your environment.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru stats</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] database stats -h [true/false]</code>
|
||||
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru database stats</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
27
Testing-connection-to-remote-server.mediawiki
Normal file
27
Testing-connection-to-remote-server.mediawiki
Normal file
@@ -0,0 +1,27 @@
|
||||
==Command description==
|
||||
This operation tests the connection between Aaru and the specified Aaru Remote Server.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru -d [true/false] -v [true/false] remote -h [true/false] <host></code>
|
||||
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru remote "IP address of host running Aaru Remote"</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Yes
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
29
Update-database.mediawiki
Normal file
29
Update-database.mediawiki
Normal file
@@ -0,0 +1,29 @@
|
||||
==Command description==
|
||||
This operation will update the master database, and can optionalyl clear the master and local database.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru -d [true/false] -v [true/false] database update -h [true/false]</code>
|
||||
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>--clear [true/false]</code> clears existing master database before updating ''(default false)''<br />
|
||||
<code>-clear-all [true/false]</code> clears existing master and local database before updating ''(default false)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru database update --clear-all</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Yes
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
@@ -4,16 +4,16 @@ If the media dump format includes a hash or checksum, it will calculate and comp
|
||||
If the media sectors/blocks format include a hash, checksum or error recovery system, it will calculate and compare them.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru verify -d [true/false] -i <dump> -s [true/false] -v [true/false] -w [true/false]</code>
|
||||
<code>Aaru -d [true/false] -v [true/false] image verify -h [true/false] -s [true/false] -w [true/false] <image-path></code>
|
||||
|
||||
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-i, --input=<dump></code> path to the media dump image<br />
|
||||
<code>-s, --verify-sectors=[true/false]</code> calculates and verifies the hash/checksum/ecc of every sector/block in the media dump ''(default true)''<br />
|
||||
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-w, --verify-disc=[true/false]</code> calculates and verifies a media dump format checksum/hash ''(default true)''<br />
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code>-s, --verify-sectors [true/false]</code> calculates and verifies the hash/checksum/ecc of every sector/block in the media dump ''(default true)''<br />
|
||||
<code>-w, --verify-disc [true/false]</code> calculates and verifies a media dump format checksum/hash ''(default true)''<br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru verify -i mydisc.cue</code>
|
||||
<code>Aaru image verify mydisc.cue</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
|
||||
Reference in New Issue
Block a user