@rom-weaver/cli 0.12.3 → 0.13.0

package/docs/man/rom-weaver-bundle-parse.1

@@ -4,7 +4,7 @@
 .SH NAME
 rom\-weaver\-bundle\-parse \- Read a rom\-weaver\-bundle.json recipe and report what it points at
 .SH SYNOPSIS
-\fBrom\-weaver bundle parse\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\-\-no\-extract\fR] [\fB\-o\fR|\fB\-\-output\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]
+\fBrom\-weaver bundle parse\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\-\-no\-extract\fR] [\fB\-o\fR|\fB\-\-output\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\-y\fR|\fB\-\-yes\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR>
 .SH DESCRIPTION
 Read a rom\-weaver\-bundle.json recipe, check that it is valid, and report the
 ROM and patches it points at.
@@ -96,3 +96,6 @@ Keep colors even when output is piped
 .TP
 \fB\-\-no\-color\fR
 Turn colors off
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Answer yes to every confirmation instead of asking. Does not choose between candidates

package/docs/man/rom-weaver-bundle-schema.1

@@ -4,7 +4,7 @@
 .SH NAME
 rom\-weaver\-bundle\-schema \- Print the rom\-weaver\-bundle.json JSON Schema, for editors and hand\-authoring
 .SH SYNOPSIS
-\fBrom\-weaver bundle schema\fR [\fB\-\-json\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-no\-color\fR] [\fB\-h\fR|\fB\-\-help\fR]
+\fBrom\-weaver bundle schema\fR [\fB\-\-json\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-no\-color\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-h\fR|\fB\-\-help\fR]
 .SH DESCRIPTION
 Print the rom\-weaver\-bundle.json JSON Schema to stdout.
 .PP
@@ -65,3 +65,6 @@ Keep colors even when output is piped
 .TP
 \fB\-\-no\-color\fR
 Turn colors off
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Answer yes to every confirmation instead of asking. Does not choose between candidates

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

@@ -4,7 +4,7 @@
 .SH NAME
 rom\-weaver\-bundle \- Build and read rom\-weaver\-bundle.json patch recipes
 .SH SYNOPSIS
-\fBrom\-weaver bundle\fR [\fB\-\-json\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-no\-color\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR>
+\fBrom\-weaver bundle\fR [\fB\-\-json\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-no\-color\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR>
 .SH DESCRIPTION
 Build and read rom\-weaver\-bundle.json patch recipes
 .SH OPTIONS
@@ -57,6 +57,9 @@ Keep colors even when output is piped
 .TP
 \fB\-\-no\-color\fR
 Turn colors off
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Answer yes to every confirmation instead of asking. Does not choose between candidates
 .SH SUBCOMMANDS
 .TP
 rom\-weaver\-bundle\-create(1)

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

@@ -4,7 +4,7 @@
 .SH NAME
 rom\-weaver\-checksum \- Compute checksums for a file, or for a ROM inside an archive
 .SH SYNOPSIS
-\fBrom\-weaver checksum\fR <\fB\-i\fR|\fB\-\-input\fR> [\fB\-\-json\fR] <\fB\-a\fR|\fB\-\-algo\fR> [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-s\fR|\fB\-\-select\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\-\-no\-trim\-fix\fR] [\fB\-\-color\fR] [\fB\-\-start\fR] [\fB\-\-length\fR] [\fB\-\-no\-color\fR] [\fB\-\-probe\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-h\fR|\fB\-\-help\fR]
+\fBrom\-weaver checksum\fR [\fB\-\-json\fR] [\fB\-a\fR|\fB\-\-algo\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-s\fR|\fB\-\-select\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\-\-no\-trim\-fix\fR] [\fB\-\-color\fR] [\fB\-\-start\fR] [\fB\-\-length\fR] [\fB\-\-no\-color\fR] [\fB\-\-probe\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR>
 .SH DESCRIPTION
 Compute checksums for a file, so you can tell one dump from another.
 .PP
@@ -20,8 +20,30 @@ match a file that is stored slightly differently.
 \fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
 File to hash. Use \- to read from stdin
 .TP
-\fB\-a\fR, \fB\-\-algo\fR \fI<ALGO>\fR
-Which checksum to compute: crc32, md5, sha1, sha256, blake3, crc32c, crc16, or adler32 (repeatable, comma\-separable)
+\fB\-a\fR, \fB\-\-algo\fR \fI<ALGO>\fR [default: crc32,md5,sha1]
+Which checksum to compute (repeatable, comma\-separable)
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+crc32
+.IP \(bu 2
+md5
+.IP \(bu 2
+sha1
+.IP \(bu 2
+sha256
+.IP \(bu 2
+blake3
+.IP \(bu 2
+crc32c
+.IP \(bu 2
+crc16
+.IP \(bu 2
+adler32
+.RE
 .TP
 \fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
 Pick which file inside the archive to use, by exact name, prefix, or glob (repeatable)
@@ -108,3 +130,6 @@ Keep colors even when output is piped
 .TP
 \fB\-\-no\-color\fR
 Turn colors off
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Answer yes to every confirmation instead of asking. Does not choose between candidates

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

@@ -4,7 +4,7 @@
 .SH NAME
 rom\-weaver\-completions \- Print a tab\-completion script for your shell
 .SH SYNOPSIS
-\fBrom\-weaver completions\fR [\fB\-\-json\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-no\-color\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fISHELL\fR>
+\fBrom\-weaver completions\fR [\fB\-\-json\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-no\-color\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fISHELL\fR>
 .SH DESCRIPTION
 Print a tab\-completion script for your shell to stdout.
 .PP
@@ -82,3 +82,6 @@ Keep colors even when output is piped
 .TP
 \fB\-\-no\-color\fR
 Turn colors off
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Answer yes to every confirmation instead of asking. Does not choose between candidates

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

@@ -4,7 +4,7 @@
 .SH NAME
 rom\-weaver\-compress \- Pack files into an archive, disc image, or ROM\-specific compressed format
 .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]
+\fBrom\-weaver compress\fR [\fB\-\-json\fR] [\fB\-f\fR|\fB\-\-format\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-codec\fR] [\fB\-\-log\-level\fR] [\fB\-\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-force\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-color\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-no\-color\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR> <\fB\-o\fR|\fB\-\-output\fR>
 .SH DESCRIPTION
 Pack files into an archive, disc image, or ROM\-specific compressed format.
 .PP
@@ -33,6 +33,22 @@ 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.
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+zip
+.IP \(bu 2
+7z
+.IP \(bu 2
+chd
+.IP \(bu 2
+rvz
+.IP \(bu 2
+z3ds
+.RE
 .TP
 \fB\-o\fR, \fB\-\-output\fR \fI<PATH>\fR
 Where to write the archive
@@ -49,6 +65,38 @@ 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.
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+store
+.IP \(bu 2
+deflate
+.IP \(bu 2
+zstd
+.IP \(bu 2
+lzma
+.IP \(bu 2
+lzma2
+.IP \(bu 2
+zlib
+.IP \(bu 2
+huff
+.IP \(bu 2
+flac
+.IP \(bu 2
+cdzs
+.IP \(bu 2
+cdlz
+.IP \(bu 2
+cdzl
+.IP \(bu 2
+cdfl
+.IP \(bu 2
+avhuff
+.RE
 .TP
 \fB\-\-level\fR \fI<LEVEL>\fR [default: max]
 How hard to compress: min, very\-low, low, medium, high, very\-high, or max
@@ -73,6 +121,12 @@ very\-high
 max
 .RE
 .TP
+\fB\-\-force\fR
+Overwrite the output if it already exists (without this, the command stops instead)
+.TP
+\fB\-n\fR, \fB\-\-dry\-run\fR
+Print the plan (inputs, output, format, codec, level, threads) and stop without writing
+.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
@@ -124,3 +178,6 @@ Keep colors even when output is piped
 .TP
 \fB\-\-no\-color\fR
 Turn colors off
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Answer yes to every confirmation instead of asking. Does not choose between candidates

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

@@ -4,7 +4,7 @@
 .SH NAME
 rom\-weaver\-extract \- Unpack an archive or single\-payload compressed format
 .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]
+\fBrom\-weaver extract\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\-\-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\-y\fR|\fB\-\-yes\fR] [\fB\-\-probe\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR> <\fB\-o\fR|\fB\-\-output\fR>
 .SH DESCRIPTION
 Unpack an archive or single\-payload compressed format into a directory.
 .PP
@@ -51,9 +51,53 @@ Overwrite files already in the output directory (without this, extraction stops
 .TP
 \fB\-\-checksum\fR \fI<ALGO>\fR
 Also hash every extracted file (repeatable, comma\-separable)
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+crc32
+.IP \(bu 2
+md5
+.IP \(bu 2
+sha1
+.IP \(bu 2
+sha256
+.IP \(bu 2
+blake3
+.IP \(bu 2
+crc32c
+.IP \(bu 2
+crc16
+.IP \(bu 2
+adler32
+.RE
 .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
+Like \-\-checksum, but hash only the ROMs and skip sidecar files. Cannot be combined with \-\-checksum
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+crc32
+.IP \(bu 2
+md5
+.IP \(bu 2
+sha1
+.IP \(bu 2
+sha256
+.IP \(bu 2
+blake3
+.IP \(bu 2
+crc32c
+.IP \(bu 2
+crc16
+.IP \(bu 2
+adler32
+.RE
 .TP
 \fB\-\-probe\fR
 Also report the format and platform of what was extracted, and fail if a lone payload matches no known platform
@@ -109,3 +153,6 @@ Keep colors even when output is piped
 .TP
 \fB\-\-no\-color\fR
 Turn colors off
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Answer yes to every confirmation instead of asking. Does not choose between candidates

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

@@ -0,0 +1,66 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-formats 1  "rom-weaver-formats "
+.SH NAME
+rom\-weaver\-formats \- List the formats, codecs, and checksum algorithms this build supports
+.SH SYNOPSIS
+\fBrom\-weaver formats\fR [\fB\-\-json\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-no\-color\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-h\fR|\fB\-\-help\fR]
+.SH DESCRIPTION
+List what this build supports, read straight from its registries: container
+formats (and whether each can be created, extracted, or both), patch formats,
+the codecs each container format accepts, and the checksum algorithms.
+.PP
+Pass \-\-json for the machine\-readable form.
+.SH OPTIONS
+.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
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Answer yes to every confirmation instead of asking. Does not choose between candidates

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

@@ -4,7 +4,7 @@
 .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]
+\fBrom\-weaver patch apply\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\-y\fR|\fB\-\-yes\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\-\-force\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR>
 .SH DESCRIPTION
 Apply one or more patches to a ROM, in order.
 .PP
@@ -17,8 +17,12 @@ compressed format (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.
+When \-\-output names the selected ROM leaf\*(Aqs extension, rom\-weaver writes a
+plain ROM. A registered container extension such as .zip compresses the result.
+Pass \-\-no\-compress (or \-\-raw) to force a plain ROM, or use \-\-compress\-format,
+\-\-compress\-codec, and \-\-compress\-level (also accepted as \-\-format, \-\-codec,
+and \-\-level) to force compression. Without \-\-output, an ordinary file apply
+writes a collision\-safe sibling named <stem>\-patched.<ext>.
 .PP
 Patch formats: IPS, IPS32, SOLID, BPS, UPS, VCDIFF, xdelta, GDIFF,
 HDiffPatch/HPatchZ, APS (N64), APSGBA, RUP, PPF, PAT/FFP, EBP, BDF/BSDIFF40,
@@ -31,33 +35,18 @@ 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)
+\fB\-\-force\fR
+Overwrite the output if it already exists (without this, the command stops instead)
 .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
+\fB\-n\fR, \fB\-\-dry\-run\fR
+Print the plan (inputs, patches, output, format, codec, level, threads) and stop without writing
 .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
+\fB\-h\fR, \fB\-\-help\fR
+Print help (see a summary with \*(Aq\-h\*(Aq)
+.SH BASIC
 .TP
-\fB\-\-no\-ignore\fR
-Also consider files normally skipped inside archives: readmes, images, checksum sidecars, and OS clutter such as .DS_Store
+\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\-\-patch\fR \fI<PATCHES>\fR
 Patch to apply. Repeat once per patch; they run in the order given, each on the
@@ -69,20 +58,6 @@ the ROM inside the input archive.
 \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
@@ -93,6 +68,22 @@ 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.
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+zip
+.IP \(bu 2
+7z
+.IP \(bu 2
+chd
+.IP \(bu 2
+rvz
+.IP \(bu 2
+z3ds
+.RE
 .TP
 \fB\-\-compress\-codec\fR \fI<COMPRESS_CODEC>\fR
 Compression method for the patched ROM, written as codec or codec:level.
@@ -103,6 +94,38 @@ 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.
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+store
+.IP \(bu 2
+deflate
+.IP \(bu 2
+zstd
+.IP \(bu 2
+lzma
+.IP \(bu 2
+lzma2
+.IP \(bu 2
+zlib
+.IP \(bu 2
+huff
+.IP \(bu 2
+flac
+.IP \(bu 2
+cdzs
+.IP \(bu 2
+cdlz
+.IP \(bu 2
+cdzl
+.IP \(bu 2
+cdfl
+.IP \(bu 2
+avhuff
+.RE
 .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]
@@ -126,6 +149,47 @@ very\-high
 .IP \(bu 2
 max
 .RE
+.SH ARCHIVE/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\-\-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)
+.SH COMPATIBILITY
 .TP
 \fB\-\-assume\-in\fR \fI<ALGO=HEX>\fR
 Take this checksum on trust instead of reading the ROM to compute it, as in
@@ -150,9 +214,12 @@ 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.
+  auto    Work it out per patch (the default). A patch carrying its own source
+          checksum (BPS, UPS, RUP) settles it outright. A patch without one
+          (IPS) is judged on where its records land, and if that is still
+          unclear by applying it both ways and keeping the result the console
+          still recognises as its own ROM. Any remaining doubt leaves the
+          bytes alone.
   keep    Apply to the bytes as they are.
   strip   Remove the header first.
 
@@ -189,8 +256,11 @@ checksums describe.
   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.
+unmodified ROM rather than against each other.
+
+This flag must follow the \-\-patch it describes; it binds to the most recent
+\-\-patch and carries forward until the next occurrence. An occurrence before any
+\-\-patch applies to every patch.
 .br
 
 .br
@@ -241,7 +311,9 @@ 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.
+                 default, and almost always right. For the first patch, one
+                 that carries no checksum (IPS) falls back to the shape of its
+                 changes; an order settled that way is named in the report.
   keep           Leave the ROM as it is.
   big\-endian     Rewrite to .z64 order.
   little\-endian  Rewrite to .n64 order.
@@ -268,6 +340,7 @@ byte\-swapped
 .TP
 \fB\-\-ignore\-checksum\-validation\fR
 Apply the patch even when its own checksums do not match. Can produce a broken ROM
+.SH DIAGNOSTICS/AUTHORING
 .TP
 \fB\-\-expect\-out\fR \fI<ALGO=HEX>\fR
 Fail unless the patched ROM has this checksum, as in sha1=abc... (repeatable, comma\-separable)
@@ -286,12 +359,10 @@ Also write a rom\-weaver\-bundle.json recording this run, so someone else can re
 .TP
 \fB\-\-tui\fR
 Ask for each patch\*(Aqs name, version, and author, then apply and write a bundle. Needs a terminal
+.SH PERFORMANCE
 .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
@@ -338,20 +409,9 @@ Keep colors even when output is piped
 .TP
 \fB\-\-no\-color\fR
 Turn colors off
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Answer yes to every confirmation instead of asking. Does not choose between candidates
 .SH EXTRA
-Examples:
-  # One patch, plain ROM out
-  rom\-weaver patch apply \-\-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 patch apply \-\-input game.zip \\
-    \-\-patch translation.bps \-\-patch fixes.ips \-\-output hacked.zip
-
-  # Replay someone else\*(Aqs published recipe
-  rom\-weaver patch apply \-\-bundle rom\-weaver\-bundle.json \-\-input game.sfc
-
-  # Check the result against a checksum the patch author published
-  rom\-weaver patch apply \-\-input game.sfc \-\-patch hack.bps \\
-    \-\-output hacked.sfc \-\-no\-compress \\
-    \-\-expect\-out sha1=0123456789abcdef0123456789abcdef01234567
+Example:
+  rom\-weaver patch apply \-i game.sfc \-\-patch hack.bps \-o hacked.sfc

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

@@ -4,7 +4,7 @@
 .SH NAME
 rom\-weaver\-patch\-create \- Build a patch from an original ROM and a changed one
 .SH SYNOPSIS
-\fBrom\-weaver patch create\fR [\fB\-\-json\fR] <\fB\-\-original\fR> [\fB\-\-modified\fR] [\fB\-\-progress\fR] [\fB\-f\fR|\fB\-\-format\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-\-plan\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-ignore\-checksum\-validation\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-checksum\-name\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-assume\-in\fR] [\fB\-\-color\fR] [\fB\-\-code\fR] [\fB\-\-no\-color\fR] [\fB\-\-code\-system\fR] [\fB\-\-code\-kind\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-solid\-system\fR] [\fB\-\-solid\-game\fR] [\fB\-\-solid\-hack\fR] [\fB\-\-solid\-version\fR] [\fB\-\-solid\-author\fR] [\fB\-\-solid\-contact\fR] [\fB\-\-solid\-comment\fR] [\fB\-\-solid\-extended\fR] [\fB\-\-xdelta\-secondary\fR] [\fB\-h\fR|\fB\-\-help\fR]
+\fBrom\-weaver patch create\fR [\fB\-\-json\fR] [\fB\-\-modified\fR] [\fB\-\-progress\fR] [\fB\-f\fR|\fB\-\-format\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-\-plan\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-ignore\-checksum\-validation\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-checksum\-name\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-assume\-in\fR] [\fB\-\-color\fR] [\fB\-\-code\fR] [\fB\-\-no\-color\fR] [\fB\-\-code\-system\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-\-code\-kind\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-solid\-system\fR] [\fB\-\-solid\-game\fR] [\fB\-\-solid\-hack\fR] [\fB\-\-solid\-version\fR] [\fB\-\-solid\-author\fR] [\fB\-\-solid\-contact\fR] [\fB\-\-solid\-comment\fR] [\fB\-\-solid\-extended\fR] [\fB\-\-xdelta\-secondary\fR] [\fB\-\-force\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-\-original\fR>
 .SH DESCRIPTION
 Build a patch from an original ROM and a changed one, so you can share the
 change without sharing the ROM.
@@ -116,6 +116,9 @@ fgk
 none
 .RE
 .TP
+\fB\-\-force\fR
+Overwrite the output if it already exists (without this, the command stops instead)
+.TP
 \fB\-h\fR, \fB\-\-help\fR
 Print help (see a summary with \*(Aq\-h\*(Aq)
 .SH "GLOBAL OPTIONS"
@@ -164,3 +167,6 @@ Keep colors even when output is piped
 .TP
 \fB\-\-no\-color\fR
 Turn colors off
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Answer yes to every confirmation instead of asking. Does not choose between candidates

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

@@ -4,7 +4,7 @@
 .SH NAME
 rom\-weaver\-patch\-validate \- Check that patches would apply cleanly, without writing anything
 .SH SYNOPSIS
-\fBrom\-weaver patch validate\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\-\-no\-extract\fR] [\fB\-\-no\-ignore\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... <\fB\-\-patch\fR> [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-assume\-in\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-expect\-in\fR] [\fB\-\-no\-color\fR] [\fB\-\-strip\-header\fR] [\fB\-\-n64\-byte\-order\fR] [\fB\-\-ignore\-checksum\-validation\fR] [\fB\-\-independent\fR] [\fB\-\-plan\fR] [\fB\-\-patch\-basis\fR] [\fB\-\-patch\-input\-check\fR] [\fB\-\-patch\-output\-check\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-h\fR|\fB\-\-help\fR]
+\fBrom\-weaver patch validate\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\-\-no\-extract\fR] [\fB\-\-no\-ignore\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-assume\-in\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-expect\-in\fR] [\fB\-\-no\-color\fR] [\fB\-\-strip\-header\fR] [\fB\-\-n64\-byte\-order\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-\-ignore\-checksum\-validation\fR] [\fB\-\-independent\fR] [\fB\-\-plan\fR] [\fB\-\-patch\-basis\fR] [\fB\-\-patch\-input\-check\fR] [\fB\-\-patch\-output\-check\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR> <\fB\-\-patch\fR>
 .SH DESCRIPTION
 Check that patches would apply cleanly to a ROM, without writing anything.
 .PP
@@ -159,3 +159,6 @@ Keep colors even when output is piped
 .TP
 \fB\-\-no\-color\fR
 Turn colors off
+.TP
+\fB\-y\fR, \fB\-\-yes\fR
+Answer yes to every confirmation instead of asking. Does not choose between candidates