Organize documents and fix links.

This commit is contained in:
2021-08-18 04:57:38 +01:00
parent ef941c4cbc
commit b401e2f34a
78 changed files with 52 additions and 1142 deletions

55
device/info.md Normal file
View File

@@ -0,0 +1,55 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## 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>
```
`-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:///
## Example
FreeBSD: `Aaru device info /dev/cd0`
Linux: `Aaru device info /dev/sda`
Windows: `Aaru device info D:`
## 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⁹ |
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 not available hardware

27
device/list.md Normal file
View File

@@ -0,0 +1,27 @@
## 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>```
## Example
```aaru device list aaru://192.168.1.25```
## Operating system support
|FreeBSD|macOS|Linux|Windows|
|---|---|---|---|
|Yes|Yes|Yes|Yes|

BIN
device/report.md Normal file

Binary file not shown.