diff --git a/.gitmodules b/.gitmodules index 5d8a50f7..d99f1766 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,7 @@ [submodule "CICMMetadata"] path = CICMMetadata url = https://github.com/claunia/CICMMetadata.git +[submodule "Aaru.Server/wwwroot"] + path = Aaru.Server/wwwroot + url = https://github.com/aaru-dps/Aaru.Documentation + branch = 5.3 diff --git a/.idea/.idea.Aaru.Server/.idea/indexLayout.xml b/.idea/.idea.Aaru.Server/.idea/indexLayout.xml index 27354263..7b08163c 100644 --- a/.idea/.idea.Aaru.Server/.idea/indexLayout.xml +++ b/.idea/.idea.Aaru.Server/.idea/indexLayout.xml @@ -1,11 +1,6 @@ - - - - - - + diff --git a/.idea/.idea.Aaru.Server/.idea/jsLibraryMappings.xml b/.idea/.idea.Aaru.Server/.idea/jsLibraryMappings.xml new file mode 100644 index 00000000..f802b986 --- /dev/null +++ b/.idea/.idea.Aaru.Server/.idea/jsLibraryMappings.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/.idea.Aaru.Server/.idea/vcs.xml b/.idea/.idea.Aaru.Server/.idea/vcs.xml index de38aa8b..00056d19 100644 --- a/.idea/.idea.Aaru.Server/.idea/vcs.xml +++ b/.idea/.idea.Aaru.Server/.idea/vcs.xml @@ -7,6 +7,7 @@ + \ No newline at end of file diff --git a/Aaru.Server/Aaru.Server.csproj b/Aaru.Server/Aaru.Server.csproj index 26a2d5da..c2f462b2 100644 --- a/Aaru.Server/Aaru.Server.csproj +++ b/Aaru.Server/Aaru.Server.csproj @@ -76,6 +76,49 @@ PreserveNewest + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -118,4 +161,8 @@ + + + + diff --git a/Aaru.Server/wwwroot/5.0/Analyzing-a-media-dump.md b/Aaru.Server/wwwroot/5.0/Analyzing-a-media-dump.md new file mode 100644 index 00000000..58aefa86 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Analyzing-a-media-dump.md @@ -0,0 +1,31 @@ +# Analyzing a media dump + +This operation will analyze a media dump, and if the format is recognized and you choose so, it will search for [supported partitioning schemes](Partitioning-schemes-recognized-by-Aaru.md) and [supported filesystems](Filesystems-recognized-by-Aaru.md) on the dump, showing information about them. + +## Command usage + +```bash +Aaru -d [true/false] -v [true/false] image analyze -h [true/false] -e [encoding] -f [true/false] -p [true/false] +``` + +`-d, --debug [true/false]` shows debug output ''(default false)'' +`-v, --verbose [true/false]` shows verbose output (default false) +`-h, --help [true/false]` shows help screen for the command instead of running it, ignores all other switches (default false) +`-e, --encoding [encoding]` sets which encoding is used by the contents of the media dump (default varies by filesystem) +`-f, --filesystems [true/false]` searches and interprets filesystems (default true) +`-p, --partitions [true/false]` searches and interprets partitions (default true) + +## Example + +```bash +Aaru image analyze mydisc.cue +``` + +## Operating system support + +| OS | Supported | +|----|-----------| +| FreeBSD | Yes | +| macOS | Yes | +| Linux | Yes | +| Windows | Yes | diff --git a/Aaru.Server/wwwroot/5.0/Bugs-in-other-dumping-software.md b/Aaru.Server/wwwroot/5.0/Bugs-in-other-dumping-software.md new file mode 100644 index 00000000..1af8a3d3 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Bugs-in-other-dumping-software.md @@ -0,0 +1,11 @@ +Some software contains bugs that can make users think the problem resides with Aaru. This page contains a list of such bugs. + +### ImgBurn complains image is smaller than disc +![](https://i.imgur.com/ddAM1YS.png) + +This seems to be a common bug, also appearing with images created with other software. + +The problem comes because ImgBurn uses the `SCSI READ CAPACITY` command to decide the size of compact discs. +Aaru instead reads and interprets the TOC (Table of Contents), that describes the disc start and end. While that command should indicate the same size as the TOC interpretation, seems to not be so in some conditions (drive firmware bug?). + +A CompactDisc data area starts from the Track 1 pregap (MSF 00:00:00, LBA -150) to the last Lead-out start, and Aaru dumps from the Track 1 start (MSF 00:02:00, LBA 0) unless you want it to try to read the pregap (not all drives can read it). diff --git a/Aaru.Server/wwwroot/5.0/Calculate-dump-contents-entropy.md b/Aaru.Server/wwwroot/5.0/Calculate-dump-contents-entropy.md new file mode 100644 index 00000000..7eb641e2 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Calculate-dump-contents-entropy.md @@ -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 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] +``` + +`-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)* + +## Example + +```bash +Aaru image entropy mydisc.cue +``` + +## Operating system support + +| OS | Supported | +|----|-----------| +| FreeBSD | Yes | +| macOS | Yes | +| Linux | Yes | +| Windows | Yes | diff --git a/Aaru.Server/wwwroot/5.0/Check-readability-of-the-media-inserted-in-a-physical-device.md b/Aaru.Server/wwwroot/5.0/Check-readability-of-the-media-inserted-in-a-physical-device.md new file mode 100644 index 00000000..2742f0c5 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Check-readability-of-the-media-inserted-in-a-physical-device.md @@ -0,0 +1,54 @@ +# Table of Contents + +- [Command Description](#command-description) +- [Command usage](#command-usage) +- [Example](#example) +- [Operating system support](#operating-system-support) + + +## 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 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] +``` + +`-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 +`` connects to an Aaru Remote Host with aaru:/// + +## Example + +FreeBSD: `Aaru media scan /dev/cd0` +Linux: `Aaru media scan /dev/sdb` +Windows: `Aaru media scan \\.\PhysicalDrive3` + +## 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 \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/Comparing-two-media-dumps.md b/Aaru.Server/wwwroot/5.0/Comparing-two-media-dumps.md new file mode 100644 index 00000000..7e0a35b7 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Comparing-two-media-dumps.md @@ -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 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] +``` + +`-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 + +```bash +Aaru image compare mydisc.cue anotherdisc.mds +``` + +## Operating system support + +| OS | Supported | +|----|-----------| +| FreeBSD | Yes | +| macOS | Yes | +| Linux | Yes | +| Windows | Yes | diff --git a/Aaru.Server/wwwroot/5.0/Comparison.md b/Aaru.Server/wwwroot/5.0/Comparison.md new file mode 100644 index 00000000..b84a77af --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Comparison.md @@ -0,0 +1,73 @@ +In this page you can find a comparison between Aaru and other dump image managers or creators. + +## Comparison of optical discs image managers + +| | Aaru | DiscImageCreator | CDRWin | CloneCD | Alcohol 120% | IsoBuster | WinImage | +|-------------------------------------------------|--------------------------|------------------|----------|----------|--------------|-----------|-----------| +| Opensource | Yes | [Yes](https://github.com/saramibreak/DiscImageCreator) | No | No | No | No | No | +| Supported platforms | Windows, Linux, macOS¹ | Windows | Windows | Windows | Windows | Windows | Windows | +| Supported formats | [12](https://github.com/aaru-dps/Aaru/blob/master/README.md#supported-disk-image-formats-read-and-write) | 3² | 1³ | 1⁴ | 1⁵ | 17⁶ | 1⁷ | +| Can dump Audio CD | Yes⁸ | Yes | Yes | Yes | Yes | Yes | No | +| Can dump Mode 0 tracks | Yes | No | No | No | No | No | No | +| Can dump Mode 1 tracks | Yes | Yes | Yes | Yes | Yes | Yes | Yes | +| Can dump Mode 2 tracks | Yes⁸ | Yes | Yes | Yes | Yes | Yes | Yes | +| Can dump multisession discs | Yes | Yes | No | Yes | Yes | Yes | No | +| Can dump discs with errors | Yes⁹ | Yes¹⁰ | No¹¹ | Yes¹⁰ | Yes¹⁰ | Unknown | Unknown | +| Reads subchannel | Yes | Yes | No¹² | Yes | Yes | Unknown | No | +| Reads lead-in postgap | Yes | Yes | No | No | No | No | No | +| Supports illegal TOCs | Yes | Yes | No | Yes | Yes | Yes | No | +| Supports error based copy protections | Yes | Yes | No | Yes | Yes | Yes | No | +| Supports twin sectors based copy protections | Not yet¹³ | No | No | No | No | No | No | +| 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 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 | +| Supports dumping Xbox Game discs | Yes²¹ ²² | Yes²² | No | No | No | No | No | + +1. macOS does not yet support dumping media, only managing existing +images + +2. CDRWin, CloneCD and raw + +3. CDRWin + +4. CloneCD + +5. Alcohol 120% + +6. Alcohol 120%, BlindWrite 5, BlindWrite 6, CD-i OptImage, CDRWin, CloneCD, DiscJuggler, Easy CD Creator, IsoBuster, Nero, NTI, PlexTools, Prassi PrimoCD, Prassi PrimoDVD, raw, Virtual CD and WinOnCD + +7. Raw + +8. It can lose a few seconds from start of audio on some discs + +9. Depending on the drive it can recover data from sectors with errors + +10. Writes fake data in the place of sectors with errors + +11. Ignores errors or stops on error + +12. Only if it detects the disc is | No a CD+G + +13. Pending format support + +14. None of its supported formats support the DDCD media + +15. Feature will be added in next release + +16. Does not include encrypted video media + +17. Includes PlayStation DVD + +18. Customized PFI information, like PSN of start LBA in DVD-RAM will be lost + +19. Customized PFI information, like PSN of start LBA in HD DVD-RAM will be lost + +20. Includes PlayStation Blu-ray + +21. XGD2 are untested + +22. XGD3 are not supported \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/Configure-Aaru-statistics.md b/Aaru.Server/wwwroot/5.0/Configure-Aaru-statistics.md new file mode 100644 index 00000000..e1a6bd6d --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Configure-Aaru-statistics.md @@ -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 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 operating system where Aaru is run. This information is not, and will never be, sold to any third party, and is publicly available at [https://www.aaru.app](https://www.aaru.app) + +## Command usage + +```bash +Aaru -d [true/false] -v [true/false] configure -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 + +```bash +Aaru configure +``` + +## Operating system support + +| OS | Supported | +|----|-----------| +| FreeBSD | Yes | +| macOS | Yes | +| Linux | Yes | +| Windows | Yes | diff --git a/Aaru.Server/wwwroot/5.0/Convert-image.md b/Aaru.Server/wwwroot/5.0/Convert-image.md new file mode 100644 index 00000000..50e95e9f --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Convert-image.md @@ -0,0 +1,47 @@ +# Table of Contents + +- [Command Description](#command-description) +- [Command usage](#command-usage) +- [Example](#example) + + +## 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 --comments --creator --drive-manufacturer manufacturer> --drive-model --drive-revision --drive-serial -f [true/false] --media-barcode --media-lastsequence --media-manufacturer --media-model --media-partnumber --media-sequence --media-serial --media-title -O <options> -p <format> -r <resume file> -x <xml sidecar> <input-path> <output-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)* +`-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 +`-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.dicf +``` + diff --git a/Aaru.Server/wwwroot/5.0/Creating-a-dump-from-physical-media.md b/Aaru.Server/wwwroot/5.0/Creating-a-dump-from-physical-media.md new file mode 100644 index 00000000..0776dd4c --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Creating-a-dump-from-physical-media.md @@ -0,0 +1,68 @@ +# Table of Contents + +- [Command Description](#command-description) +- [Command usage](#command-usage) +- [Example](#example) +- [Operating system support](#operating-system-support) + + +## 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, even with 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> +``` + +`-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)* +`-m, --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)* +`<aaru-remote-host>` connects to an Aaru Remote Host with aaru:/// + +## 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.dicf` + +## 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 \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/Creating-metadata-sidecar-XML.md b/Aaru.Server/wwwroot/5.0/Creating-metadata-sidecar-XML.md new file mode 100644 index 00000000..f77214f9 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Creating-metadata-sidecar-XML.md @@ -0,0 +1,41 @@ +# 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 a media dump, and if the format is recognized, create a CICM XML metadata sidecar with all information that can be automatically gotten about it, as well as all [supported checksum algorithms.](https://github.com/aaru-dps/Aaru.Documentation/blob/master/5.0/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> +``` + +`-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)* + +## 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" +``` + +## Operating system support + +| OS | Supported | +|----|-----------| +| FreeBSD | Yes | +| macOS | Yes | +| Linux | Yes | +| Windows | Yes | diff --git a/Aaru.Server/wwwroot/5.0/Decoding-and-printing-media-tags.md b/Aaru.Server/wwwroot/5.0/Decoding-and-printing-media-tags.md new file mode 100644 index 00000000..db135f62 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Decoding-and-printing-media-tags.md @@ -0,0 +1,40 @@ +# Table of Contents + +- [Command Description](#command-description) +- [Command usage](#command-usage) +- [Example](#example) +- [Operating system support](#operating-system-support) + + +## Command Description + +This operation will decode all [sector tags](https://github.com/aaru-dps/Aaru.Documentation/blob/master/5.0/Sector-tags.md) and [media tags](https://github.com/aaru-dps/Aaru.Documentation/blob/master/5.0/Media-tags.md) on 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> +``` + +`-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)* + +## Example + +```bash +Aaru image decode -s 1000 -l 15 -p false mydisc.cue +``` + +## Operating system support + +| OS | Supported | +|----|-----------| +| FreeBSD | Yes | +| macOS | Yes | +| Linux | Yes | +| Windows | Yes | diff --git a/Aaru.Server/wwwroot/5.0/Extracting-files-from-a-media-dump.md b/Aaru.Server/wwwroot/5.0/Extracting-files-from-a-media-dump.md new file mode 100644 index 00000000..e7bb02dc --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Extracting-files-from-a-media-dump.md @@ -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 analyze and find all filesystems in a media dump and extract the files that are contained in [supported filesystems.](https://github.com/aaru-dps/Aaru.Documentation/blob/master/5.0/Filesystems-recognized-by-Aaru.md) +## Command usage + +```bash +Aaru -d [true/false] -v [true/false] filesystem extract -h [true/false] -e [encoding] -O <options> -x [true/false] -n <namespace> +``` + +`-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 + +## Example + +```bash +Aaru filesystem extract -x -e iso8859-15 mydisc.cue contents +``` + +## Operating system support + +| OS | Supported | +|----|-----------| +| FreeBSD | Yes | +| macOS | Yes | +| Linux | Yes | +| Windows | Yes | diff --git a/Aaru.Server/wwwroot/5.0/Filesystems-recognized-by-Aaru.md b/Aaru.Server/wwwroot/5.0/Filesystems-recognized-by-Aaru.md new file mode 100644 index 00000000..a2e81e99 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Filesystems-recognized-by-Aaru.md @@ -0,0 +1,76 @@ +Supported file systems for read-only operations +=============================================== +* Apple DOS file system +* Apple Lisa file system +* Apple Macintosh File System (MFS) +* CP/M file system +* U.C.S.D Pascal file system + +Supported file systems for identification and information only +============================================================== +* 3DO Opera file system +* 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 Hierarchical File System (HFS) +* Apple Hierarchical File System+ (HFS+) +* Apple ProDOS / SOS file system +* AtheOS file system +* B-tree file system (btrfs) +* 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 +* Cram file system +* 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 +* Flash-Friendly File System (F2FS) +* Fossil file system (from Plan9) +* HAMMER file system +* High Sierra Format +* HP Logical Interchange Format +* IBM Journaling File System (JFS) +* ISO9660 +* Linux extended file system +* Linux extended file system 2 +* Linux extended file system 3 +* Linux extended file system 4 +* Locus file system +* MicroDOS file system +* Microsoft 12-bit File Allocation Table (FAT12), including Atari ST extensions +* 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 +* NILFS2 +* OS-9 Random Block File +* Professional File System +* QNX4 and QNX6 filesystems +* Reiser file systems +* SGI Extent File System (EFS) +* SGI XFS +* SmartFileSystem +* SolarOS file system +* Squash file system +* UNICOS 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 +* Zettabyte File System (ZFS) \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/Frequently-Asked-Questions.md b/Aaru.Server/wwwroot/5.0/Frequently-Asked-Questions.md new file mode 100644 index 00000000..9533e852 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Frequently-Asked-Questions.md @@ -0,0 +1,20 @@ +# Why the name, why Aaru? +Aaru is the Ancient Egyptian concept of paradise where your soul would be rebirthed after the preservation of your physical body. That's why we chose this name, because of the paradise where data will reside after it's has been preserved from its original physical media. + +# Which operating systems does Aaru work under? +Any operating system with a .NET Core 2.0 runtime should work. Has been tested under Windows, Linux, Mac OS X and FreeBSD. + +# Will you support media dump image format XXXX? +If you can send me documentation, test images and/or the application that creates them, I will do my best to. + +# Will you create a graphical interface for Aaru? +After all features are implemented (analyze, dump, browse), I will. + +# Can I use any of your modules? +As long as you comply with the LGPL license, yes. I would thank you if you tell me where you're using them. + +# Can I use the CICM XML metadata sidecar format in my project? +Of course, I invite you to use it extensively and provide me with as much feedback as you can. + +# I have tried Aaru and found a bug, how can I tell you? +Please don't send me an email, it will simply fall in oblivion. Github has a pretty nice bug tracker, just click [Issues](https://github.com/aaru-dps/Aaru/issues) and create a New Issue, that way the bug will not be forgotten and you can follow progress on its solution. diff --git a/Aaru.Server/wwwroot/5.0/Get-a-hexadecimal-print-of-a-media-dump-sector-or-block.md b/Aaru.Server/wwwroot/5.0/Get-a-hexadecimal-print-of-a-media-dump-sector-or-block.md new file mode 100644 index 00000000..5dc96a2c --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Get-a-hexadecimal-print-of-a-media-dump-sector-or-block.md @@ -0,0 +1,40 @@ +# Table of Contents + +- [Command Description](#command-description) +- [Command usage](#command-usage) +- [Example](#example) +- [Operating system support](#operating-system-support) + + +## Command Description + +This operation will print a hexadecimal dump in the console of the chosen sector/block of the indicated media dump image. + +## 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> +``` + +`-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)* + +## Example + +```bash +Aaru image print -s 15 -l 30 -r -w 64 mydisc.cue +``` + +## Operating system support + +| OS | Supported | +|----|-----------| +| FreeBSD | Yes | +| macOS | Yes | +| Linux | Yes | +| Windows | Yes | diff --git a/Aaru.Server/wwwroot/5.0/Getting-hashes-and-checksums-from-a-media-dump.md b/Aaru.Server/wwwroot/5.0/Getting-hashes-and-checksums-from-a-media-dump.md new file mode 100644 index 00000000..d5b5c882 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Getting-hashes-and-checksums-from-a-media-dump.md @@ -0,0 +1,51 @@ +# Table of Contents + +- [Command Description](#command-description) +- [Command usage](#command-usage) +- [Example](#example) +- [Operating system support](#operating-system-support) + + +## 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> +``` + +`-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)* + +## Example + +```bash +Aaru image checksum -a false --sha512 true mydisc.cue +``` + +## Operating system support + +| OS | Supported | +|----|-----------| +| FreeBSD | Yes | +| macOS | Yes | +| Linux | Yes | +| Windows | Yes | diff --git a/Aaru.Server/wwwroot/5.0/Getting-information-from-a-media-dump.md b/Aaru.Server/wwwroot/5.0/Getting-information-from-a-media-dump.md new file mode 100644 index 00000000..89d98073 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Getting-information-from-a-media-dump.md @@ -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 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> +``` + +`-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 + +```bash +Aaru image info mydisc.cue +``` + +## Operating system support + +| OS | Supported | +|----|-----------| +| FreeBSD | Yes | +| macOS | Yes | +| Linux | Yes | +| Windows | Yes | diff --git a/Aaru.Server/wwwroot/5.0/Getting-information-from-a-physical-device.md b/Aaru.Server/wwwroot/5.0/Getting-information-from-a-physical-device.md new file mode 100644 index 00000000..7c745ab6 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Getting-information-from-a-physical-device.md @@ -0,0 +1,54 @@ +# 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.](https://github.com/aaru-dps/Aaru.Documentation/blob/master/5.0/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 diff --git a/Aaru.Server/wwwroot/5.0/Getting-information-from-media-inserted-in-a-physical-device.md b/Aaru.Server/wwwroot/5.0/Getting-information-from-media-inserted-in-a-physical-device.md new file mode 100644 index 00000000..e6545d9a --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Getting-information-from-media-inserted-in-a-physical-device.md @@ -0,0 +1,48 @@ +# 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 the inserted media in a physical device. For information about supported physical devices check [the list of supported physical devices.](https://github.com/Senn1/Aaru.Documentation/blob/master/5.0/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> +``` + +`-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 media info /dev/cd0` +Linux: `Aaru media info /dev/sdb` +Windows: `Aaru media info \\.\PhysicalDrive3` + +## 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. Use device-info command \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/List-files.md b/Aaru.Server/wwwroot/5.0/List-files.md new file mode 100644 index 00000000..25b946e0 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/List-files.md @@ -0,0 +1,23 @@ +## Command description +This operation will analyze and find all filesystems in a media dump and list all the files that are contained in [[Filesystems-recognized-by-Aaru.md|supported filesystems]]. + +## Command usage +```aaru -d [true/false] -v [true/false] filesystem list -h [true/false] -e [encoding] -l [true/false]``` + +```-d, --debug [true/false]```shows debug output *(default false)* + +```-v, --verbose [true/false]``` shows verbose output *(default false)* + +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches '*(default false)* + +```-e, --encoding [encoding]``` sets which encoding is used by the contents of the media dump *(default varies by filesystem)* + +```-l, --long [true/false]``` uses a long listing format, showing sizes and extended attributes *(default false)* + +## Example +```aaru filesystem list -l -e x-mac-icelandic mydisc.cue``` + +## Operating system support +|FreeBSD|macOS|Linux|Windows| +|---|---|---|---| +|Yes|Yes|Yes|Yes| diff --git a/Aaru.Server/wwwroot/5.0/List-filesystem-options.md b/Aaru.Server/wwwroot/5.0/List-filesystem-options.md new file mode 100644 index 00000000..132b04cb --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/List-filesystem-options.md @@ -0,0 +1,22 @@ +## Command description +Lists all options supported by read-only filesystems. + + +## Command usage +```aaru -d [true/false] -v [true/false] filesystem options -h [true/false]``` + +```-d, --debug [true/false]``` shows debug output *(default false)* + +```-v, --verbose [true/false]``` shows verbose output *(default false)* + +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* + + +## Example +```aaru filesystem options``` + +## Operating system support +|FreeBSD|macOS|Linux|Windows| +|---|---|---|---| +|Yes|Yes|Yes|Yes| + diff --git a/Aaru.Server/wwwroot/5.0/List-image-options.md b/Aaru.Server/wwwroot/5.0/List-image-options.md new file mode 100644 index 00000000..d6b3d90d --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/List-image-options.md @@ -0,0 +1,20 @@ +## Command description + Lists all options supported by writable media images. + +## Command usage +```aaru -d [true/false] -v [true/false] image options -h [true/false]``` + +```-d, --debug [true/false]``` shows debug output *(default false)* + +```-v, --verbose [true/false]``` shows verbose output *(default false)* + +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* + + +## Example +```aaru image options``` + +## Operating system support +|FreeBSD|macOS|Linux|Windows| +|---|---|---|---| +|Yes|Yes|Yes|Yes| diff --git a/Aaru.Server/wwwroot/5.0/List-supported-devices.md b/Aaru.Server/wwwroot/5.0/List-supported-devices.md new file mode 100644 index 00000000..b6839ea6 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/List-supported-devices.md @@ -0,0 +1,22 @@ +## Command description +This operation will show all known attached devices on your system and if they are supported for device dependent operations. + +## Command usage +```aaru -d [true/false] -v [true/false] device list -h [true/false] <aaru-remote-host>``` + +```-d, --debug [true/false]``` shows debug output *(default false)* + +```-v, --verbose [true/false]``` shows verbose output *(default false)* + +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* + +```<aaru-remote-host>``` connects to an Aaru Remote Host with ```aaru://<IP ADDRESS>``` + +## Example +```aaru device list aaru://192.168.1.25``` + +## Operating system support + +|FreeBSD|macOS|Linux|Windows| +|---|---|---|---| +|Yes|Yes|Yes|Yes| \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/List-supported-encodings.md b/Aaru.Server/wwwroot/5.0/List-supported-encodings.md new file mode 100644 index 00000000..b5e54e86 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/List-supported-encodings.md @@ -0,0 +1,20 @@ +## Command description +This operation will list all your character set encodings supported in your environment. This list depends on libraries installed on your system, so if an encoding is available in one environment there are no guarantees it will be available in another one. + +## Command usage +```aaru -d [true/false] -v [true/false] list-encodings -h [true/false]``` + +```-d, --debug [true/false]``` shows debug output *(default false)* + +```-v, --verbose [true/false]``` shows verbose output *(default false)* + +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* + + +## Example +```aaru list-encodings``` + +## Operating system support +|FreeBSD|macOS|Linux|Windows| +|---|---|---|---| +|Yes|Yes|Yes|Yes| diff --git a/Aaru.Server/wwwroot/5.0/List-supported-formats.md b/Aaru.Server/wwwroot/5.0/List-supported-formats.md new file mode 100644 index 00000000..45545088 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/List-supported-formats.md @@ -0,0 +1,20 @@ +## Command description +This operation will list all filters, dump media formats, partitioning schemes and filesystems supported by your version of Aaru. + +## Command usage +```aaru -d [true/false] -v [true/false] formats -h [true/false]``` + +```-d, --debug [true/false]``` shows debug output *(default false)* + +```-v, --verbose [true/false]``` shows verbose output *(default false)* + +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* + + +## Example +```aaru formats``` + +## Operating system support +|FreeBSD|macOS|Linux|Windows| +|---|---|---|---| +|Yes|Yes|Yes|Yes| diff --git a/Aaru.Server/wwwroot/5.0/List-supported-namespaces.md b/Aaru.Server/wwwroot/5.0/List-supported-namespaces.md new file mode 100644 index 00000000..f34d5ed4 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/List-supported-namespaces.md @@ -0,0 +1,20 @@ +## Command description +This operation will list all the supported namespaces of the [[Filesystems-recognized-by-DiscImageChef|supported filesystems]]. + +## Command usage +```aaru -d [true/false] -v [true/false] list-namespaces -h [true/false]``` + +```-d, --debug [true/false]``` shows debug output *(default false)* + +```-v, --verbose [true/false]``` shows verbose output *(default false)* + +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* + + +## Example +```aaru list-namespaces``` + +## Operating system support +|FreeBSD|macOS|Linux|Windows| +|---|---|---|---| +|Yes|Yes|Yes|Yes| diff --git a/Aaru.Server/wwwroot/5.0/Media-dump-formats-supported-by-Aaru.md b/Aaru.Server/wwwroot/5.0/Media-dump-formats-supported-by-Aaru.md new file mode 100644 index 00000000..bd4bcba2 Binary files /dev/null and b/Aaru.Server/wwwroot/5.0/Media-dump-formats-supported-by-Aaru.md differ diff --git a/Aaru.Server/wwwroot/5.0/Media-tags.md b/Aaru.Server/wwwroot/5.0/Media-tags.md new file mode 100644 index 00000000..0c374bf9 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Media-tags.md @@ -0,0 +1,59 @@ +A media tag is data that accompany the media or the device, and is stored on the medium besides the user data, or normally accessible. Media tags are usually used to store metadata about the medium, copy protection information, or information about the device used to read the media. + +# Compact Disc media tags +* Table of contents (cooked by drive) +* Full table of contents (cooked by drive) +* Session information +* Program Management Area +* Absolute Time In Pregroove +* CD-Text +* Media Catalogue Number + +# DVD and HD DVD media tags +* Physical Format Information +* Lead-in Copyright Management Information +* CSS Disc Key +* Burst Cutting Area +* Lead-in Disc Manufacturer Information +* Media identifier +* CSS/CPPM Media Key Block +* Disc Description Structures +* Media status +* Spare Area Information +* RMD +* Pre-recorded information in Lead-in +* Pre-recorded Physical Format Information +* Layer capacity +* Middle zone start address +* Jump interval size +* Start LBA of the manual layer jump +* Pseudo-overwrite information + +# Blu-ray media tags +* Disc Information +* Burst Cutting Area +* Disc Definition Structure +* Cartridge Status +* Spare Area Status + +# AACS media tags for HD DVD and Blu-ray +* Volume identifier +* Pre-recorded media serial number +* Media identifier +* Media Key Block +* AACS Data Keys +* Encrypted LBA extents +* CPRM Media Key Block + +# Media tags defined by MMC specifications +* Recognized hybrid layers +* Write protection status +* Disc standard information +* Disc track resources information + +# Device tags defined by SCSI specifications +* Inquiry response + +# Device tags defined by ATA/ATAPI specifications +* Ata Identify response +* Atapi Identify response \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/Partitioning-schemes-recognized-by-Aaru.md b/Aaru.Server/wwwroot/5.0/Partitioning-schemes-recognized-by-Aaru.md new file mode 100644 index 00000000..a39d6a93 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Partitioning-schemes-recognized-by-Aaru.md @@ -0,0 +1,24 @@ +* Acorn Linux and RISCiX partitions +* ACT Apricot partitions +* Amiga Rigid Disk Block (RDB) +* Apple Partition Map +* Atari AHDI and ICDPro +* BSD disklabels +* BSD slices inside MBR +* DEC disklabels +* DragonFly BSD 64-bit disklabel +* EFI GUID Partition Table (GPT) +* Human68k (Sharp X68000) partitions table +* Microsoft/IBM/Intel Master Boot Record (MBR) +* Minix subpartitions inside MBR +* NEC PC9800 partitions +* NeXT disklabel +* Plan9 partition table +* Rio Karma partitions +* SGI volume headers +* Solaris slices inside MBR +* Sun disklabel +* UNIX VTOC and disklabel +* UNIX VTOC inside MBR +* Xbox 360 hard coded partitions +* XENIX partition table \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/README.md b/Aaru.Server/wwwroot/5.0/README.md new file mode 100644 index 00000000..53a53b5f --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/README.md @@ -0,0 +1,47 @@ +# Welcome to the Aaru wiki. + +Aaru is a tool designed to handle different media dump formats (also called disc or disk images) and do common operations with them. + +## What do you want to do? +* [[Analyzing-a-media-dump.mediawiki|Analyze a media dump|]] +* [[Getting-hashes-and-checksums-from-a-media-dump.mediawiki|Get checksums or hashes from a dump]] +* [[Comparing-two-media-dumps.mediawiki|Compare two media dumps]] +* [[Getting-information-from-a-media-dump.mediawiki|Get information from a media dump]] +* [[Configure-Aaru-statistics.mediawiki|Set which information will Aaru send to you]] +* [[Convert-image.mediawiki|Convert a media dump from one format to another]] +* [[Creating-metadata-sidecar-XML.mediawiki|Create XML sidecar with metadata of a dump]] +* [[Decoding-and-printing-media-tags.mediawiki|Decode media tags and print them]] +* [[Getting-information-from-a-physical-device.mediawiki|Get information from a physical device]] +* [[Reporting-physical-device-capabilities.mediawiki|Test physical device capabilities and create an XML report of them]] +* [[Creating-a-dump-from-physical-media.mediawiki|Create a media dump from a physical device]] +* [[Calculate-dump-contents-entropy.mediawiki|Calculate entropy of a media dump]] +* [[Extracting-files-from-a-media-dump.mediawiki|Extract all files contained in a media dump]] +* [[List-supported-formats.mediawiki|Get a list of all formats supported]] +* [[List-supported-devices.mediawiki|Get a list of all supported physical devices]] +* [[List-supported-encodings.mediawiki|Get a list of all supported character set encodings]] +* [[List-files.mediawiki|List all files contained in a media dump]] +* [[List-filesystem-options.mediawiki|Lists all options supported by read-only filesystems]] +* [[List-image-options.mediawiki|Lists all options supported by writable media images]] +* [[Getting-information-from-media-inserted-in-a-physical-device.mediawiki|Show information about media inserted in a physical device]] +* [[Check-readability-of-the-media-inserted-in-a-physical-device.mediawiki|Check readability of the media inserted in a physical device]] +* [[Get-a-hexadecimal-print-of-a-media-dump-sector-or-block.mediawiki|Get a hexadecimal print of a media dump sector or block]] +* [[Show-statistics.mediawiki|See my own usage statistics]] +* [[Update-database.mediawiki|Update the master database]] +* [[Verifying-media-dump-integrity.mediawiki|Verify integrity of a media dump or its contents]] +* [[Testing-connection-to-remote-server.mediawiki| Test the connection to an Aaru Remote Server]] + +## What is supported by Aaru? +* [[Supported-filters.md|Filters]] +* [[Media-dump-formats-supported-by-Aaru.mediawiki|Media dump formats]] +* [[Partitioning-schemes-recognized-by-Aaru.md|Partitioning schemes]] +* [[Filesystems-recognized-by-Aaru.md|Filesystems]] +* [[Supported-devices.mediawiki|Physical devices]] +* [[Supported-checksums.md|Checksum and hashes]] +* [[Media-tags.md|Known media tags|]] +* [[Sector-tags.md|Known sector/block tags]] + +**[[Comparison.mediawiki|Comparing Aaru to similar software]]** + +**[[Frequently-Asked-Questions.md|Frequently Asked Questions]]** + +**[[Bugs-in-other-dumping-software.md|Bugs in other dumping software]]** diff --git a/Aaru.Server/wwwroot/5.0/Reporting-physical-device-capabilities.md b/Aaru.Server/wwwroot/5.0/Reporting-physical-device-capabilities.md new file mode 100644 index 00000000..3b8b5902 Binary files /dev/null and b/Aaru.Server/wwwroot/5.0/Reporting-physical-device-capabilities.md differ diff --git a/Aaru.Server/wwwroot/5.0/Sector-tags.md b/Aaru.Server/wwwroot/5.0/Sector-tags.md new file mode 100644 index 00000000..47cabf15 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Sector-tags.md @@ -0,0 +1,19 @@ +A sector tag is data that accompany the sector, but it's not part of the data written by the user, or normally accessible. Sector tags can be used to contain metadata about that sector, such as error detection and correction, filesystem recovery information, copy protection, etc... + +# Floppy disk sector tags +* Apple GCR sector tags + +# Compact Disc sector tags +* Data sector sync frame +* Data sector header +* Mode 2 data sector subheader +* Data sector EDC +* Data sector ECC P +* Data sector ECC Q +* Data sector ECC (P and Q) +* Data sector subchannels (P to W) +* Track ISRC +* Track flags + +# DVD sector tags +* Copyright information diff --git a/Aaru.Server/wwwroot/5.0/Show-statistics.md b/Aaru.Server/wwwroot/5.0/Show-statistics.md new file mode 100644 index 00000000..761f9048 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Show-statistics.md @@ -0,0 +1,20 @@ +## Command description +This operation will show the statistics that have been stored locally on your environment. + +## Command usage +```aaru -d [true/false] -v [true/false] database stats -h [true/false]``` + +```-d, --debug [true/false]``` shows debug output *(default false)* + +```-v, --verbose [true/false]``` shows verbose output *(default false)* + +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* + + +## Example +```aaru database stats``` + +## Operating system support +| FreeBSD | macOS | Linux | Windows | +|---|---|---|---| +| Yes | Yes | Yes | Yes | \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/Supported-checksums.md b/Aaru.Server/wwwroot/5.0/Supported-checksums.md new file mode 100644 index 00000000..1f2b5a80 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Supported-checksums.md @@ -0,0 +1,11 @@ +* Adler-32 +* CRC-16 +* CRC-32 +* CRC-64 +* Fletcher-16 +* Fletcher-32 +* MD5 +* RMD160 +* SHA-1 +* SHA-2 (256, 384 and 512 bits) +* SpamSum (fuzzy hashing) \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/Supported-devices.md b/Aaru.Server/wwwroot/5.0/Supported-devices.md new file mode 100644 index 00000000..a1267861 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Supported-devices.md @@ -0,0 +1,25 @@ +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⁹ | + +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 \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/Supported-filters.md b/Aaru.Server/wwwroot/5.0/Supported-filters.md new file mode 100644 index 00000000..b56ade8c --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Supported-filters.md @@ -0,0 +1,8 @@ +* Apple PCExchange (FINDER.DAT & RESOURCE.FRK) +* AppleDouble +* AppleSingle +* BZip2 +* GZip +* LZip +* MacBinary I, II, III +* XZ \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/Testing-connection-to-remote-server.md b/Aaru.Server/wwwroot/5.0/Testing-connection-to-remote-server.md new file mode 100644 index 00000000..2fdd3115 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Testing-connection-to-remote-server.md @@ -0,0 +1,23 @@ +## Command description +This operation tests the connection between Aaru and the specified Aaru Remote Server. + +## Command usage +```aaru -d [true/false] -v [true/false] remote -h [true/false] <aaru-remote-host>``` + +```-d, --debug [true/false]``` shows debug output *(default false)* + +```-v, --verbose [true/false]``` shows verbose output *(default false)* + +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* + +```<aaru-remote-host>``` connects to an Aaru Remote Host with ```aaru://<IP ADDRESS>``` + + +## Example +```aaru remote aaru://192.168.1.25``` + +## Operating system support + +| FreeBSD | macOS | Linux | Windows | +|---|---|---|---| +| Yes | Yes | Yes | Yes | \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/Update-database.md b/Aaru.Server/wwwroot/5.0/Update-database.md new file mode 100644 index 00000000..e846bd2f --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Update-database.md @@ -0,0 +1,24 @@ +## Command description +This operation will update the master database, and can optionalyl clear the master and local database. + +## Command usage +```aaru -d [true/false] -v [true/false] database update -h [true/false]``` + +```-d, --debug [true/false]``` shows debug output *(default false)* + +```-v, --verbose [true/false]``` shows verbose output *(default false)* + +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* + +```--clear [true/false]``` clears existing master database before updating *(default false)* + +```--clear-all [true/false]``` clears existing master and local database before updating *(default false)* + +## Example +```aaru database update --clear-all``` + +## Operating system support + +| FreeBSD | macOS | Linux | Windows | +|---|---|---|---| +| Yes | Yes | Yes | Yes | \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/Verifying-media-dump-integrity.md b/Aaru.Server/wwwroot/5.0/Verifying-media-dump-integrity.md new file mode 100644 index 00000000..1c1b327d --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/Verifying-media-dump-integrity.md @@ -0,0 +1,28 @@ +## Command description +This operation will verify a media dump. +If the media dump format includes a hash or checksum, it will calculate and compare it. +If the media sectors/blocks format include a hash, checksum or error recovery system, it will calculate and compare them. + +## Command usage +```aaru -d [true/false] -v [true/false] image verify -h [true/false] -s [true/false] -w [true/false] <image-path>``` + +```-d, --debug [true/false]``` shows debug output *(default false)* + +```-v, --verbose [true/false]``` shows verbose output *(default false)* + +```-h, --help [true/false]``` shows help screen for the command instead of running it, ignores all other switches *(default false)* + +```-s, --verify-sectors [true/false]``` calculates and verifies the hash/checksum/ecc of every sector/block in the media dump *(default true)* + +```-w, --verify-disc [true/false]``` calculates and verifies a media dump format checksum/hash *(default true)* + + +## Example +```aaru image verify mydisc.cue``` + + +## Operating system support + +| FreeBSD | macOS | Linux | Windows | +|---|---|---|---| +| Yes | Yes | Yes | Yes | \ No newline at end of file diff --git a/Aaru.Server/wwwroot/5.0/_Footer.md b/Aaru.Server/wwwroot/5.0/_Footer.md new file mode 100644 index 00000000..3a5f8e35 --- /dev/null +++ b/Aaru.Server/wwwroot/5.0/_Footer.md @@ -0,0 +1 @@ +Aaru © 2011-2020 Natalia Portillo diff --git a/Aaru.Server/wwwroot/5.3/Quickstart.md b/Aaru.Server/wwwroot/5.3/Quickstart.md new file mode 100644 index 00000000..41b13eba --- /dev/null +++ b/Aaru.Server/wwwroot/5.3/Quickstart.md @@ -0,0 +1,36 @@ +# Quickstart + +## 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. + +### Examples (Windows): + +`aaru media dump E: Image.aaruf` + +`aaru media dump F: Image.iso -f` + +### Examples (Linux): + +`aaru media dump /dev/sr0 Image.aaruf` + +`aaru media dump /dev/sr1 Image.iso -f` + +## Comparing Between Two Media Dumps +Comparing between media dumps using Aaru is simple! All you have to do is run the command `aaru image compare image-1 image-2`. Neither of the dumps being compared have to be created by Aaru, they can be any of the supported formats from any software. + +### Examples (All OS’): + +`aaru image compare Image1.aaruf Image2.cue` + +`aaru image compare Image1.iso Image2.ccd` + +## Analysing a Media Dump +WIP + +## Extracting Content From a Media Dump +Aaru can extract the files from any supported media dump, as long as it uses a supported filesystem to store its files. The command for this is “aaru filesystem extract *Image* *Output folder*”. You can also add “-x” to the end of the command to extract the more technical extended attributes from an image as well. + +### Examples: +`aaru filesystem extract Image.aaruf Output` + +`aaru filesystem extract Image.ccd Output -x` diff --git a/Aaru.Server/wwwroot/README.md b/Aaru.Server/wwwroot/README.md new file mode 100644 index 00000000..0549cab8 --- /dev/null +++ b/Aaru.Server/wwwroot/README.md @@ -0,0 +1,35 @@ +# Aaru Data Preservation Suite + +Hello! **Aaru Data Preservation Suite** is a fully-featured software package to preserve all storage media from the very old to the cutting edge, as well as to give detailed information about any supported image file (whether from Aaru or not) and to extract the files from those images. + +## Aaru DPS includes: +- **Aaru** + - The main software that does all the heavy lifting, including dumping and extraction. +- **Aaru Remote** + - A slim application that allows Aaru to dump media or run other commands on an unsupported system via a network connection. +- **Libaaruformat** + - C implementation of the Aaru Image Format. +- And more! + +## Key features of Aaru: + +- Aaru Image Format, the format that stores the most amount of data for any given format, and supports media of almost any type. +- Dumps almost any kind of storage media, with more types of media being added whenever possible. +- Able to read information and extract files from many different formats, as well as easily convert from any format to many other compatible formats. +- Automatically stores metadata, including checksums, of the image files and their tracks (if applicable) in an easily accessible XML, and can generate this data for any image. + +## Key features of the Aaru Image Format: +- Stores the most amount of data compared to any other image format for supported media. +- Uses compression to take up the least space possible compared to any other format. +- Can be used to store data from any type of media supported by Aaru. +- Can be converted to many formats supported by Aaru, so you can easily create an ISO (or other image types) for software that doesn’t support the Aaru Image Format. + +## Installation + +Download the latest release from https://github.com/aaru-dps/Aaru/releases + +For a practical UI for Aaru, we recommend using the [Media Preservation Frontend](https://github.com/SabreTools/MPF). + +## Quickstart + +See the [Quickstart](5.3/Quickstart.md) section of the docs! \ No newline at end of file diff --git a/Aaru.Server/wwwroot/_Footer.md b/Aaru.Server/wwwroot/_Footer.md new file mode 100644 index 00000000..3a5f8e35 --- /dev/null +++ b/Aaru.Server/wwwroot/_Footer.md @@ -0,0 +1 @@ +Aaru © 2011-2020 Natalia Portillo diff --git a/Aaru.Server/wwwroot/_coverpage.md b/Aaru.Server/wwwroot/_coverpage.md new file mode 100644 index 00000000..1f1c338b --- /dev/null +++ b/Aaru.Server/wwwroot/_coverpage.md @@ -0,0 +1,8 @@ +![logo](assets/img/aaru.png) + +# Aaru Data Preservation Suite + +> A fully featured media dump management solution + +[GitHub](https://github.com/aaru-dps/aaru/) +[Getting Started](#aaru-data-preservation-suite) diff --git a/Aaru.Server/wwwroot/_sidebar.md b/Aaru.Server/wwwroot/_sidebar.md new file mode 100644 index 00000000..792eaa9e --- /dev/null +++ b/Aaru.Server/wwwroot/_sidebar.md @@ -0,0 +1,48 @@ +- Getting started + - [Quickstart](5.3/Quickstart.md) + - [Creating a media dump](Creating-a-dump-from-physical-media.md) + - [Analyzing a media dump](Analyzing-a-media-dump.md) + - [Comparing two media dumps](Comparing-two-media-dumps.md) + - [Extracting files from a media dump](Extracting-files-from-a-media-dump.md) + - [Calculate hashes and checksums](Getting-hashes-and-checksums-from-a-media-dump.md) + +- Configuration + + - [Configure statistics](Configure-Aaru-statistics.md) + +- Detection + + - [Check readability of the media](Check-readability-of-the-media-inserted-in-a-physical-device.md) + +- Analysis + + - [Creating metadata sidecar](Creating-metadata-sidecar-XML.md) + - [Decoding and printing media tags](Decoding-and-printing-media-tags.md) + - [Supported media tags](Media-tags.md) + - [Hexadecimal print of a media dump](Get-a-hexadecimal-print-of-a-media-dump-sector-or-block.md) + - [Calculate dump contents entropy](Calculate-dump-contents-entropy.md) + - [Get info about a media dump](Getting-information-from-a-media-dump.md) + - [Get info about a physical device](Getting-information-from-a-physical-device.md) + - [Get info about a inserted media](Getting-information-from-media-inserted-in-a-physical-device.md) + +- Conversion + + - [Convert a media dump](Convert-image.md) + +- Listing + + - [List files](List-files.md) + - [List filesystem options](List-filesystem-options.md) + - [List image options](List-image-options.md) + - [List supported devices](List-supported-devices.md) + - [List supported encodings](List-supported-encodings.md) + - [List supported formats](List-supported-formats.md) + - [List supported namespaces](List-supported-namespaces.md) + +- FAQ + + - [Filesystems recognized by Aaru](Filesystems-recognized-by-Aaru.md) + - [Media dump formats supported by Aaru](Media-dump-formats-supported-by-Aaru.md) + - [Comparing Aaru with other solutions](Comparison.md) + - [Bugs in other dumping software](Bugs-in-other-dumping-software.md) + - [More FAQ](FAQ.md) diff --git a/Aaru.Server/wwwroot/assets/.DS_Store b/Aaru.Server/wwwroot/assets/.DS_Store new file mode 100644 index 00000000..498272f3 Binary files /dev/null and b/Aaru.Server/wwwroot/assets/.DS_Store differ diff --git a/Aaru.Server/wwwroot/assets/img/.DS_Store b/Aaru.Server/wwwroot/assets/img/.DS_Store new file mode 100644 index 00000000..128acd05 Binary files /dev/null and b/Aaru.Server/wwwroot/assets/img/.DS_Store differ diff --git a/Aaru.Server/wwwroot/assets/img/aaru.png b/Aaru.Server/wwwroot/assets/img/aaru.png new file mode 100644 index 00000000..d19691f6 Binary files /dev/null and b/Aaru.Server/wwwroot/assets/img/aaru.png differ diff --git a/Aaru.Server/wwwroot/assets/img/github.svg b/Aaru.Server/wwwroot/assets/img/github.svg new file mode 100644 index 00000000..93af7db5 --- /dev/null +++ b/Aaru.Server/wwwroot/assets/img/github.svg @@ -0,0 +1,3 @@ +<svg width="1024" height="1024" viewBox="0 0 1024 1024" fill="none" xmlns="http://www.w3.org/2000/svg"> +<path fill-rule="evenodd" clip-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8C0 11.54 2.29 14.53 5.47 15.59C5.87 15.66 6.02 15.42 6.02 15.21C6.02 15.02 6.01 14.39 6.01 13.72C4 14.09 3.48 13.23 3.32 12.78C3.23 12.55 2.84 11.84 2.5 11.65C2.22 11.5 1.82 11.13 2.49 11.12C3.12 11.11 3.57 11.7 3.72 11.94C4.44 13.15 5.59 12.81 6.05 12.6C6.12 12.08 6.33 11.73 6.56 11.53C4.78 11.33 2.92 10.64 2.92 7.58C2.92 6.71 3.23 5.99 3.74 5.43C3.66 5.23 3.38 4.41 3.82 3.31C3.82 3.31 4.49 3.1 6.02 4.13C6.66 3.95 7.34 3.86 8.02 3.86C8.7 3.86 9.38 3.95 10.02 4.13C11.55 3.09 12.22 3.31 12.22 3.31C12.66 4.41 12.38 5.23 12.3 5.43C12.81 5.99 13.12 6.7 13.12 7.58C13.12 10.65 11.25 11.33 9.47 11.53C9.76 11.78 10.01 12.26 10.01 13.01C10.01 14.08 10 14.94 10 15.21C10 15.42 10.15 15.67 10.55 15.59C13.71 14.53 16 11.53 16 8C16 3.58 12.42 0 8 0Z" transform="scale(64)" fill="#1B1F23"/> +</svg> \ No newline at end of file diff --git a/Aaru.Server/wwwroot/index.html b/Aaru.Server/wwwroot/index.html new file mode 100644 index 00000000..205788f9 --- /dev/null +++ b/Aaru.Server/wwwroot/index.html @@ -0,0 +1,33 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="UTF-8"> + <title>Aaru Data Preservation Suite + + + + + + + + +
+ + + + + + +