Files
Aaru.Documentation/Creating-metadata-sidecar-XML.mediawiki

33 lines
1.6 KiB
Plaintext

==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-checksums.md|supported checksum algorithms]].
==Command usage==
<code>Aaru -d [true/false] -v [true/false] image create-sidecar -h [true/false] -b [block size] -e [encoding] -t tape [true/false] <image-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 />
<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, --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>-e, --encoding [encoding]</code> sets which encoding is used by the contents of the media dump ''(default varies by filesystem)''<br />
<code>-t, --tape [true/false]</code> 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)''<br />
==Examples==
<code>Aaru image create-sidecar mydisc.cue</code><br />
<code>Aaru image create-sidecar -t -b 1024 mytapedir</code><br />
<code>Aaru image create-sidecar -e shift_jis "My japanese software.img"</code><br />
==Operating system support==
{|
| FreeBSD
| Yes
|-
| macOS
| Yes
|-
| Linux
| Yes
|-
| Windows
| Yes
|}