@rom-weaver/cli 0.10.2 → 0.11.1

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

@@ -0,0 +1,213 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-bundle-create 1  "rom-weaver-bundle-create "
+.SH NAME
+rom\-weaver\-bundle\-create \- Write a rom\-weaver\-bundle.json recipe from local ROM and patch files
+.SH SYNOPSIS
+\fBrom\-weaver bundle create\fR [\fB\-i\fR|\fB\-\-input\fR] [\fB\-\-json\fR] [\fB\-\-assume\-in\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-rom\-url\fR] [\fB\-\-log\-level\fR] [\fB\-\-rom\-name\fR] [\fB\-\-patch\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-patch\-id\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-patch\-version\fR] [\fB\-\-color\fR] [\fB\-\-patch\-name\fR] [\fB\-\-no\-color\fR] [\fB\-\-patch\-description\fR] [\fB\-\-patch\-author\fR] [\fB\-\-patch\-label\fR] [\fB\-\-patch\-optional\fR] [\fB\-\-patch\-source\-url\fR] [\fB\-\-patch\-header\fR] [\fB\-\-patch\-basis\fR] [\fB\-\-patch\-expect\-in\fR] [\fB\-\-patch\-expect\-out\fR] [\fB\-\-expect\-out\fR] [\fB\-\-output\-name\fR] [\fB\-\-output\-header\fR] <\fB\-o\fR|\fB\-\-output\fR> [\fB\-\-bundle\fR] [\fB\-\-bundle\-rom\fR] [\fB\-\-no\-bundle\-rom\fR] [\fB\-\-checksum\fR] [\fB\-\-from\fR] [\fB\-\-schema\-ref\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-h\fR|\fB\-\-help\fR]
+.SH DESCRIPTION
+Write a rom\-weaver\-bundle.json recipe from local ROM and patch files.
+.PP
+A bundle records which ROM the patches are for, what order they run in, and
+what the result should hash to. Hand it to someone else and
+`rom\-weaver weave \-\-bundle` reproduces your exact result.
+.PP
+Checksums come from the real files, so nothing here is taken on faith. Every
+\-\-patch\-* flag describes the \-\-patch before it.
+.PP
+\-\-output names the recipe itself; add .gz or .zst to compress it. \-\-bundle
+additionally packs the recipe and its files into one shareable archive.
+.SH OPTIONS
+.TP
+\fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
+ROM the patches apply to. Its checksums and size are read from the file and recorded in the bundle
+.TP
+\fB\-\-assume\-in\fR \fI<ALGO=HEX>\fR
+Take the ROM\*(Aqs checksum and size on trust rather than reading it, as in crc32=1234abcd,size=1048576 (repeatable, comma\-separable)
+.TP
+\fB\-\-rom\-url\fR \fI<ROM_URL>\fR
+Where the ROM can be downloaded from. With \-\-input, the local file still supplies the checksums; on its own, the bundle records only this url
+.TP
+\fB\-\-rom\-name\fR \fI<ROM_NAME>\fR
+File name to show for the ROM, and to base the output name on
+.TP
+\fB\-\-patch\fR \fI<PATCH>\fR
+Patch to list in the bundle. Repeat once per patch, in the order they should be
+applied.
+
+Every \-\-patch\-* flag describes the \-\-patch before it, so metadata for several
+patches reads left to right:
+
+  \-\-patch tl.bps  \-\-patch\-name \*(AqTranslation\*(Aq \-\-patch\-author \*(AqTeam A\*(Aq \\
+  \-\-patch fix.ips \-\-patch\-name \*(AqBugfixes\*(Aq    \-\-patch\-optional true
+.TP
+\fB\-\-patch\-id\fR \fI<PATCH_ID>\fR
+Identifier for the preceding \-\-patch that stays the same across releases, so a replacement keeps its settings
+.TP
+\fB\-\-patch\-version\fR \fI<PATCH_VERSION>\fR
+Version of the preceding \-\-patch, in whatever form its author uses
+.TP
+\fB\-\-patch\-name\fR \fI<PATCH_NAME>\fR
+Name to show for the preceding \-\-patch
+.TP
+\fB\-\-patch\-description\fR \fI<PATCH_DESCRIPTION>\fR
+What the preceding \-\-patch does
+.TP
+\fB\-\-patch\-author\fR \fI<PATCH_AUTHOR>\fR
+Who made the preceding \-\-patch
+.TP
+\fB\-\-patch\-label\fR \fI<PATCH_LABEL>\fR
+Short status note for the preceding \-\-patch, such as beta or recommended
+.TP
+\fB\-\-patch\-optional\fR \fI<PATCH_OPTIONAL>\fR
+Mark the preceding \-\-patch optional, so it starts switched off and needs \-\-with to run
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+true
+.IP \(bu 2
+false
+.RE
+.TP
+\fB\-\-patch\-source\-url\fR \fI<PATCH_SOURCE_URL>\fR
+Where the preceding \-\-patch can be downloaded from. The local file is still read to build the bundle
+.TP
+\fB\-\-patch\-header\fR \fI<PATCH_HEADER>\fR
+Whether the preceding \-\-patch applies to the ROM with or without its copier header: auto, keep, or strip
+.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: base (the bundle\*(Aqs ROM) or previous (the patch before it). Use auto to leave it out and let apply infer it
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+auto
+.IP \(bu 2
+base
+.IP \(bu 2
+previous
+.RE
+.TP
+\fB\-\-patch\-expect\-in\fR \fI<ALGO=HEX>\fR
+Checksum the ROM should have before the preceding \-\-patch runs. Recorded only when it differs from the bundle\*(Aqs ROM checksums (repeatable, comma\-separable)
+.TP
+\fB\-\-patch\-expect\-out\fR \fI<ALGO=HEX>\fR
+Checksum the ROM should have after the preceding \-\-patch runs. Recorded only when it differs from the final output checksums (repeatable, comma\-separable)
+.TP
+\fB\-\-expect\-out\fR \fI<ALGO=HEX>\fR
+Checksum the ROM should have once every patch has run, so users can confirm they got the right result (repeatable, comma\-separable)
+.TP
+\fB\-\-output\-name\fR \fI<OUTPUT_NAME>\fR
+File name the bundle suggests for the patched ROM
+.TP
+\fB\-\-output\-header\fR \fI<OUTPUT_HEADER>\fR
+Whether the patched ROM should keep its copier header: auto, keep, or strip
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+keep
+.IP \(bu 2
+strip
+.IP \(bu 2
+auto
+.RE
+.TP
+\fB\-o\fR, \fB\-\-output\fR \fI<OUTPUT>\fR
+Where to write the bundle. Name it rom\-weaver\-bundle.json, or add .gz or .zst to compress it
+.TP
+\fB\-\-bundle\fR \fI<BUNDLE>\fR
+Also pack the bundle and its ROM and patches into one shareable archive, such as release.zip
+.TP
+\fB\-\-bundle\-rom\fR \fI<BUNDLE_ROM>\fR
+Pack this file into \-\-bundle as the ROM, while \-\-input supplies the checksums and metadata
+.TP
+\fB\-\-no\-bundle\-rom\fR
+Keep the ROM out of \-\-bundle and record only its checksums, so whoever applies the bundle brings their own copy
+.TP
+\fB\-\-checksum\fR \fI<CHECKSUM>\fR
+Which checksums to record for the ROM (repeatable) [default: crc32,md5,sha1]
+.TP
+\fB\-\-from\fR \fI<FILE>\fR
+Build the bundle from a hand\-written rom\-weaver\-bundle.json instead of flags.
+Use \- to read it from stdin.
+
+Write the file with local paths and leave the checksums out; they are filled in
+from the real files. Get the schema with `rom\-weaver bundle schema` so your
+editor can check the file as you write it.
+
+Any flag you also pass overrides what the file says.
+.TP
+\fB\-\-schema\-ref\fR \fI<URL>\fR
+Record this $schema URL in the bundle so editors can validate it. Left out unless asked for
+.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-bundle-parse.1

@@ -0,0 +1,98 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-bundle-parse 1  "rom-weaver-bundle-parse "
+.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]
+.SH DESCRIPTION
+Read a rom\-weaver\-bundle.json recipe, check that it is valid, and report the
+ROM and patches it points at.
+.PP
+The input can be a plain rom\-weaver\-bundle.json, a compressed one (.gz, .bz2,
+\&.xz, or .zst), or an archive with the recipe at its root alongside the files it
+names.
+.PP
+Entries that name a file are looked for in the archive, or next to the recipe.
+Pass \-\-output to write those files out and get real paths back. Entries that
+name a url are reported as they are; nothing is downloaded.
+.PP
+To actually run a bundle, use `rom\-weaver weave \-\-bundle` instead.
+.SH OPTIONS
+.TP
+\fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
+Bundle file, or an archive with a bundle at its root
+.TP
+\fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
+Handle only the bundle entries whose file name matches this exact name, prefix, or glob (repeatable)
+.TP
+\fB\-\-filter\fR \fI<FILTER>\fR
+Handle only the bundle\*(Aqs rom entry or only its patch entries (repeatable, comma\-separable)
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+rom
+.IP \(bu 2
+patch
+.RE
+.TP
+\fB\-\-no\-extract\fR
+Report what the bundle contains without unpacking any of it
+.TP
+\fB\-o\fR, \fB\-\-output\fR \fI<DIR>\fR
+Directory to unpack the bundle\*(Aqs files into. Without it, files packed in an archive are listed but not written out
+.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-bundle-schema.1

@@ -0,0 +1,67 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-bundle-schema 1  "rom-weaver-bundle-schema "
+.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]
+.SH DESCRIPTION
+Print the rom\-weaver\-bundle.json JSON Schema to stdout.
+.PP
+Save it and point your editor at it, and the editor will check and autocomplete
+a bundle as you write it:
+.PP
+  rom\-weaver bundle schema > rom\-weaver\-bundle\-v1.schema.json
+.PP
+Then `bundle create \-\-from <your file>` turns what you wrote into a finished
+bundle with the checksums filled in.
+.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

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

@@ -0,0 +1,69 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-bundle 1  "rom-weaver-bundle "
+.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>
+.SH DESCRIPTION
+Build and read rom\-weaver\-bundle.json patch recipes
+.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\-bundle\-create(1)
+Write a rom\-weaver\-bundle.json recipe from local ROM and patch files
+.TP
+rom\-weaver\-bundle\-parse(1)
+Read a rom\-weaver\-bundle.json recipe and report what it points at
+.TP
+rom\-weaver\-bundle\-schema(1)
+Print the rom\-weaver\-bundle.json JSON Schema, for editors and hand\-authoring

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

@@ -0,0 +1,110 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-checksum 1  "rom-weaver-checksum "
+.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]
+.SH DESCRIPTION
+Compute checksums for a file, so you can tell one dump from another.
+.PP
+Archives are opened automatically, so this hashes the ROM inside a .zip rather
+than the zip itself. Pass \-\-no\-extract to hash the file as it sits on disk.
+.PP
+Alongside the plain checksum, rom\-weaver reports how the same ROM would hash in
+its other common forms: with and without a copier header, in each N64 byte
+order, and trimmed or padded. That is what lets a checksum from a database
+match a file that is stored slightly differently.
+.SH OPTIONS
+.TP
+\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)
+.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; hash 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\-\-no\-trim\-fix\fR
+Skip the extra checksums computed for how a trimmable ROM would hash trimmed or untrimmed
+.TP
+\fB\-\-start\fR \fI<BYTE>\fR
+Start hashing at this byte offset, counting from 0
+.TP
+\fB\-\-length\fR \fI<BYTES>\fR
+How many bytes to hash from \-\-start. Defaults to the rest of the file
+.TP
+\fB\-\-probe\fR
+Also report the platform of the hashed bytes, and fail if it 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-completions.1

@@ -0,0 +1,84 @@
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.TH rom-weaver-completions 1  "rom-weaver-completions "
+.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>
+.SH DESCRIPTION
+Print a tab\-completion script for your shell to stdout.
+.PP
+Save it where your shell looks for completions, then start a new shell:
+.PP
+  rom\-weaver completions bash > /etc/bash_completion.d/rom\-weaver
+  rom\-weaver completions zsh  > ~/.zfunc/_rom\-weaver
+  rom\-weaver completions fish > ~/.config/fish/completions/rom\-weaver.fish
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help (see a summary with \*(Aq\-h\*(Aq)
+.TP
+<\fISHELL\fR>
+Shell to print completions for
+.br
+
+.br
+\fIPossible values:\fR
+.RS 14
+.IP \(bu 2
+bash
+.IP \(bu 2
+elvish
+.IP \(bu 2
+fish
+.IP \(bu 2
+powershell
+.IP \(bu 2
+zsh
+.RE
+.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