aaru-dps/Aaru.Documentation
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.Documentation.git synced 2026-07-08 17:56:14 +00:00
Code Issues 20 Packages Projects Releases Wiki Activity

Updated documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2026-04-10 01:23:25 +01:00
parent 40ffd312bc
commit ad9b036c76
44 changed files with 1124 additions and 582 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.idea/.gitignore generated vendored Normal file
View File

@@ -0,0 +1,2 @@
# Default ignored files
/.idea.Aaru.Documentation.dir/.idea/workspace.xml

1
Aaru_Anubis_icon.svg Normal file
View File

File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 6.0 MiB

11
_sidebar.md
View File

@@ -1,11 +1,20 @@
- [Getting started](/quickstart.md)
- Archives
- [Extract files from an archive](/archive/extract.md)
- [Get info about an archive](/archive/info.md)
- [List archive contents](/archive/list.md)
- Configuration
- [Database update](/database/update.md)
- [Default configuration](/configure.md)
- [Generate metadata schema](/metadata-schema.md)
- [Local statistics](/database/stats.md)
- [Test Aaru Remote connection](/remote.md)
- Devices
@@ -32,6 +41,8 @@
- [Get info about a media dump](/image/info.md)
- [Hexadecimal print of a media dump](/image/print.md)
- [List image options](/image/options.md)
- [Merge media dumps](/image/merge.md)
- [Write image metadata](/image/write-metadata.md)
- Media image contents

39
archive/extract.md Normal file
View File

@@ -0,0 +1,39 @@
# Table of Contents
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will extract the contents of an archive file to the selected output directory.
## Command usage
```text
USAGE:
aaru archive extract <path> <output> [OPTIONS]
ARGUMENTS:
<path> Archive file path
<output> Directory where extracted files will be created. Will abort if
it exists
OPTIONS:
-h, --help Prints help information
-e, --encoding Name of character encoding to use
-x, --xattrs Extract extended attributes if present
```
## Example
```bash
aaru archive extract example.zip output
```
## Operating system support
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

36
archive/info.md Normal file
View File

@@ -0,0 +1,36 @@
# Table of Contents
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will show information about the selected archive file and the format Aaru detected for it.
## Command usage
```text
USAGE:
aaru archive info <path> [OPTIONS]
ARGUMENTS:
<path> Archive file path
OPTIONS:
-h, --help Prints help information
-e, --encoding Name of character encoding to use
```
## Example
```bash
aaru archive info example.zip
```
## Operating system support
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

37
archive/list.md Normal file
View File

@@ -0,0 +1,37 @@
# Table of Contents
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will list the contents of the selected archive file.
## Command usage
```text
USAGE:
aaru archive list <path> [OPTIONS]
ARGUMENTS:
<path> Archive file path
OPTIONS:
-h, --help Prints help information
-e, --encoding Name of character encoding to use
-l, --long-format Use long format
```
## Example
```bash
aaru archive list example.zip
```
## Operating system support
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

1
codealike.json Normal file
View File

@@ -0,0 +1 @@
{"projectId":"5829a980-3441-11f1-93d9-a924c58c4388","projectName":"Aaru.Documentation"}

29
configure.md
View File

@@ -1,11 +1,11 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
## Command description
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
@@ -14,23 +14,26 @@ available at [https://www.aaru.app](https://www.aaru.app)
## Command usage
```bash
Aaru -d [true/false] -v [true/false] configure -h [true/false]
```
```text
USAGE:
aaru configure [OPTIONS]
`-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)*
OPTIONS:
-h, --help Prints help information
-v, --verbose Shows verbose output
-d, --debug Shows debug output from plugins
--logfile <PATH> Path to log file
--pause Pauses before exiting
```
## Example
```bash
Aaru configure
aaru configure
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

27
database/stats.md
View File

@@ -1,6 +1,6 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
@@ -11,23 +11,22 @@ This operation will show the statistics that have been stored locally in your en
## Command usage
```text
USAGE:
aaru database stats [OPTIONS]
OPTIONS:
-h, --help Prints help information
```
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```
```bash
aaru database stats
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

32
database/update.md
View File

@@ -1,6 +1,6 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
@@ -11,26 +11,24 @@ This operation will update the master database and optionally clear the master a
## Command usage
```bash
Aaru -d [true/false] -v [true/false] database update -h [true/false]
```text
USAGE:
aaru database update [OPTIONS]
OPTIONS:
-h, --help Prints help information
--clear Clear existing main database
--clear-all Clear existing main and local database
```
```-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```
```bash
aaru database update --clear-all
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

52
device/info.md
View File

@@ -1,52 +1,38 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
## Command description
This operation will request and show all information about a physical device. For information about supported physical devices check [the list of supported physical devices.](../faq/supported-devices.md)
## Command usage
```bash
Aaru -d [true/false] -v [true/false] device info -h [true/false] -w [prefix] <device-path/aaru-remote-host>
```
```text
USAGE:
aaru device info <device-path> [OPTIONS]
`-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)*
`-w, --output-prefix [prefix]` writes binary responses from device to that prefix
```<aaru-remote-host>``` connects to an Aaru Remote Host with ```aaru://<IP ADDRESS>```
ARGUMENTS:
<device-path> Device path
OPTIONS:
-h, --help Prints help information
-w, --output-prefix Prefix for saving binary information from device
```
## Example
FreeBSD: `Aaru device info /dev/cd0`
Linux: `Aaru device info /dev/sda`
Windows: `Aaru device info D:`
```bash
aaru device info /dev/rdisk2
```
## Operating system support
| Device Type | FreeBSD | MacOS | Linux | Windows |
|--------------|----------|--------|--------|----------|
| SCSI Block device | Yes | No¹ | Yes | Yes |
| SCSI MultiMedia device | Yes | Not yet² | Yes | Yes |
| SCSI Streaming device | Yes | No¹ | Yes | Yes |
| Parallel ATA | No³ | No¹ | Yes | Yes |
| Serial ATA | Yes | No¹ | Yes | Yes |
| USB | Partial⁴ | Partial⁵ | Yes | Yes |
| FireWire | Partial⁶ | Partial⁵ | Yes | Partial⁶ |
| PCMCIA | Partial⁷ | Partial⁵ | Yes | Partial⁷ |
| SecureDigital / MultiMediaCard | Not yet⁸ | No¹ | Yes | Untested⁹ |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| No¹ | Yes | Yes |
1. macOS only allows talking with MultiMedia devices.
2. Support for MultiMedia devices in macOS will be added if users require it
3. Not supported due to upstream bug
4. USB descriptors are not retrieved
5. Only MultiMedia devices can be supported and descriptors will not be retrieved
6. FireWire descriptors are not retrieved
7. PCMCIA CIS is not retrieved
8. Support will come with FreeBSD 12-RELEASE
9. Should work, untested due to no available hardware
1. Device info and other device-access commands are not currently supported on macOS.

29
device/list.md
View File

@@ -1,6 +1,6 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
@@ -11,22 +11,27 @@ This operation will show all known attached devices on your system and if they a
## Command usage
```Aaru -d [true/false] -v [true/false] device list -h [true/false] <aaru-remote-host>```
```text
USAGE:
aaru device list [aaru-remote-host] [OPTIONS]
```-d, --debug [true/false]``` shows debug output *(default false)*
ARGUMENTS:
[aaru-remote-host] aaruremote host
```-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>```
OPTIONS:
-h, --help Prints help information
```
## Example
```aaru device list aaru://192.168.1.25```
```bash
aaru device list
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| No¹ | Yes | Yes |
1. Device list and other device-access commands are not currently supported on macOS.

3
docs/README.md
View File

@@ -59,8 +59,7 @@ Features
* Can create standard open XML metadata from existing images.
* Can measure readability and speed of media (same that can be dumped, MHDD style)
* Has an online database with drive capabilities, and can report the capabilities of any drive.
* Works on any operating system and architecture where .NET Core is supported (drive access requires Windows, Linux or
FreeBSD).
* Works on any operating system and architecture where .NET Core is supported (device access currently requires Linux or Windows).
* Has a graphical interface (work in progress)
Supported disk image formats (read-only)

2
faq/comparison.md
View File

@@ -21,7 +21,7 @@ In this page you can find a comparison between Aaru and other dump image manager
| Supports position based copy protections | Not yet¹³ | No | No | No | Yes | No | No |
| Supports dumping DDCD | Yes | No¹⁴ | No¹⁴ | No¹⁴ | No¹⁴ | No¹⁴ | No¹⁴ |
| Supports dumping GD | Not yet¹⁵ | Yes | No | No | No | No | No |
| Supports dumping GameCube/Wii | Not yet¹⁵ | Yes | No | No | No | No | No |
| Supports dumping GameCube/Wii | Yes | Yes | No | No | No | No | No |
| Supports dumping DVD¹⁶ ¹⁷ | Yes | Partial¹⁸ | No | No | Partial¹⁸ | Partial¹⁸ | Partial¹⁸ |
| Supports dumping HD DVD¹⁶ | Yes | Partial¹⁹ | No | No | Partial¹⁹ | Partial¹⁹ | Partial¹⁹ |
| Supports dumping Blu- ray¹⁶ ²⁰ | Yes | Yes | No | No | Yes | Yes | Yes |

66
faq/filesystems.md
View File

@@ -1,43 +1,42 @@
## Supported file systems for read-only operations
# Filesystems recognized by Aaru
* Apple DOS file system
* Apple Lisa file system
* Apple Macintosh File System (MFS)
* CP/M file system
* U.C.S.D Pascal file system
## Fully supported file systems
## Supported file systems for identification and information only
These file systems currently support both identification and extraction:
* 3DO Opera file system
* Acer File System (AFS)
* Acorn Advanced Disc Filing System
* Alexander Osipov DOS (AO-DOS for Electronika BK-0011) file system
* Amiga Fast File System v2, untested
* Amiga Fast File System, with international characters, directory cache and multi-user patches
* Amiga Original File System, with international characters, directory cache and multi-user patches
* Apple File System (preliminary detection until on-disk layout is stable)
* Apple DOS file system
* Apple Lisa file system
* Apple Hierarchical File System (HFS)
* Apple Hierarchical File System+ (HFS+)
* Apple Macintosh File System (MFS)
* Apple ProDOS / SOS file system
* AtheOS file system
* B-tree file system (btrfs)
* BeOS filesystem
* BeOS (old) filesystem
* BSD Fast File System (FFS) / Unix File System (UFS)
* BSD Unix File System 2 (UFS2)
* BeOS filesystem
* CD-i file system
* Coherent UNIX file system
* Commodore 1540/1541/1571/1581 filesystems
* CP/M file system
* Coherent UNIX file system
* Cram file system
* DEC Files-11 (also known as ODS)
* DEC RT-11 file system
* DEC Files-11 (only checked with On Disk Structure 2, ODS-2)
* dump(8) (Old historic BSD, AIX, UFS and UFS2 types)
* ECMA-67: 130mm Flexible Disk Cartridge Labelling and File Structure for Information Interchange
* Extended Acer File System (EAFS)
* Flash-Friendly File System (F2FS)
* Fossil file system (from Plan9)
* HAMMER file system
* High Sierra Format
* High Performance Optical File System (HPOFS)
* HP Logical Interchange Format
* IBM Journaling File System (JFS)
* ISO9660
* ISO9660, including Apple, Amiga, Rock Ridge, Joliet and Romeo extensions
* Linux extended file system
* Linux extended file system 2
* Linux extended file system 3
@@ -48,29 +47,42 @@
* Microsoft 16-bit File Allocation Table (FAT16)
* Microsoft 32-bit File Allocation Table (FAT32), including FAT+ extension
* Microsoft Extended File Allocation Table (exFAT)
* Microsoft New Technology File System (NTFS)
* Microsoft/IBM High Performance File System (HPFS)
* Minix v2 file system
* Minix v3 file system
* NEC PC-Engine file system
* Microsoft New Technology File System (NTFS)
* Minix v1/v2/v3 file systems
* NILFS2
* Nintendo optical filesystems (GameCube and Wii)
* OS-9 Random Block File
* Professional File System
* QNX4 and QNX6 filesystems
* Reiser file systems
* QNX4 filesystems
* QNX6 filesystems
* Reiser v3 file systems
* Reiser v4 file system
* SGI Extent File System (EFS)
* SGI XFS
* SmartFileSystem
* SolarOS file system
* Squash file system
* UNICOS file system
* U.C.S.D Pascal file system
* Universal Disk Format (UDF)
* UNIX boot file system
* UNIX System V file system
* UNIX Version 7 file system
* Universal Disk Format (UDF)
* UnixWare boot file system
* VMware file system (VMFS)
* Veritas file system
* Xbox filesystems
* Xenix file system
* Xia filesystem
## Supported file systems for identification and information only
* Amiga Fast File System v2 (untested)
* Apple File System (preliminary detection until the on-disk layout is stable)
* `dump(8)` (old historic BSD, AIX, UFS and UFS2 types)
* Fossil file system (from Plan9)
* HAMMER file system
* Microsoft Resilient File System (ReFS)
* NEC PC-Engine executable
* NEC PC-FX executable
* SolarOS file system
* UNICOS file system
* VMware file system (VMFS)
* Zettabyte File System (ZFS)

BIN
faq/formats.md
View File

Binary file not shown.

2
faq/more.md
View File

@@ -4,7 +4,7 @@ Aaru is the Ancient Egyptian concept of paradise where your soul would be rebirt
# Which operating systems does Aaru work under?
Any operating system with a .NET Core 3.1 runtime should work. Has been tested under Windows, Linux, Mac OS X, and FreeBSD.
Any operating system with a .NET 10 runtime should work. It has been tested under Windows, Linux, and macOS.
# Will you support media dump image format XXXX?

5
faq/partitions.md
View File

@@ -1,4 +1,7 @@
## Partitions
# Partitions recognized by Aaru
The following partitioning schemes are currently documented as supported by Aaru.
* Acorn Linux and RISCiX partitions
* ACT Apricot partitions

35
faq/supported-devices.md
View File

@@ -2,24 +2,21 @@ The following physical devices are supported:
## Operating system support
| Device Type | FreeBSD | MacOS | Linux | Windows |
|--------------|----------|--------|--------|----------|
| SCSI Block device | Yes | No¹ | Yes | Yes |
| SCSI MultiMedia device | Yes | Not yet² | Yes | Yes |
| SCSI Streaming device | Yes | No¹ | Yes | Yes |
| Parallel ATA | No³ | No¹ | Yes | Yes |
| Serial ATA | Yes | No¹ | Yes | Yes |
| USB | Partial⁴ | Partial⁵ | Yes | Yes |
| FireWire | Partial⁶ | Partial⁵ | Yes | Partial⁶ |
| PCMCIA | Partial⁷ | Partial⁵ | Yes | Partial⁷ |
| SecureDigital / MultiMediaCard | Not yet⁸ | No¹ | Yes | Untested⁹ |
| Device Type | macOS | Linux | Windows |
|-------------|-------|-------|---------|
| SCSI Block device | No¹ | Yes | Yes |
| SCSI MultiMedia device | Not yet² | Yes | Yes |
| SCSI Streaming device | No¹ | Yes | Yes |
| Parallel ATA | No¹ | Yes | Yes |
| Serial ATA | No¹ | Yes | Yes |
| USB | Not yet³ | Yes | Yes |
| FireWire | Not yet³ | Yes | Partial⁴ |
| PCMCIA | Not yet³ | Yes | Partial⁵ |
| SecureDigital / MultiMediaCard | No¹ | Yes | Untested⁶ |
1. macOS only allows talking with MultiMedia devices.
2. Support for MultiMedia devices in macOS will be added if users require it
3. Not supported due to upstream bug
4. USB descriptors are not retrieved
5. Only MultiMedia devices can be supported and descriptors will not be retrieved
6. FireWire descriptors are not retrieved
7. PCMCIA CIS is not retrieved
8. Support will come with FreeBSD 12-RELEASE
9. Should work, untested due to no available hardware
2. Support for MultiMedia devices in macOS will be added if users require it.
3. Only MultiMedia devices can be supported and descriptors will not be retrieved.
4. FireWire descriptors are not retrieved.
5. PCMCIA CIS is not retrieved.
6. Should work, but it remains untested due to lack of hardware.

39
filesystem/extract.md
View File

@@ -1,6 +1,6 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
@@ -11,27 +11,34 @@ This operation will analyze and find all filesystems in a media dump, then extra
## Command usage
```bash
Aaru -d [true/false] -v [true/false] filesystem extract -h [true/false] -e [encoding] -O <options> -x [true/false] -n <namespace>
```
```text
USAGE:
aaru filesystem extract <image-path> <output-dir> [OPTIONS]
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-e, --encoding [encoding]` sets which encoding is used by the contents of the media dump *(default varies by filesystem)*
`-O, --options <options>` specifies comma separated name=value pairs of options to pass to output filesystem plugin
`-x, --xattrs [true/false]` extracts extended attributes if present *(default false)*
`-n, --namespace <namespace>` specifies namespace to use for filenames *(default varies by filesystem)*
ARGUMENTS:
<image-path> Media image path
<output-dir> Directory where extracted files will be created. Will abort
if it exists
OPTIONS:
-h, --help Prints help information
-e, --encoding Name of character encoding to use
-O, --options Comma separated name=value pairs of options to pass to
filesystem plugin
-x, --xattrs Extract extended attributes if present
--volume Extract only from the specified volume number
(0-indexed). If not specified, extracts from all volumes
-n, --namespace Namespace to use for filenames
```
## Example
```bash
Aaru filesystem extract -x -e iso8859-15 mydisc.cue contents
aaru filesystem extract example.iso output
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

44
filesystem/info.md
View File

@@ -1,30 +1,40 @@
# Analyzing a media dump
# Table of Contents
This operation will analyze a media dump and if the format is recognized (and you choose so), it will search
for [supported partitioning schemes](/faq/partitions.md)
and [supported filesystems](/faq/filesystems.md) on the dump, showing information about them.
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will open a disc image and print information about the partitions and filesystems found inside it.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image analyze -h [true/false] -e [encoding] -f [true/false] -p [true/false] <image-path>
```
```text
USAGE:
aaru filesystem info <image-path> [OPTIONS]
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-e, --encoding [encoding]` sets which encoding is used by the contents of the media dump *(default varies by filesystem)*
`-f, --filesystems [true/false]` searches and interprets filesystems *(default true)*
`-p, --partitions [true/false]` searches and interprets partitions *(default true)*
ARGUMENTS:
<image-path> Media image path
OPTIONS:
DEFAULT
-h, --help Prints help information
-e, --encoding Name of character encoding to use
-p, --partitions True Searches and interprets partitions
-f, --filesystems True Searches and prints information about
filesystems
```
## Example
```bash
Aaru image analyze mydisc.cue
aaru filesystem info example.iso
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

42
filesystem/ls.md
View File

@@ -1,31 +1,39 @@
# Table of Contents
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will analyze and find all filesystems in a media dump, then list all the files that are contained in [supported filesystems](../faq/filesystems.md).
## Command usage
```Aaru -d [true/false] -v [true/false] filesystem list -h [true/false] -e [encoding] -l [true/false]```
```text
USAGE:
aaru filesystem list <image-path> [OPTIONS]
```-d, --debug [true/false]```shows debug output *(default false)*
ARGUMENTS:
<image-path> Media image path
```-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)*
```-O, --options [options]``` comma separated name=value pairs of options to pass to filesystem plugin
```-n, --namespace [namespace]``` namespace to use for filenames *(default varies by filesystem)*
OPTIONS:
-h, --help Prints help information
-e, --encoding Name of character encoding to use
-O, --options Comma separated name=value pairs of options to pass to
filesystem plugin
-n, --namespace Namespace to use for filenames
```
## Example
```Aaru filesystem list -l -e x-mac-icelandic mydisc.cue```
```bash
aaru filesystem list example.iso
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

31
filesystem/options.md
View File

@@ -1,23 +1,32 @@
# Table of Contents
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
Lists all options supported by read-only filesystems.
This operation will list all options supported by the read-only filesystem plugins recognized by Aaru.
## Command usage
```Aaru -d [true/false] -v [true/false] filesystem options -h [true/false]```
```text
USAGE:
aaru filesystem options [OPTIONS]
```-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)*
OPTIONS:
-h, --help Prints help information
```
## Example
```Aaru filesystem options```
```bash
aaru filesystem options example.iso
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

34
formats.md
View File

@@ -1,3 +1,10 @@
# Table of Contents
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will list all filters, dumpable media formats, partitioning schemes, and filesystems supported by your version
@@ -5,21 +12,26 @@ of Aaru.
## Command usage
```aaru -d [true/false] -v [true/false] formats -h [true/false]```
```text
USAGE:
aaru formats [OPTIONS]
```-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)*
OPTIONS:
-h, --help Prints help information
-v, --verbose Shows verbose output
-d, --debug Shows debug output from plugins
--logfile <PATH> Path to log file
--pause Pauses before exiting
```
## Example
```aaru formats```
```bash
aaru formats
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

57
image/checksum.md
View File

@@ -1,47 +1,50 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
## Command description
This operation will calculate the checksums for the media represented by a media dump image.
## Command usage
```bash
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>
```
```text
USAGE:
aaru image checksum <image-path> [OPTIONS]
`-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)*
`-a, --adler32 [true/false]` calculates the Adler-32 checksum *(default true)*
`--crc16 [true/false]` calculates the CRC16 checksum *(default true)*
`-c, --crc32 [true/false]` calculates the CRC32 checksum *(default true)*
`--crc64 [true/false]` calculates the ECMA CRC64 checksum *(default false)*
`-f, --spamsum [true/false]` calculates the SpamSum fuzzy hash *(default true)*
`--fletcher16 [true/false]` calculates the Fletcher-16 checksum *(default false)*
`--fletcher32 [true/false]` calculates the Fletcher-32 checksum *(default false)*
`-m, --md5 [true/false]` calculates the MD5 hash *(default true)*
`--ripemd160 [true/false]` calculates the RIPEMD160 hash *(default false)*
`-s, --sha1 [true/false]` calculates the SHA1 hash *(default true)*
`--sha256 [true/false]` calculates the SHA2 hash with 256-bit *(default false)*
`--sha384 [†rue/false]` calculates the SHA2 hash with 384-bit *(default false)*
`--sha512 [true/false]` calculates the SHA2 hash with 512-bit *(default false)*
`-t, --separated-tracks [true/false]` calculates each track checksum separately *(default true)*
`-w, --whole-discs [true/false]` calculates the whole media checksum *(default true)*
ARGUMENTS:
<image-path> Media image path
OPTIONS:
DEFAULT
-h, --help Prints help information
-a, --adler32 Calculates Adler-32
--crc16 True Calculates CRC16
-c, --crc32 True Calculates CRC32
--crc64 True Calculates CRC64 (ECMA)
--fletcher16 Calculates Fletcher-16
--fletcher32 Calculates Fletcher-32
-m, --md5 True Calculates MD5
-s, --sha1 True Calculates SHA1
--sha256 Calculates SHA256
--sha384 Calculates SHA384
--sha512 True Calculates SHA512
-f, --spamsum True Calculates SpamSum fuzzy hash
-w, --whole-disc True Checksums the whole disc
-t, --separated-tracks True Checksums each track separately
```
## Example
```bash
Aaru image checksum -f false --sha512 true mydisc.cue
aaru image checksum example.iso
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

29
image/compare.md
View File

@@ -1,32 +1,37 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
## Command description
This operation will compare two media dumps and print all differences between them. Dumps can be in different formats.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image compare -h [true/false] <image-path1> <image-path2>
```
```text
USAGE:
aaru image compare <image-path1> <image-path1> [OPTIONS]
`-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)*
ARGUMENTS:
<image-path1> First media image path
<image-path1> Second media image path
OPTIONS:
-h, --help Prints help information
-r, --long-sectors Use long sectors (with tags)
```
## Example
```bash
Aaru image compare mydisc.cue anotherdisc.mds
aaru image compare disc1.iso disc2.iso
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

132
image/convert.md
View File

@@ -1,63 +1,107 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
## Command description
This operation will convert a dump from one image format to another.
## Command usage
```bash
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>
```text
USAGE:
aaru image convert <input-image> <output-image> [OPTIONS]
ARGUMENTS:
<input-image> Input image path
<output-image> Output image path
OPTIONS:
DEFAULT
-h, --help Prints help information
-x, --cicm-xml Take metadata from existing CICM
XML sidecar
--comments Image comments
-c, --count 64 How many sectors to convert at
once
--creator Who (person) created the image?
--drive-manufacturer Manufacturer of the drive used
to read the media represented by
the image
--drive-model Model of the drive used to read
the media represented by the
image
--drive-revision Firmware revision of the drive
used to read the media
represented by the image
--drive-serial Serial number of the drive used
to read the media represented by
the image
-f, --force Continue conversion even if
sector or media tags will be
lost in the process
-p, --format Format of the output image, as
plugin name or plugin id. If not
present, will try to detect it
from output image extension
--media-barcode Barcode of the media represented
by the image
--media-lastsequence 0 Last media of the sequence the
media represented by the image
corresponds to
--media-manufacturer Manufacturer of the media
represented by the image
--media-model Model of the media represented
by the image
--media-partnumber Part number of the media
represented by the image
--media-sequence 0 Number in sequence for the media
represented by the image
--media-serial Serial number of the media
represented by the image
--media-title Title of the media represented
by the image
-O, --options Comma separated name=value pairs
of options to pass to output
image plugin
-r, --resume-file Take list of dump hardware from
existing resume file
-g, --geometry Force geometry, only supported
in not tape block media. Specify
as C/H/S
--fix-subchannel-position True Store subchannel according to
the sector they describe
--fix-subchannel Try to fix subchannel. Implies
fixing subchannel position
--fix-subchannel-crc If subchannel looks OK but CRC
fails, rewrite it. Implies
fixing subchannel
--generate-subchannels Generates missing subchannels
--decrypt Try to decrypt encrypted sectors
--bypass-ps3-decryption Skip PS3 disc encryption
processing during conversion
--bypass-wiiu-decryption Skip Wii U disc encryption
processing during conversion
--bypass-wii-decryption Skip Wii disc encryption
processing during conversion or
dump
-m, --aaru-metadata Take metadata from existing Aaru
Metadata sidecar
--ignore-negative-sectors Ignore negative sectors
--ignore-overflow-sectors Ignore overflow sectors
```
`-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)*
`-c, --count <count>` specifies how many sectors to convert at once *(default 64)*
`--comments <comments>` specifies image comments
`--creator <creator>` specifies who (person) created the image?
`--drive-manufacturer <manufacturer>` specifies manufacturer of the drive used to read the media represented by the image
`--drive-model <model>` specifies model of the drive used to read the media represented by the image
`--drive-revision <revision>` specifies firmware revision of the drive used to read the media represented by the image
`--drive-serial <serial>` specifies serial number of the drive used to read the media represented by the image
`-f, --force [true/false]` continues conversion even if sector or media tags will be lost in the process *(default false)*
`--media-barcode <barcode>` specifies barcode of the media represented by the image
`--media-lastsequence <number>` specifies last media of the sequence the media represented by the image corresponds to *(default 0)*
`--media-manufacturer <manufacturer>` specifies manufacturer of the media represented by the image
`--media-model <model>` specifies model of the media represented by the image
`--media-partnumber <partnumber>` specifies part number of the media represented by the image
`--media-sequence <sequence>` specifies number in sequence for the media represented by the image *(default 0)*
`--media-serial <serial>` specifies serial number of the media represented by the image
`--media-title <title>` specifies title of the media represented by the image
`-O, --options <options>` specifies comma separated name=value pairs of options to pass to output image plugin
`-p, --format <format>` specifies format of the output image, as plugin name or plugin id. If not present, will try to
detect it from output image extension
`-r, --resume-file <resume file>` takes list of dump hardware from existing resume file
`-g, --geometry <geometry>` force geometry, only supported in not tape block media. Specify as C/H/S
`--fix-subchannel-position` store subchannel according to the sector they describe
`--fix-subchannel` try to fix subchannel. Implies fixing subchannel position
`--fix-subchannel-crc` If subchannel looks OK but CRC fails, rewrite it. Implies fixing subchannel
`--generate-subchannels` generates missing subchannels
`-x, --cicm-xml <xml sidecar>` takes metadata from existing CICM XML sidecar
## Example
```bash
Aaru image convert -c 32 --comments "My converted image" --creator "Jane Doe" --drive-manufacturer "LG" --drive-model "CD-RW 1234" --drive-revision "1.0" --drive-serial "AABBCCDDEEFF01" --media-lastsequence 2 --media-sequence 1 --media-title "Important software" -O "deduplicate=true,nocompress=false" -r dd_dump.resume.xml -x dd_dump.cicm.xml dd_dump.iso dump.aaruf
aaru image convert input.iso output.aif
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

46
image/create-sidecar.md
View File

@@ -1,38 +1,48 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
## Command description
This operation will analyze a media dump and, if the format is recognized, create a CICM XML metadata sidecar with all information that can be automatically retrieved from it, as well as all [supported checksum algorithms.](../faq/supported-checksums.md)
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image create-sidecar -h [true/false] -b [block size] -e [encoding] -t tape [true/false] <image-path>
```
```text
USAGE:
aaru image create-sidecar <image-path> [OPTIONS]
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-b, --block-size [block size]` used only for tapes, indicates fixed block size in bytes. File in dump folder not multiple of this value will be ignored *(default 512)*
`-e, --encoding [encoding]` sets which encoding is used by the contents of the media dump *(default varies by filesystem)*
`-t, --tape [true/false]` indicates that dump points to a folder containing alphabetically sorted files extracted from a linear block-based tape with fixed block size (e.g. a SCSI streaming device) *(default false)*
ARGUMENTS:
<image-path> Media image path
OPTIONS:
DEFAULT
-h, --help Prints help information
-b, --block-size 512 Only used for tapes, indicates block
size. Files in the folder whose size is
not a multiple of this value will simply
be ignored
-e, --encoding Name of character encoding to use
-t, --tape When used indicates that input is a
folder containing alphabetically sorted
files extracted from a linear block-based
tape with fixed block size (e.g. a SCSI
tape device)
--enable-spamsum Enables calculation of Spamsum fuzzy
hashes
```
## Example
```bash
Aaru image create-sidecar mydisc.cue
Aaru image create-sidecar -t -b 1024 mytapedir
Aaru image create-sidecar -e shift_jis "My japanese software.img"
aaru image create-sidecar example.iso
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

36
image/decode.md
View File

@@ -1,36 +1,40 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
## Command description
This operation will decode all [sector tags](../faq/sector-tags.md) and [media tags](../faq/media-tags.md) in a media dump image.
## Command usage
```bash
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>
```
```text
USAGE:
aaru image decode <image-path> [OPTIONS]
`-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)*
`-f, --disk-tags [true/false]` decodes all media tags *(default true)*
`-l, --length [sectors]` how many sectors to decode or all to decode all *(default all)*
`-p, --sector-tags [true/false]` decodes all sector tags *(default true)*
`-s, --start [start-sector]` starting sector *(default 0)*
ARGUMENTS:
<image-path> Media image path
OPTIONS:
DEFAULT
-h, --help Prints help information
-f, --disk-tags True Decode media tags
-l, --length all How many sectors to decode, or "all"
-p, --sector-tags True Decode sector tags
-s, --start 0 Sector to start decoding from
```
## Example
```bash
Aaru image decode -s 1000 -l 15 -p false mydisc.cue
aaru image decode example.iso
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

37
image/entropy.md
View File

@@ -1,35 +1,42 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
## Command description
This operation will calculate uniqueness and entropy of the media represented by a media dump image. It's not affected by the image format compression, if applicable.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image entropy -h [true/false] -p [true/false] -t [true/false] -w [true/false] <image-path>
```
```text
USAGE:
aaru image entropy <image-path> [OPTIONS]
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-p, --duplicated-sectors [true/false]` besides entropy also calculates how many sectors have the exact same data in their user area *(default true)*
`-t, --separated-tracks true/false]` separately calculates the entropy for each track dividing the media. Only applicable to certain kind of media (optical discs and digital tapes mostly) *(default true)*
`-w, --whole-disc [true/false]` calculates the entropy for the whole media *(default true)*
ARGUMENTS:
<image-path> Media image path
OPTIONS:
DEFAULT
-h, --help Prints help information
-p, --duplicated-sectors True Calculates how many sectors are
duplicated (have same exact data in
user area)
-t, --separated-tracks True Calculates entropy for each track
separately
-w, --whole-disc True Calculates entropy for the whole disc
```
## Example
```bash
Aaru image entropy mydisc.cue
aaru image entropy example.iso
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

28
image/info.md
View File

@@ -1,33 +1,35 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
## Command description
This operation will request and show all information about the selected media dump.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image info -h [true/false] <image-path>
```
```text
USAGE:
aaru image info <image-path> [OPTIONS]
`-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)*
ARGUMENTS:
<image-path> Media image path
OPTIONS:
-h, --help Prints help information
```
## Example
```bash
Aaru image info mydisc.cue
aaru image info example.iso
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

105
image/merge.md Normal file
View File

@@ -0,0 +1,105 @@
# Table of Contents
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will merge two compatible media images into a new output image, optionally taking sectors or metadata from the secondary image when needed.
## Command usage
```text
USAGE:
aaru image merge <primary-image> <secondary-image> <output-image> [
OPTIONS]
ARGUMENTS:
<primary-image> Path to the primary image file
<secondary-image> Path to the secondary image file
<output-image> Path to the output merged image file
OPTIONS:
DEFAULT
-h, --help Prints help information
--secondary-tags Use media tags from secondary
image (otherwise when in both
images, primary image tags are
used)
--sectors-file File containing list of sectors
to take from secondary image
(one sector number per line)
--ignore-media-type Ignore mismatched image media
type. Merged image will still
have primary image media type
--comments Image comments
-c, --count 64 How many sectors to convert at
once
--creator Who (person) created the image?
--drive-manufacturer Manufacturer of the drive used
to read the media represented by
the image
--drive-model Model of the drive used to read
the media represented by the
image
--drive-revision Firmware revision of the drive
used to read the media
represented by the image
--drive-serial Serial number of the drive used
to read the media represented by
the image
-p, --format Format of the output image, as
plugin name or plugin id. If not
present, will try to detect it
from output image extension
--media-barcode Barcode of the media represented
by the image
--media-lastsequence 0 Last media of the sequence the
media represented by the image
corresponds to
--media-manufacturer Manufacturer of the media
represented by the image
--media-model Model of the media represented
by the image
--media-partnumber Part number of the media
represented by the image
--media-sequence 0 Number in sequence for the media
represented by the image
--media-serial Serial number of the media
represented by the image
--media-title Title of the media represented
by the image
-O, --options Comma separated name=value pairs
of options to pass to output
image plugin
--primary-resume Resume file for primary image
--secondary-resume Resume file for secondary image
-g, --geometry Force geometry, only supported
in not tape block media. Specify
as C/H/S
--fix-subchannel-position True Store subchannel according to
the sector they describe
--fix-subchannel Try to fix subchannel. Implies
fixing subchannel position
--fix-subchannel-crc If subchannel looks OK but CRC
fails, rewrite it. Implies
fixing subchannel
--generate-subchannels Generates missing subchannels
--decrypt Try to decrypt encrypted sectors
--ignore-negative-sectors Ignore negative sectors
--ignore-overflow-sectors Ignore overflow sectors
```
## Example
```bash
aaru image merge primary.aif secondary.aif merged.aif
```
## Operating system support
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

26
image/options.md
View File

@@ -1,30 +1,32 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
Lists all options supported by writable media images.
This operation will list all options supported by the writable media image plugins recognized by Aaru.
## Command usage
```Aaru -d [true/false] -v [true/false] image options -h [true/false]```
```text
USAGE:
aaru image options [OPTIONS]
```-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)*
OPTIONS:
-h, --help Prints help information
```
## Example
```Aaru image options```
```bash
aaru image options example.iso
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

36
image/print.md
View File

@@ -1,36 +1,40 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
## Command description
This operation will print a hexadecimal dump of the chosen sector/block from the indicated media dump image to the console.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image print -h [true/false] -l [sectors] -r [true/false] -s <starting sector> -w [width] <image-path>
```
```text
USAGE:
aaru image print-hex <image-path> [OPTIONS]
`-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)*
`-l, --length [sectors]` specifies how many sectors to print *(default 1)*
`-r, --long-sectors [true/false]` specifies if hex print should include all sector tags stored in the media dump *(default false)*
`-s, --start <starting sector>` starts the hexadecimal printing from this sector
`-w, --width <width>` specifies how long the width, in characters, should the print be before creating a new line *(default 32)*
ARGUMENTS:
<image-path> Media image path
OPTIONS:
DEFAULT
-h, --help Prints help information
-l, --length 1 How many sectors to print
-r, --long-sectors Print sectors with tags included
-s, --start 0 Starting sector
-w, --width 32 How many bytes to print per line
```
## Example
```bash
Aaru image print -s 15 -l 30 -r -w 64 mydisc.cue
aaru image print-hex example.iso
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

48
image/verify.md
View File

@@ -1,35 +1,43 @@
# Table of Contents
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## 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 sector/block format include a hash, checksum, or error recovery system, it will calculate and compare them.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] image verify -h [true/false] -s [true/false] -w [true/false]
```text
USAGE:
aaru image verify <image-path> [OPTIONS]
ARGUMENTS:
<image-path> Media image path
OPTIONS:
DEFAULT
-h, --help Prints help information
-w, --verify-disc True Verify media image if supported
-s, --verify-sectors True Verify all sectors if supported
-g, --create-graph True Create graph of verified disc (currently
only implemented for optical discs)
-d, --dimensions 1080 Dimensions, as a square, in pixels, for
the graph of verified media
-t, --data-only True Verify only data tracks
```
<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
```bash
Aaru image verify mydisc.cue
aaru image verify example.iso
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

58
image/write-metadata.md Normal file
View File

@@ -0,0 +1,58 @@
# Table of Contents
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will write or update metadata fields in an existing Aaru Image Format (`.aif`) image.
## Command usage
```text
USAGE:
aaru image write-metadata <image-path> [OPTIONS]
ARGUMENTS:
<image-path> Media image path
OPTIONS:
-h, --help Prints help information
--comments Image comments
--creator Who (person) created the image?
--drive-manufacturer Manufacturer of the drive used to read the media
represented by the image
--drive-model Model of the drive used to read the media
represented by the image
--drive-revision Firmware revision of the drive used to read the
media represented by the image
--drive-serial Serial number of the drive used to read the
media represented by the image
--media-barcode Barcode of the media represented by the image
--media-lastsequence Last media of the sequence the media represented
by the image corresponds to
--media-manufacturer Manufacturer of the media represented by the
image
--media-model Model of the media represented by the image
--media-partnumber Part number of the media represented by the
image
--media-sequence Number in sequence for the media represented by
the image
--media-serial Serial number of the media represented by the
image
--media-title Title of the media represented by the image
```
## Example
```bash
aaru image write-metadata example.aif
```
## Operating system support
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

34
list-encodings.md
View File

@@ -1,3 +1,10 @@
# Table of Contents
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will list all character set encodings supported in your environment. This list depends on the libraries
@@ -6,21 +13,26 @@ in another one.
## Command usage
```aaru -d [true/false] -v [true/false] list-encodings -h [true/false]```
```text
USAGE:
aaru list-encodings [OPTIONS]
```-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)*
OPTIONS:
-h, --help Prints help information
-v, --verbose Shows verbose output
-d, --debug Shows debug output from plugins
--logfile <PATH> Path to log file
--pause Pauses before exiting
```
## Example
```aaru list-encodings```
```bash
aaru list-encodings
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

34
list-namespaces.md
View File

@@ -1,24 +1,36 @@
# Table of Contents
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will list all the supported namespaces of the [Filesystems recognized by Aaru](faq/filesystems.md).
## Command usage
```aaru -d [true/false] -v [true/false] list-namespaces -h [true/false]```
```text
USAGE:
aaru list-namespaces [OPTIONS]
```-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)*
OPTIONS:
-h, --help Prints help information
-v, --verbose Shows verbose output
-d, --debug Shows debug output from plugins
--logfile <PATH> Path to log file
--pause Pauses before exiting
```
## Example
```aaru list-namespaces```
```bash
aaru list-namespaces
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

205
media/dump.md
View File

@@ -1,93 +1,150 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
## Command description
This operation will create a media dump from real media using a physical device. It will retry errors and when finished, create an XML metadata sidecar. The dumping operation can be interrupted and continued later with supported formats, even from a different device.
## Command usage
```bash
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/aaru-remote-host> <output-path>
```text
USAGE:
aaru media dump <device-path> <output-path> [OPTIONS]
ARGUMENTS:
<device-path> Device path
<output-path> Output image path. If filename starts with # and exists, it
will be read as a list of output images, its extension will
be used to detect the image output format, each media will
be ejected and confirmation for the next one will be asked
OPTIONS:
DEFAULT
-h, --help Prints help information
-x, --cicm-xml Take metadata from existing CICM
XML sidecar
-e, --encoding Name of character encoding to
use
--first-pregap Try to read first track pregap.
Only applicable to CD/DDCD/GD
--fix-offset True Fix audio tracks offset. Only
applicable to CD/GD
-f, --force Continue dumping whatever
happens
-t, --format Format of the output image, as
plugin name or plugin id. If not
present, will try to detect it
from output image extension
--metadata True Enables creating Aaru Metadata
sidecar
--trim True Enables trimming errored from
skipped sectors
-O, --options Comma separated name=value pairs
of options to pass to output
image plugin
--persistent Try to recover partial or
incorrect data
-r, --resume True Create/use resume mapfile
-p, --retry-passes 5 How many retry passes to do
-k, --skip 512 When an unreadable sector is
found skip this many sectors
-s, --stop-on-error Stop media dump on first error
--subchannel any Subchannel to dump. Only
applicable to CD/GD. Values:
any, rw, rw-or-pq, pq, none
--speed 0 Speed to dump. Only applicable
to optical drives, 0 for maximum
--private Do not store paths and serial
numbers in log or metadata
--fix-subchannel-position True Store subchannel according to
the sector they describe
--retry-subchannel True Retry subchannel. Implies fixing
subchannel position
--fix-subchannel Try to fix subchannel. Implies
fixing subchannel position
--fix-subchannel-crc If subchannel looks OK but CRC
fails, rewrite it. Implies
fixing subchannel
--generate-subchannels Generates missing subchannels
(they don't count as dumped in
resume file)
--skip-cdiready-hole True Skip the hole between data and
audio in a CD-i Ready disc
--eject Eject media after dump finishes
--max-blocks 64 Maximum number of blocks to read
at once
--use-buffered-reads True For MMC/SD, use OS buffered
reads if CMD23 is not supported
--store-encrypted True Store encrypted data as is
--bypass-wii-decryption Skip Wii disc encryption
processing during conversion or
dump
--title-keys True Try to read the title keys from
CSS encrypted DVDs (very slow)
--ignore-cdr-runouts 10 How many CD-R(W) run-out sectors
to ignore and regenerate (0 for
none)
-g, --create-graph True Create graph of dumped media.
Currently only supported for
CD/DVD/BD/GD/UMD
--dimensions 1080 Dimensions in pixels of the
square that will contain the
graph of dumped media
--aaru-metadata Take metadata from existing Aaru
Metadata sidecar
--paranoia Do not trust the drive, check
the sectors integrity before
writing them to the image. Valid
only for CD/GD
--cure-paranoia Try to fix sectors that do not
pass the integrity checks
--raw EXPERIMENTAL: Enable raw dumping
mode. This feature is
experimental and may not work
correctly with all devices or
media types. Use at your own
risk.
```
`-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>` specifies character encoding to use when creating dump sidecar
`-f, --force [true/false]` continues dumping whatever happens *(default false)*
`-k, --skip <sectors>` skips this many sectors when an unreadable sector is found *(default 512)*
`--first-pregap [true/false]` tries to dump first track pregap. Only applicable to CD, DDCD or GD media *(default
false)*
`--fix-offset [true/false]` fixes audio tracks offset. Only applicable to CD or GD media. *(default false)*
`-r, --resume [true/false]` creates and/or use resume mapfile *(default true)*
`--metadata [true/false]` enables creating CICM XML sidecar *(default true)*
`--trim [true/false]` enables trimming errores from skipped sectors *(default true)*
`-O, --options <options>` specifies comma separated name=value pairs of options to pass to output image plugin
`--persistent [true/false]` tries to recover partial or incorrect data *(default false)*
`-p, --retry-passes <passes>` specifies how many times to retry reading a sector *(default 5)*
`-s, --stop-on-error [true/false]` stops dumping on first error *(default false)*
`-t, --format <plugin>` specifies format for the output image, as plugin name or plugin id. If not present, will try to detect it from output image extension
`-x, --cicm-xml <xml sidecar>` takes metadata from existing CICM XML sidecar
`--subchannel <subchannel>` specifies which subchannel to dump. Only applicable to CD/GD. Values: any, rw, rw-or-pq, pq, none *(default any)*
`--speed <speed>` specifies at what speed to dump. Only applicable to optical drives, 0 for maximum *(default 0)*
```--private [true/false]``` do not store paths and serial numbers in log or metadata *(default false)*
```--fix-subchannel-position [true/false]``` store subchannel according to the sector they describe *(default true*)
```--retry-subchannel [true/false]``` retry subchannel. Implies fixing subchannel position *(default true)*
```--fix-subchannel [true/false]``` try to fix subchannel. Implies fixing subchannel position *(default false)*
```--fix-subchannel-crc [true/false]``` if subchannel looks OK but CRC fails, rewrite it. Implies fixing subchannel *(default false)*
```--generate-subchannels [true/false]``` generates missing subchannels (they don't count as dumped in resume file). *(default false)*
```--skip-cdiready-hole [true/false]``` skip the hole between data and audio in a CD-i Ready disc *(default ???)*
```--eject [true/false]``` eject media after dump finishes *(default false)*
```--max-blocks <max-blocks>``` maximum number of blocks to read at once *(default ???)*
```--use-buffered-reads [true/false]``` for MMC/SD, use OS buffered reads if CMD23 is not supported *(default ???)*
```--store-encrypted [true/false]``` store encrypted data as is *(default ???)*
```--title-keys [true/false]``` try to read the title keys from CSS encrypted DVDs (very slow) *(default ???)*
`<aaru-remote-host>` connects to an Aaru Remote Host with ```aaru://<IP ADDRESS>```
## Example
FreeBSD: `Aaru media dump -f --persistent true --separate-subchannel /dev/cd0 mydisc.cue`
Linux: `Aaru media dump -r -f -p 15 /dev/sdb myusbfloppy.img`
Windows: `Aaru media dump -f -p 0 --resume false \\.\PhysicalDrive3 mydisk.aaruf`
macOS:
```bash
aaru media dump -f /dev/rdisk2 mydisc.aif
```
Linux:
```bash
aaru media dump -r -f -p 15 /dev/sr0 mydisc.aif
```
Windows:
```bash
aaru media dump -f -p 0 \\.\PhysicalDrive3 mydisk.aif
```
## Operating system support
| Device Type | FreeBSD | MacOS | Linux | Windows |
|--------------|----------|--------|--------|----------|
| SCSI Block device | Yes | No¹ | Yes | Yes |
| SCSI MultiMedia device | Yes | Not yet² | Yes | Yes |
| SCSI Streaming device | Yes | No¹ | Yes | Yes |
| Parallel ATA | No³ | No¹ | Yes | Yes |
| Serial ATA | Yes | No¹ | Yes | Yes |
| USB | Partial⁴ | Partial⁵ | Yes | Yes |
| FireWire | Partial⁶ | Partial⁵ | Yes | Partial⁶ |
| PCMCIA | Partial⁷ | Partial⁵ | Yes | Partial⁷ |
| SecureDigital / MultiMediaCard | Not yet⁸ | No¹ | Yes | Untested⁹ |
| Device Type | macOS | Linux | Windows |
|-------------|-------|-------|---------|
| SCSI Block device | No¹ | Yes | Yes |
| SCSI MultiMedia device | No¹ | Yes | Yes |
| SCSI Streaming device | No¹ | Yes | Yes |
| Parallel ATA | No¹ | Yes | Yes |
| Serial ATA | No¹ | Yes | Yes |
| USB | No¹ | Yes | Yes |
| FireWire | No¹ | Yes | Partial² |
| PCMCIA | No¹ | Yes | Partial³ |
| SecureDigital / MultiMediaCard | No¹ | Yes | Untested⁴ |
1. macOS only allows talking with MultiMedia devices.
2. Support for MultiMedia devices in macOS will be added if users require it
3. Not supported due to upstream bug
4. USB descriptors are not retrieved
5. Only MultiMedia devices can be supported and descriptors will not be retrieved
6. FireWire descriptors are not retrieved
7. PCMCIA CIS is not retrieved
8. Support will come with FreeBSD 12-RELEASE
9. Should work, untested due to no available hardware
1. Media dump and other device-access commands are not currently supported on macOS.
2. FireWire descriptors are not retrieved.
3. PCMCIA CIS is not retrieved.
4. Should work, but it remains untested due to lack of hardware.

46
media/info.md
View File

@@ -1,46 +1,38 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
## Command description
This operation will request and show all information about the inserted media from a physical device. For information about supported physical devices check [the list of supported physical devices.](../faq/supported-devices.md)
## Command usage
```bash
Aaru -d [true/false] -v [true/false] media info -h [true/false] -w [prefix] <device-path/aaru-remote-host>
```
```text
USAGE:
aaru media info <device-path> [OPTIONS]
`-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)*
`-w, --output-prefix [prefix]` writes binary responses from device to that prefix
`<aaru-remote-host>` connects to an Aaru Remote Host with ```aaru://<IP ADDRESS>```
ARGUMENTS:
<device-path> Device path
OPTIONS:
-h, --help Prints help information
-w, --output-prefix Prefix for saving binary information from device
```
## Example
FreeBSD: `Aaru media info /dev/cd0`
Linux: `Aaru media info /dev/sdb`
Windows: `Aaru media info \\.\PhysicalDrive3`
```bash
aaru media info /dev/rdisk2
```
## Operating system support
| Device Type | FreeBSD | MacOS | Linux | Windows |
|--------------|----------|--------|--------|----------|
| SCSI Block device | Yes | No¹ | Yes | Yes |
| SCSI MultiMedia device | Yes | Not yet² | Yes | Yes |
| SCSI Streaming device | Yes | No¹ | Yes | Yes |
| Parallel ATA | No³ | No³ | Yes³ | Yes³ |
| Serial ATA | Yes³ | No³ | Yes³ | Yes³ |
| USB | Partial | Partial | Yes | Yes |
| FireWire | Partial | Partial | Yes | Partial |
| PCMCIA | Partial | Partial | Yes | Partial |
| SecureDigital / MultiMediaCard | Not yet³ | No³ | Yes³ | Untested³ |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| No¹ | Yes | Yes |
1. macOS only allows talking with MultiMedia devices.
2. Support for MultiMedia devices in macOS will be added if users require it
3. Use device-info command
1. Media info and other device-access commands are not currently supported on macOS.

60
media/scan.md
View File

@@ -1,11 +1,11 @@
# Table of Contents
- [Command Description](#command-description)
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command Description
## Command description
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
@@ -13,44 +13,34 @@ finished it will check how fast can the device seek and report speed statistics.
## Command usage
```bash
Aaru -d [true/false] -v [true/false] media scan -h [true/false] -b [ibglog] -m [mhddlog] <device-path/aaru-remote-host>
```
```text
USAGE:
aaru media scan <device-path> [OPTIONS]
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default
false)*
`-b, --ibg-log [ibglog]` writes a log in the format used by ImgBurn
`-m, --mhdd-log [mhddlog]` writes a log in the format used by MHDD
`<aaru-remote-host>` connects to an Aaru Remote Host with aaru:///
ARGUMENTS:
<device-path> Device path
OPTIONS:
DEFAULT
-h, --help Prints help information
-m, --mhdd-log Write a log of the scan in the format
used by MHDD
-b, --ibg-log Write a log of the scan in the format
used by ImgBurn
--use-buffered-reads True For MMC/SD, use OS buffered reads if
CMD23 is not supported
```
## Example
FreeBSD: `Aaru media scan /dev/cd0`
Linux: `Aaru media scan /dev/sdb`
Windows: `Aaru media scan \\.\PhysicalDrive3`
```bash
aaru media scan /dev/rdisk2
```
## Operating system support
| Device Type | FreeBSD | MacOS | Linux | Windows |
|--------------|----------|--------|--------|----------|
| SCSI Block device | Yes | No¹ | Yes | Yes |
| SCSI MultiMedia device | Yes | Not yet² | Yes | Yes |
| SCSI Streaming device | Yes | No¹ | Yes | Yes |
| Parallel ATA | No³ | No¹ | Yes | Yes |
| Serial ATA | Yes | No¹ | Yes | Yes |
| USB | Partial⁴ | Partial⁵ | Yes | Yes |
| FireWire | Partial⁶ | Partial⁵ | Yes | Partial⁶ |
| PCMCIA | Partial⁷ | Partial⁵ | Yes | Partial⁷ |
| SecureDigital / MultiMediaCard | Not yet⁸ | No¹ | Yes | Untested⁹ |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| No¹ | Yes | Yes |
1. macOS only allows talking with MultiMedia devices.
2. Support for MultiMedia devices in macOS will be added if users require it
3. Not supported due to upstream bug
4. USB descriptors are not retrieved
5. Only MultiMedia devices can be supported and descriptors will not be retrieved
6. FireWire descriptors are not retrieved
7. PCMCIA CIS is not retrieved
8. Support will come with FreeBSD 12-RELEASE
9. Should work, untested due to no available hardware
1. Media scan and other device-access commands are not currently supported on macOS.

39
metadata-schema.md Normal file
View File

@@ -0,0 +1,39 @@
# Table of Contents
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will generate the JSON schema used by Aaru metadata files and write it to the selected output path.
## Command usage
```text
USAGE:
aaru metadata-schema <output> [OPTIONS]
ARGUMENTS:
<output> Output file for the JSON schema
OPTIONS:
-h, --help Prints help information
-v, --verbose Shows verbose output
-d, --debug Shows debug output from plugins
--logfile <PATH> Path to log file
--pause Pauses before exiting
```
## Example
```bash
aaru metadata-schema metadata-schema.json
```
## Operating system support
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |

14
quickstart.md
View File

@@ -3,19 +3,19 @@
## How to Dump a Disk Image
It’s very easy to dump any supported media quickly with Aaru! You just have to
run `aaru media dump <drive> <output image>` for the most basic options. If you dump to something that’s not Aaru Image
Format (images with the extensions `.aaruformat`, `.aaruf`, and `.aif`), you will also have to add the “-f” option at the end
of the command.
run `aaru media dump <drive> <output image>` for the most basic options. If you dump to something that’s not the
Aaru Image Format (which uses the `.aif` extension), you will also have to add the `-f` option at the end of the
command.
### Examples (Windows):
`aaru media dump E: Image.aaruf`
`aaru media dump E: Image.aif`
`aaru media dump F: Image.iso -f`
### Examples (Linux):
`aaru media dump /dev/sr0 Image.aaruf`
`aaru media dump /dev/sr0 Image.aif`
`aaru media dump /dev/sr1 Image.iso -f`
@@ -27,7 +27,7 @@ be any of the supported formats from any software.
### Examples (All OS’):
`aaru image compare Image1.aaruf Image2.cue`
`aaru image compare Image1.aif Image2.cue`
`aaru image compare Image1.iso Image2.ccd`
@@ -43,7 +43,7 @@ command to extract the more technical extended attributes from an image as well.
### Examples:
`aaru filesystem extract Image.aaruf Output`
`aaru filesystem extract Image.aif Output`
`aaru filesystem extract Image.ccd Output -x`

37
remote.md
View File

@@ -1,26 +1,39 @@
# Table of Contents
- [Command description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## 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>```
```text
USAGE:
aaru remote <host> [OPTIONS]
```-d, --debug [true/false]``` shows debug output *(default false)*
ARGUMENTS:
<host> aaruremote host
```-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>```
OPTIONS:
-h, --help Prints help information
-v, --verbose Shows verbose output
-d, --debug Shows debug output from plugins
--logfile <PATH> Path to log file
--pause Pauses before exiting
```
## Example
```aaru remote aaru://192.168.1.25```
```bash
aaru remote aaru://192.168.1.25
```
## Operating system support
| FreeBSD | macOS | Linux | Windows |
| ------- | ----- | ----- | ------- |
| Yes | Yes | Yes | Yes |
| macOS | Linux | Windows |
| ----- | ----- | ------- |
| Yes | Yes | Yes |