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

Rename DiscImageChef to Aaru.

Browse Source
This commit is contained in:
Natalia Portillo
2021-08-18 04:22:48 +01:00
parent 1acdb6653d
commit 013614a4f0
13 changed files with 38 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
5.0/List-supported-namespaces.md
View File

@@ -1,7 +1,7 @@
## Command description
This operation will list all the supported namespaces of
the [[Filesystems-recognized-by-DiscImageChef|supported filesystems]].
the [[Filesystems-recognized-by-Aaru|supported filesystems]].
## Command usage

6
5.3/Bugs-in-other-dumping-software.md
View File

@@ -1,4 +1,4 @@
Some software contains bugs that can make users think the problem resides with DiscImageChef. This page contains a list of such bugs.
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)
@@ -6,6 +6,6 @@ Some software contains bugs that can make users think the problem resides with D
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.
DiscImageChef instead reads and interprets the 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?).
Aaru instead reads and interprets the 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 DiscImageChef 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).
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).

4
5.3/Calculate-dump-contents-entropy.md
View File

@@ -2,7 +2,7 @@
This operation will calculate uniqueness and entropy of the media represented by a media dump image. It's not affected my the image format compression if applicable.
==Command usage==
<code>DiscImageChef entropy -d [true/false] -i <dump> -p [true/false] -t [true/false] -v [true/false] -w [true/false]</code>
<code>Aaru entropy -d [true/false] -i <dump> -p [true/false] -t [true/false] -v [true/false] -w [true/false]</code>
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-i, --input=<dump></code> path to the media dump image<br />
@@ -12,7 +12,7 @@ This operation will calculate uniqueness and entropy of the media represented by
<code>-w, --whole-disc=[true/false]</code> calculates the entropy for the whole media ''(default true)''
==Example==
<code>DiscImageChef entropy -i mydisc.cue</code>
<code>Aaru entropy -i mydisc.cue</code>
==Operating system support==
{|

8
5.3/Check-readability-of-the-media-inserted-in-a-physical-device.md
View File

@@ -2,7 +2,7 @@
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>DiscImageChef media-scan -b [ibglog] -d [true/false] -i <device> -m [mhddlog] -v [true/false]</code>
<code>Aaru media-scan -b [ibglog] -d [true/false] -i <device> -m [mhddlog] -v [true/false]</code>
<code>-b, --ibg-log=[ibglog]</code> writes a log in the format used by ImgBurn<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
@@ -11,9 +11,9 @@ This operation will read the media inserted in the physical device, and measure
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
==Example==
FreeBSD: <code>DiscImageChef media-scan -i /dev/cd0</code><br />
Linux: <code>DiscImageChef media-scan -i /dev/sdb</code><br />
Windows: <code>DiscImageChef media-scan -i \\.\PhysicalDrive3</code><br />
FreeBSD: <code>Aaru media-scan -i /dev/cd0</code><br />
Linux: <code>Aaru media-scan -i /dev/sdb</code><br />
Windows: <code>Aaru media-scan -i \\.\PhysicalDrive3</code><br />
==Operating system support==
{|

6
5.3/Comparison.md
View File

@@ -1,4 +1,4 @@
In this page you can find a comparison between DiscImageChef and other dump image managers or creators.
In this page you can find a comparison between Aaru and other dump image managers or creators.
You can see a [[Comparison#comparison of optical discs image managers|comparison of optical discs image managers]],
a [[Comparison#comparison of floppy disk image managers|comparison of floppy disk image managers]], a
@@ -8,7 +8,7 @@ a [[Comparison#comparison of floppy disk image managers|comparison of floppy dis
==Comparison of optical discs image managers==
{|
!
! DiscImageChef
! Aaru
! DiscImageCreator
! CDRWin
! CloneCD
@@ -35,7 +35,7 @@ a [[Comparison#comparison of floppy disk image managers|comparison of floppy dis
| Windows
|-
| Supported formats
| [https://github.com/claunia/DiscImageChef/blob/master/README.md#supported-disk-image-formats-read-and-write 12]
| [https://github.com/aaru-dps/Aaru/blob/master/README.md#supported-disk-image-formats-read-and-write 12]
| 3<ref name="discimagecreator">CDRWin, CloneCD and raw</ref>
| 1<ref name="cdrwin">CDRWin</ref>
| 1<ref name="clonecd">CloneCD</ref>

8
5.3/Creating-a-dump-from-physical-media.md
View File

@@ -2,7 +2,7 @@
This operating will create a dump image from real media using a physical device. It will retry errors and when finished create an XML metadata sidecar and an Alcohol 120% media descriptor for optical media. The dumping operation can be interrupted and continued later, even with a different device.
==Command usage==
<code>DiscImageChef dump-media -d [true/false] -e <encoding> -f [true/false] -i <device path> -k <sectors> --lead-in [true/false] -m [true/false] --no-metadata [true/false] --no-trim [true/false] -O <options> -o <filename> --persistent [true/false] -p <passes> -s [true/false] -t <plugin> -v [true/false] -x <xml sidecar></code>
<code>Aaru dump-media -d [true/false] -e <encoding> -f [true/false] -i <device path> -k <sectors> --lead-in [true/false] -m [true/false] --no-metadata [true/false] --no-trim [true/false] -O <options> -o <filename> --persistent [true/false] -p <passes> -s [true/false] -t <plugin> -v [true/false] -x <xml sidecar></code>
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-e, --encoding=<encoding></code> character encoding to use when creating dump sidecar<br />
@@ -23,9 +23,9 @@ This operating will create a dump image from real media using a physical device.
<code>-x, --cicm-xml=<xml sidecar></code> take metadata from existing CICM XML sidecar<br />
==Example==
FreeBSD: <code>DiscImageChef dump-media -i /dev/cd0 -f --persistent=true --separate-subchannel -w mydisc</code><br />
Linux: <code>DiscImageChef dump-media -i /dev/sdb -r -f -p 15 -w myusbfloppy</code><br />
Windows: <code>DiscImageChef dump-media -i \\.\PhysicalDrive3 -f -p 0 --resume=false mydisk</code><br />
FreeBSD: <code>Aaru dump-media -i /dev/cd0 -f --persistent=true --separate-subchannel -w mydisc</code><br />
Linux: <code>Aaru dump-media -i /dev/sdb -r -f -p 15 -w myusbfloppy</code><br />
Windows: <code>Aaru dump-media -i \\.\PhysicalDrive3 -f -p 0 --resume=false mydisk</code><br />
==Operating system support==
{|

8
5.3/Creating-metadata-sidecar-XML.md
View File

@@ -2,7 +2,7 @@
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 get about it, as well as all [[Supported-checksums|supported checksum algorithms]].
==Command usage==
<code>DiscImageChef create-sidecar -b [block size] -d [true/false] -e [encoding] -i <dump> -t tape [true/false] -v [true/false]</code>
<code>Aaru create-sidecar -b [block size] -d [true/false] -e [encoding] -i <dump> -t tape [true/false] -v [true/false]</code>
<code>-b, --block-size=[block size]</code> used only for tapes, indicates fixed block size in bytes. File in dump folder not multiple of this value will be ignored ''(default 512)''<br />
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
@@ -12,9 +12,9 @@ This operation will analyze a media dump, and if the format is recognized, creat
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
==Examples==
<code>DiscImageChef create-sidecar -i mydisc.cue</code><br />
<code>DiscImageChef create-sidecar -i mytapedir -t -b 1024</code><br />
<code>DiscImageChef create-sidecar -i "My japanese software.img" -e shift_jis</code><br />
<code>Aaru create-sidecar -i mydisc.cue</code><br />
<code>Aaru create-sidecar -i mytapedir -t -b 1024</code><br />
<code>Aaru create-sidecar -i "My japanese software.img" -e shift_jis</code><br />
==Operating system support==
{|

4
5.3/Decoding-and-printing-media-tags.md
View File

@@ -2,7 +2,7 @@
This operation will decode all [[Sector-tags|sector tags]] and [[Media-tags|media tags]] on a media dump image.
==Command usage==
<code>DiscImageChef decode -d [true/false] -i <dump> -k [true/false] -l [sectors] -t [true/false] -s [start sector] -v [true/false]</code>
<code>Aaru decode -d [true/false] -i <dump> -k [true/false] -l [sectors] -t [true/false] -s [start sector] -v [true/false]</code>
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-i, --input=<dump></code> path to the media dump image<br />
@@ -13,7 +13,7 @@ This operation will decode all [[Sector-tags|sector tags]] and [[Media-tags|medi
<code>-v, --verbose=[true/false]</code> shows verbose output ''(default false)''<br />
==Example==
<code>DiscImageChef decode -i mydisc.cue -s 1000 -l 15 -t false</code>
<code>Aaru decode -i mydisc.cue -s 1000 -l 15 -t false</code>
==Operating system support==
{|

12
5.3/Frequently-Asked-Questions.md
View File

@@ -1,13 +1,13 @@
# Why the name, why DiscImageChef?
Because a chef is someone that takes raw ingredients and according to a recipe makes magic with them, and so does DiscImageChef with media dump images.
# Why the name, why Aaru?
Because a chef is someone that takes raw ingredients and according to a recipe makes magic with them, and so does Aaru with media dump images.
# Which operating systems does DiscImageChef work under?
# Which operating systems does Aaru work under?
Any operating system with a .NET 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 DiscImageChef?
# 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?
@@ -16,5 +16,5 @@ As long as you comply with the LGPL license, yes. I would thank you if you tell
# 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 DiscImageChef 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/claunia/DiscImageChef/issues) and create a New Issue, that way the bug will not be forgotten and you can follow progress on its solution.
# 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/claunia/Aaru/issues) and create a New Issue, that way the bug will not be forgotten and you can follow progress on its solution.

4
5.3/Get-a-hexadecimal-print-of-a-media-dump-sector-or-block.md
View File

@@ -2,7 +2,7 @@
This operation will print in console a hexadecimal dump of the chosen sector/block of the indicated media dump image.
==Command usage==
<code>DiscImageChef printhex -d [true/false] -i <dump> -l [sectors] -r [true/false] -s <starting sector> -v [true/false] -w [width]</code>
<code>Aaru printhex -d [true/false] -i <dump> -l [sectors] -r [true/false] -s <starting sector> -v [true/false] -w [width]</code>
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-i, --input=<dump></code> path to the media dump image<br />
@@ -13,7 +13,7 @@ This operation will print in console a hexadecimal dump of the chosen sector/blo
<code>-w, --width=[width]</code> how width, in characters, should the print be before creating a new line ''(default 32)''
==Example==
<code>DiscImageChef printhex -i mydisc.cue -s 15 -l 30 -r -w 64</code>
<code>Aaru printhex -i mydisc.cue -s 15 -l 30 -r -w 64</code>
==Operating system support==
{|

8
5.3/Getting-information-from-media-inserted-in-a-physical-device.md
View File

@@ -2,7 +2,7 @@
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|the list of supported physical devices]]
==Command usage==
<code>DiscImageChef media-info -d [true/false] -i <device> -v [true/false] -w [prefix]</code>
<code>Aaru media-info -d [true/false] -i <device> -v [true/false] -w [prefix]</code>
<code>-d, --debug=[true/false]</code> shows debug output ''(default false'')<br />
<code>-i, --input=<device></code> path to the physical device<br />
@@ -10,9 +10,9 @@ This operation will request and show all information about the inserted media in
<code>-w, --output-prefix=[prefix]</code> writes binary responses from device to that prefix
==Example==
FreeBSD: <code>DiscImageChef media-info -i /dev/cd0</code><br />
Linux: <code>DiscImageChef media-info -i /dev/sdb</code><br />
Windows: <code>DiscImageChef media-info -i \\.\PhysicalDrive3</code><br />
FreeBSD: <code>Aaru media-info -i /dev/cd0</code><br />
Linux: <code>Aaru media-info -i /dev/sdb</code><br />
Windows: <code>Aaru media-info -i \\.\PhysicalDrive3</code><br />
==Operating system support==
{|

4
5.3/Verifying-media-dump-integrity.md
View File

@@ -4,7 +4,7 @@ If the media dump format includes a hash or checksum, it will calculate and comp
If the media sectors/blocks format include a hash, checksum or error recovery system, it will calculate and compare them.
==Command usage==
<code>DiscImageChef verify -d [true/false] -i <dump> -s [true/false] -v [true/false] -w [true/false]</code>
<code>Aaru verify -d [true/false] -i <dump> -s [true/false] -v [true/false] -w [true/false]</code>
<code>-d, --debug=[true/false]</code> shows debug output ''(default false)''<br />
<code>-i, --input=<dump></code> path to the media dump image<br />
@@ -13,7 +13,7 @@ If the media sectors/blocks format include a hash, checksum or error recovery sy
<code>-w, --verify-disc=[true/false]</code> calculates and verifies a media dump format checksum/hash ''(default true)''<br />
==Example==
<code>DiscImageChef verify -i mydisc.cue</code>
<code>Aaru verify -i mydisc.cue</code>
==Operating system support==
{|

2
docs/Changelog.md
View File

@@ -838,7 +838,7 @@
# [5.0.0.2879] - 2020-03-15
- First and most importantly, we got a rename. We're now Aaru, part of the Aaru Data Preservation Suite, that
encompasses Aaru (previously DiscImageChef), Aaru.Server (previously DiscImageChef.Server), aaruformat (previously
encompasses Aaru (previously Aaru), Aaru.Server (previously Aaru.Server), aaruformat (previously
dicformat) and aaruremote.
- This release is dedicated to the loving memory of Facunda "Tata" Suárez Domínguez, R.I.P. 2019/07/24.