@rom-weaver/cli 0.12.3 → 0.14.0

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 (38) hide show
  1. package/README.md +38 -270
  2. package/docs/completions/_rom-weaver +878 -23
  3. package/docs/completions/rom-weaver.bash +1052 -53
  4. package/docs/completions/rom-weaver.elv +442 -12
  5. package/docs/completions/rom-weaver.fish +258 -41
  6. package/docs/completions/rom-weaver.ps1 +489 -12
  7. package/docs/man/rom-weaver-bundle-create.1 +75 -3
  8. package/docs/man/rom-weaver-bundle-parse.1 +4 -1
  9. package/docs/man/rom-weaver-bundle-schema.1 +4 -1
  10. package/docs/man/rom-weaver-bundle.1 +4 -1
  11. package/docs/man/rom-weaver-checksum.1 +28 -3
  12. package/docs/man/rom-weaver-completions.1 +4 -1
  13. package/docs/man/rom-weaver-compress.1 +58 -1
  14. package/docs/man/rom-weaver-extract.1 +49 -2
  15. package/docs/man/rom-weaver-formats.1 +66 -0
  16. package/docs/man/rom-weaver-identify-database-import-redump.1 +68 -0
  17. package/docs/man/rom-weaver-identify-database-install-all.1 +65 -0
  18. package/docs/man/rom-weaver-identify-database-install-group.1 +71 -0
  19. package/docs/man/rom-weaver-identify-database-install.1 +74 -0
  20. package/docs/man/rom-weaver-identify-database-list.1 +65 -0
  21. package/docs/man/rom-weaver-identify-database-path.1 +65 -0
  22. package/docs/man/rom-weaver-identify-database-remove.1 +68 -0
  23. package/docs/man/rom-weaver-identify-database-status.1 +65 -0
  24. package/docs/man/rom-weaver-identify-database-update.1 +71 -0
  25. package/docs/man/rom-weaver-identify-database.1 +90 -0
  26. package/docs/man/rom-weaver-identify.1 +123 -0
  27. package/docs/man/rom-weaver-patch-apply.1 +128 -68
  28. package/docs/man/rom-weaver-patch-create.1 +9 -3
  29. package/docs/man/rom-weaver-patch-validate.1 +4 -1
  30. package/docs/man/rom-weaver-patch.1 +4 -1
  31. package/docs/man/rom-weaver-probe.1 +4 -1
  32. package/docs/man/rom-weaver-tools-ppf-undo.1 +4 -1
  33. package/docs/man/rom-weaver-tools.1 +4 -1
  34. package/docs/man/rom-weaver-trim.1 +20 -1
  35. package/docs/man/rom-weaver-weave.1 +128 -68
  36. package/docs/man/rom-weaver.1 +11 -5
  37. package/package.json +14 -13
  38. package/docs/man/rom-weaver-ingest.1 +0 -98
@@ -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\-\-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]
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>
8
8
  .SH DESCRIPTION
9
9
  Write a rom\-weaver\-bundle.json recipe from local ROM and patch files.
10
10
  .PP
@@ -43,24 +43,52 @@ patches reads left to right:
43
43
  .TP
44
44
  \fB\-\-patch\-id\fR \fI<PATCH_ID>\fR
45
45
  Identifier for the preceding \-\-patch that stays the same across releases, so a replacement keeps its settings
46
+
47
+ 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.
48
+
49
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
46
50
  .TP
47
51
  \fB\-\-patch\-version\fR \fI<PATCH_VERSION>\fR
48
52
  Version of the preceding \-\-patch, in whatever form its author uses
53
+
54
+ 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.
55
+
56
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
49
57
  .TP
50
58
  \fB\-\-patch\-name\fR \fI<PATCH_NAME>\fR
51
59
  Name to show for the preceding \-\-patch
60
+
61
+ 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.
62
+
63
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
52
64
  .TP
53
65
  \fB\-\-patch\-description\fR \fI<PATCH_DESCRIPTION>\fR
54
66
  What the preceding \-\-patch does
67
+
68
+ 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.
69
+
70
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
55
71
  .TP
56
72
  \fB\-\-patch\-author\fR \fI<PATCH_AUTHOR>\fR
57
73
  Who made the preceding \-\-patch
74
+
75
+ 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.
76
+
77
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
58
78
  .TP
59
79
  \fB\-\-patch\-label\fR \fI<PATCH_LABEL>\fR
60
80
  Short status note for the preceding \-\-patch, such as beta or recommended
81
+
82
+ 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.
83
+
84
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
61
85
  .TP
62
86
  \fB\-\-patch\-optional\fR \fI<PATCH_OPTIONAL>\fR
63
87
  Mark the preceding \-\-patch optional, so it starts switched off and needs \-\-with to run
88
+
89
+ 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.
90
+
91
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
64
92
  .br
65
93
 
66
94
  .br
@@ -74,9 +102,17 @@ false
74
102
  .TP
75
103
  \fB\-\-patch\-source\-url\fR \fI<PATCH_SOURCE_URL>\fR
76
104
  Where the preceding \-\-patch can be downloaded from. The local file is still read to build the bundle
105
+
106
+ 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.
107
+
108
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
77
109
  .TP
78
110
  \fB\-\-patch\-header\fR \fI<PATCH_HEADER>\fR
79
111
  Whether the preceding \-\-patch applies to the ROM with or without its copier header: auto, keep, or strip
112
+
113
+ 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.
114
+
115
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
80
116
  .br
81
117
 
82
118
  .br
@@ -92,6 +128,10 @@ auto
92
128
  .TP
93
129
  \fB\-\-patch\-basis\fR \fI<PATCH_BASIS>\fR
94
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
131
+
132
+ 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
+
134
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
95
135
  .br
96
136
 
97
137
  .br
@@ -107,6 +147,10 @@ previous
107
147
  .TP
108
148
  \fB\-\-patch\-expect\-in\fR \fI<ALGO=HEX>\fR
109
149
  Checksum the ROM should have before the preceding \-\-patch runs. Recorded only when it differs from the bundle\*(Aqs ROM checksums (repeatable, comma\-separable)
150
+
151
+ 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.
152
+
153
+ \-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
110
154
  .TP
111
155
  \fB\-\-patch\-expect\-out\fR \fI<ALGO=HEX>\fR
112
156
  Checksum the ROM should have after the preceding \-\-patch runs. Recorded only when it differs from the final output checksums (repeatable, comma\-separable)
@@ -144,8 +188,30 @@ Pack this file into \-\-bundle as the ROM, while \-\-input supplies the checksum
144
188
  \fB\-\-no\-bundle\-rom\fR
145
189
  Keep the ROM out of \-\-bundle and record only its checksums, so whoever applies the bundle brings their own copy
146
190
  .TP
147
- \fB\-\-checksum\fR \fI<CHECKSUM>\fR
148
- Which checksums to record for the ROM (repeatable) [default: crc32,md5,sha1]
191
+ \fB\-\-checksum\fR \fI<ALGO>\fR
192
+ Which checksums to record for the ROM (repeatable, comma\-separable) [default: crc32,md5,sha1]
193
+ .br
194
+
195
+ .br
196
+ \fIPossible values:\fR
197
+ .RS 14
198
+ .IP \(bu 2
199
+ crc32
200
+ .IP \(bu 2
201
+ md5
202
+ .IP \(bu 2
203
+ sha1
204
+ .IP \(bu 2
205
+ sha256
206
+ .IP \(bu 2
207
+ blake3
208
+ .IP \(bu 2
209
+ crc32c
210
+ .IP \(bu 2
211
+ crc16
212
+ .IP \(bu 2
213
+ adler32
214
+ .RE
149
215
  .TP
150
216
  \fB\-\-from\fR \fI<FILE>\fR
151
217
  Build the bundle from a hand\-written rom\-weaver\-bundle.json instead of flags.
@@ -163,6 +229,9 @@ Record this $schema URL in the bundle so editors can validate it. Left out unles
163
229
  \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
164
230
  How many threads to use at most. auto uses every core; a format may still use fewer
165
231
  .TP
232
+ \fB\-\-force\fR
233
+ Overwrite the output if it already exists (without this, the command stops instead)
234
+ .TP
166
235
  \fB\-h\fR, \fB\-\-help\fR
167
236
  Print help (see a summary with \*(Aq\-h\*(Aq)
168
237
  .SH "GLOBAL OPTIONS"
@@ -211,3 +280,6 @@ Keep colors even when output is piped
211
280
  .TP
212
281
  \fB\-\-no\-color\fR
213
282
  Turn colors off
283
+ .TP
284
+ \fB\-y\fR, \fB\-\-yes\fR
285
+ 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\-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\-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]
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>
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.
@@ -96,3 +96,6 @@ Keep colors even when output is piped
96
96
  .TP
97
97
  \fB\-\-no\-color\fR
98
98
  Turn colors off
99
+ .TP
100
+ \fB\-y\fR, \fB\-\-yes\fR
101
+ 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\-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\-h\fR|\fB\-\-help\fR]
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]
8
8
  .SH DESCRIPTION
9
9
  Print the rom\-weaver\-bundle.json JSON Schema to stdout.
10
10
  .PP
@@ -65,3 +65,6 @@ Keep colors even when output is piped
65
65
  .TP
66
66
  \fB\-\-no\-color\fR
67
67
  Turn colors off
68
+ .TP
69
+ \fB\-y\fR, \fB\-\-yes\fR
70
+ 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\-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\-h\fR|\fB\-\-help\fR] <\fIsubcommands\fR>
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>
8
8
  .SH DESCRIPTION
9
9
  Build and read rom\-weaver\-bundle.json patch recipes
10
10
  .SH OPTIONS
@@ -57,6 +57,9 @@ Keep colors even when output is piped
57
57
  .TP
58
58
  \fB\-\-no\-color\fR
59
59
  Turn colors off
60
+ .TP
61
+ \fB\-y\fR, \fB\-\-yes\fR
62
+ Answer yes to every confirmation instead of asking. Does not choose between candidates
60
63
  .SH SUBCOMMANDS
61
64
  .TP
62
65
  rom\-weaver\-bundle\-create(1)
@@ -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\-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]
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>
8
8
  .SH DESCRIPTION
9
9
  Compute checksums for a file, so you can tell one dump from another.
10
10
  .PP
@@ -20,8 +20,30 @@ match a file that is stored slightly differently.
20
20
  \fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
21
21
  File to hash. Use \- to read from stdin
22
22
  .TP
23
- \fB\-a\fR, \fB\-\-algo\fR \fI<ALGO>\fR
24
- Which checksum to compute: crc32, md5, sha1, sha256, blake3, crc32c, crc16, or adler32 (repeatable, comma\-separable)
23
+ \fB\-a\fR, \fB\-\-algo\fR \fI<ALGO>\fR [default: crc32,md5,sha1]
24
+ Which checksum to compute (repeatable, comma\-separable)
25
+ .br
26
+
27
+ .br
28
+ \fIPossible values:\fR
29
+ .RS 14
30
+ .IP \(bu 2
31
+ crc32
32
+ .IP \(bu 2
33
+ md5
34
+ .IP \(bu 2
35
+ sha1
36
+ .IP \(bu 2
37
+ sha256
38
+ .IP \(bu 2
39
+ blake3
40
+ .IP \(bu 2
41
+ crc32c
42
+ .IP \(bu 2
43
+ crc16
44
+ .IP \(bu 2
45
+ adler32
46
+ .RE
25
47
  .TP
26
48
  \fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
27
49
  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
108
130
  .TP
109
131
  \fB\-\-no\-color\fR
110
132
  Turn colors off
133
+ .TP
134
+ \fB\-y\fR, \fB\-\-yes\fR
135
+ 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\-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\-h\fR|\fB\-\-help\fR] <\fISHELL\fR>
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>
8
8
  .SH DESCRIPTION
9
9
  Print a tab\-completion script for your shell to stdout.
10
10
  .PP
@@ -82,3 +82,6 @@ Keep colors even when output is piped
82
82
  .TP
83
83
  \fB\-\-no\-color\fR
84
84
  Turn colors off
85
+ .TP
86
+ \fB\-y\fR, \fB\-\-yes\fR
87
+ 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\-compress \- Pack files into an archive, disc image, or ROM\-specific compressed format
6
6
  .SH SYNOPSIS
7
- \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]
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>
8
8
  .SH DESCRIPTION
9
9
  Pack files into an archive, disc image, or ROM\-specific compressed format.
10
10
  .PP
@@ -33,6 +33,22 @@ extension, this flag wins and a warning is printed.
33
33
 
34
34
  Common alternate spellings are accepted, so `7zip` works as well as `7z` and
35
35
  `3ds` as well as `z3ds`. The CLI guide lists every alias.
36
+ .br
37
+
38
+ .br
39
+ \fIPossible values:\fR
40
+ .RS 14
41
+ .IP \(bu 2
42
+ zip
43
+ .IP \(bu 2
44
+ 7z
45
+ .IP \(bu 2
46
+ chd
47
+ .IP \(bu 2
48
+ rvz
49
+ .IP \(bu 2
50
+ z3ds
51
+ .RE
36
52
  .TP
37
53
  \fB\-o\fR, \fB\-\-output\fR \fI<PATH>\fR
38
54
  Where to write the archive
@@ -49,6 +65,38 @@ Without :level, a codec follows the \-\-level profile.
49
65
 
50
66
  Only the codec names a format actually supports are accepted; there are no
51
67
  cross\-format synonyms. The CLI guide lists them per format.
68
+ .br
69
+
70
+ .br
71
+ \fIPossible values:\fR
72
+ .RS 14
73
+ .IP \(bu 2
74
+ store
75
+ .IP \(bu 2
76
+ deflate
77
+ .IP \(bu 2
78
+ zstd
79
+ .IP \(bu 2
80
+ lzma
81
+ .IP \(bu 2
82
+ lzma2
83
+ .IP \(bu 2
84
+ zlib
85
+ .IP \(bu 2
86
+ huff
87
+ .IP \(bu 2
88
+ flac
89
+ .IP \(bu 2
90
+ cdzs
91
+ .IP \(bu 2
92
+ cdlz
93
+ .IP \(bu 2
94
+ cdzl
95
+ .IP \(bu 2
96
+ cdfl
97
+ .IP \(bu 2
98
+ avhuff
99
+ .RE
52
100
  .TP
53
101
  \fB\-\-level\fR \fI<LEVEL>\fR [default: max]
54
102
  How hard to compress: min, very\-low, low, medium, high, very\-high, or max
@@ -73,6 +121,12 @@ very\-high
73
121
  max
74
122
  .RE
75
123
  .TP
124
+ \fB\-\-force\fR
125
+ Overwrite the output if it already exists (without this, the command stops instead)
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
76
130
  \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
77
131
  How many threads to use at most. auto uses every core; a format may still use fewer
78
132
  .TP
@@ -124,3 +178,6 @@ Keep colors even when output is piped
124
178
  .TP
125
179
  \fB\-\-no\-color\fR
126
180
  Turn colors off
181
+ .TP
182
+ \fB\-y\fR, \fB\-\-yes\fR
183
+ 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\-extract \- Unpack an archive or single\-payload compressed format
6
6
  .SH SYNOPSIS
7
- \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]
7
+ \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>
8
8
  .SH DESCRIPTION
9
9
  Unpack an archive or single\-payload compressed format into a directory.
10
10
  .PP
@@ -51,9 +51,53 @@ Overwrite files already in the output directory (without this, extraction stops
51
51
  .TP
52
52
  \fB\-\-checksum\fR \fI<ALGO>\fR
53
53
  Also hash every extracted file (repeatable, comma\-separable)
54
+ .br
55
+
56
+ .br
57
+ \fIPossible values:\fR
58
+ .RS 14
59
+ .IP \(bu 2
60
+ crc32
61
+ .IP \(bu 2
62
+ md5
63
+ .IP \(bu 2
64
+ sha1
65
+ .IP \(bu 2
66
+ sha256
67
+ .IP \(bu 2
68
+ blake3
69
+ .IP \(bu 2
70
+ crc32c
71
+ .IP \(bu 2
72
+ crc16
73
+ .IP \(bu 2
74
+ adler32
75
+ .RE
54
76
  .TP
55
77
  \fB\-\-checksum\-rom\fR \fI<ALGO>\fR
56
- Like \-\-checksum, but hash only the ROMs and skip sidecar files. Ignored when \-\-checksum is also given
78
+ Like \-\-checksum, but hash only the ROMs and skip sidecar files. Cannot be combined with \-\-checksum
79
+ .br
80
+
81
+ .br
82
+ \fIPossible values:\fR
83
+ .RS 14
84
+ .IP \(bu 2
85
+ crc32
86
+ .IP \(bu 2
87
+ md5
88
+ .IP \(bu 2
89
+ sha1
90
+ .IP \(bu 2
91
+ sha256
92
+ .IP \(bu 2
93
+ blake3
94
+ .IP \(bu 2
95
+ crc32c
96
+ .IP \(bu 2
97
+ crc16
98
+ .IP \(bu 2
99
+ adler32
100
+ .RE
57
101
  .TP
58
102
  \fB\-\-probe\fR
59
103
  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
109
153
  .TP
110
154
  \fB\-\-no\-color\fR
111
155
  Turn colors off
156
+ .TP
157
+ \fB\-y\fR, \fB\-\-yes\fR
158
+ Answer yes to every confirmation instead of asking. Does not choose between candidates
@@ -0,0 +1,66 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-formats 1 "rom-weaver-formats "
4
+ .SH NAME
5
+ rom\-weaver\-formats \- List the formats, codecs, and checksum algorithms this build supports
6
+ .SH SYNOPSIS
7
+ \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]
8
+ .SH DESCRIPTION
9
+ List what this build supports, read straight from its registries: container
10
+ formats (and whether each can be created, extracted, or both), patch formats,
11
+ the codecs each container format accepts, and the checksum algorithms.
12
+ .PP
13
+ Pass \-\-json for the machine\-readable form.
14
+ .SH OPTIONS
15
+ .TP
16
+ \fB\-h\fR, \fB\-\-help\fR
17
+ Print help (see a summary with \*(Aq\-h\*(Aq)
18
+ .SH "GLOBAL OPTIONS"
19
+ .TP
20
+ \fB\-\-json\fR
21
+ Print one JSON object per line instead of human\-readable output
22
+ .TP
23
+ \fB\-\-progress\fR
24
+ Show progress even when output is piped to a file or another program
25
+ .TP
26
+ \fB\-\-no\-progress\fR
27
+ Hide progress
28
+ .TP
29
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
30
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
31
+ .br
32
+
33
+ .br
34
+ \fIPossible values:\fR
35
+ .RS 14
36
+ .IP \(bu 2
37
+ off
38
+ .IP \(bu 2
39
+ error
40
+ .IP \(bu 2
41
+ warn
42
+ .IP \(bu 2
43
+ info
44
+ .IP \(bu 2
45
+ debug
46
+ .IP \(bu 2
47
+ trace
48
+ .RE
49
+ .TP
50
+ \fB\-v\fR, \fB\-\-verbose\fR
51
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
52
+ .TP
53
+ \fB\-q\fR, \fB\-\-quiet\fR
54
+ Log errors only
55
+ .TP
56
+ \fB\-\-dep\-trace\fR
57
+ Also log trace output from bundled libraries (for bug reports)
58
+ .TP
59
+ \fB\-\-color\fR
60
+ Keep colors even when output is piped
61
+ .TP
62
+ \fB\-\-no\-color\fR
63
+ Turn colors off
64
+ .TP
65
+ \fB\-y\fR, \fB\-\-yes\fR
66
+ Answer yes to every confirmation instead of asking. Does not choose between candidates
@@ -0,0 +1,68 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-identify-database-import-redump 1 "rom-weaver-identify-database-import-redump "
4
+ .SH NAME
5
+ rom\-weaver\-identify\-database\-import\-redump \- Build identify packs from local Redump DAT ZIP files
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver identify database import\-redump\fR [\fB\-\-database\-dir\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] <\fIZIP\fR>
8
+ .SH DESCRIPTION
9
+ Build identify packs from local Redump DAT ZIP files
10
+ .SH OPTIONS
11
+ .TP
12
+ \fB\-\-database\-dir\fR \fI<DIR>\fR
13
+ Identify database directory. Defaults to the per\-user data directory
14
+ .TP
15
+ \fB\-h\fR, \fB\-\-help\fR
16
+ Print help
17
+ .TP
18
+ <\fIZIP\fR>
19
+ Local Redump DAT ZIP file to import
20
+ .SH "GLOBAL OPTIONS"
21
+ .TP
22
+ \fB\-\-json\fR
23
+ Print one JSON object per line instead of human\-readable output
24
+ .TP
25
+ \fB\-\-progress\fR
26
+ Show progress even when output is piped to a file or another program
27
+ .TP
28
+ \fB\-\-no\-progress\fR
29
+ Hide progress
30
+ .TP
31
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
32
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
33
+ .br
34
+
35
+ .br
36
+ \fIPossible values:\fR
37
+ .RS 14
38
+ .IP \(bu 2
39
+ off
40
+ .IP \(bu 2
41
+ error
42
+ .IP \(bu 2
43
+ warn
44
+ .IP \(bu 2
45
+ info
46
+ .IP \(bu 2
47
+ debug
48
+ .IP \(bu 2
49
+ trace
50
+ .RE
51
+ .TP
52
+ \fB\-v\fR, \fB\-\-verbose\fR
53
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
54
+ .TP
55
+ \fB\-q\fR, \fB\-\-quiet\fR
56
+ Log errors only
57
+ .TP
58
+ \fB\-\-dep\-trace\fR
59
+ Also log trace output from bundled libraries (for bug reports)
60
+ .TP
61
+ \fB\-\-color\fR
62
+ Keep colors even when output is piped
63
+ .TP
64
+ \fB\-\-no\-color\fR
65
+ Turn colors off
66
+ .TP
67
+ \fB\-y\fR, \fB\-\-yes\fR
68
+ Answer yes to every confirmation instead of asking. Does not choose between candidates
@@ -0,0 +1,65 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-identify-database-install-all 1 "rom-weaver-identify-database-install-all "
4
+ .SH NAME
5
+ rom\-weaver\-identify\-database\-install\-all \- Install the full identify database for this rom\-weaver version
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver identify database install\-all\fR [\fB\-\-database\-dir\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]
8
+ .SH DESCRIPTION
9
+ Install the full identify database for this rom\-weaver version
10
+ .SH OPTIONS
11
+ .TP
12
+ \fB\-\-database\-dir\fR \fI<DIR>\fR
13
+ Identify database directory. Defaults to the per\-user data directory
14
+ .TP
15
+ \fB\-h\fR, \fB\-\-help\fR
16
+ Print help
17
+ .SH "GLOBAL OPTIONS"
18
+ .TP
19
+ \fB\-\-json\fR
20
+ Print one JSON object per line instead of human\-readable output
21
+ .TP
22
+ \fB\-\-progress\fR
23
+ Show progress even when output is piped to a file or another program
24
+ .TP
25
+ \fB\-\-no\-progress\fR
26
+ Hide progress
27
+ .TP
28
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
29
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
30
+ .br
31
+
32
+ .br
33
+ \fIPossible values:\fR
34
+ .RS 14
35
+ .IP \(bu 2
36
+ off
37
+ .IP \(bu 2
38
+ error
39
+ .IP \(bu 2
40
+ warn
41
+ .IP \(bu 2
42
+ info
43
+ .IP \(bu 2
44
+ debug
45
+ .IP \(bu 2
46
+ trace
47
+ .RE
48
+ .TP
49
+ \fB\-v\fR, \fB\-\-verbose\fR
50
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
51
+ .TP
52
+ \fB\-q\fR, \fB\-\-quiet\fR
53
+ Log errors only
54
+ .TP
55
+ \fB\-\-dep\-trace\fR
56
+ Also log trace output from bundled libraries (for bug reports)
57
+ .TP
58
+ \fB\-\-color\fR
59
+ Keep colors even when output is piped
60
+ .TP
61
+ \fB\-\-no\-color\fR
62
+ Turn colors off
63
+ .TP
64
+ \fB\-y\fR, \fB\-\-yes\fR
65
+ Answer yes to every confirmation instead of asking. Does not choose between candidates