rom-weaver 0.14.1 → 0.15.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 (33) hide show
  1. package/docs/man/rom-weaver-bundle-create.1 +285 -0
  2. package/docs/man/rom-weaver-bundle-parse.1 +101 -0
  3. package/docs/man/rom-weaver-bundle-schema.1 +70 -0
  4. package/docs/man/rom-weaver-bundle.1 +72 -0
  5. package/docs/man/rom-weaver-checksum.1 +135 -0
  6. package/docs/man/rom-weaver-completions.1 +87 -0
  7. package/docs/man/rom-weaver-compress.1 +183 -0
  8. package/docs/man/rom-weaver-extract.1 +158 -0
  9. package/docs/man/rom-weaver-formats.1 +66 -0
  10. package/docs/man/rom-weaver-identify-database-import-redump.1 +68 -0
  11. package/docs/man/rom-weaver-identify-database-install-all.1 +65 -0
  12. package/docs/man/rom-weaver-identify-database-install-group.1 +71 -0
  13. package/docs/man/rom-weaver-identify-database-install.1 +74 -0
  14. package/docs/man/rom-weaver-identify-database-list.1 +65 -0
  15. package/docs/man/rom-weaver-identify-database-path.1 +65 -0
  16. package/docs/man/rom-weaver-identify-database-remove.1 +68 -0
  17. package/docs/man/rom-weaver-identify-database-status.1 +65 -0
  18. package/docs/man/rom-weaver-identify-database-update.1 +71 -0
  19. package/docs/man/rom-weaver-identify-database.1 +90 -0
  20. package/docs/man/rom-weaver-identify.1 +123 -0
  21. package/docs/man/rom-weaver-man.1 +78 -0
  22. package/docs/man/rom-weaver-patch-apply.1 +420 -0
  23. package/docs/man/rom-weaver-patch-create.1 +172 -0
  24. package/docs/man/rom-weaver-patch-validate.1 +168 -0
  25. package/docs/man/rom-weaver-patch.1 +72 -0
  26. package/docs/man/rom-weaver-probe.1 +96 -0
  27. package/docs/man/rom-weaver-setup.1 +76 -0
  28. package/docs/man/rom-weaver-tools-ppf-undo.1 +74 -0
  29. package/docs/man/rom-weaver-tools.1 +66 -0
  30. package/docs/man/rom-weaver-trim.1 +130 -0
  31. package/docs/man/rom-weaver-weave.1 +420 -0
  32. package/docs/man/rom-weaver.1 +136 -0
  33. package/package.json +37 -2
@@ -0,0 +1,285 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-bundle-create 1 "rom-weaver-bundle-create "
4
+ .SH NAME
5
+ rom\-weaver\-bundle\-create \- Write a rom\-weaver\-bundle.json recipe from local ROM and patch files
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>
8
+ .SH DESCRIPTION
9
+ Write a rom\-weaver\-bundle.json recipe from local ROM and patch files.
10
+ .PP
11
+ A bundle records which ROM the patches are for, what order they run in, and
12
+ what the result should hash to. Hand it to someone else and
13
+ `rom\-weaver patch apply \-\-bundle` reproduces your exact result.
14
+ .PP
15
+ Checksums come from the real files, so nothing here is taken on faith. Every
16
+ \-\-patch\-* flag describes the \-\-patch before it.
17
+ .PP
18
+ \-\-output names the recipe itself; add .gz or .zst to compress it. \-\-bundle
19
+ additionally packs the recipe and its files into one shareable archive.
20
+ .SH OPTIONS
21
+ .TP
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 bundle
24
+ .TP
25
+ \fB\-\-assume\-in\fR \fI<ALGO=HEX>\fR
26
+ Take the ROM\*(Aqs checksum and size on trust rather than reading it, as in crc32=1234abcd,size=1048576 (repeatable, comma\-separable)
27
+ .TP
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 bundle records only this url
30
+ .TP
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
33
+ .TP
34
+ \fB\-\-patch\fR \fI<PATCH>\fR
35
+ Patch to list in the bundle. Repeat once per patch, in the order they should be
36
+ applied.
37
+
38
+ Every \-\-patch\-* flag describes the \-\-patch before it, so metadata for several
39
+ patches reads left to right:
40
+
41
+ \-\-patch tl.bps \-\-patch\-name \*(AqTranslation\*(Aq \-\-patch\-author \*(AqTeam A\*(Aq \\
42
+ \-\-patch fix.ips \-\-patch\-name \*(AqBugfixes\*(Aq \-\-patch\-optional true
43
+ .TP
44
+ \fB\-\-patch\-id\fR \fI<PATCH_ID>\fR
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"
50
+ .TP
51
+ \fB\-\-patch\-version\fR \fI<PATCH_VERSION>\fR
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"
57
+ .TP
58
+ \fB\-\-patch\-name\fR \fI<PATCH_NAME>\fR
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"
64
+ .TP
65
+ \fB\-\-patch\-description\fR \fI<PATCH_DESCRIPTION>\fR
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"
71
+ .TP
72
+ \fB\-\-patch\-author\fR \fI<PATCH_AUTHOR>\fR
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"
78
+ .TP
79
+ \fB\-\-patch\-label\fR \fI<PATCH_LABEL>\fR
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"
85
+ .TP
86
+ \fB\-\-patch\-optional\fR \fI<PATCH_OPTIONAL>\fR
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"
92
+ .br
93
+
94
+ .br
95
+ \fIPossible values:\fR
96
+ .RS 14
97
+ .IP \(bu 2
98
+ true
99
+ .IP \(bu 2
100
+ false
101
+ .RE
102
+ .TP
103
+ \fB\-\-patch\-source\-url\fR \fI<PATCH_SOURCE_URL>\fR
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"
109
+ .TP
110
+ \fB\-\-patch\-header\fR \fI<PATCH_HEADER>\fR
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"
116
+ .br
117
+
118
+ .br
119
+ \fIPossible values:\fR
120
+ .RS 14
121
+ .IP \(bu 2
122
+ keep
123
+ .IP \(bu 2
124
+ strip
125
+ .IP \(bu 2
126
+ auto
127
+ .RE
128
+ .TP
129
+ \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
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"
135
+ .br
136
+
137
+ .br
138
+ \fIPossible values:\fR
139
+ .RS 14
140
+ .IP \(bu 2
141
+ auto
142
+ .IP \(bu 2
143
+ base
144
+ .IP \(bu 2
145
+ previous
146
+ .RE
147
+ .TP
148
+ \fB\-\-patch\-expect\-in\fR \fI<ALGO=HEX>\fR
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"
154
+ .TP
155
+ \fB\-\-patch\-expect\-out\fR \fI<ALGO=HEX>\fR
156
+ Checksum the ROM should have after the preceding \-\-patch runs. Recorded only when it differs from the final output checksums (repeatable, comma\-separable)
157
+ .TP
158
+ \fB\-\-expect\-out\fR \fI<ALGO=HEX>\fR
159
+ Checksum the ROM should have once every patch has run, so users can confirm they got the right result (repeatable, comma\-separable)
160
+ .TP
161
+ \fB\-\-output\-name\fR \fI<OUTPUT_NAME>\fR
162
+ File name the bundle suggests for the patched ROM
163
+ .TP
164
+ \fB\-\-output\-header\fR \fI<OUTPUT_HEADER>\fR
165
+ Whether the patched ROM should keep its copier header: auto, keep, or strip
166
+ .br
167
+
168
+ .br
169
+ \fIPossible values:\fR
170
+ .RS 14
171
+ .IP \(bu 2
172
+ keep
173
+ .IP \(bu 2
174
+ strip
175
+ .IP \(bu 2
176
+ auto
177
+ .RE
178
+ .TP
179
+ \fB\-o\fR, \fB\-\-output\fR \fI<OUTPUT>\fR
180
+ Where to write the bundle. Name it rom\-weaver\-bundle.json, or add .gz or .zst to compress it
181
+ .TP
182
+ \fB\-\-bundle\fR \fI<BUNDLE>\fR
183
+ Also pack the bundle and its ROM and patches into one shareable archive, such as release.zip
184
+ .TP
185
+ \fB\-\-bundle\-rom\fR \fI<BUNDLE_ROM>\fR
186
+ Pack this file into \-\-bundle as the ROM, while \-\-input supplies the checksums and metadata
187
+ .TP
188
+ \fB\-\-no\-bundle\-rom\fR
189
+ Keep the ROM out of \-\-bundle and record only its checksums, so whoever applies the bundle brings their own copy
190
+ .TP
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
215
+ .TP
216
+ \fB\-\-from\fR \fI<FILE>\fR
217
+ Build the bundle from a hand\-written rom\-weaver\-bundle.json instead of flags.
218
+ Use \- to read it from stdin.
219
+
220
+ Write the file with local paths and leave the checksums out; they are filled in
221
+ from the real files. Get the schema with `rom\-weaver bundle schema` so your
222
+ editor can check the file as you write it.
223
+
224
+ Any flag you also pass overrides what the file says.
225
+ .TP
226
+ \fB\-\-schema\-ref\fR \fI<URL>\fR
227
+ Record this $schema URL in the bundle so editors can validate it. Left out unless asked for
228
+ .TP
229
+ \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
230
+ How many threads to use at most. auto uses every core; a format may still use fewer
231
+ .TP
232
+ \fB\-\-force\fR
233
+ Overwrite the output if it already exists (without this, the command stops instead)
234
+ .TP
235
+ \fB\-h\fR, \fB\-\-help\fR
236
+ Print help (see a summary with \*(Aq\-h\*(Aq)
237
+ .SH "GLOBAL OPTIONS"
238
+ .TP
239
+ \fB\-\-json\fR
240
+ Print one JSON object per line instead of human\-readable output
241
+ .TP
242
+ \fB\-\-progress\fR
243
+ Show progress even when output is piped to a file or another program
244
+ .TP
245
+ \fB\-\-no\-progress\fR
246
+ Hide progress
247
+ .TP
248
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
249
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
250
+ .br
251
+
252
+ .br
253
+ \fIPossible values:\fR
254
+ .RS 14
255
+ .IP \(bu 2
256
+ off
257
+ .IP \(bu 2
258
+ error
259
+ .IP \(bu 2
260
+ warn
261
+ .IP \(bu 2
262
+ info
263
+ .IP \(bu 2
264
+ debug
265
+ .IP \(bu 2
266
+ trace
267
+ .RE
268
+ .TP
269
+ \fB\-v\fR, \fB\-\-verbose\fR
270
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
271
+ .TP
272
+ \fB\-q\fR, \fB\-\-quiet\fR
273
+ Log errors only
274
+ .TP
275
+ \fB\-\-dep\-trace\fR
276
+ Also log trace output from bundled libraries (for bug reports)
277
+ .TP
278
+ \fB\-\-color\fR
279
+ Keep colors even when output is piped
280
+ .TP
281
+ \fB\-\-no\-color\fR
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
@@ -0,0 +1,101 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-bundle-parse 1 "rom-weaver-bundle-parse "
4
+ .SH NAME
5
+ rom\-weaver\-bundle\-parse \- Read a rom\-weaver\-bundle.json recipe and report what it points at
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>
8
+ .SH DESCRIPTION
9
+ Read a rom\-weaver\-bundle.json recipe, check that it is valid, and report the
10
+ ROM and patches it points at.
11
+ .PP
12
+ The input can be a plain rom\-weaver\-bundle.json, a compressed one (.gz, .bz2,
13
+ \&.xz, or .zst), or an archive with the recipe at its root alongside the files it
14
+ names.
15
+ .PP
16
+ Entries that name a file are looked for in the archive, or next to the recipe.
17
+ Pass \-\-output to write those files out and get real paths back. Entries that
18
+ name a url are reported as they are; nothing is downloaded.
19
+ .PP
20
+ To actually run a bundle, use `rom\-weaver patch apply \-\-bundle` instead.
21
+ .SH OPTIONS
22
+ .TP
23
+ \fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
24
+ Bundle file, or an archive with a bundle at its root
25
+ .TP
26
+ \fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
27
+ Handle only the bundle entries whose file name matches this exact name, prefix, or glob (repeatable)
28
+ .TP
29
+ \fB\-\-filter\fR \fI<FILTER>\fR
30
+ Handle only the bundle\*(Aqs rom entry or only its patch entries (repeatable, comma\-separable)
31
+ .br
32
+
33
+ .br
34
+ \fIPossible values:\fR
35
+ .RS 14
36
+ .IP \(bu 2
37
+ rom
38
+ .IP \(bu 2
39
+ patch
40
+ .RE
41
+ .TP
42
+ \fB\-\-no\-extract\fR
43
+ Report what the bundle contains without unpacking any of it
44
+ .TP
45
+ \fB\-o\fR, \fB\-\-output\fR \fI<DIR>\fR
46
+ Directory to unpack the bundle\*(Aqs files into. Without it, files packed in an archive are listed but not written out
47
+ .TP
48
+ \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
49
+ How many threads to use at most. auto uses every core; a format may still use fewer
50
+ .TP
51
+ \fB\-h\fR, \fB\-\-help\fR
52
+ Print help (see a summary with \*(Aq\-h\*(Aq)
53
+ .SH "GLOBAL OPTIONS"
54
+ .TP
55
+ \fB\-\-json\fR
56
+ Print one JSON object per line instead of human\-readable output
57
+ .TP
58
+ \fB\-\-progress\fR
59
+ Show progress even when output is piped to a file or another program
60
+ .TP
61
+ \fB\-\-no\-progress\fR
62
+ Hide progress
63
+ .TP
64
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
65
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
66
+ .br
67
+
68
+ .br
69
+ \fIPossible values:\fR
70
+ .RS 14
71
+ .IP \(bu 2
72
+ off
73
+ .IP \(bu 2
74
+ error
75
+ .IP \(bu 2
76
+ warn
77
+ .IP \(bu 2
78
+ info
79
+ .IP \(bu 2
80
+ debug
81
+ .IP \(bu 2
82
+ trace
83
+ .RE
84
+ .TP
85
+ \fB\-v\fR, \fB\-\-verbose\fR
86
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
87
+ .TP
88
+ \fB\-q\fR, \fB\-\-quiet\fR
89
+ Log errors only
90
+ .TP
91
+ \fB\-\-dep\-trace\fR
92
+ Also log trace output from bundled libraries (for bug reports)
93
+ .TP
94
+ \fB\-\-color\fR
95
+ Keep colors even when output is piped
96
+ .TP
97
+ \fB\-\-no\-color\fR
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
@@ -0,0 +1,70 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-bundle-schema 1 "rom-weaver-bundle-schema "
4
+ .SH NAME
5
+ rom\-weaver\-bundle\-schema \- Print the rom\-weaver\-bundle.json JSON Schema, for editors and hand\-authoring
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]
8
+ .SH DESCRIPTION
9
+ Print the rom\-weaver\-bundle.json JSON Schema to stdout.
10
+ .PP
11
+ Save it and point your editor at it, and the editor will check and autocomplete
12
+ a bundle as you write it:
13
+ .PP
14
+ rom\-weaver bundle schema > rom\-weaver\-bundle\-v1.schema.json
15
+ .PP
16
+ Then `bundle create \-\-from <your file>` turns what you wrote into a finished
17
+ bundle with the checksums filled in.
18
+ .SH OPTIONS
19
+ .TP
20
+ \fB\-h\fR, \fB\-\-help\fR
21
+ Print help (see a summary with \*(Aq\-h\*(Aq)
22
+ .SH "GLOBAL OPTIONS"
23
+ .TP
24
+ \fB\-\-json\fR
25
+ Print one JSON object per line instead of human\-readable output
26
+ .TP
27
+ \fB\-\-progress\fR
28
+ Show progress even when output is piped to a file or another program
29
+ .TP
30
+ \fB\-\-no\-progress\fR
31
+ Hide progress
32
+ .TP
33
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
34
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
35
+ .br
36
+
37
+ .br
38
+ \fIPossible values:\fR
39
+ .RS 14
40
+ .IP \(bu 2
41
+ off
42
+ .IP \(bu 2
43
+ error
44
+ .IP \(bu 2
45
+ warn
46
+ .IP \(bu 2
47
+ info
48
+ .IP \(bu 2
49
+ debug
50
+ .IP \(bu 2
51
+ trace
52
+ .RE
53
+ .TP
54
+ \fB\-v\fR, \fB\-\-verbose\fR
55
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
56
+ .TP
57
+ \fB\-q\fR, \fB\-\-quiet\fR
58
+ Log errors only
59
+ .TP
60
+ \fB\-\-dep\-trace\fR
61
+ Also log trace output from bundled libraries (for bug reports)
62
+ .TP
63
+ \fB\-\-color\fR
64
+ Keep colors even when output is piped
65
+ .TP
66
+ \fB\-\-no\-color\fR
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
@@ -0,0 +1,72 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-bundle 1 "rom-weaver-bundle "
4
+ .SH NAME
5
+ rom\-weaver\-bundle \- Build and read rom\-weaver\-bundle.json patch recipes
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>
8
+ .SH DESCRIPTION
9
+ Build and read rom\-weaver\-bundle.json patch recipes
10
+ .SH OPTIONS
11
+ .TP
12
+ \fB\-h\fR, \fB\-\-help\fR
13
+ Print help
14
+ .SH "GLOBAL OPTIONS"
15
+ .TP
16
+ \fB\-\-json\fR
17
+ Print one JSON object per line instead of human\-readable output
18
+ .TP
19
+ \fB\-\-progress\fR
20
+ Show progress even when output is piped to a file or another program
21
+ .TP
22
+ \fB\-\-no\-progress\fR
23
+ Hide progress
24
+ .TP
25
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
26
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
27
+ .br
28
+
29
+ .br
30
+ \fIPossible values:\fR
31
+ .RS 14
32
+ .IP \(bu 2
33
+ off
34
+ .IP \(bu 2
35
+ error
36
+ .IP \(bu 2
37
+ warn
38
+ .IP \(bu 2
39
+ info
40
+ .IP \(bu 2
41
+ debug
42
+ .IP \(bu 2
43
+ trace
44
+ .RE
45
+ .TP
46
+ \fB\-v\fR, \fB\-\-verbose\fR
47
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
48
+ .TP
49
+ \fB\-q\fR, \fB\-\-quiet\fR
50
+ Log errors only
51
+ .TP
52
+ \fB\-\-dep\-trace\fR
53
+ Also log trace output from bundled libraries (for bug reports)
54
+ .TP
55
+ \fB\-\-color\fR
56
+ Keep colors even when output is piped
57
+ .TP
58
+ \fB\-\-no\-color\fR
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
63
+ .SH SUBCOMMANDS
64
+ .TP
65
+ rom\-weaver\-bundle\-create(1)
66
+ Write a rom\-weaver\-bundle.json recipe from local ROM and patch files
67
+ .TP
68
+ rom\-weaver\-bundle\-parse(1)
69
+ Read a rom\-weaver\-bundle.json recipe and report what it points at
70
+ .TP
71
+ rom\-weaver\-bundle\-schema(1)
72
+ Print the rom\-weaver\-bundle.json JSON Schema, for editors and hand\-authoring
@@ -0,0 +1,135 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-checksum 1 "rom-weaver-checksum "
4
+ .SH NAME
5
+ rom\-weaver\-checksum \- Compute checksums for a file, or for a ROM inside an archive
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>
8
+ .SH DESCRIPTION
9
+ Compute checksums for a file, so you can tell one dump from another.
10
+ .PP
11
+ Archives are opened automatically, so this hashes the ROM inside a .zip rather
12
+ than the zip itself. Pass \-\-no\-extract to hash the file as it sits on disk.
13
+ .PP
14
+ Alongside the plain checksum, rom\-weaver reports how the same ROM would hash in
15
+ its other common forms: with and without a copier header, in each N64 byte
16
+ order, and trimmed or padded. That is what lets a checksum from a database
17
+ match a file that is stored slightly differently.
18
+ .SH OPTIONS
19
+ .TP
20
+ \fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
21
+ File to hash. Use \- to read from stdin
22
+ .TP
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
47
+ .TP
48
+ \fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
49
+ Pick which file inside the archive to use, by exact name, prefix, or glob (repeatable)
50
+ .TP
51
+ \fB\-\-filter\fR \fI<FILTER>\fR
52
+ Consider only files that look like a rom or a patch, judged by extension (repeatable, comma\-separable)
53
+ .br
54
+
55
+ .br
56
+ \fIPossible values:\fR
57
+ .RS 14
58
+ .IP \(bu 2
59
+ rom
60
+ .IP \(bu 2
61
+ patch
62
+ .RE
63
+ .TP
64
+ \fB\-\-no\-extract\fR
65
+ Do not look inside archives; hash the file itself
66
+ .TP
67
+ \fB\-\-no\-ignore\fR
68
+ Also consider files normally skipped inside archives: readmes, images, checksum sidecars, and OS clutter such as .DS_Store
69
+ .TP
70
+ \fB\-\-no\-trim\-fix\fR
71
+ Skip the extra checksums computed for how a trimmable ROM would hash trimmed or untrimmed
72
+ .TP
73
+ \fB\-\-start\fR \fI<BYTE>\fR
74
+ Start hashing at this byte offset, counting from 0
75
+ .TP
76
+ \fB\-\-length\fR \fI<BYTES>\fR
77
+ How many bytes to hash from \-\-start. Defaults to the rest of the file
78
+ .TP
79
+ \fB\-\-probe\fR
80
+ Also report the platform of the hashed bytes, and fail if it matches no known platform
81
+ .TP
82
+ \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
83
+ How many threads to use at most. auto uses every core; a format may still use fewer
84
+ .TP
85
+ \fB\-h\fR, \fB\-\-help\fR
86
+ Print help (see a summary with \*(Aq\-h\*(Aq)
87
+ .SH "GLOBAL OPTIONS"
88
+ .TP
89
+ \fB\-\-json\fR
90
+ Print one JSON object per line instead of human\-readable output
91
+ .TP
92
+ \fB\-\-progress\fR
93
+ Show progress even when output is piped to a file or another program
94
+ .TP
95
+ \fB\-\-no\-progress\fR
96
+ Hide progress
97
+ .TP
98
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
99
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
100
+ .br
101
+
102
+ .br
103
+ \fIPossible values:\fR
104
+ .RS 14
105
+ .IP \(bu 2
106
+ off
107
+ .IP \(bu 2
108
+ error
109
+ .IP \(bu 2
110
+ warn
111
+ .IP \(bu 2
112
+ info
113
+ .IP \(bu 2
114
+ debug
115
+ .IP \(bu 2
116
+ trace
117
+ .RE
118
+ .TP
119
+ \fB\-v\fR, \fB\-\-verbose\fR
120
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
121
+ .TP
122
+ \fB\-q\fR, \fB\-\-quiet\fR
123
+ Log errors only
124
+ .TP
125
+ \fB\-\-dep\-trace\fR
126
+ Also log trace output from bundled libraries (for bug reports)
127
+ .TP
128
+ \fB\-\-color\fR
129
+ Keep colors even when output is piped
130
+ .TP
131
+ \fB\-\-no\-color\fR
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