@rom-weaver/cli 0.10.1 → 0.11.0

package/docs/man/rom-weaver-compress.1

@@ -0,0 +1,125 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-compress 1  "rom-weaver-compress "
+.SH NAME
+rom\-weaver\-compress \- Pack files into an archive or a compressed disc image
+.SH SYNOPSIS
+\fBrom\-weaver compress\fR <\fB\-i\fR|\fB\-\-input\fR> [\fB\-\-json\fR] [\fB\-f\fR|\fB\-\-format\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] <\fB\-o\fR|\fB\-\-output\fR> [\fB\-\-codec\fR] [\fB\-\-log\-level\fR] [\fB\-\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-no\-color\fR] [\fB\-h\fR|\fB\-\-help\fR]
+.SH DESCRIPTION
+Pack files into an archive or a compressed disc image.
+.PP
+The format comes from the \-\-output extension, so `\-\-output game.chd` writes a
+CHD. Formats that can be written: zip, 7z, chd, rvz, and z3ds.
+.PP
+Repeat \-\-input to put several files in one archive. Disc images take a single
+input instead: point \-\-input at the .cue or .gdi and its tracks come along.
+.PP
+  rom\-weaver compress \-\-input game.cue \-\-output game.chd
+.PP
+Each format picks a suitable codec on its own; \-\-codec and \-\-level are there
+for when you want to override that.
+.SH OPTIONS
+.TP
+\fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
+File to put in the archive; repeat for each one. For a disc image, pass the .cue or .gdi alone and its tracks come along
+.TP
+\fB\-f\fR, \fB\-\-format\fR \fI<FORMAT>\fR
+Output format, such as zip, 7z, chd, rvz, or z3ds.
+
+Normally you do not need this: the format comes from the \-\-output extension.
+Pass it when the output name has no usable extension. If it disagrees with the
+extension, this flag wins and a warning is printed.
+
+Common alternate spellings are accepted, so `7zip` works as well as `7z` and
+`3ds` as well as `z3ds`. The CLI guide lists every alias.
+.TP
+\fB\-o\fR, \fB\-\-output\fR \fI<PATH>\fR
+Where to write the archive
+.TP
+\fB\-\-codec\fR \fI<CODEC>\fR
+Compression method to use, written as codec or codec:level.
+
+Each format has its own codecs, and each picks a sensible one on its own, so
+this is only for overriding that choice. CHD takes a list, tried in order:
+
+  \-\-codec cdzs:19,cdzl,cdfl
+
+Without :level, a codec follows the \-\-level profile.
+
+Only the codec names a format actually supports are accepted; there are no
+cross\-format synonyms. The CLI guide lists them per format.
+.TP
+\fB\-\-level\fR \fI<LEVEL>\fR [default: max]
+How hard to compress: min, very\-low, low, medium, high, very\-high, or max
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+min
+.IP \(bu 2
+very\-low
+.IP \(bu 2
+low
+.IP \(bu 2
+medium
+.IP \(bu 2
+high
+.IP \(bu 2
+very\-high
+.IP \(bu 2
+max
+.RE
+.TP
+\fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
+How many threads to use at most. auto uses every core; a format may still use fewer
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help (see a summary with \*(Aq\-h\*(Aq)
+.SH "GLOBAL OPTIONS"
+.TP
+\fB\-\-json\fR
+Print one JSON object per line instead of human\-readable output
+.TP
+\fB\-\-progress\fR
+Show progress even when output is piped to a file or another program
+.TP
+\fB\-\-no\-progress\fR
+Hide progress
+.TP
+\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
+How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+off
+.IP \(bu 2
+error
+.IP \(bu 2
+warn
+.IP \(bu 2
+info
+.IP \(bu 2
+debug
+.IP \(bu 2
+trace
+.RE
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Log more: \-v for info, \-vv for debug, \-vvv for trace
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Log errors only
+.TP
+\fB\-\-dep\-trace\fR
+Also log trace output from bundled libraries (for bug reports)
+.TP
+\fB\-\-color\fR
+Keep colors even when output is piped
+.TP
+\fB\-\-no\-color\fR
+Turn colors off

package/docs/man/rom-weaver-extract.1

@@ -0,0 +1,111 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-extract 1  "rom-weaver-extract "
+.SH NAME
+rom\-weaver\-extract \- Unpack an archive or disc image
+.SH SYNOPSIS
+\fBrom\-weaver extract\fR <\fB\-i\fR|\fB\-\-input\fR> [\fB\-\-json\fR] [\fB\-\-progress\fR] [\fB\-s\fR|\fB\-\-select\fR] [\fB\-\-filter\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] <\fB\-o\fR|\fB\-\-output\fR> [\fB\-\-split\-bin\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-no\-ignore\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-no\-nested\-extract\fR] [\fB\-\-color\fR] [\fB\-\-force\fR] [\fB\-\-checksum\fR] [\fB\-\-no\-color\fR] [\fB\-\-checksum\-rom\fR] [\fB\-\-probe\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-h\fR|\fB\-\-help\fR]
+.SH DESCRIPTION
+Unpack an archive or disc image into a directory.
+.PP
+Archives found inside the input are unpacked too, up to eight levels deep. Pass
+\-\-no\-nested\-extract to stop after the first layer.
+.PP
+Existing files are never overwritten: if any output file is already there, the
+whole extraction stops before writing. Pass \-\-force to overwrite instead.
+.SH OPTIONS
+.TP
+\fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
+Archive or disc image to unpack
+.TP
+\fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
+Extract only these files, by exact name, prefix, or glob (repeatable). For example: \-\-select \*(Aqgame.disc0?.bin\*(Aq
+.TP
+\fB\-\-filter\fR \fI<FILTER>\fR
+Extract only files that look like a rom or a patch, judged by extension (repeatable, comma\-separable)
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+rom
+.IP \(bu 2
+patch
+.RE
+.TP
+\fB\-o\fR, \fB\-\-output\fR \fI<DIR>\fR
+Directory to write the extracted files into
+.TP
+\fB\-\-split\-bin\fR
+Write a CD\-format CHD as a CUE plus one BIN per track (*.trackNN.bin), rather than one merged BIN
+.TP
+\fB\-\-no\-ignore\fR
+Also consider files normally skipped inside archives: readmes, images, checksum sidecars, and OS clutter such as .DS_Store
+.TP
+\fB\-\-no\-nested\-extract\fR
+Stop after one layer; leave any archive found inside the input packed
+.TP
+\fB\-\-force\fR
+Overwrite files already in the output directory (without this, extraction stops instead)
+.TP
+\fB\-\-checksum\fR \fI<ALGO>\fR
+Also hash every extracted file (repeatable, comma\-separable)
+.TP
+\fB\-\-checksum\-rom\fR \fI<ALGO>\fR
+Like \-\-checksum, but hash only the ROMs and skip sidecar files. Ignored when \-\-checksum is also given
+.TP
+\fB\-\-probe\fR
+Also report the format and platform of what was extracted, and fail if a lone payload matches no known platform
+.TP
+\fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
+How many threads to use at most. auto uses every core; a format may still use fewer
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help (see a summary with \*(Aq\-h\*(Aq)
+.SH "GLOBAL OPTIONS"
+.TP
+\fB\-\-json\fR
+Print one JSON object per line instead of human\-readable output
+.TP
+\fB\-\-progress\fR
+Show progress even when output is piped to a file or another program
+.TP
+\fB\-\-no\-progress\fR
+Hide progress
+.TP
+\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
+How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+off
+.IP \(bu 2
+error
+.IP \(bu 2
+warn
+.IP \(bu 2
+info
+.IP \(bu 2
+debug
+.IP \(bu 2
+trace
+.RE
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Log more: \-v for info, \-vv for debug, \-vvv for trace
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Log errors only
+.TP
+\fB\-\-dep\-trace\fR
+Also log trace output from bundled libraries (for bug reports)
+.TP
+\fB\-\-color\fR
+Keep colors even when output is piped
+.TP
+\fB\-\-no\-color\fR
+Turn colors off

package/docs/man/rom-weaver-ingest.1

@@ -0,0 +1,98 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-ingest 1  "rom-weaver-ingest "
+.SH NAME
+rom\-weaver\-ingest \- Sort a file into ROMs and patches, unpacking and hashing along the way
+.SH SYNOPSIS
+\fBrom\-weaver ingest\fR <\fB\-i\fR|\fB\-\-input\fR> [\fB\-\-json\fR] <\fB\-o\fR|\fB\-\-output\fR> [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-s\fR|\fB\-\-select\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-no\-ignore\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-no\-nested\-extract\fR] [\fB\-\-color\fR] [\fB\-\-split\-bin\fR] [\fB\-\-checksum\fR] [\fB\-\-no\-color\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-h\fR|\fB\-\-help\fR]
+.SH DESCRIPTION
+Sort a file into ROMs and patches, unpacking archives and hashing the ROMs as
+it goes.
+.PP
+This is what the webapp runs when you drop a file on it, and it is the command
+to reach for when you do not know what you have. For a description without the
+unpacking, use `probe`.
+.SH OPTIONS
+.TP
+\fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
+File to sort into ROMs and patches
+.TP
+\fB\-o\fR, \fB\-\-output\fR \fI<DIR>\fR
+Directory to write anything unpacked along the way into
+.TP
+\fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
+Pick which ROM to use when the archive holds more than one, by exact name, prefix, or glob (repeatable)
+.TP
+\fB\-\-no\-ignore\fR
+Also consider files normally skipped inside archives: readmes, images, checksum sidecars, and OS clutter such as .DS_Store
+.TP
+\fB\-\-no\-nested\-extract\fR
+Stop after one layer; leave any archive found inside the input packed
+.TP
+\fB\-\-split\-bin\fR [\fI<SPLIT_BIN>\fR]
+For a multi\-track CD\-format CHD, write one BIN per track (\-\-split\-bin) or one merged BIN (\-\-split\-bin false). Omit to be asked
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+true
+.IP \(bu 2
+false
+.RE
+.TP
+\fB\-\-checksum\fR \fI<ALGO>\fR
+Which checksums to compute for each ROM found (repeatable, comma\-separable) [default: crc32,md5,sha1]
+.TP
+\fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
+How many threads to use at most. auto uses every core; a format may still use fewer
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help (see a summary with \*(Aq\-h\*(Aq)
+.SH "GLOBAL OPTIONS"
+.TP
+\fB\-\-json\fR
+Print one JSON object per line instead of human\-readable output
+.TP
+\fB\-\-progress\fR
+Show progress even when output is piped to a file or another program
+.TP
+\fB\-\-no\-progress\fR
+Hide progress
+.TP
+\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
+How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+off
+.IP \(bu 2
+error
+.IP \(bu 2
+warn
+.IP \(bu 2
+info
+.IP \(bu 2
+debug
+.IP \(bu 2
+trace
+.RE
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Log more: \-v for info, \-vv for debug, \-vvv for trace
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Log errors only
+.TP
+\fB\-\-dep\-trace\fR
+Also log trace output from bundled libraries (for bug reports)
+.TP
+\fB\-\-color\fR
+Keep colors even when output is piped
+.TP
+\fB\-\-no\-color\fR
+Turn colors off

package/docs/man/rom-weaver-patch-apply.1

@@ -0,0 +1,356 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-patch-apply 1  "rom-weaver-patch-apply "
+.SH NAME
+rom\-weaver\-patch\-apply \- Apply one or more patches to a ROM, in order
+.SH SYNOPSIS
+\fBrom\-weaver patch apply\fR <\fB\-i\fR|\fB\-\-input\fR> [\fB\-\-json\fR] [\fB\-\-progress\fR] [\fB\-s\fR|\fB\-\-select\fR] [\fB\-\-no\-progress\fR] [\fB\-\-target\fR] [\fB\-\-filter\fR] [\fB\-\-log\-level\fR] [\fB\-\-no\-extract\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-no\-ignore\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-patch\fR] [\fB\-\-color\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-\-bundle\fR] [\fB\-\-no\-color\fR] [\fB\-\-with\fR] [\fB\-\-without\fR] [\fB\-\-no\-compress\fR] [\fB\-\-compress\-format\fR] [\fB\-\-compress\-codec\fR] [\fB\-\-compress\-level\fR] [\fB\-\-assume\-in\fR] [\fB\-\-expect\-in\fR] [\fB\-\-patch\-header\fR] [\fB\-\-patch\-basis\fR] [\fB\-\-output\-header\fR] [\fB\-\-repair\-checksum\fR] [\fB\-\-n64\-byte\-order\fR] [\fB\-\-ignore\-checksum\-validation\fR] [\fB\-\-expect\-out\fR] [\fB\-\-code\fR] [\fB\-\-code\-system\fR] [\fB\-\-code\-kind\fR] [\fB\-\-emit\-bundle\fR] [\fB\-\-tui\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-h\fR|\fB\-\-help\fR]
+.SH DESCRIPTION
+Apply one or more patches to a ROM, in order.
+.PP
+`rom\-weaver weave` runs this same command under a shorter name, and is what
+most of the examples use.
+.PP
+Repeat \-\-patch once per patch. They run left to right, each one on the result
+of the last. \-\-input takes a plain ROM, an archive or disc image (the ROM
+inside is found for you), or a rom\-weaver\-bundle.json that already names the
+ROM, the patches, and the output.
+.PP
+The result is compressed by default, into whatever container the \-\-output
+extension names. Pass \-\-no\-compress for a plain ROM file.
+.PP
+Patch formats: IPS, IPS32, SOLID, BPS, UPS, VCDIFF, xdelta, GDIFF,
+HDiffPatch/HPatchZ, APS (N64), APSGBA, RUP, PPF, PAT/FFP, EBP, BDF/BSDIFF40,
+BSP, MOD/PMSR, DLDI, DPS, and DCP (Dreamcast).
+.PP
+Not supported: PDS; NINJA1 (recognized, but cannot be applied); HDiffPatch
+directory patches, HDIFF19 (single\-file .hdiff and .hpatchz are fine).
+.PP
+DCP needs a Dreamcast .cue or .gdi input. It rebuilds the whole disc, so it
+cannot be combined with other patches or with the header and checksum options.
+.SH OPTIONS
+.TP
+\fB\-i\fR, \fB\-\-input\fR \fI<PATH>\fR
+ROM to patch. May be an archive, a disc sheet (.cue/.gdi), or a bundle
+.TP
+\fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
+Pick which file to use when the ROM or a patch is inside an archive, by exact name, prefix, or glob (repeatable)
+.TP
+\fB\-\-target\fR \fI<TARGET>\fR
+For a .cue or .gdi input, which track gets the patch. Matched like \-\-select and must hit exactly one track
+.TP
+\fB\-\-filter\fR \fI<FILTER>\fR
+Consider only files that look like a rom or a patch, judged by extension (repeatable, comma\-separable)
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+rom
+.IP \(bu 2
+patch
+.RE
+.TP
+\fB\-\-no\-extract\fR
+Do not look inside archives; treat the input and every patch as raw files
+.TP
+\fB\-\-no\-ignore\fR
+Also consider files normally skipped inside archives: readmes, images, checksum sidecars, and OS clutter such as .DS_Store
+.TP
+\fB\-\-patch\fR \fI<PATCHES>\fR
+Patch to apply. Repeat once per patch; they run in the order given, each on the
+result of the last.
+
+Leave it out and rom\-weaver looks for RetroArch\-style patches sitting next to
+the ROM inside the input archive.
+.TP
+\fB\-o\fR, \fB\-\-output\fR \fI<OUTPUT>\fR
+Where to write the patched ROM. Optional when a bundle already names the output
+.TP
+\fB\-\-bundle\fR \fI<BUNDLE>\fR
+Follow a rom\-weaver\-bundle.json recipe, which lists the patches, their order,
+and the expected checksums. Takes a file path or an http(s) URL.
+
+You can usually skip this flag. A bundle is picked up automatically when
+\-\-input is a rom\-weaver\-bundle.json (optionally .gz, .bz2, .xz, or .zst), or an
+archive with one at its root, and you passed no \-\-patch of your own.
+.TP
+\fB\-\-with\fR \fI<GLOB>\fR
+Turn on a bundle patch the bundle leaves off by default, matched by name or file name (repeatable)
+.TP
+\fB\-\-without\fR \fI<GLOB>\fR
+Turn off a bundle patch, matched by name or file name (repeatable)
+.TP
+\fB\-\-no\-compress\fR
+Write a plain ROM instead of compressing the result
+.TP
+\fB\-\-compress\-format\fR \fI<COMPRESS_FORMAT>\fR
+Format to compress the patched ROM into, such as zip, 7z, chd, rvz, or z3ds.
+
+Normally you do not need this: the format comes from the \-\-output extension.
+Pass it when the output name has no usable extension. If it disagrees with the
+extension, this flag wins and a warning is printed. Use \-\-no\-compress to write
+a plain ROM instead.
+.TP
+\fB\-\-compress\-codec\fR \fI<COMPRESS_CODEC>\fR
+Compression method for the patched ROM, written as codec or codec:level.
+
+Each format has its own codecs, and each picks a sensible one on its own, so
+this is only for overriding that choice. CHD takes a list, tried in order:
+
+  \-\-compress\-codec cdzs:19,cdzl,cdfl
+
+Without :level, a codec follows the \-\-compress\-level profile.
+.TP
+\fB\-\-compress\-level\fR \fI<COMPRESS_LEVEL>\fR
+How hard to compress: min, very\-low, low, medium, high, very\-high, or max [default: max]
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+min
+.IP \(bu 2
+very\-low
+.IP \(bu 2
+low
+.IP \(bu 2
+medium
+.IP \(bu 2
+high
+.IP \(bu 2
+very\-high
+.IP \(bu 2
+max
+.RE
+.TP
+\fB\-\-assume\-in\fR \fI<ALGO=HEX>\fR
+Take this checksum on trust instead of reading the ROM to compute it, as in
+crc32=1234abcd. Repeatable and comma\-separable.
+
+This is a speed option for scripts that already know the checksum: it skips a
+full read of a large ROM. It does not verify anything. To check a ROM against a
+checksum, use \-\-expect\-in.
+.TP
+\fB\-\-expect\-in\fR \fI<ALGO=HEX>\fR
+Stop unless the ROM about to be patched has this checksum, as in
+crc32=1234abcd. Repeatable and comma\-separable.
+
+Use it when a patch\*(Aqs readme publishes a source checksum, to be sure you are
+starting from the ROM the author used. The size gates size=N and min\-size=N
+work on `patch validate` only.
+.TP
+\fB\-\-patch\-header\fR \fI<PATCH_HEADER>\fR
+Whether a patch applies to the ROM with or without its copier header.
+
+Some ROMs carry a small header added by old copier hardware, and a patch may
+have been made either with it or without it. Getting this wrong makes the patch
+fail or produce a broken ROM.
+
+  auto    Work it out per patch (the default). The header is stripped or put
+          back only when the patch\*(Aqs own source checksum proves which form it
+          expects. With no such proof, the bytes are left alone.
+  keep    Apply to the bytes as they are.
+  strip   Remove the header first.
+
+Repeatable, and each occurrence binds to the \-\-patch before it and carries
+forward until the next one:
+
+  \-\-patch a.bps \-\-patch\-header strip \-\-patch b.ups   strips for both
+  \-\-patch a.bps \-\-patch b.ups \-\-patch\-header strip   strips for b.ups only
+
+An occurrence before any \-\-patch applies to every patch.
+
+Headers detected: A78, LNX, NES, FDS, and SMC signatures, plus the SNES and PCE
+copier size rules.
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+keep
+.IP \(bu 2
+strip
+.IP \(bu 2
+auto
+.RE
+.TP
+\fB\-\-patch\-basis\fR \fI<PATCH_BASIS>\fR
+Which ROM the preceding \-\-patch was built against, and so which one its
+checksums describe.
+
+  auto      Work it out from the checksums (the default).
+  base      The original ROM. It is verified once up front, and the patch\*(Aqs own
+            checks are skipped when it runs later in the chain.
+  previous  The output of the patch before it.
+
+Reach for this when several patches in a chain were each written against the
+unmodified ROM rather than against each other. Binds to the most recent
+\-\-patch.
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+auto
+.IP \(bu 2
+base
+.IP \(bu 2
+previous
+.RE
+.TP
+\fB\-\-output\-header\fR \fI<OUTPUT_HEADER>\fR
+Whether the finished ROM keeps its copier header.
+
+  auto   Keep headers emulators need (iNES, FDS, LNX, A78) and drop the ones
+         they do not (SNES, PCE, Game Doctor). The default.
+  keep   Put back a header that was stripped in order to patch.
+  strip  Write a headerless ROM, removing the header if it is still there.
+
+The chain produces one file, so this is a single setting; if repeated, the last
+value wins.
+
+When the header decision changes which extension is conventional, the output
+extension follows (SNES .smc becomes headerless .sfc, for instance) and the
+report says so. Extensions unrelated to headers are never touched.
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+keep
+.IP \(bu 2
+strip
+.IP \(bu 2
+auto
+.RE
+.TP
+\fB\-\-repair\-checksum\fR
+Recompute the ROM\*(Aqs internal header checksum afterwards, so the console does not reject it (SNES, NES, GB, GBA, Mega Drive, SMS, N64, NDS)
+.TP
+\fB\-\-n64\-byte\-order\fR \fI<N64_BYTE_ORDER>\fR
+Byte order to put an N64 ROM in before each patch runs.
+
+N64 dumps circulate in three interleavings (.z64 big\-endian, .v64 byte\-swapped,
+\&.n64 little\-endian) and a patch only matches one of them.
+
+  auto           Match whichever order the patch\*(Aqs source CRC32 names. The
+                 default, and almost always right.
+  keep           Leave the ROM as it is.
+  big\-endian     Rewrite to .z64 order.
+  little\-endian  Rewrite to .n64 order.
+  byte\-swapped   Rewrite to .v64 order.
+
+Repeatable, one per patch; a short list carries its last value forward. The
+output is written back in the order the input arrived in.
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+auto
+.IP \(bu 2
+keep
+.IP \(bu 2
+big\-endian
+.IP \(bu 2
+little\-endian
+.IP \(bu 2
+byte\-swapped
+.RE
+.TP
+\fB\-\-ignore\-checksum\-validation\fR
+Apply the patch even when its own checksums do not match. Can produce a broken ROM
+.TP
+\fB\-\-expect\-out\fR \fI<ALGO=HEX>\fR
+Fail unless the patched ROM has this checksum, as in sha1=abc... (repeatable, comma\-separable)
+.TP
+\fB\-\-code\fR \fI<CODES>\fR
+Game Genie or GameShark/Pro Action Replay code to bake into the ROM. Repeat for each code
+.TP
+\fB\-\-code\-system\fR \fI<CODE_SYSTEM>\fR
+Console the \-\-code values are for (nes, snes, genesis, gameboy), when the ROM header does not say
+.TP
+\fB\-\-code\-kind\fR \fI<CODE_KIND>\fR [default: auto]
+Which cheat scheme the \-\-code values use: auto, game\-genie, or gameshark/par
+.TP
+\fB\-\-emit\-bundle\fR \fI<PATH>\fR
+Also write a rom\-weaver\-bundle.json recording this run, so someone else can repeat it
+.TP
+\fB\-\-tui\fR
+Ask for each patch\*(Aqs name, version, and author, then apply and write a bundle. Needs a terminal
+.TP
+\fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
+How many threads to use at most. auto uses every core; a format may still use fewer
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help (see a summary with \*(Aq\-h\*(Aq)
+.SH "GLOBAL OPTIONS"
+.TP
+\fB\-\-json\fR
+Print one JSON object per line instead of human\-readable output
+.TP
+\fB\-\-progress\fR
+Show progress even when output is piped to a file or another program
+.TP
+\fB\-\-no\-progress\fR
+Hide progress
+.TP
+\fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
+How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+off
+.IP \(bu 2
+error
+.IP \(bu 2
+warn
+.IP \(bu 2
+info
+.IP \(bu 2
+debug
+.IP \(bu 2
+trace
+.RE
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Log more: \-v for info, \-vv for debug, \-vvv for trace
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Log errors only
+.TP
+\fB\-\-dep\-trace\fR
+Also log trace output from bundled libraries (for bug reports)
+.TP
+\fB\-\-color\fR
+Keep colors even when output is piped
+.TP
+\fB\-\-no\-color\fR
+Turn colors off
+.SH EXTRA
+Examples:
+  # One patch, plain ROM out
+  rom\-weaver weave \-\-input game.sfc \-\-patch hack.bps \\
+    \-\-output hacked.sfc \-\-no\-compress
+
+  # Two patches in order, straight out of and back into a zip
+  rom\-weaver weave \-\-input game.zip \\
+    \-\-patch translation.bps \-\-patch fixes.ips \-\-output hacked.zip
+
+  # Replay someone else\*(Aqs published recipe
+  rom\-weaver weave \-\-bundle rom\-weaver\-bundle.json \-\-input game.sfc
+
+  # Check the result against a checksum the patch author published
+  rom\-weaver weave \-\-input game.sfc \-\-patch hack.bps \\
+    \-\-output hacked.sfc \-\-no\-compress \\
+    \-\-expect\-out sha1=0123456789abcdef0123456789abcdef01234567