mirror of
https://github.com/aaru-dps/Aaru.Documentation.git
synced 2025-12-16 19:24:33 +00:00
Merge pull request #4 from PhynixHeart/master
Converts remaining MediaWiki files to Markdown.
This commit is contained in:
GitHub
23
5.0/List-files.md
Normal file
23
5.0/List-files.md
Normal file
@@ -0,0 +1,23 @@
|
||||
## Command description
|
||||
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
|
||||
```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)*
|
||||
|
||||
```-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)*
|
||||
|
||||
## Example
|
||||
```aaru filesystem list -l -e x-mac-icelandic mydisc.cue```
|
||||
|
||||
## Operating system support
|
||||
|FreeBSD|macOS|Linux|Windows|
|
||||
|---|---|---|---|
|
||||
|Yes|Yes|Yes|Yes|
|
||||
@@ -1,29 +0,0 @@
|
||||
==Command description==
|
||||
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 -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>-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 filesystem list -l -e x-mac-icelandic mydisc.cue</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Yes
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
22
5.0/List-filesystem-options.md
Normal file
22
5.0/List-filesystem-options.md
Normal file
@@ -0,0 +1,22 @@
|
||||
## Command description
|
||||
Lists all options supported by read-only filesystems.
|
||||
|
||||
|
||||
## Command usage
|
||||
```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)*
|
||||
|
||||
|
||||
## Example
|
||||
```aaru filesystem options```
|
||||
|
||||
## Operating system support
|
||||
|FreeBSD|macOS|Linux|Windows|
|
||||
|---|---|---|---|
|
||||
|Yes|Yes|Yes|Yes|
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
==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
|
||||
|}
|
||||
20
5.0/List-image-options.md
Normal file
20
5.0/List-image-options.md
Normal file
@@ -0,0 +1,20 @@
|
||||
## Command description
|
||||
Lists all options supported by writable media images.
|
||||
|
||||
## Command usage
|
||||
```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)*
|
||||
|
||||
|
||||
## Example
|
||||
```aaru image options```
|
||||
|
||||
## Operating system support
|
||||
|FreeBSD|macOS|Linux|Windows|
|
||||
|---|---|---|---|
|
||||
|Yes|Yes|Yes|Yes|
|
||||
@@ -1,27 +0,0 @@
|
||||
==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
|
||||
|}
|
||||
22
5.0/List-supported-devices.md
Normal file
22
5.0/List-supported-devices.md
Normal file
@@ -0,0 +1,22 @@
|
||||
## Command description
|
||||
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-remote-host>```
|
||||
|
||||
```-d, --debug [true/false]``` shows debug output *(default false)*
|
||||
|
||||
```-v, --verbose [true/false]``` shows verbose output *(default false)*
|
||||
|
||||
```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)*
|
||||
|
||||
```<aaru-remote-host>``` connects to an Aaru Remote Host with ```aaru://<IP ADDRESS>/<DEVICE PATH>```
|
||||
|
||||
## Example
|
||||
```aaru device list aaru://<IP ADDRESS>/<DEVICE PATH>```
|
||||
|
||||
## Operating system support
|
||||
|
||||
|FreeBSD|macOS|Linux|Windows|
|
||||
|---|---|---|---|
|
||||
|Yes|Yes|Yes|Yes|
|
||||
@@ -1,30 +0,0 @@
|
||||
==Command description==
|
||||
This operation will show all known attached devices on your system and if they are supported for device dependent operations.
|
||||
|
||||
==Command usage==
|
||||
<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 />
|
||||
<code><aaru-remote-host></code> connects to an Aaru Remote Host with aaru://<IP ADDRESS>/<DEVICE PATH><br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru device list aaru://<IP ADDRESS>/<DEVICE PATH></code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Not yet <ref name="macOS users">Support for MultiMedia devices in macOS will be added if users require it</ref>
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
|
||||
<references/>
|
||||
20
5.0/List-supported-encodings.md
Normal file
20
5.0/List-supported-encodings.md
Normal file
@@ -0,0 +1,20 @@
|
||||
## Command description
|
||||
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
|
||||
```aaru -d [true/false] -v [true/false] list-encodings -h [true/false]```
|
||||
|
||||
```-d, --debug [true/false]``` shows debug output *(default false)*
|
||||
|
||||
```-v, --verbose [true/false]``` shows verbose output *(default false)*
|
||||
|
||||
```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)*
|
||||
|
||||
|
||||
## Example
|
||||
```aaru list-encodings```
|
||||
|
||||
## Operating system support
|
||||
|FreeBSD|macOS|Linux|Windows|
|
||||
|---|---|---|---|
|
||||
|Yes|Yes|Yes|Yes|
|
||||
@@ -1,27 +0,0 @@
|
||||
==Command description==
|
||||
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 -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==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Yes
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
20
5.0/List-supported-formats.md
Normal file
20
5.0/List-supported-formats.md
Normal file
@@ -0,0 +1,20 @@
|
||||
## Command description
|
||||
This operation will list all filters, dump media formats, partitioning schemes and filesystems supported by your version of Aaru.
|
||||
|
||||
## Command usage
|
||||
```aaru -d [true/false] -v [true/false] formats -h [true/false]```
|
||||
|
||||
```-d, --debug [true/false]``` shows debug output *(default false)*
|
||||
|
||||
```-v, --verbose [true/false]``` shows verbose output *(default false)*
|
||||
|
||||
```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)*
|
||||
|
||||
|
||||
## Example
|
||||
```aaru formats```
|
||||
|
||||
## Operating system support
|
||||
|FreeBSD|macOS|Linux|Windows|
|
||||
|---|---|---|---|
|
||||
|Yes|Yes|Yes|Yes|
|
||||
@@ -1,27 +0,0 @@
|
||||
==Command description==
|
||||
This operation will list all filters, dump media formats, partinioning schemes and filesystems supported by your version of Aaru.
|
||||
|
||||
==Command usage==
|
||||
<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==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Yes
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
20
5.0/List-supported-namespaces.md
Normal file
20
5.0/List-supported-namespaces.md
Normal file
@@ -0,0 +1,20 @@
|
||||
## Command description
|
||||
This operation will list all the supported namespaces of the [[Filesystems-recognized-by-DiscImageChef|supported filesystems]].
|
||||
|
||||
## Command usage
|
||||
```aaru -d [true/false] -v [true/false] list-namespaces -h [true/false]```
|
||||
|
||||
```-d, --debug [true/false]``` shows debug output *(default false)*
|
||||
|
||||
```-v, --verbose [true/false]``` shows verbose output *(default false)*
|
||||
|
||||
```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)*
|
||||
|
||||
|
||||
## Example
|
||||
```aaru list-namespaces```
|
||||
|
||||
## Operating system support
|
||||
|FreeBSD|macOS|Linux|Windows|
|
||||
|---|---|---|---|
|
||||
|Yes|Yes|Yes|Yes|
|
||||
@@ -1,27 +0,0 @@
|
||||
==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
|
||||
|}
|
||||
BIN
5.0/Media-dump-formats-supported-by-Aaru.md
Normal file
BIN
5.0/Media-dump-formats-supported-by-Aaru.md
Normal file
Binary file not shown.
@@ -1,58 +0,0 @@
|
||||
== Disk images that can be read only ==
|
||||
* Apple Disk Archival/Retrieval Tool<ref name="nocompress">Compressed images are not supported yet</ref>
|
||||
* Apple New Disk Image Format<ref>Requires resource fork to be presented by any filter</ref><ref>Only supports images compressed with ADC algorithm</ref>
|
||||
* Apple NIB
|
||||
* BlindWrite 4
|
||||
* BlindWrite 5
|
||||
* CPCEMU Disk-File and Extended CPC Disk-File
|
||||
* D88 Disk Image
|
||||
* DataPackRat's d2f/f2d disk image format ("WC DISK IMAGE")
|
||||
* DIM Disk Image
|
||||
* DiscFerret<ref name="flux">Only supported for sidecar creation. No data is read from its contents</ref>
|
||||
* DiscJuggler
|
||||
* Dreamcast GDI image
|
||||
* Dunfield's IMD
|
||||
* HD-Copy disk image
|
||||
* KryoFlux STREAM<ref name="flux"/>
|
||||
* MAME Compressed Hunks of Data<ref name="nocompress"/>
|
||||
* Microsoft VHDX
|
||||
* Nero Burning ROM image
|
||||
* PartClone disk image
|
||||
* Partimage disk image
|
||||
* Spectrum Floppy Disk Image
|
||||
* SuperCardPro<ref name="flux"/>
|
||||
* Sydex CopyQM
|
||||
* Sydex TeleDisk
|
||||
|
||||
== Disk images that can be read and written ==
|
||||
* ACT Apricot Disk Image
|
||||
* Alcohol 120% Media Descriptor Structure
|
||||
* Anex86 Disk Image
|
||||
* Apple 2IMG
|
||||
* Apple ][ Interleaved Disk Image
|
||||
* Apple DiskCopy 4.2
|
||||
* Apple Universal Disk Image Format<ref>Only supports images compressed with ADC, bzip2 or zlib algorithms</ref>
|
||||
* Basic Lisa Utility
|
||||
* CDRDAO tocfile
|
||||
* CDRWin cuesheet
|
||||
* CisCopy Disk Image (DC-File)
|
||||
* CloneCD
|
||||
* Digital Research DiskCopy
|
||||
* Aaru format
|
||||
* IBM SaveDskF
|
||||
* MAXI Disk image
|
||||
* Parallels disk image
|
||||
* QEMU Copy-On-Write disk image
|
||||
* QEMU Copy-On-Write disk image v2
|
||||
* QEMU Enhanced Disk image
|
||||
* Raw Disk Image
|
||||
* Ray Arachelian's Disk IMage
|
||||
* RS-IDE Hard Disk Image
|
||||
* T98 Hard Disk Image
|
||||
* T98-Next NHD r0 Disk Image
|
||||
* Virtual98 Disk Image
|
||||
* VirtualBox Disk Image
|
||||
* VirtualPC
|
||||
* VMware disk image<ref name="nocompress"/>
|
||||
|
||||
<references/>
|
||||
@@ -1,47 +1,47 @@
|
||||
Welcome to the Aaru wiki.
|
||||
# Welcome to the Aaru wiki.
|
||||
|
||||
Aaru is a tool designed to handle different media dump formats (also called disc or disk images) and do common operations with them.
|
||||
|
||||
### What do you want to do?
|
||||
* [Analyze a media dump](Analyzing-a-media-dump.md)
|
||||
* [Get checksums or hashes from a dump](Getting-hashes-and-checksums-from-a-media-dump.md)
|
||||
* [Compare two media dumps](Comparing-two-media-dumps.md)
|
||||
* [Get information from a media dump](Getting-information-from-a-media-dump.md)
|
||||
* [Set which information will Aaru send to you](Configure-Aaru-statistics.md)
|
||||
* [Convert a media dump from one format to another](Convert-image.md)
|
||||
* [Create XML sidecar with metadata of a dump](Creating-metadata-sidecar-XML.md)
|
||||
* [Decode media tags and print them](Decoding-and-printing-media-tags.md)
|
||||
* [Get information from a physical device](Getting-information-from-a-physical-device.md)
|
||||
* [Test physical device capabilities and create an XML report of them](Reporting-physical-device-capabilities.mediawiki)
|
||||
* [Create a media dump from a physical device](Creating-a-dump-from-physical-media.md)
|
||||
* [Calculate entropy of a media dump](Calculate-dump-contents-entropy.md)
|
||||
* [Extract all files contained in a media dump](Extracting-files-from-a-media-dump.md)
|
||||
* [Get a list of all formats supported](List-supported-formats.mediawiki)
|
||||
* [Get a list of all supported physical devices](List-supported-devices.mediawiki)
|
||||
* [Get a list of all supported character set encodings](List-supported-encodings.mediawiki)
|
||||
* [List all files contained in a media dump](List-files.mediawiki)
|
||||
* [Lists all options supported by read-only filesystems](List-filesystem-options.mediawiki)
|
||||
* [Lists all options supported by writable media images](List-image-options.mediawiki)
|
||||
* [Show information about media inserted in a physical device](Getting-information-from-media-inserted-in-a-physical-device.md)
|
||||
* [Check readability of the media inserted in a physical device](Check-readability-of-the-media-inserted-in-a-physical-device.md)
|
||||
* [Get a hexadecimal print of a media dump sector or block](Get-a-hexadecimal-print-of-a-media-dump-sector-or-block.md)
|
||||
* [See my own usage statistics](Show-statistics.mediawiki)
|
||||
* [Update the master database](Update-database.mediawiki)
|
||||
* [Verify integrity of a media dump or its contents](Verifying-media-dump-integrity.mediawiki)
|
||||
* [Test the connection to an Aaru Remote Server](Testing-connection-to-remote-server.mediawiki)
|
||||
## What do you want to do?
|
||||
* [[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]]
|
||||
* [[Decoding-and-printing-media-tags.mediawiki|Decode media tags and print them]]
|
||||
* [[Getting-information-from-a-physical-device.mediawiki|Get information from a physical device]]
|
||||
* [[Reporting-physical-device-capabilities.mediawiki|Test physical device capabilities and create an XML report of them]]
|
||||
* [[Creating-a-dump-from-physical-media.mediawiki|Create a media dump from a physical device]]
|
||||
* [[Calculate-dump-contents-entropy.mediawiki|Calculate entropy of a media dump]]
|
||||
* [[Extracting-files-from-a-media-dump.mediawiki|Extract all files contained in a media dump]]
|
||||
* [[List-supported-formats.mediawiki|Get a list of all formats supported]]
|
||||
* [[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-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?
|
||||
* [Filters](Supported-filters.md)
|
||||
* [Media dump formats](Media-dump-formats-supported-by-Aaru.mediawiki)
|
||||
* [Partitioning schemes](Partitioning-schemes-recognized-by-Aaru.md)
|
||||
* [Filesystems](Filesystems-recognized-by-Aaru.md)
|
||||
* [Physical devices](Supported-devices.md)
|
||||
* [Checksum and hashes](Supported-checksums.md)
|
||||
* [Known media tags](Media-tags.md)
|
||||
* [Known sector/block tags](Sector-tags.md)
|
||||
## What is supported by Aaru?
|
||||
* [[Supported-filters.md|Filters]]
|
||||
* [[Media-dump-formats-supported-by-Aaru.mediawiki|Media dump formats]]
|
||||
* [[Partitioning-schemes-recognized-by-Aaru.md|Partitioning schemes]]
|
||||
* [[Filesystems-recognized-by-Aaru.md|Filesystems]]
|
||||
* [[Supported-devices.mediawiki|Physical devices]]
|
||||
* [[Supported-checksums.md|Checksum and hashes]]
|
||||
* [[Media-tags.md|Known media tags|]]
|
||||
* [[Sector-tags.md|Known sector/block tags]]
|
||||
|
||||
### [Comparing Aaru to similar software](Comparison.md)
|
||||
**[[Comparison.mediawiki|Comparing Aaru to similar software]]**
|
||||
|
||||
### [Frequently Asked Questions](Frequently-Asked-Questions.md)
|
||||
**[[Frequently-Asked-Questions.md|Frequently Asked Questions]]**
|
||||
|
||||
### [Bugs in other dumping software](Bugs-in-other-dumping-software.md)
|
||||
**[[Bugs-in-other-dumping-software.md|Bugs in other dumping software]]**
|
||||
|
||||
BIN
5.0/Reporting-physical-device-capabilities.md
Normal file
BIN
5.0/Reporting-physical-device-capabilities.md
Normal file
Binary file not shown.
@@ -1,80 +0,0 @@
|
||||
==Command description==
|
||||
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 https://www.aaru.app.
|
||||
|
||||
==Command usage==
|
||||
<code>Aaru -d [true/false] -v [true/false] device-report -h [true/false] <device-path/aaru-remote-host></code>
|
||||
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code><aaru-remote-host></code> connects to an Aaru Remote Host with aaru://<IP ADDRESS>/<DEVICE PATH><br />
|
||||
|
||||
==Example==
|
||||
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==
|
||||
{|
|
||||
! Device type
|
||||
! FreeBSD
|
||||
! macOS
|
||||
! Linux
|
||||
! Windows
|
||||
|-
|
||||
| SCSI Block device
|
||||
| Yes
|
||||
| No <ref name="macOS permissions">macOS only allows talking with MultiMedia devices</ref>
|
||||
| Yes
|
||||
| Yes
|
||||
|-
|
||||
| SCSI MultiMedia device
|
||||
| Yes
|
||||
| Not yet <ref name="macOS users">Support for MultiMedia devices in macOS will be added if users require it</ref>
|
||||
| Yes
|
||||
| Yes
|
||||
|-
|
||||
| SCSI Streaming device
|
||||
| Yes
|
||||
| No <ref name="macOS permissions"/>
|
||||
| Yes
|
||||
| Yes
|
||||
|-
|
||||
| Parallel ATA
|
||||
| No <ref name="FreeBSD bug">Not supported due to upstream bug</ref>
|
||||
| No <ref name="macOS permissions"/>
|
||||
| Yes
|
||||
| Yes
|
||||
|-
|
||||
| Serial ATA
|
||||
| Yes
|
||||
| No <ref name="macOS permissions"/>
|
||||
| Yes
|
||||
| Yes
|
||||
|-
|
||||
| USB
|
||||
| Partial <ref name="usb">USB descriptors are not retrieved</ref>
|
||||
| Partial <ref name="macOS">Only MultiMedia devices can be supported and descriptors will not be retrieved</ref>
|
||||
| Yes
|
||||
| Yes
|
||||
|-
|
||||
| FireWire
|
||||
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
|
||||
| Partial <ref name="macOS"/>
|
||||
| Yes
|
||||
| Partial <ref name="firewire">FireWire descriptors are not retrieved</ref>
|
||||
|-
|
||||
| PCMCIA
|
||||
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
|
||||
| Partial <ref name="macOS"/>
|
||||
| Yes
|
||||
| Partial <ref name="pcmcia">PCMCIA CIS is not retrieved</ref>
|
||||
|-
|
||||
| SecureDigital / MultiMediaCard
|
||||
| Not yet <ref name="FreeBSD sd">Support will come with FreeBSD 12-RELEASE</ref>
|
||||
| No <ref name="macOS permissions"/>
|
||||
| Yes
|
||||
| Untested <ref name="Windows sd">Should work, untested due to not available hardware</ref>
|
||||
|}
|
||||
|
||||
<references/>
|
||||
20
5.0/Show-statistics.md
Normal file
20
5.0/Show-statistics.md
Normal file
@@ -0,0 +1,20 @@
|
||||
## 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]```
|
||||
|
||||
```-d, --debug [true/false]``` shows debug output *(default false)*
|
||||
|
||||
```-v, --verbose [true/false]``` shows verbose output *(default false)*
|
||||
|
||||
```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)*
|
||||
|
||||
|
||||
## Example
|
||||
```aaru database stats```
|
||||
|
||||
## Operating system support
|
||||
| FreeBSD | macOS | Linux | Windows |
|
||||
|---|---|---|---|
|
||||
| Yes | Yes | Yes | Yes |
|
||||
@@ -1,27 +0,0 @@
|
||||
==Command description==
|
||||
This operation will show the statistics that have been stored locally on your environment.
|
||||
|
||||
==Command usage==
|
||||
<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==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Yes
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
23
5.0/Testing-connection-to-remote-server.md
Normal file
23
5.0/Testing-connection-to-remote-server.md
Normal file
@@ -0,0 +1,23 @@
|
||||
## Command description
|
||||
This operation tests the connection between Aaru and the specified Aaru Remote Server.
|
||||
|
||||
## Command usage
|
||||
```aaru -d [true/false] -v [true/false] remote -h [true/false] <aaru-remote-host>```
|
||||
|
||||
```-d, --debug [true/false]``` shows debug output *(default false)*
|
||||
|
||||
```-v, --verbose [true/false]``` shows verbose output *(default false)*
|
||||
|
||||
```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)*
|
||||
|
||||
```<aaru-remote-host>``` connects to an Aaru Remote Host with ```aaru://<IP ADDRESS>/<DEVICE PATH>```
|
||||
|
||||
|
||||
## Example
|
||||
```aaru remote aaru://<IP ADDRESS>/<DEVICE PATH>```
|
||||
|
||||
## Operating system support
|
||||
|
||||
| FreeBSD | macOS | Linux | Windows |
|
||||
|---|---|---|---|
|
||||
| Yes | Yes | Yes | Yes |
|
||||
@@ -1,28 +0,0 @@
|
||||
==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] <aaru-remote-host></code>
|
||||
|
||||
<code>-d, --debug [true/false]</code> shows debug output ''(default false)''<br />
|
||||
<code>-v, --verbose [true/false]</code> shows verbose output ''(default false)''<br />
|
||||
<code>-h, --help [true/false]</code> shows help screen for the command instead of running it, ignores all other switches ''(default false)''<br />
|
||||
<code><aaru-remote-host></code> connects to an Aaru Remote Host with aaru://<IP ADDRESS>/<DEVICE PATH><br />
|
||||
|
||||
==Example==
|
||||
<code>Aaru remote aaru://<IP ADDRESS>/<DEVICE PATH></code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Yes
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
24
5.0/Update-database.md
Normal file
24
5.0/Update-database.md
Normal file
@@ -0,0 +1,24 @@
|
||||
## Command description
|
||||
This operation will update the master database, and can optionalyl clear the master and local database.
|
||||
|
||||
## Command usage
|
||||
```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)*
|
||||
|
||||
```--clear [true/false]``` clears existing master database before updating *(default false)*
|
||||
|
||||
```--clear-all [true/false]``` clears existing master and local database before updating *(default false)*
|
||||
|
||||
## Example
|
||||
```aaru database update --clear-all```
|
||||
|
||||
## Operating system support
|
||||
|
||||
| FreeBSD | macOS | Linux | Windows |
|
||||
|---|---|---|---|
|
||||
| Yes | Yes | Yes | Yes |
|
||||
@@ -1,29 +0,0 @@
|
||||
==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
|
||||
|}
|
||||
28
5.0/Verifying-media-dump-integrity.md
Normal file
28
5.0/Verifying-media-dump-integrity.md
Normal file
@@ -0,0 +1,28 @@
|
||||
## 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.
|
||||
|
||||
## Command usage
|
||||
```aaru -d [true/false] -v [true/false] image verify -h [true/false] -s [true/false] -w [true/false] <image-path>```
|
||||
|
||||
```-d, --debug [true/false]``` shows debug output *(default false)*
|
||||
|
||||
```-v, --verbose [true/false]``` shows verbose output *(default false)*
|
||||
|
||||
```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)*
|
||||
|
||||
```-s, --verify-sectors [true/false]``` calculates and verifies the hash/checksum/ecc of every sector/block in the media dump *(default true)*
|
||||
|
||||
```-w, --verify-disc [true/false]``` calculates and verifies a media dump format checksum/hash *(default true)*
|
||||
|
||||
|
||||
## Example
|
||||
```aaru image verify mydisc.cue```
|
||||
|
||||
|
||||
## Operating system support
|
||||
|
||||
| FreeBSD | macOS | Linux | Windows |
|
||||
|---|---|---|---|
|
||||
| Yes | Yes | Yes | Yes |
|
||||
@@ -1,31 +0,0 @@
|
||||
==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.
|
||||
|
||||
==Command usage==
|
||||
<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>-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 image verify mydisc.cue</code>
|
||||
|
||||
==Operating system support==
|
||||
{|
|
||||
| FreeBSD
|
||||
| Yes
|
||||
|-
|
||||
| macOS
|
||||
| Yes
|
||||
|-
|
||||
| Linux
|
||||
| Yes
|
||||
|-
|
||||
| Windows
|
||||
| Yes
|
||||
|}
|
||||
Reference in New Issue
Block a user