@rom-weaver/cli 0.15.1 → 0.16.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/README.md +40 -24
  2. package/docs/completions/_rom-weaver +1242 -644
  3. package/docs/completions/rom-weaver.bash +690 -109
  4. package/docs/completions/rom-weaver.elv +973 -576
  5. package/docs/completions/rom-weaver.fish +841 -536
  6. package/docs/completions/rom-weaver.ps1 +1006 -588
  7. package/docs/man/rom-weaver-bundle-create.1 +55 -8
  8. package/docs/man/rom-weaver-bundle-parse.1 +15 -6
  9. package/docs/man/rom-weaver-bundle-schema.1 +16 -7
  10. package/docs/man/rom-weaver-bundle.1 +15 -6
  11. package/docs/man/rom-weaver-cheat.1 +107 -0
  12. package/docs/man/rom-weaver-checksum.1 +21 -6
  13. package/docs/man/rom-weaver-completions.1 +15 -6
  14. package/docs/man/rom-weaver-compress.1 +23 -11
  15. package/docs/man/rom-weaver-extract.1 +23 -8
  16. package/docs/man/rom-weaver-formats.1 +15 -6
  17. package/docs/man/rom-weaver-identify-database-import-redump.1 +15 -6
  18. package/docs/man/rom-weaver-identify-database-install-all.1 +15 -6
  19. package/docs/man/rom-weaver-identify-database-install-group.1 +15 -6
  20. package/docs/man/rom-weaver-identify-database-install.1 +15 -6
  21. package/docs/man/rom-weaver-identify-database-list.1 +15 -6
  22. package/docs/man/rom-weaver-identify-database-path.1 +15 -6
  23. package/docs/man/rom-weaver-identify-database-remove.1 +15 -6
  24. package/docs/man/rom-weaver-identify-database-status.1 +15 -6
  25. package/docs/man/rom-weaver-identify-database-update.1 +15 -6
  26. package/docs/man/rom-weaver-identify-database.1 +15 -6
  27. package/docs/man/rom-weaver-identify.1 +27 -6
  28. package/docs/man/rom-weaver-man.1 +15 -6
  29. package/docs/man/rom-weaver-patch-apply.1 +64 -15
  30. package/docs/man/rom-weaver-patch-create.1 +33 -8
  31. package/docs/man/rom-weaver-patch-validate.1 +35 -7
  32. package/docs/man/rom-weaver-patch.1 +15 -6
  33. package/docs/man/rom-weaver-probe.1 +18 -6
  34. package/docs/man/rom-weaver-save-export-schema.1 +80 -0
  35. package/docs/man/rom-weaver-save-get.1 +83 -0
  36. package/docs/man/rom-weaver-save-identify.1 +80 -0
  37. package/docs/man/rom-weaver-save-inspect.1 +80 -0
  38. package/docs/man/rom-weaver-save-set.1 +89 -0
  39. package/docs/man/rom-weaver-save.1 +87 -0
  40. package/docs/man/rom-weaver-setup.1 +18 -6
  41. package/docs/man/rom-weaver-tools-ppf-undo.1 +16 -7
  42. package/docs/man/rom-weaver-tools.1 +15 -6
  43. package/docs/man/rom-weaver-trim.1 +24 -15
  44. package/docs/man/rom-weaver-weave.1 +64 -15
  45. package/docs/man/rom-weaver.1 +23 -8
  46. package/package.json +20 -13
@@ -4,7 +4,7 @@
4
4
  .SH NAME
5
5
  rom\-weaver\-bundle\-create \- Write a rom\-weaver\-bundle.json recipe from local ROM and patch files
6
6
  .SH SYNOPSIS
7
- \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\-y\fR|\fB\-\-yes\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\-\-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\-\-force\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-o\fR|\fB\-\-output\fR>
7
+ \fBrom\-weaver bundle create\fR [\fB\-i\fR|\fB\-\-input\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-assume\-in\fR] [\fB\-\-json\fR] [\fB\-\-jsonl\fR] [\fB\-\-rom\-url\fR] [\fB\-\-progress\fR] [\fB\-\-rom\-name\fR] [\fB\-\-no\-progress\fR] [\fB\-\-rom\-member\fR] [\fB\-\-log\-level\fR] [\fB\-\-patch\fR] [\fB\-\-patch\-id\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\fR] [\fB\-\-patch\-version\fR] [\fB\-\-patch\-name\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-patch\-description\fR] [\fB\-\-color\fR] [\fB\-\-patch\-author\fR] [\fB\-\-no\-color\fR] [\fB\-\-patch\-label\fR] [\fB\-\-patch\-optional\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-\-patch\-source\-url\fR] [\fB\-\-patch\-header\fR] [\fB\-\-patch\-basis\fR] [\fB\-\-default\-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\-\-cheat\fR] [\fB\-\-cheat\-database\fR] [\fB\-\-cheat\-system\fR] [\fB\-\-game\fR] [\fB\-\-allow\-cheat\-conflicts\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\-\-force\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-o\fR|\fB\-\-output\fR>
8
8
  .SH DESCRIPTION
9
9
  Write a rom\-weaver\-bundle.json recipe from local ROM and patch files.
10
10
  .PP
@@ -29,7 +29,10 @@ Take the ROM\*(Aqs checksum and size on trust rather than reading it, as in crc3
29
29
  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
30
30
  .TP
31
31
  \fB\-\-rom\-name\fR \fI<ROM_NAME>\fR
32
- Expected ROM file name to show and use for output naming; a supplied ROM with a different name only warns
32
+ Expected source ROM file name to show and use for output naming; a mismatch is advisory
33
+ .TP
34
+ \fB\-\-rom\-member\fR \fI<ROM_MEMBER>\fR
35
+ Use this exact archive member or disc track as the bundle ROM target
33
36
  .TP
34
37
  \fB\-\-patch\fR \fI<PATCH>\fR
35
38
  Patch to list in the bundle. Repeat once per patch, in the order they should be
@@ -127,13 +130,32 @@ auto
127
130
  .RE
128
131
  .TP
129
132
  \fB\-\-patch\-basis\fR \fI<PATCH_BASIS>\fR
130
- 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
133
+ Override the preceding \-\-patch input rule: base (the bundle\*(Aqs ROM) or previous (the patch before it). Use auto to inherit the bundle rule
131
134
 
132
135
  This flag must follow the \-\-patch it describes. Give it once per \-\-patch, in the same order, or leave it out entirely \- a partial list is an error. An occurrence before any \-\-patch has nothing to bind to.
133
136
 
134
137
  \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
135
138
  .br
136
139
 
140
+ .br
141
+ \fIPossible values:\fR
142
+ .RS 14
143
+ .IP \(bu 2
144
+ auto
145
+ .IP \(bu 2
146
+ base
147
+ .IP \(bu 2
148
+ previous
149
+ .RE
150
+ .TP
151
+ \fB\-\-default\-patch\-basis\fR \fI<DEFAULT_PATCH_BASIS>\fR
152
+ Record one input ROM rule for every patch. An individual \-\-patch\-basis overrides it.
153
+
154
+ base Every patch was made from the original ROM.
155
+ previous Each later patch was made from the previous result.
156
+ auto Infer the input ROM from checksums (the default).
157
+ .br
158
+
137
159
  .br
138
160
  \fIPossible values:\fR
139
161
  .RS 14
@@ -234,19 +256,41 @@ Overwrite the output if it already exists (without this, the command stops inste
234
256
  .TP
235
257
  \fB\-h\fR, \fB\-\-help\fR
236
258
  Print help (see a summary with \*(Aq\-h\*(Aq)
259
+ .SH CHEATS
260
+ .TP
261
+ \fB\-\-cheat\fR \fI<ID_OR_DESCRIPTION>\fR
262
+ Database cheat to use, by record ID or exact description. Repeat for each cheat
263
+ .TP
264
+ \fB\-\-cheat\-database\fR \fI<DIR>\fR
265
+ Directory holding manifest.json and the <system>.json cheat shards. Defaults to $ROM_WEAVER_CHEAT_DATABASE, then the per\-user data directory
266
+ .TP
267
+ \fB\-\-cheat\-system\fR \fI<SYS>\fR
268
+ Console the cheat shard is for (nes, snes, genesis, gameboy, gameboy\-color, gba), when the ROM header does not say
269
+ .TP
270
+ \fB\-\-game\fR \fI<ID>\fR
271
+ Use this database game ID instead of matching the ROM by checksum or title
272
+ .TP
273
+ \fB\-\-allow\-cheat\-conflicts\fR
274
+ Let a later cheat overwrite an earlier one at the same offset instead of failing
237
275
  .SH "GLOBAL OPTIONS"
238
276
  .TP
277
+ \fB\-n\fR, \fB\-\-dry\-run\fR
278
+ Plan the command without changing files or downloading data
279
+ .TP
239
280
  \fB\-\-json\fR
240
- Print one JSON object per line instead of human\-readable output
281
+ Print one complete JSON report; progress and diagnostics use stderr
282
+ .TP
283
+ \fB\-\-jsonl\fR
284
+ Stream JSON events, including progress, one object per line
241
285
  .TP
242
286
  \fB\-\-progress\fR
243
- Show progress even when output is piped to a file or another program
287
+ Show progress on stderr (off by default; JSONL includes progress)
244
288
  .TP
245
289
  \fB\-\-no\-progress\fR
246
290
  Hide progress
247
291
  .TP
248
292
  \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
249
- How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
293
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
250
294
  .br
251
295
 
252
296
  .br
@@ -267,10 +311,13 @@ trace
267
311
  .RE
268
312
  .TP
269
313
  \fB\-v\fR, \fB\-\-verbose\fR
270
- Log more: \-v for info, \-vv for debug, \-vvv for trace
314
+ Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
315
+ .TP
316
+ \fB\-\-debug\fR
317
+ Show developer diagnostics and trace events on stderr (same as \-vvv)
271
318
  .TP
272
319
  \fB\-q\fR, \fB\-\-quiet\fR
273
- Log errors only
320
+ Hide optional diagnostics and progress; keep results, warnings, and errors
274
321
  .TP
275
322
  \fB\-\-dep\-trace\fR
276
323
  Also log trace output from bundled libraries (for bug reports)
@@ -4,7 +4,7 @@
4
4
  .SH NAME
5
5
  rom\-weaver\-bundle\-parse \- Read a rom\-weaver\-bundle.json recipe and report what it points at
6
6
  .SH SYNOPSIS
7
- \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>
7
+ \fBrom\-weaver bundle parse\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-s\fR|\fB\-\-select\fR] [\fB\-\-filter\fR] [\fB\-\-jsonl\fR] [\fB\-\-no\-extract\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\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>
8
8
  .SH DESCRIPTION
9
9
  Read a rom\-weaver\-bundle.json recipe, check that it is valid, and report the
10
10
  ROM and patches it points at.
@@ -52,17 +52,23 @@ How many threads to use at most. auto uses every core; a format may still use fe
52
52
  Print help (see a summary with \*(Aq\-h\*(Aq)
53
53
  .SH "GLOBAL OPTIONS"
54
54
  .TP
55
+ \fB\-n\fR, \fB\-\-dry\-run\fR
56
+ Plan the command without changing files or downloading data
57
+ .TP
55
58
  \fB\-\-json\fR
56
- Print one JSON object per line instead of human\-readable output
59
+ Print one complete JSON report; progress and diagnostics use stderr
60
+ .TP
61
+ \fB\-\-jsonl\fR
62
+ Stream JSON events, including progress, one object per line
57
63
  .TP
58
64
  \fB\-\-progress\fR
59
- Show progress even when output is piped to a file or another program
65
+ Show progress on stderr (off by default; JSONL includes progress)
60
66
  .TP
61
67
  \fB\-\-no\-progress\fR
62
68
  Hide progress
63
69
  .TP
64
70
  \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
65
- How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
71
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
66
72
  .br
67
73
 
68
74
  .br
@@ -83,10 +89,13 @@ trace
83
89
  .RE
84
90
  .TP
85
91
  \fB\-v\fR, \fB\-\-verbose\fR
86
- Log more: \-v for info, \-vv for debug, \-vvv for trace
92
+ Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
93
+ .TP
94
+ \fB\-\-debug\fR
95
+ Show developer diagnostics and trace events on stderr (same as \-vvv)
87
96
  .TP
88
97
  \fB\-q\fR, \fB\-\-quiet\fR
89
- Log errors only
98
+ Hide optional diagnostics and progress; keep results, warnings, and errors
90
99
  .TP
91
100
  \fB\-\-dep\-trace\fR
92
101
  Also log trace output from bundled libraries (for bug reports)
@@ -4,14 +4,14 @@
4
4
  .SH NAME
5
5
  rom\-weaver\-bundle\-schema \- Print the rom\-weaver\-bundle.json JSON Schema, for editors and hand\-authoring
6
6
  .SH SYNOPSIS
7
- \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]
7
+ \fBrom\-weaver bundle schema\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-\-jsonl\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\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]
8
8
  .SH DESCRIPTION
9
9
  Print the rom\-weaver\-bundle.json JSON Schema to stdout.
10
10
  .PP
11
11
  Save it and point your editor at it, and the editor will check and autocomplete
12
12
  a bundle as you write it:
13
13
  .PP
14
- rom\-weaver bundle schema > rom\-weaver\-bundle\-v1.schema.json
14
+ rom\-weaver bundle schema > rom\-weaver\-bundle\-v2.schema.json
15
15
  .PP
16
16
  Then `bundle create \-\-from <your file>` turns what you wrote into a finished
17
17
  bundle with the checksums filled in.
@@ -21,17 +21,23 @@ bundle with the checksums filled in.
21
21
  Print help (see a summary with \*(Aq\-h\*(Aq)
22
22
  .SH "GLOBAL OPTIONS"
23
23
  .TP
24
+ \fB\-n\fR, \fB\-\-dry\-run\fR
25
+ Plan the command without changing files or downloading data
26
+ .TP
24
27
  \fB\-\-json\fR
25
- Print one JSON object per line instead of human\-readable output
28
+ Print one complete JSON report; progress and diagnostics use stderr
29
+ .TP
30
+ \fB\-\-jsonl\fR
31
+ Stream JSON events, including progress, one object per line
26
32
  .TP
27
33
  \fB\-\-progress\fR
28
- Show progress even when output is piped to a file or another program
34
+ Show progress on stderr (off by default; JSONL includes progress)
29
35
  .TP
30
36
  \fB\-\-no\-progress\fR
31
37
  Hide progress
32
38
  .TP
33
39
  \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
34
- How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
40
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
35
41
  .br
36
42
 
37
43
  .br
@@ -52,10 +58,13 @@ trace
52
58
  .RE
53
59
  .TP
54
60
  \fB\-v\fR, \fB\-\-verbose\fR
55
- Log more: \-v for info, \-vv for debug, \-vvv for trace
61
+ Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
62
+ .TP
63
+ \fB\-\-debug\fR
64
+ Show developer diagnostics and trace events on stderr (same as \-vvv)
56
65
  .TP
57
66
  \fB\-q\fR, \fB\-\-quiet\fR
58
- Log errors only
67
+ Hide optional diagnostics and progress; keep results, warnings, and errors
59
68
  .TP
60
69
  \fB\-\-dep\-trace\fR
61
70
  Also log trace output from bundled libraries (for bug reports)
@@ -4,7 +4,7 @@
4
4
  .SH NAME
5
5
  rom\-weaver\-bundle \- Build and read rom\-weaver\-bundle.json patch recipes
6
6
  .SH SYNOPSIS
7
- \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>
7
+ \fBrom\-weaver bundle\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-\-jsonl\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\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>
8
8
  .SH DESCRIPTION
9
9
  Build and read rom\-weaver\-bundle.json patch recipes
10
10
  .SH OPTIONS
@@ -13,17 +13,23 @@ Build and read rom\-weaver\-bundle.json patch recipes
13
13
  Print help
14
14
  .SH "GLOBAL OPTIONS"
15
15
  .TP
16
+ \fB\-n\fR, \fB\-\-dry\-run\fR
17
+ Plan the command without changing files or downloading data
18
+ .TP
16
19
  \fB\-\-json\fR
17
- Print one JSON object per line instead of human\-readable output
20
+ Print one complete JSON report; progress and diagnostics use stderr
21
+ .TP
22
+ \fB\-\-jsonl\fR
23
+ Stream JSON events, including progress, one object per line
18
24
  .TP
19
25
  \fB\-\-progress\fR
20
- Show progress even when output is piped to a file or another program
26
+ Show progress on stderr (off by default; JSONL includes progress)
21
27
  .TP
22
28
  \fB\-\-no\-progress\fR
23
29
  Hide progress
24
30
  .TP
25
31
  \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
26
- How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
32
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
27
33
  .br
28
34
 
29
35
  .br
@@ -44,10 +50,13 @@ trace
44
50
  .RE
45
51
  .TP
46
52
  \fB\-v\fR, \fB\-\-verbose\fR
47
- Log more: \-v for info, \-vv for debug, \-vvv for trace
53
+ Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
54
+ .TP
55
+ \fB\-\-debug\fR
56
+ Show developer diagnostics and trace events on stderr (same as \-vvv)
48
57
  .TP
49
58
  \fB\-q\fR, \fB\-\-quiet\fR
50
- Log errors only
59
+ Hide optional diagnostics and progress; keep results, warnings, and errors
51
60
  .TP
52
61
  \fB\-\-dep\-trace\fR
53
62
  Also log trace output from bundled libraries (for bug reports)
@@ -0,0 +1,107 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-cheat 1 "rom-weaver-cheat "
4
+ .SH NAME
5
+ rom\-weaver\-cheat \- List the cheat database\*(Aqs entries for a ROM
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver cheat\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-cheat\fR] [\fB\-\-json\fR] [\fB\-\-cheat\-database\fR] [\fB\-\-jsonl\fR] [\fB\-\-cheat\-system\fR] [\fB\-\-progress\fR] [\fB\-\-game\fR] [\fB\-\-no\-progress\fR] [\fB\-\-allow\-cheat\-conflicts\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\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> <\fIACTION\fR>
8
+ .SH DESCRIPTION
9
+ List the cheat database\*(Aqs entries for a ROM.
10
+ .PP
11
+ `cheat list` identifies the ROM\*(Aqs system, loads that system\*(Aqs shard from the
12
+ cheat\-database directory, matches the game by checksum and then by title, and
13
+ prints every cheat with whether it can be baked into the ROM.
14
+ .PP
15
+ To use a cheat, bake it: `patch create \-\-code`, then `patch apply`.
16
+ .SH OPTIONS
17
+ .TP
18
+ \fB\-i\fR, \fB\-\-input\fR \fI<ROM>\fR
19
+ The ROM the cheats are for. Its header picks the cheat shard and its bytes decide each cheat\*(Aqs delivery
20
+ .TP
21
+ \fB\-h\fR, \fB\-\-help\fR
22
+ Print help (see a summary with \*(Aq\-h\*(Aq)
23
+ .TP
24
+ <\fIACTION\fR>
25
+ list: print the matched game\*(Aqs cheats
26
+ .br
27
+
28
+ .br
29
+ \fIPossible values:\fR
30
+ .RS 14
31
+ .IP \(bu 2
32
+ list: Print the cheats the database holds for the input ROM
33
+ .RE
34
+ .SH CHEATS
35
+ .TP
36
+ \fB\-\-cheat\fR \fI<ID_OR_DESCRIPTION>\fR
37
+ Database cheat to use, by record ID or exact description. Repeat for each cheat
38
+ .TP
39
+ \fB\-\-cheat\-database\fR \fI<DIR>\fR
40
+ Directory holding manifest.json and the <system>.json cheat shards. Defaults to $ROM_WEAVER_CHEAT_DATABASE, then the per\-user data directory
41
+ .TP
42
+ \fB\-\-cheat\-system\fR \fI<SYS>\fR
43
+ Console the cheat shard is for (nes, snes, genesis, gameboy, gameboy\-color, gba), when the ROM header does not say
44
+ .TP
45
+ \fB\-\-game\fR \fI<ID>\fR
46
+ Use this database game ID instead of matching the ROM by checksum or title
47
+ .TP
48
+ \fB\-\-allow\-cheat\-conflicts\fR
49
+ Let a later cheat overwrite an earlier one at the same offset instead of failing
50
+ .SH "GLOBAL OPTIONS"
51
+ .TP
52
+ \fB\-n\fR, \fB\-\-dry\-run\fR
53
+ Plan the command without changing files or downloading data
54
+ .TP
55
+ \fB\-\-json\fR
56
+ Print one complete JSON report; progress and diagnostics use stderr
57
+ .TP
58
+ \fB\-\-jsonl\fR
59
+ Stream JSON events, including progress, one object per line
60
+ .TP
61
+ \fB\-\-progress\fR
62
+ Show progress on stderr (off by default; JSONL includes progress)
63
+ .TP
64
+ \fB\-\-no\-progress\fR
65
+ Hide progress
66
+ .TP
67
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
68
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
69
+ .br
70
+
71
+ .br
72
+ \fIPossible values:\fR
73
+ .RS 14
74
+ .IP \(bu 2
75
+ off
76
+ .IP \(bu 2
77
+ error
78
+ .IP \(bu 2
79
+ warn
80
+ .IP \(bu 2
81
+ info
82
+ .IP \(bu 2
83
+ debug
84
+ .IP \(bu 2
85
+ trace
86
+ .RE
87
+ .TP
88
+ \fB\-v\fR, \fB\-\-verbose\fR
89
+ Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
90
+ .TP
91
+ \fB\-\-debug\fR
92
+ Show developer diagnostics and trace events on stderr (same as \-vvv)
93
+ .TP
94
+ \fB\-q\fR, \fB\-\-quiet\fR
95
+ Hide optional diagnostics and progress; keep results, warnings, and errors
96
+ .TP
97
+ \fB\-\-dep\-trace\fR
98
+ Also log trace output from bundled libraries (for bug reports)
99
+ .TP
100
+ \fB\-\-color\fR
101
+ Keep colors even when output is piped
102
+ .TP
103
+ \fB\-\-no\-color\fR
104
+ Turn colors off
105
+ .TP
106
+ \fB\-y\fR, \fB\-\-yes\fR
107
+ Answer yes to every confirmation instead of asking. Does not choose between candidates
@@ -4,7 +4,7 @@
4
4
  .SH NAME
5
5
  rom\-weaver\-checksum \- Compute checksums for a file, or for a ROM inside an archive
6
6
  .SH SYNOPSIS
7
- \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>
7
+ \fBrom\-weaver checksum\fR [\fB\-i\fR|\fB\-\-input\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-a\fR|\fB\-\-algo\fR] [\fB\-\-json\fR] [\fB\-\-jsonl\fR] [\fB\-s\fR|\fB\-\-select\fR] [\fB\-\-filter\fR] [\fB\-\-progress\fR] [\fB\-\-no\-extract\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-\-no\-ignore\fR] [\fB\-\-no\-trim\-fix\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\fR] [\fB\-\-start\fR] [\fB\-\-length\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-probe\fR] [\fB\-\-color\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-digest\fR] [\fB\-\-no\-color\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIFILE\fR]
8
8
  .SH DESCRIPTION
9
9
  Compute checksums for a file, so you can tell one dump from another.
10
10
  .PP
@@ -82,21 +82,33 @@ Also report the platform of the hashed bytes, and fail if it matches no known pl
82
82
  \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
83
83
  How many threads to use at most. auto uses every core; a format may still use fewer
84
84
  .TP
85
+ \fB\-\-digest\fR
86
+ Print only the digest; requires one \-\-algo (no labels or elapsed time)
87
+ .TP
85
88
  \fB\-h\fR, \fB\-\-help\fR
86
89
  Print help (see a summary with \*(Aq\-h\*(Aq)
90
+ .TP
91
+ [\fIFILE\fR]
92
+ File input; an alternative to \-i, \-\-input
87
93
  .SH "GLOBAL OPTIONS"
88
94
  .TP
95
+ \fB\-n\fR, \fB\-\-dry\-run\fR
96
+ Plan the command without changing files or downloading data
97
+ .TP
89
98
  \fB\-\-json\fR
90
- Print one JSON object per line instead of human\-readable output
99
+ Print one complete JSON report; progress and diagnostics use stderr
100
+ .TP
101
+ \fB\-\-jsonl\fR
102
+ Stream JSON events, including progress, one object per line
91
103
  .TP
92
104
  \fB\-\-progress\fR
93
- Show progress even when output is piped to a file or another program
105
+ Show progress on stderr (off by default; JSONL includes progress)
94
106
  .TP
95
107
  \fB\-\-no\-progress\fR
96
108
  Hide progress
97
109
  .TP
98
110
  \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
99
- How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
111
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
100
112
  .br
101
113
 
102
114
  .br
@@ -117,10 +129,13 @@ trace
117
129
  .RE
118
130
  .TP
119
131
  \fB\-v\fR, \fB\-\-verbose\fR
120
- Log more: \-v for info, \-vv for debug, \-vvv for trace
132
+ Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
133
+ .TP
134
+ \fB\-\-debug\fR
135
+ Show developer diagnostics and trace events on stderr (same as \-vvv)
121
136
  .TP
122
137
  \fB\-q\fR, \fB\-\-quiet\fR
123
- Log errors only
138
+ Hide optional diagnostics and progress; keep results, warnings, and errors
124
139
  .TP
125
140
  \fB\-\-dep\-trace\fR
126
141
  Also log trace output from bundled libraries (for bug reports)
@@ -4,7 +4,7 @@
4
4
  .SH NAME
5
5
  rom\-weaver\-completions \- Print a tab\-completion script for your shell
6
6
  .SH SYNOPSIS
7
- \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>
7
+ \fBrom\-weaver completions\fR [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-\-jsonl\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-log\-level\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\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>
8
8
  .SH DESCRIPTION
9
9
  Print a tab\-completion script for your shell to stdout.
10
10
  .PP
@@ -38,17 +38,23 @@ zsh
38
38
  .RE
39
39
  .SH "GLOBAL OPTIONS"
40
40
  .TP
41
+ \fB\-n\fR, \fB\-\-dry\-run\fR
42
+ Plan the command without changing files or downloading data
43
+ .TP
41
44
  \fB\-\-json\fR
42
- Print one JSON object per line instead of human\-readable output
45
+ Print one complete JSON report; progress and diagnostics use stderr
46
+ .TP
47
+ \fB\-\-jsonl\fR
48
+ Stream JSON events, including progress, one object per line
43
49
  .TP
44
50
  \fB\-\-progress\fR
45
- Show progress even when output is piped to a file or another program
51
+ Show progress on stderr (off by default; JSONL includes progress)
46
52
  .TP
47
53
  \fB\-\-no\-progress\fR
48
54
  Hide progress
49
55
  .TP
50
56
  \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
51
- How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
57
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
52
58
  .br
53
59
 
54
60
  .br
@@ -69,10 +75,13 @@ trace
69
75
  .RE
70
76
  .TP
71
77
  \fB\-v\fR, \fB\-\-verbose\fR
72
- Log more: \-v for info, \-vv for debug, \-vvv for trace
78
+ Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
79
+ .TP
80
+ \fB\-\-debug\fR
81
+ Show developer diagnostics and trace events on stderr (same as \-vvv)
73
82
  .TP
74
83
  \fB\-q\fR, \fB\-\-quiet\fR
75
- Log errors only
84
+ Hide optional diagnostics and progress; keep results, warnings, and errors
76
85
  .TP
77
86
  \fB\-\-dep\-trace\fR
78
87
  Also log trace output from bundled libraries (for bug reports)
@@ -4,7 +4,7 @@
4
4
  .SH NAME
5
5
  rom\-weaver\-compress \- Pack files into an archive, disc image, or ROM\-specific compressed format
6
6
  .SH SYNOPSIS
7
- \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>
7
+ \fBrom\-weaver compress\fR [\fB\-i\fR|\fB\-\-input\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-f\fR|\fB\-\-format\fR] [\fB\-\-json\fR] [\fB\-\-jsonl\fR] [\fB\-\-codec\fR] [\fB\-\-progress\fR] [\fB\-\-level\fR] [\fB\-\-no\-progress\fR] [\fB\-\-force\fR] [\fB\-\-log\-level\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-debug\fR] [\fB\-\-stdin\-name\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\-o\fR|\fB\-\-output\fR> [\fIFILE\fR]
8
8
  .SH DESCRIPTION
9
9
  Pack files into an archive, disc image, or ROM\-specific compressed format.
10
10
  .PP
@@ -22,7 +22,7 @@ for when you want to override that.
22
22
  .SH OPTIONS
23
23
  .TP
24
24
  \fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
25
- 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
25
+ Input path; \- reads stdin using a temporary file
26
26
  .TP
27
27
  \fB\-f\fR, \fB\-\-format\fR \fI<FORMAT>\fR
28
28
  Output format, such as zip, 7z, chd, rvz, or z3ds.
@@ -51,7 +51,7 @@ z3ds
51
51
  .RE
52
52
  .TP
53
53
  \fB\-o\fR, \fB\-\-output\fR \fI<PATH>\fR
54
- Where to write the archive
54
+ Output path; \- writes one binary result to stdout (compress requires \-\-format)
55
55
  .TP
56
56
  \fB\-\-codec\fR \fI<CODEC>\fR
57
57
  Compression method to use, written as codec or codec:level.
@@ -124,27 +124,36 @@ max
124
124
  \fB\-\-force\fR
125
125
  Overwrite the output if it already exists (without this, the command stops instead)
126
126
  .TP
127
- \fB\-n\fR, \fB\-\-dry\-run\fR
128
- Print the plan (inputs, output, format, codec, level, threads) and stop without writing
129
- .TP
130
127
  \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
131
128
  How many threads to use at most. auto uses every core; a format may still use fewer
132
129
  .TP
130
+ \fB\-\-stdin\-name\fR \fI<NAME>\fR
131
+ Filename for input \- (default: stdin.bin); one filename, no directories
132
+ .TP
133
133
  \fB\-h\fR, \fB\-\-help\fR
134
134
  Print help (see a summary with \*(Aq\-h\*(Aq)
135
+ .TP
136
+ [\fIFILE\fR]
137
+ File input; an alternative to \-i, \-\-input
135
138
  .SH "GLOBAL OPTIONS"
136
139
  .TP
140
+ \fB\-n\fR, \fB\-\-dry\-run\fR
141
+ Plan the command without changing files or downloading data
142
+ .TP
137
143
  \fB\-\-json\fR
138
- Print one JSON object per line instead of human\-readable output
144
+ Print one complete JSON report; progress and diagnostics use stderr
145
+ .TP
146
+ \fB\-\-jsonl\fR
147
+ Stream JSON events, including progress, one object per line
139
148
  .TP
140
149
  \fB\-\-progress\fR
141
- Show progress even when output is piped to a file or another program
150
+ Show progress on stderr (off by default; JSONL includes progress)
142
151
  .TP
143
152
  \fB\-\-no\-progress\fR
144
153
  Hide progress
145
154
  .TP
146
155
  \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
147
- How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
156
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: warn]
148
157
  .br
149
158
 
150
159
  .br
@@ -165,10 +174,13 @@ trace
165
174
  .RE
166
175
  .TP
167
176
  \fB\-v\fR, \fB\-\-verbose\fR
168
- Log more: \-v for info, \-vv for debug, \-vvv for trace
177
+ Show user diagnostics on stderr; repeat for developer detail (\-vv debug, \-vvv trace)
178
+ .TP
179
+ \fB\-\-debug\fR
180
+ Show developer diagnostics and trace events on stderr (same as \-vvv)
169
181
  .TP
170
182
  \fB\-q\fR, \fB\-\-quiet\fR
171
- Log errors only
183
+ Hide optional diagnostics and progress; keep results, warnings, and errors
172
184
  .TP
173
185
  \fB\-\-dep\-trace\fR
174
186
  Also log trace output from bundled libraries (for bug reports)