wozardry/README.md

78 lines
2.1 KiB
Markdown
Raw Normal View History

2018-05-31 21:34:29 +00:00
```
$ ./wozardry.py verify -h
2018-05-31 21:34:29 +00:00
usage: wozardry verify [-h] file
Verify file structure and metadata of a .woz disk image (produces no output
unless a problem is found)
positional arguments:
file .woz disk image
optional arguments:
-h, --help show this help message and exit
$ ./wozardry.py dump -h
2018-05-31 21:34:29 +00:00
usage: wozardry dump [-h] file
Print all available information and metadata in a .woz disk image
positional arguments:
file .woz disk image
optional arguments:
-h, --help show this help message and exit
$ ./wozardry edit -h
usage: wozardry edit [-h] [-i INFO] [-m META] file
Edit information and metadata in a .woz disk image
positional arguments:
file .woz disk image (modified in place)
optional arguments:
-h, --help show this help message and exit
-i INFO, --info INFO change information field. INFO format is "key:value".
Acceptable keys are disk_type, write_protected,
synchronized, cleaned, creator, version. Other keys
are ignored.
-m META, --meta META change metadata field. META format is "key:value".
Standard keys are title, subtitle, publisher,
developer, copyright, version, language, requires_ram,
requires_machine, notes, side, side_name, contributor,
image_date. Other keys are allowed.
Tips:
- Use repeated flags to edit multiple fields at once.
- Use "key:" with no value to delete a metadata field.
- Keys are case-sensitive.
- Some values have format restrictions; read the .woz specification.
$ ./wozardry export -h
usage: wozardry export [-h] file
Export (as JSON) all information and metadata from a .woz disk image
positional arguments:
file .woz disk image
optional arguments:
-h, --help show this help message and exit
$ ./wozardry import -h
usage: wozardry import [-h] file
Import JSON file to update information and metadata in a .woz disk image
positional arguments:
file .woz disk image
optional arguments:
-h, --help show this help message and exit
2018-05-31 21:34:29 +00:00
```