Documentation cleanup and updates

This commit is contained in:
SilasLaspada
2021-08-18 03:10:57 -06:00
parent f5598117c7
commit 4ce8487fbb
26 changed files with 203 additions and 206 deletions

View File

@@ -7,9 +7,7 @@
## Command Description
This operation will request and show all information about a physical device. For information about supported physical
devices
check [the list of supported physical devices.](../faq/supported-devices.md)
This operation will request and show all information about a physical device. For information about supported physical devices check [the list of supported physical devices.](../faq/supported-devices.md)
## Command usage
@@ -19,10 +17,9 @@ Aaru -d [true/false] -v [true/false] device info -h [true/false] -w [prefix] <de
`-d, --debug [true/false]` shows debug output *(default false)*
`-v, --verbose [true/false]` shows verbose output *(default false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default
false)*
`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches *(default false)*
`-w, --output-prefix [prefix]` writes binary responses from device to that prefix
`<aaru-remote-host>` connects to an Aaru Remote Host with aaru:///
```<aaru-remote-host>``` connects to an Aaru Remote Host with ```aaru://<IP ADDRESS>```
## Example

View File

@@ -1,18 +1,23 @@
# Table of Contents
- [Command Description](#command-description)
- [Command usage](#command-usage)
- [Example](#example)
- [Operating system support](#operating-system-support)
## Command description
This operation will show all known attached devices on your system and if they are supported for device dependent
operations.
This operation will show all known attached devices on your system and if they are supported for device dependent operations.
## Command usage
```aaru -d [true/false] -v [true/false] device list -h [true/false] <aaru-remote-host>```
```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)*
```-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>```

Binary file not shown.