@rom-weaver/cli 0.10.2 → 0.11.1

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

@@ -0,0 +1,166 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-patch-create 1  "rom-weaver-patch-create "
+.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]
+.SH DESCRIPTION
+Build a patch from an original ROM and a changed one, so you can share the
+change without sharing the ROM.
+.PP
+The format comes from the \-\-output extension, so `\-\-output hack.bps` writes a
+BPS patch. Use \-\-plan to see which formats suit these two files before
+committing to one.
+.PP
+Instead of a second ROM, \-\-code builds the patch from Game Genie or
+GameShark/Pro Action Replay codes.
+.SH OPTIONS
+.TP
+\fB\-\-original\fR \fI<PATH>\fR
+The unmodified ROM
+.TP
+\fB\-\-modified\fR \fI<MODIFIED>\fR
+The changed ROM. Leave out when using \-\-code, which produces the changed ROM for you
+.TP
+\fB\-f\fR, \fB\-\-format\fR \fI<FORMAT>\fR
+Patch format, such as bps, ips, or xdelta.
+
+Normally you do not need this: the format comes from the \-\-output extension, so
+`\-\-output hack.bps` writes a BPS patch. Pass it when the output name has no
+recognizable patch extension.
+
+Common alternate spellings are accepted, so `xdelta3` works as well as `xdelta`
+and `bsdiff` as well as `bdf`. The CLI guide lists every alias.
+.TP
+\fB\-o\fR, \fB\-\-output\fR \fI<PATH>\fR
+Where to write the patch. Required unless \-\-plan is used
+.TP
+\fB\-\-plan\fR
+Only report which formats suit these two ROMs; write nothing
+.TP
+\fB\-\-ignore\-checksum\-validation\fR
+Write the patch even when the format\*(Aqs own consistency checks fail, and leave its checksums out
+.TP
+\fB\-\-checksum\-name\fR
+Put the original ROM\*(Aqs crc32 in the patch file name, as [crc32:HEX].
+
+Formats like IPS carry no checksum of their own, so there is nothing to catch
+the patch being applied to the wrong ROM. rom\-weaver reads this token back on
+apply and verifies the input, as long as the file name survives.
+.TP
+\fB\-\-assume\-in\fR \fI<ALGO=HEX>\fR
+Take the original ROM\*(Aqs checksum on trust rather than reading the file, as in crc32=1234abcd (repeatable, comma\-separable)
+.TP
+\fB\-\-code\fR \fI<CODES>\fR
+Build the patch from a Game Genie or GameShark/Pro Action Replay code instead of a second ROM. Repeat for each code; cannot be used with \-\-modified
+.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\-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\-\-solid\-system\fR \fI<SOLID_SYSTEM>\fR
+SOLID patches only: console the ROM is for
+.TP
+\fB\-\-solid\-game\fR \fI<SOLID_GAME>\fR
+SOLID patches only: name of the game
+.TP
+\fB\-\-solid\-hack\fR \fI<SOLID_HACK>\fR
+SOLID patches only: name of the hack
+.TP
+\fB\-\-solid\-version\fR \fI<SOLID_VERSION>\fR
+SOLID patches only: version of the hack. Switches the patch to its extended header
+.TP
+\fB\-\-solid\-author\fR \fI<SOLID_AUTHOR>\fR
+SOLID patches only: who made the hack. Switches the patch to its extended header
+.TP
+\fB\-\-solid\-contact\fR \fI<SOLID_CONTACT>\fR
+SOLID patches only: how to reach the author. Switches the patch to its extended header
+.TP
+\fB\-\-solid\-comment\fR \fI<SOLID_COMMENT>\fR
+SOLID patches only: free\-form note. Switches the patch to its extended header
+.TP
+\fB\-\-solid\-extended\fR
+SOLID patches only: use the extended header even with none of the extended fields filled in
+.TP
+\fB\-\-xdelta\-secondary\fR \fI<XDELTA_SECONDARY>\fR [default: none]
+xdelta patches only: compress the patch\*(Aqs own contents.
+
+  none  Leave it uncompressed. The default, and what xdelta3 does without \-S.
+  lzma  Add LZMA, like xdelta3 \-S lzma.
+  djw   xdelta3\*(Aqs Huffman coder.
+  fgk   xdelta3\*(Aqs adaptive Huffman coder.
+  auto  Try djw, lzma, and fgk, and keep whichever comes out smallest.
+
+Leaving it at none is usually right: patch payloads are often already\-compressed
+game assets, and the patch tends to get compressed again downstream anyway.
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+auto
+.IP \(bu 2
+lzma
+.IP \(bu 2
+djw
+.IP \(bu 2
+fgk
+.IP \(bu 2
+none
+.RE
+.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-validate.1

@@ -0,0 +1,161 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-patch-validate 1  "rom-weaver-patch-validate "
+.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]
+.SH DESCRIPTION
+Check that patches would apply cleanly to a ROM, without writing anything.
+.PP
+This runs the same checks apply does: it parses each patch and verifies every
+checksum the format carries. Use \-\-expect\-in to also confirm the ROM itself is
+the one you think it is, by checksum or by size.
+.PP
+Patches are checked as a chain by default, each against the output of the one
+before it. Pass \-\-independent to check each one against the original ROM
+instead and get a verdict per patch.
+.SH OPTIONS
+.TP
+\fB\-i\fR, \fB\-\-input\fR \fI<PATH>\fR
+ROM to check the patches against. May be an archive
+.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\-\-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 check. Repeat once per patch; they are checked in the order given
+.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
+Fail unless the ROM matches: a checksum (crc32=1234abcd), an exact size (size=N), or a floor (min\-size=N). Repeatable, comma\-separable
+.TP
+\fB\-\-strip\-header\fR
+Remove the ROM\*(Aqs copier header before checking (A78, LNX, NES, FDS, SMC signatures, plus the SNES and PCE size rules)
+.TP
+\fB\-\-n64\-byte\-order\fR \fI<N64_BYTE_ORDER>\fR
+Byte order to put an N64 ROM in before checking: auto, keep, big\-endian, little\-endian, or byte\-swapped [default: auto]
+.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
+Report a patch as usable even when its own checksums do not match
+.TP
+\fB\-\-independent\fR
+Check every patch against the original ROM rather than as a chain, and report a verdict for each instead of stopping at the first failure
+.TP
+\fB\-\-plan\fR
+Report the order the patches would run in and what each would be checked against, without reading the ROM more than needed
+.TP
+\fB\-\-patch\-basis\fR \fI<PATCH_BASIS>\fR
+Which ROM the preceding \-\-patch was built against: auto, base, or previous [default: auto]
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+auto
+.IP \(bu 2
+base
+.IP \(bu 2
+previous
+.RE
+.TP
+\fB\-\-patch\-input\-check\fR \fI<ALGO=HEX>\fR
+Checksum the preceding \-\-patch expects to see going in, when the patch does not carry one (comma\-separable; empty means none)
+.TP
+\fB\-\-patch\-output\-check\fR \fI<ALGO=HEX>\fR
+Checksum the preceding \-\-patch should produce, when the patch does not carry one (comma\-separable; empty means none)
+.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.1

@@ -0,0 +1,69 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-patch 1  "rom-weaver-patch "
+.SH NAME
+rom\-weaver\-patch \- Apply, create, or check ROM patches
+.SH SYNOPSIS
+\fBrom\-weaver patch\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>
+.SH DESCRIPTION
+Apply, create, or check ROM patches
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help
+.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 SUBCOMMANDS
+.TP
+rom\-weaver\-patch\-apply(1)
+Apply one or more patches to a ROM, in order
+.TP
+rom\-weaver\-patch\-validate(1)
+Check that patches would apply cleanly, without writing anything
+.TP
+rom\-weaver\-patch\-create(1)
+Build a patch from an original ROM and a changed one

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

@@ -0,0 +1,93 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-probe 1  "rom-weaver-probe "
+.SH NAME
+rom\-weaver\-probe \- Identify a file: its format, its platform, and any header it carries
+.SH SYNOPSIS
+\fBrom\-weaver probe\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\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-no\-color\fR] [\fB\-h\fR|\fB\-\-help\fR]
+.SH DESCRIPTION
+Identify a file. Reports what format it is, which console it is for, whether it
+carries a copier header, and what is inside it if it is an archive.
+.PP
+`rom\-weaver inspect` runs this same command under another name.
+.PP
+Archives are opened automatically, so pointing this at a .zip describes the ROM
+inside rather than the zip itself. Pass \-\-no\-extract to describe the file as it
+sits on disk.
+.PP
+Nothing is written; this only reads.
+.SH OPTIONS
+.TP
+\fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
+File to identify. Use \- to read from stdin
+.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)
+.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; identify the file itself
+.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\-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-tools-ppf-undo.1

@@ -0,0 +1,71 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-tools-ppf-undo 1  "rom-weaver-tools-ppf-undo "
+.SH NAME
+rom\-weaver\-tools\-ppf\-undo \- Undo a PPF3 patch, using the undo data stored inside it
+.SH SYNOPSIS
+\fBrom\-weaver tools ppf\-undo\fR <\fB\-i\fR|\fB\-\-input\fR> [\fB\-\-json\fR] <\fB\-\-patch\fR> [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] <\fB\-o\fR|\fB\-\-output\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]
+.SH DESCRIPTION
+Undo a PPF3 patch, turning a patched ROM back into the original.
+.PP
+Only works when the patch was written with undo data, which is optional in the
+PPF3 format. Without it there is nothing to reverse from.
+.SH OPTIONS
+.TP
+\fB\-i\fR, \fB\-\-input\fR \fI<ROM>\fR
+The already\-patched ROM to undo
+.TP
+\fB\-\-patch\fR \fI<PPF>\fR
+The PPF3 patch that was applied. It must carry undo data
+.TP
+\fB\-o\fR, \fB\-\-output\fR \fI<PATH>\fR
+Where to write the restored ROM
+.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-tools.1

@@ -0,0 +1,63 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-tools 1  "rom-weaver-tools "
+.SH NAME
+rom\-weaver\-tools \- One\-off recovery tools
+.SH SYNOPSIS
+\fBrom\-weaver tools\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>
+.SH DESCRIPTION
+One\-off recovery tools
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help
+.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 SUBCOMMANDS
+.TP
+rom\-weaver\-tools\-ppf\-undo(1)
+Undo a PPF3 patch, using the undo data stored inside it