aaru-dps/Aaru.Documentation
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.Documentation.git synced 2025-12-16 19:24:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation on how to connect to an Aaru Remote Host

Browse Source
This commit is contained in:
SilasLaspada
2020-03-02 17:28:06 -07:00
parent 457d00228e
commit 591b891845
7 changed files with 16 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Check-readability-of-the-media-inserted-in-a-physical-device.mediawiki
View File

@@ -2,13 +2,14 @@
This operation will read the media inserted in the physical device, and measure how fast it can be read sequentially. It's not intended as a benchmark, but as a detector of damaged sectors, sectors that are losing readability, etc. When finished it will check how fast can the device seek, and report speed statistics.
==Command usage==
<code>Aaru -d [true/false] -v [true/false] media scan -h [true/false] -b [ibglog] -m [mhddlog] <device-path></code>
<code>Aaru -d [true/false] -v [true/false] media scan -h [true/false] -b [ibglog] -m [mhddlog] <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>-b, --ibg-log [ibglog]</code> writes a log in the format used by ImgBurn<br />
<code>-m, --mhdd-log [mhddlog]</code> writes a log in the format used by MHDD<br />
<code><aaru-remote-host></code> connects to an Aaru Remote Host with aaru://<IP ADDRESS>/<DEVICE PATH><br />
==Example==
FreeBSD: <code>Aaru media scan /dev/cd0</code><br />

3
Creating-a-dump-from-physical-media.mediawiki
View File

@@ -2,7 +2,7 @@
This operation will create a media dump from real media using a physical device. It will retry errors and when finished create an XML metadata sidecar. The dumping operation can be interrupted and continued later, even with a different device.
==Command usage==
<code>Aaru -d [true/false] -v [true/false] media dump -h [true/false] -e <encoding> -f [true/false] -k <sectors> --first-pregap [true/false] --fix-offset [true/false] -m [true/false] --metadata [true/false] --trim [true/false] -O <options> --persistent [true/false] -p <passes> -s [true/false] -t <plugin> -x <xml sidecar> --subchannel <subchannel> --speed <speed> <device-path> <output-path></code>
<code>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></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 />
@@ -23,6 +23,7 @@ This operation will create a media dump from real media using a physical device.
<code>-x, --cicm-xml <xml sidecar></code> takes metadata from existing CICM XML sidecar<br />
<code>--subchannel <subchannel></code> specifies which subchannel to dump. Only applicable to CD/GD. Values: any, rw, rw-or-pq, pq, none ''(default any)''<br />
<code>--speed <speed></code> specifies at what speed to dump. Only applicable to optical drives, 0 for maximum ''(default 0)''<br />
<code><aaru-remote-host></code> connects to an Aaru Remote Host with aaru://<IP ADDRESS>/<DEVICE PATH><br />
==Example==
FreeBSD: <code>Aaru media dump -f --persistent true --separate-subchannel /dev/cd0 mydisc.cue</code><br />

3
Getting-information-from-a-physical-device.mediawiki
View File

@@ -2,12 +2,13 @@
This operation will request and show all information about a physical device. For information about supported physical devices check [[Supported-devices.mediawiki|the list of supported physical devices]].
==Command usage==
<code>Aaru -d [true/false] -v [true/false] device info -h [true/false] -w [prefix] <device-path></code>
<code>Aaru -d [true/false] -v [true/false] device info -h [true/false] -w [prefix] <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>-w, --output-prefix [prefix]</code> writes binary responses from device to that prefix<br />
<code><aaru-remote-host></code> connects to an Aaru Remote Host with aaru://<IP ADDRESS>/<DEVICE PATH><br />
==Example==
FreeBSD: <code>Aaru device info /dev/cd0</code><br />

3
Getting-information-from-media-inserted-in-a-physical-device.mediawiki
View File

@@ -2,12 +2,13 @@
This operation will request and show all information about the inserted media in a physical device. For information about supported physical devices check [[Supported-devices.mediawiki|the list of supported physical devices]].
==Command usage==
<code>Aaru -d [true/false] -v [true/false] media info -h [true/false] -w [prefix] <device-path></code>
<code>Aaru -d [true/false] -v [true/false] media info -h [true/false] -w [prefix] <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>-w, --output-prefix [prefix]</code> writes binary responses from device to that prefix<br />
<code><aaru-remote-host></code> connects to an Aaru Remote Host with aaru://<IP ADDRESS>/<DEVICE PATH><br />
==Example==
FreeBSD: <code>Aaru media info /dev/cd0</code><br />

5
List-supported-devices.mediawiki
View File

@@ -2,14 +2,15 @@
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>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 "IP address of host running Aaru Remote"</code>
<code>Aaru device list aaru://<IP ADDRESS>/<DEVICE PATH></code>
==Operating system support==
{|

3
Reporting-physical-device-capabilities.mediawiki
View File

@@ -2,11 +2,12 @@
This operation will test a physical device for its read capabilities. If the media is removable, it will ask you to insert different media on it, as read capabilities vary with different media. The report will be saved in the executing directory, and sent to us. Shared reports can be seen in www.aaru.app.
==Command usage==
<code>Aaru -d [true/false] -v [true/false] device-report -h [true/false] <device-path></code>
<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 />

5
Testing-connection-to-remote-server.mediawiki
View File

@@ -2,14 +2,15 @@
This operation tests the connection between Aaru and the specified Aaru Remote Server.
==Command usage==
<code>Aaru -d [true/false] -v [true/false] remote -h [true/false] <host></code>
<code>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 "IP address of host running Aaru Remote"</code>
<code>Aaru remote aaru://<IP ADDRESS>/<DEVICE PATH></code>
==Operating system support==
{|