rom-weaver 0.20.1 → 0.22.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.
- package/docs/man/rom-weaver-bundle-create.1 +34 -28
- package/docs/man/rom-weaver-bundle-parse.1 +13 -11
- package/docs/man/rom-weaver-bundle-schema.1 +10 -8
- package/docs/man/rom-weaver-bundle.1 +12 -10
- package/docs/man/rom-weaver-cheat.1 +4 -2
- package/docs/man/rom-weaver-checksum.1 +3 -1
- package/docs/man/rom-weaver-completions.1 +3 -1
- package/docs/man/rom-weaver-compress.1 +4 -2
- package/docs/man/rom-weaver-extract.1 +5 -3
- package/docs/man/rom-weaver-formats.1 +3 -1
- package/docs/man/rom-weaver-identify-database-import-redump.1 +3 -1
- package/docs/man/rom-weaver-identify-database-install-all.1 +3 -1
- package/docs/man/rom-weaver-identify-database-install-group.1 +3 -1
- package/docs/man/rom-weaver-identify-database-install.1 +3 -1
- package/docs/man/rom-weaver-identify-database-list.1 +3 -1
- package/docs/man/rom-weaver-identify-database-path.1 +3 -1
- package/docs/man/rom-weaver-identify-database-remove.1 +3 -1
- package/docs/man/rom-weaver-identify-database-status.1 +3 -1
- package/docs/man/rom-weaver-identify-database-update.1 +3 -1
- package/docs/man/rom-weaver-identify-database.1 +3 -1
- package/docs/man/rom-weaver-identify.1 +4 -2
- package/docs/man/rom-weaver-man.1 +3 -1
- package/docs/man/rom-weaver-patch-apply.1 +19 -17
- package/docs/man/rom-weaver-patch-create.1 +8 -3
- package/docs/man/rom-weaver-patch-validate.1 +4 -2
- package/docs/man/rom-weaver-patch.1 +3 -1
- package/docs/man/rom-weaver-probe.1 +3 -1
- package/docs/man/rom-weaver-save-create.1 +3 -1
- package/docs/man/rom-weaver-save-export-schema.1 +3 -1
- package/docs/man/rom-weaver-save-get.1 +3 -1
- package/docs/man/rom-weaver-save-identify.1 +3 -1
- package/docs/man/rom-weaver-save-inspect.1 +3 -1
- package/docs/man/rom-weaver-save-list-games.1 +3 -1
- package/docs/man/rom-weaver-save-set.1 +3 -1
- package/docs/man/rom-weaver-save.1 +3 -1
- package/docs/man/rom-weaver-setup.1 +4 -2
- package/docs/man/rom-weaver-tools-ppf-undo.1 +3 -1
- package/docs/man/rom-weaver-tools.1 +3 -1
- package/docs/man/rom-weaver-trim.1 +4 -2
- package/docs/man/rom-weaver-weave-create.1 +338 -0
- package/docs/man/rom-weaver-weave-parse.1 +112 -0
- package/docs/man/rom-weaver-weave-schema.1 +81 -0
- package/docs/man/rom-weaver-weave.1 +17 -403
- package/docs/man/rom-weaver.1 +4 -7
- package/package.json +6 -3
|
@@ -1,41 +1,41 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-
|
|
3
|
+
.TH rom-weaver-weave-create 1 "rom-weaver-weave-create 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
|
-
rom\-weaver\-
|
|
5
|
+
rom\-weaver\-weave\-create \- Write a rom\-weaver\-weave.json recipe from local ROM and patch files
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBrom\-weaver
|
|
7
|
+
\fBrom\-weaver weave 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\-input\-check\fR] [\fB\-\-patch\-output\-check\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\-\-weave\fR] [\fB\-\-weave\-rom\fR] [\fB\-\-no\-weave\-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
|
-
Write a rom\-weaver\-
|
|
9
|
+
Write a rom\-weaver\-weave.json recipe from local ROM and patch files.
|
|
10
10
|
.PP
|
|
11
|
-
A
|
|
11
|
+
A weave records which ROM the patches are for, what order they run in, and
|
|
12
12
|
what the result should hash to. Hand it to someone else and
|
|
13
|
-
`rom\-weaver patch apply \-\-
|
|
13
|
+
`rom\-weaver patch apply \-\-weave` reproduces your exact result.
|
|
14
14
|
.PP
|
|
15
15
|
Checksums come from the real files, so nothing here is taken on faith. Every
|
|
16
16
|
\-\-patch\-* flag describes the \-\-patch before it.
|
|
17
17
|
.PP
|
|
18
|
-
\-\-output names the recipe itself; add .gz or .zst to compress it. \-\-
|
|
18
|
+
\-\-output names the recipe itself; add .gz or .zst to compress it. \-\-weave
|
|
19
19
|
additionally packs the recipe and its files into one shareable archive.
|
|
20
20
|
.SH OPTIONS
|
|
21
21
|
.TP
|
|
22
22
|
\fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
|
|
23
|
-
ROM the patches apply to. Its checksums and size are read from the file and recorded in the
|
|
23
|
+
ROM the patches apply to. Its checksums and size are read from the file and recorded in the weave
|
|
24
24
|
.TP
|
|
25
25
|
\fB\-\-assume\-in\fR \fI<ALGO=HEX>\fR
|
|
26
26
|
Take the ROM\*(Aqs checksum and size on trust rather than reading it, as in crc32=1234abcd,size=1048576 (repeatable, comma\-separable)
|
|
27
27
|
.TP
|
|
28
28
|
\fB\-\-rom\-url\fR \fI<ROM_URL>\fR
|
|
29
|
-
Where the ROM can be downloaded from. With \-\-input, the local file still supplies the checksums; on its own, the
|
|
29
|
+
Where the ROM can be downloaded from. With \-\-input, the local file still supplies the checksums; on its own, the weave records only this url
|
|
30
30
|
.TP
|
|
31
31
|
\fB\-\-rom\-name\fR \fI<ROM_NAME>\fR
|
|
32
32
|
Expected source ROM file name to show and use for output naming; a mismatch is advisory
|
|
33
33
|
.TP
|
|
34
34
|
\fB\-\-rom\-member\fR \fI<ROM_MEMBER>\fR
|
|
35
|
-
Use this exact archive member or disc track as the
|
|
35
|
+
Use this exact archive member or disc track as the weave ROM target
|
|
36
36
|
.TP
|
|
37
37
|
\fB\-\-patch\fR \fI<PATCH>\fR
|
|
38
|
-
Patch to list in the
|
|
38
|
+
Patch to list in the weave. Repeat once per patch, in the order they should be
|
|
39
39
|
applied.
|
|
40
40
|
|
|
41
41
|
Every \-\-patch\-* flag describes the \-\-patch before it, so metadata for several
|
|
@@ -104,7 +104,7 @@ false
|
|
|
104
104
|
.RE
|
|
105
105
|
.TP
|
|
106
106
|
\fB\-\-patch\-source\-url\fR \fI<PATCH_SOURCE_URL>\fR
|
|
107
|
-
Where the preceding \-\-patch can be downloaded from. The local file is still read to build the
|
|
107
|
+
Where the preceding \-\-patch can be downloaded from. The local file is still read to build the weave
|
|
108
108
|
|
|
109
109
|
This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
|
|
110
110
|
|
|
@@ -130,7 +130,7 @@ auto
|
|
|
130
130
|
.RE
|
|
131
131
|
.TP
|
|
132
132
|
\fB\-\-patch\-basis\fR \fI<PATCH_BASIS>\fR
|
|
133
|
-
Override the preceding \-\-patch input rule: base (the
|
|
133
|
+
Override the preceding \-\-patch input rule: base (the weave\*(Aqs ROM) or previous (the patch before it). Use auto to inherit the weave rule
|
|
134
134
|
|
|
135
135
|
This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
|
|
136
136
|
|
|
@@ -167,21 +167,25 @@ base
|
|
|
167
167
|
previous
|
|
168
168
|
.RE
|
|
169
169
|
.TP
|
|
170
|
-
\fB\-\-patch\-
|
|
171
|
-
Checksum the ROM should have before the preceding \-\-patch runs. Recorded only when it differs from the
|
|
170
|
+
\fB\-\-patch\-input\-check\fR \fI<ALGO=HEX>\fR
|
|
171
|
+
Checksum the ROM should have before the preceding \-\-patch runs. Recorded only when it differs from the weave\*(Aqs ROM checksums (repeatable, comma\-separable)
|
|
172
172
|
|
|
173
173
|
This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
|
|
174
174
|
|
|
175
175
|
\-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
|
|
176
176
|
.TP
|
|
177
|
-
\fB\-\-patch\-
|
|
177
|
+
\fB\-\-patch\-output\-check\fR \fI<ALGO=HEX>\fR
|
|
178
178
|
Checksum the ROM should have after the preceding \-\-patch runs. Recorded only when it differs from the final output checksums (repeatable, comma\-separable)
|
|
179
|
+
|
|
180
|
+
This flag describes the most recent preceding \-\-patch. Before the first \-\-patch, it describes that first patch. You may leave metadata out for any patch.
|
|
181
|
+
|
|
182
|
+
\-\-patch a.bps \-\-patch\-name "First" \-\-patch b.ups \-\-patch\-name "Second"
|
|
179
183
|
.TP
|
|
180
184
|
\fB\-\-expect\-out\fR \fI<ALGO=HEX>\fR
|
|
181
185
|
Checksum the ROM should have once every patch has run, so users can confirm they got the right result (repeatable, comma\-separable)
|
|
182
186
|
.TP
|
|
183
187
|
\fB\-\-output\-name\fR \fI<OUTPUT_NAME>\fR
|
|
184
|
-
File name the
|
|
188
|
+
File name the weave suggests for the patched ROM
|
|
185
189
|
.TP
|
|
186
190
|
\fB\-\-output\-header\fR \fI<OUTPUT_HEADER>\fR
|
|
187
191
|
Whether the patched ROM should keep its copier header: auto, keep, or strip
|
|
@@ -199,16 +203,16 @@ auto
|
|
|
199
203
|
.RE
|
|
200
204
|
.TP
|
|
201
205
|
\fB\-o\fR, \fB\-\-output\fR \fI<OUTPUT>\fR
|
|
202
|
-
Where to write the
|
|
206
|
+
Where to write the weave. Name it rom\-weaver\-weave.json, or add .gz or .zst to compress it
|
|
203
207
|
.TP
|
|
204
|
-
\fB\-\-
|
|
205
|
-
Also pack the
|
|
208
|
+
\fB\-\-weave\fR \fI<BUNDLE>\fR
|
|
209
|
+
Also pack the weave and its ROM and patches into one shareable archive, such as release.zip
|
|
206
210
|
.TP
|
|
207
|
-
\fB\-\-
|
|
208
|
-
Pack this file into \-\-
|
|
211
|
+
\fB\-\-weave\-rom\fR \fI<BUNDLE_ROM>\fR
|
|
212
|
+
Pack this file into \-\-weave as the ROM, while \-\-input supplies the checksums and metadata
|
|
209
213
|
.TP
|
|
210
|
-
\fB\-\-no\-
|
|
211
|
-
Keep the ROM out of \-\-
|
|
214
|
+
\fB\-\-no\-weave\-rom\fR
|
|
215
|
+
Keep the ROM out of \-\-weave and record only its checksums, so whoever applies the weave brings their own copy
|
|
212
216
|
.TP
|
|
213
217
|
\fB\-\-checksum\fR \fI<ALGO>\fR
|
|
214
218
|
Which checksums to record for the ROM (repeatable, comma\-separable) [default: crc32,md5,sha1]
|
|
@@ -236,17 +240,17 @@ adler32
|
|
|
236
240
|
.RE
|
|
237
241
|
.TP
|
|
238
242
|
\fB\-\-from\fR \fI<FILE>\fR
|
|
239
|
-
Build the
|
|
243
|
+
Build the weave from a hand\-written rom\-weaver\-weave.json instead of flags.
|
|
240
244
|
Use \- to read it from stdin.
|
|
241
245
|
|
|
242
246
|
Write the file with local paths and leave the checksums out; they are filled in
|
|
243
|
-
from the real files. Get the schema with `rom\-weaver
|
|
247
|
+
from the real files. Get the schema with `rom\-weaver weave schema` so your
|
|
244
248
|
editor can check the file as you write it.
|
|
245
249
|
|
|
246
250
|
Any flag you also pass overrides what the file says.
|
|
247
251
|
.TP
|
|
248
252
|
\fB\-\-schema\-ref\fR \fI<URL>\fR
|
|
249
|
-
Record this $schema URL in the
|
|
253
|
+
Record this $schema URL in the weave so editors can validate it. Left out unless asked for
|
|
250
254
|
.TP
|
|
251
255
|
\fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
|
|
252
256
|
How many threads to use at most. auto uses every core; a format may still use fewer
|
|
@@ -265,7 +269,7 @@ Database cheat to use, by record ID or exact description. Repeat for each cheat
|
|
|
265
269
|
Directory holding the cheat shards and optional manifest.json. Defaults to $ROM_WEAVER_CHEAT_DATABASE, then matching shards in per\-user and packaged data trees
|
|
266
270
|
.TP
|
|
267
271
|
\fB\-\-cheat\-system\fR \fI<SYS>\fR
|
|
268
|
-
Console the
|
|
272
|
+
Console the cheats are for (nes, snes, genesis, 32x, sms, gamegear, sg1000, gameboy, gameboy\-color, gba, psx), when the ROM header does not say
|
|
269
273
|
.TP
|
|
270
274
|
\fB\-\-game\fR \fI<ID>\fR
|
|
271
275
|
Use this database game ID instead of matching the ROM by checksum or title
|
|
@@ -330,3 +334,5 @@ Turn colors off
|
|
|
330
334
|
.TP
|
|
331
335
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
332
336
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
337
|
+
.SH VERSION
|
|
338
|
+
v0.22.0
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-
|
|
3
|
+
.TH rom-weaver-weave-parse 1 "rom-weaver-weave-parse 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
|
-
rom\-weaver\-
|
|
5
|
+
rom\-weaver\-weave\-parse \- Read a rom\-weaver\-weave.json recipe and report what it points at
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBrom\-weaver
|
|
7
|
+
\fBrom\-weaver weave 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
|
-
Read a rom\-weaver\-
|
|
9
|
+
Read a rom\-weaver\-weave.json recipe, check that it is valid, and report the
|
|
10
10
|
ROM and patches it points at.
|
|
11
11
|
.PP
|
|
12
|
-
The input can be a plain rom\-weaver\-
|
|
12
|
+
The input can be a plain rom\-weaver\-weave.json, a compressed one (.gz, .bz2,
|
|
13
13
|
\&.xz, or .zst), or an archive with the recipe at its root alongside the files it
|
|
14
14
|
names.
|
|
15
15
|
.PP
|
|
@@ -17,17 +17,17 @@ Entries that name a file are looked for in the archive, or next to the recipe.
|
|
|
17
17
|
Pass \-\-output to write those files out and get real paths back. Entries that
|
|
18
18
|
name a url are reported as they are; nothing is downloaded.
|
|
19
19
|
.PP
|
|
20
|
-
To actually run a
|
|
20
|
+
To actually run a weave, use `rom\-weaver patch apply \-\-weave` instead.
|
|
21
21
|
.SH OPTIONS
|
|
22
22
|
.TP
|
|
23
23
|
\fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
|
|
24
|
-
|
|
24
|
+
Weave file, or an archive with a weave at its root
|
|
25
25
|
.TP
|
|
26
26
|
\fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
|
|
27
|
-
Handle only the
|
|
27
|
+
Handle only the weave entries whose file name matches this exact name, prefix, or glob (repeatable)
|
|
28
28
|
.TP
|
|
29
29
|
\fB\-\-filter\fR \fI<FILTER>\fR
|
|
30
|
-
Handle only the
|
|
30
|
+
Handle only the weave\*(Aqs rom entry or only its patch entries (repeatable, comma\-separable)
|
|
31
31
|
.br
|
|
32
32
|
|
|
33
33
|
.br
|
|
@@ -40,10 +40,10 @@ patch
|
|
|
40
40
|
.RE
|
|
41
41
|
.TP
|
|
42
42
|
\fB\-\-no\-extract\fR
|
|
43
|
-
Report what the
|
|
43
|
+
Report what the weave contains without unpacking any of it
|
|
44
44
|
.TP
|
|
45
45
|
\fB\-o\fR, \fB\-\-output\fR \fI<DIR>\fR
|
|
46
|
-
Directory to unpack the
|
|
46
|
+
Directory to unpack the weave\*(Aqs files into. Without it, files packed in an archive are listed but not written out
|
|
47
47
|
.TP
|
|
48
48
|
\fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
|
|
49
49
|
How many threads to use at most. auto uses every core; a format may still use fewer
|
|
@@ -108,3 +108,5 @@ Turn colors off
|
|
|
108
108
|
.TP
|
|
109
109
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
110
110
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
111
|
+
.SH VERSION
|
|
112
|
+
v0.22.0
|
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-
|
|
3
|
+
.TH rom-weaver-weave-schema 1 "rom-weaver-weave-schema 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
|
-
rom\-weaver\-
|
|
5
|
+
rom\-weaver\-weave\-schema \- Print the rom\-weaver\-weave.json JSON Schema, for editors and hand\-authoring
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBrom\-weaver
|
|
7
|
+
\fBrom\-weaver weave 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
|
-
Print the rom\-weaver\-
|
|
9
|
+
Print the rom\-weaver\-weave.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
|
-
a
|
|
12
|
+
a weave as you write it:
|
|
13
13
|
.PP
|
|
14
|
-
rom\-weaver
|
|
14
|
+
rom\-weaver weave schema > rom\-weaver\-weave\-v2.schema.json
|
|
15
15
|
.PP
|
|
16
|
-
Then `
|
|
17
|
-
|
|
16
|
+
Then `weave create \-\-from <your file>` turns what you wrote into a finished
|
|
17
|
+
weave with the checksums filled in.
|
|
18
18
|
.SH OPTIONS
|
|
19
19
|
.TP
|
|
20
20
|
\fB\-h\fR, \fB\-\-help\fR
|
|
@@ -77,3 +77,5 @@ Turn colors off
|
|
|
77
77
|
.TP
|
|
78
78
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
79
79
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
80
|
+
.SH VERSION
|
|
81
|
+
v0.22.0
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-
|
|
3
|
+
.TH rom-weaver-weave 1 "rom-weaver-weave 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
|
-
rom\-weaver\-
|
|
5
|
+
rom\-weaver\-weave \- Build and read rom\-weaver\-weave.json patch recipes
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBrom\-weaver
|
|
7
|
+
\fBrom\-weaver weave\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
|
-
Build and read rom\-weaver\-
|
|
9
|
+
Build and read rom\-weaver\-weave.json patch recipes
|
|
10
10
|
.SH OPTIONS
|
|
11
11
|
.TP
|
|
12
12
|
\fB\-h\fR, \fB\-\-help\fR
|
|
@@ -71,11 +71,13 @@ Turn colors off
|
|
|
71
71
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
72
72
|
.SH SUBCOMMANDS
|
|
73
73
|
.TP
|
|
74
|
-
rom\-weaver\-
|
|
75
|
-
Write a rom\-weaver\-
|
|
74
|
+
rom\-weaver\-weave\-create(1)
|
|
75
|
+
Write a rom\-weaver\-weave.json recipe from local ROM and patch files
|
|
76
76
|
.TP
|
|
77
|
-
rom\-weaver\-
|
|
78
|
-
Read a rom\-weaver\-
|
|
77
|
+
rom\-weaver\-weave\-parse(1)
|
|
78
|
+
Read a rom\-weaver\-weave.json recipe and report what it points at
|
|
79
79
|
.TP
|
|
80
|
-
rom\-weaver\-
|
|
81
|
-
Print the rom\-weaver\-
|
|
80
|
+
rom\-weaver\-weave\-schema(1)
|
|
81
|
+
Print the rom\-weaver\-weave.json JSON Schema, for editors and hand\-authoring
|
|
82
|
+
.SH VERSION
|
|
83
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-cheat 1 "rom-weaver-cheat "
|
|
3
|
+
.TH rom-weaver-cheat 1 "rom-weaver-cheat 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-cheat \- List the cheat database\*(Aqs entries for a ROM
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -40,7 +40,7 @@ Database cheat to use, by record ID or exact description. Repeat for each cheat
|
|
|
40
40
|
Directory holding the cheat shards and optional manifest.json. Defaults to $ROM_WEAVER_CHEAT_DATABASE, then matching shards in per\-user and packaged data trees
|
|
41
41
|
.TP
|
|
42
42
|
\fB\-\-cheat\-system\fR \fI<SYS>\fR
|
|
43
|
-
Console the
|
|
43
|
+
Console the cheats are for (nes, snes, genesis, 32x, sms, gamegear, sg1000, gameboy, gameboy\-color, gba, psx), when the ROM header does not say
|
|
44
44
|
.TP
|
|
45
45
|
\fB\-\-game\fR \fI<ID>\fR
|
|
46
46
|
Use this database game ID instead of matching the ROM by checksum or title
|
|
@@ -105,3 +105,5 @@ Turn colors off
|
|
|
105
105
|
.TP
|
|
106
106
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
107
107
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
108
|
+
.SH VERSION
|
|
109
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-checksum 1 "rom-weaver-checksum "
|
|
3
|
+
.TH rom-weaver-checksum 1 "rom-weaver-checksum 0.22.0"
|
|
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
|
|
@@ -148,3 +148,5 @@ Turn colors off
|
|
|
148
148
|
.TP
|
|
149
149
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
150
150
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
151
|
+
.SH VERSION
|
|
152
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-completions 1 "rom-weaver-completions "
|
|
3
|
+
.TH rom-weaver-completions 1 "rom-weaver-completions 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-completions \- Print a tab\-completion script for your shell
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -94,3 +94,5 @@ Turn colors off
|
|
|
94
94
|
.TP
|
|
95
95
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
96
96
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
97
|
+
.SH VERSION
|
|
98
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-compress 1 "rom-weaver-compress "
|
|
3
|
+
.TH rom-weaver-compress 1 "rom-weaver-compress 0.22.0"
|
|
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
|
|
@@ -51,7 +51,7 @@ z3ds
|
|
|
51
51
|
.RE
|
|
52
52
|
.TP
|
|
53
53
|
\fB\-o\fR, \fB\-\-output\fR \fI<PATH>\fR
|
|
54
|
-
Output path; \- writes
|
|
54
|
+
Output path; \- writes the result to stdout (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.
|
|
@@ -193,3 +193,5 @@ Turn colors off
|
|
|
193
193
|
.TP
|
|
194
194
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
195
195
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
196
|
+
.SH VERSION
|
|
197
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-extract 1 "rom-weaver-extract "
|
|
3
|
+
.TH rom-weaver-extract 1 "rom-weaver-extract 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-extract \- Unpack an archive or single\-payload compressed format
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -35,10 +35,10 @@ patch
|
|
|
35
35
|
.RE
|
|
36
36
|
.TP
|
|
37
37
|
\fB\-o\fR, \fB\-\-output\fR \fI<DIR>\fR
|
|
38
|
-
Output
|
|
38
|
+
Output directory; \- writes the one extracted file to stdout
|
|
39
39
|
.TP
|
|
40
40
|
\fB\-\-split\-bin\fR
|
|
41
|
-
Write a CD\-format CHD as a CUE plus one
|
|
41
|
+
Write a CD\-format CHD as a CUE plus one Redump\-style `<name> (Track N).bin` per track, rather than one merged BIN
|
|
42
42
|
.TP
|
|
43
43
|
\fB\-\-no\-ignore\fR
|
|
44
44
|
Also consider files normally skipped inside archives: readmes, images, checksum sidecars, and OS clutter such as .DS_Store
|
|
@@ -171,3 +171,5 @@ Turn colors off
|
|
|
171
171
|
.TP
|
|
172
172
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
173
173
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
174
|
+
.SH VERSION
|
|
175
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-formats 1 "rom-weaver-formats "
|
|
3
|
+
.TH rom-weaver-formats 1 "rom-weaver-formats 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-formats \- List the formats, codecs, and checksum algorithms this build supports
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -73,3 +73,5 @@ Turn colors off
|
|
|
73
73
|
.TP
|
|
74
74
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
75
75
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
76
|
+
.SH VERSION
|
|
77
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-identify-database-import-redump 1 "rom-weaver-identify-database-import-redump "
|
|
3
|
+
.TH rom-weaver-identify-database-import-redump 1 "rom-weaver-identify-database-import-redump 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-identify\-database\-import\-redump \- Build identify packs from local Redump DAT ZIP files
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -75,3 +75,5 @@ Turn colors off
|
|
|
75
75
|
.TP
|
|
76
76
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
77
77
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
78
|
+
.SH VERSION
|
|
79
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-identify-database-install-all 1 "rom-weaver-identify-database-install-all "
|
|
3
|
+
.TH rom-weaver-identify-database-install-all 1 "rom-weaver-identify-database-install-all 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-identify\-database\-install\-all \- Install the full identify database for this rom\-weaver version
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -72,3 +72,5 @@ Turn colors off
|
|
|
72
72
|
.TP
|
|
73
73
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
74
74
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
75
|
+
.SH VERSION
|
|
76
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-identify-database-install-group 1 "rom-weaver-identify-database-install-group "
|
|
3
|
+
.TH rom-weaver-identify-database-install-group 1 "rom-weaver-identify-database-install-group 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-identify\-database\-install\-group \- Download and install one optional identify pack group
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -78,3 +78,5 @@ Turn colors off
|
|
|
78
78
|
.TP
|
|
79
79
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
80
80
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
81
|
+
.SH VERSION
|
|
82
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-identify-database-install 1 "rom-weaver-identify-database-install "
|
|
3
|
+
.TH rom-weaver-identify-database-install 1 "rom-weaver-identify-database-install 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-identify\-database\-install \- Download and install one Redump system pack (or \-\-all)
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -81,3 +81,5 @@ Turn colors off
|
|
|
81
81
|
.TP
|
|
82
82
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
83
83
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
84
|
+
.SH VERSION
|
|
85
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-identify-database-list 1 "rom-weaver-identify-database-list "
|
|
3
|
+
.TH rom-weaver-identify-database-list 1 "rom-weaver-identify-database-list 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-identify\-database\-list \- List every catalog platform, its source, and whether its pack is installed
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -72,3 +72,5 @@ Turn colors off
|
|
|
72
72
|
.TP
|
|
73
73
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
74
74
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
75
|
+
.SH VERSION
|
|
76
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-identify-database-path 1 "rom-weaver-identify-database-path "
|
|
3
|
+
.TH rom-weaver-identify-database-path 1 "rom-weaver-identify-database-path 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-identify\-database\-path \- Print the identify database directory
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -72,3 +72,5 @@ Turn colors off
|
|
|
72
72
|
.TP
|
|
73
73
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
74
74
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
75
|
+
.SH VERSION
|
|
76
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-identify-database-remove 1 "rom-weaver-identify-database-remove "
|
|
3
|
+
.TH rom-weaver-identify-database-remove 1 "rom-weaver-identify-database-remove 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-identify\-database\-remove \- Remove one system\*(Aqs installed pack
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -75,3 +75,5 @@ Turn colors off
|
|
|
75
75
|
.TP
|
|
76
76
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
77
77
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
78
|
+
.SH VERSION
|
|
79
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-identify-database-status 1 "rom-weaver-identify-database-status "
|
|
3
|
+
.TH rom-weaver-identify-database-status 1 "rom-weaver-identify-database-status 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-identify\-database\-status \- List the installed pack files: slug, format, size, and sha256
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -72,3 +72,5 @@ Turn colors off
|
|
|
72
72
|
.TP
|
|
73
73
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
74
74
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
75
|
+
.SH VERSION
|
|
76
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-identify-database-update 1 "rom-weaver-identify-database-update "
|
|
3
|
+
.TH rom-weaver-identify-database-update 1 "rom-weaver-identify-database-update 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-identify\-database\-update \- Download and update installed Redump system packs
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -78,3 +78,5 @@ Turn colors off
|
|
|
78
78
|
.TP
|
|
79
79
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
80
80
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
81
|
+
.SH VERSION
|
|
82
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-identify-database 1 "rom-weaver-identify-database "
|
|
3
|
+
.TH rom-weaver-identify-database 1 "rom-weaver-identify-database 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-identify\-database \- Manage the installed identify database packs
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -97,3 +97,5 @@ Download and install one Redump system pack (or \-\-all)
|
|
|
97
97
|
.TP
|
|
98
98
|
rom\-weaver\-identify\-database\-update(1)
|
|
99
99
|
Download and update installed Redump system packs
|
|
100
|
+
.SH VERSION
|
|
101
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-identify 1 "rom-weaver-identify "
|
|
3
|
+
.TH rom-weaver-identify 1 "rom-weaver-identify 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-identify \- Identify a ROM title from its checksums
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -18,7 +18,7 @@ detected platform pick the pack. Nothing is uploaded.
|
|
|
18
18
|
ROM to identify. Use \- to read from stdin
|
|
19
19
|
.TP
|
|
20
20
|
\fB\-\-hash\fR \fI<HEX>\fR
|
|
21
|
-
Identify by a checksum instead of a file; accepts crc32/md5/sha1 hex (repeatable, one per algorithm)
|
|
21
|
+
Identify by a checksum instead of a file; accepts crc32/md5/sha1/sha256 hex (repeatable, one per algorithm)
|
|
22
22
|
.TP
|
|
23
23
|
\fB\-\-size\fR \fI<BYTES>\fR
|
|
24
24
|
Exact byte size to pair with \-\-hash, narrowing the lookup to records of that size
|
|
@@ -142,3 +142,5 @@ Answer yes to every confirmation instead of asking. Does not choose between cand
|
|
|
142
142
|
.TP
|
|
143
143
|
rom\-weaver\-identify\-database(1)
|
|
144
144
|
Manage the installed identify database packs
|
|
145
|
+
.SH VERSION
|
|
146
|
+
v0.22.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH rom-weaver-man 1 "rom-weaver-man "
|
|
3
|
+
.TH rom-weaver-man 1 "rom-weaver-man 0.22.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
rom\-weaver\-man \- Print or install the generated CLI man pages
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -85,3 +85,5 @@ Turn colors off
|
|
|
85
85
|
.TP
|
|
86
86
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
87
87
|
Answer yes to every confirmation instead of asking. Does not choose between candidates
|
|
88
|
+
.SH VERSION
|
|
89
|
+
v0.22.0
|