rom-weaver 0.14.0 → 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,168 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-patch-validate 1 "rom-weaver-patch-validate "
4
+ .SH NAME
5
+ rom\-weaver\-patch\-validate \- Check that patches would apply cleanly, without writing anything
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver patch validate\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\-\-no\-ignore\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-patch\-select\fR] [\fB\-\-assume\-in\fR] [\fB\-\-color\fR] [\fB\-\-expect\-in\fR] [\fB\-\-no\-color\fR] [\fB\-\-strip\-header\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-\-n64\-byte\-order\fR] [\fB\-\-ignore\-checksum\-validation\fR] [\fB\-\-independent\fR] [\fB\-\-plan\fR] [\fB\-\-patch\-basis\fR] [\fB\-\-patch\-input\-check\fR] [\fB\-\-patch\-output\-check\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR> <\fB\-\-patch\fR>
8
+ .SH DESCRIPTION
9
+ Check that patches would apply cleanly to a ROM, without writing anything.
10
+ .PP
11
+ This runs the same checks apply does: it parses each patch and verifies every
12
+ checksum the format carries. Use \-\-expect\-in to also confirm the ROM itself is
13
+ the one you think it is, by checksum or by size.
14
+ .PP
15
+ Patches are checked as a chain by default, each against the output of the one
16
+ before it. Pass \-\-independent to check each one against the original ROM
17
+ instead and get a verdict per patch.
18
+ .SH OPTIONS
19
+ .TP
20
+ \fB\-i\fR, \fB\-\-input\fR \fI<PATH>\fR
21
+ ROM to check the patches against. May be an archive
22
+ .TP
23
+ \fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
24
+ Pick which file to use when the ROM or a patch is inside an archive, by exact name, prefix, or glob (repeatable). \-\-patch\-select overrides it for the patch it follows
25
+ .TP
26
+ \fB\-\-filter\fR \fI<FILTER>\fR
27
+ Consider only files that look like a rom or a patch, judged by extension (repeatable, comma\-separable)
28
+ .br
29
+
30
+ .br
31
+ \fIPossible values:\fR
32
+ .RS 14
33
+ .IP \(bu 2
34
+ rom
35
+ .IP \(bu 2
36
+ patch
37
+ .RE
38
+ .TP
39
+ \fB\-\-no\-extract\fR
40
+ Do not look inside archives; treat the input and every patch as raw files
41
+ .TP
42
+ \fB\-\-no\-ignore\fR
43
+ Also consider files normally skipped inside archives: readmes, images, checksum sidecars, and OS clutter such as .DS_Store
44
+ .TP
45
+ \fB\-\-patch\fR \fI<PATCHES>\fR
46
+ Patch to check. Repeat once per patch; they are checked in the order given
47
+ .TP
48
+ \fB\-\-assume\-in\fR \fI<ALGO=HEX>\fR
49
+ Take this checksum on trust instead of reading the ROM to compute it, as in
50
+ crc32=1234abcd. Repeatable and comma\-separable.
51
+
52
+ This is a speed option for scripts that already know the checksum: it skips a
53
+ full read of a large ROM. It does not verify anything. To check a ROM against a
54
+ checksum, use \-\-expect\-in.
55
+ .TP
56
+ \fB\-\-expect\-in\fR \fI<ALGO=HEX>\fR
57
+ Fail unless the ROM matches: a checksum (crc32=1234abcd), an exact size (size=N), or a floor (min\-size=N). Repeatable, comma\-separable
58
+ .TP
59
+ \fB\-\-strip\-header\fR
60
+ Remove the ROM\*(Aqs copier header before checking (A78, LNX, NES, FDS, SMC signatures, plus the SNES and PCE size rules)
61
+ .TP
62
+ \fB\-\-n64\-byte\-order\fR \fI<N64_BYTE_ORDER>\fR
63
+ Byte order to put an N64 ROM in before checking: auto, keep, big\-endian, little\-endian, or byte\-swapped [default: auto]
64
+ .br
65
+
66
+ .br
67
+ \fIPossible values:\fR
68
+ .RS 14
69
+ .IP \(bu 2
70
+ auto
71
+ .IP \(bu 2
72
+ keep
73
+ .IP \(bu 2
74
+ big\-endian
75
+ .IP \(bu 2
76
+ little\-endian
77
+ .IP \(bu 2
78
+ byte\-swapped
79
+ .RE
80
+ .TP
81
+ \fB\-\-ignore\-checksum\-validation\fR
82
+ Report a patch as usable even when its own checksums do not match
83
+ .TP
84
+ \fB\-\-independent\fR
85
+ Check every patch against the original ROM rather than as a chain, and report a verdict for each instead of stopping at the first failure
86
+ .TP
87
+ \fB\-\-plan\fR
88
+ Report the order the patches would run in and what each would be checked against, without reading the ROM more than needed
89
+ .TP
90
+ \fB\-\-patch\-basis\fR \fI<PATCH_BASIS>\fR
91
+ Which ROM the preceding \-\-patch was built against: auto, base, or previous [default: auto]
92
+ .br
93
+
94
+ .br
95
+ \fIPossible values:\fR
96
+ .RS 14
97
+ .IP \(bu 2
98
+ auto
99
+ .IP \(bu 2
100
+ base
101
+ .IP \(bu 2
102
+ previous
103
+ .RE
104
+ .TP
105
+ \fB\-\-patch\-input\-check\fR \fI<ALGO=HEX>\fR
106
+ Checksum the preceding \-\-patch expects to see going in, when the patch does not carry one (comma\-separable; empty means none)
107
+ .TP
108
+ \fB\-\-patch\-output\-check\fR \fI<ALGO=HEX>\fR
109
+ Checksum the preceding \-\-patch should produce, when the patch does not carry one (comma\-separable; empty means none)
110
+ .TP
111
+ \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
112
+ How many threads to use at most. auto uses every core; a format may still use fewer
113
+ .TP
114
+ \fB\-h\fR, \fB\-\-help\fR
115
+ Print help (see a summary with \*(Aq\-h\*(Aq)
116
+ .SH ARCHIVE/BUNDLE
117
+ .TP
118
+ \fB\-\-patch\-select\fR \fI<GLOB>\fR
119
+ Pick which file to use inside the \-\-patch archive before it. Repeatable, one per \-\-patch; falls back to \-\-select
120
+ .SH "GLOBAL OPTIONS"
121
+ .TP
122
+ \fB\-\-json\fR
123
+ Print one JSON object per line instead of human\-readable output
124
+ .TP
125
+ \fB\-\-progress\fR
126
+ Show progress even when output is piped to a file or another program
127
+ .TP
128
+ \fB\-\-no\-progress\fR
129
+ Hide progress
130
+ .TP
131
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
132
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
133
+ .br
134
+
135
+ .br
136
+ \fIPossible values:\fR
137
+ .RS 14
138
+ .IP \(bu 2
139
+ off
140
+ .IP \(bu 2
141
+ error
142
+ .IP \(bu 2
143
+ warn
144
+ .IP \(bu 2
145
+ info
146
+ .IP \(bu 2
147
+ debug
148
+ .IP \(bu 2
149
+ trace
150
+ .RE
151
+ .TP
152
+ \fB\-v\fR, \fB\-\-verbose\fR
153
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
154
+ .TP
155
+ \fB\-q\fR, \fB\-\-quiet\fR
156
+ Log errors only
157
+ .TP
158
+ \fB\-\-dep\-trace\fR
159
+ Also log trace output from bundled libraries (for bug reports)
160
+ .TP
161
+ \fB\-\-color\fR
162
+ Keep colors even when output is piped
163
+ .TP
164
+ \fB\-\-no\-color\fR
165
+ Turn colors off
166
+ .TP
167
+ \fB\-y\fR, \fB\-\-yes\fR
168
+ 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-patch 1 "rom-weaver-patch "
4
+ .SH NAME
5
+ rom\-weaver\-patch \- Apply, create, or check ROM patches
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver patch\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
+ Apply, create, or check ROM patches
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\-patch\-apply(1)
66
+ Apply one or more patches to a ROM, in order
67
+ .TP
68
+ rom\-weaver\-patch\-validate(1)
69
+ Check that patches would apply cleanly, without writing anything
70
+ .TP
71
+ rom\-weaver\-patch\-create(1)
72
+ Build a patch from an original ROM and a changed one
@@ -0,0 +1,96 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-probe 1 "rom-weaver-probe "
4
+ .SH NAME
5
+ rom\-weaver\-probe \- Identify a file: its format, its platform, and any header it carries
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver probe\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\-\-no\-ignore\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] <\fB\-i\fR|\fB\-\-input\fR>
8
+ .SH DESCRIPTION
9
+ Identify a file. Reports what format it is, which console it is for, whether it
10
+ carries a copier header, and what is inside it if it is an archive.
11
+ .PP
12
+ `rom\-weaver inspect` runs this same command under another name.
13
+ .PP
14
+ Archives are opened automatically, so pointing this at a .zip describes the ROM
15
+ inside rather than the zip itself. Pass \-\-no\-extract to describe the file as it
16
+ sits on disk.
17
+ .PP
18
+ Nothing is written; this only reads.
19
+ .SH OPTIONS
20
+ .TP
21
+ \fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
22
+ File to identify. Use \- to read from stdin
23
+ .TP
24
+ \fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
25
+ Pick which file inside the archive to use, by exact name, prefix, or glob (repeatable)
26
+ .TP
27
+ \fB\-\-filter\fR \fI<FILTER>\fR
28
+ Consider only files that look like a rom or a patch, judged by extension (repeatable, comma\-separable)
29
+ .br
30
+
31
+ .br
32
+ \fIPossible values:\fR
33
+ .RS 14
34
+ .IP \(bu 2
35
+ rom
36
+ .IP \(bu 2
37
+ patch
38
+ .RE
39
+ .TP
40
+ \fB\-\-no\-extract\fR
41
+ Do not look inside archives; identify the file itself
42
+ .TP
43
+ \fB\-\-no\-ignore\fR
44
+ Also consider files normally skipped inside archives: readmes, images, checksum sidecars, and OS clutter such as .DS_Store
45
+ .TP
46
+ \fB\-h\fR, \fB\-\-help\fR
47
+ Print help (see a summary with \*(Aq\-h\*(Aq)
48
+ .SH "GLOBAL OPTIONS"
49
+ .TP
50
+ \fB\-\-json\fR
51
+ Print one JSON object per line instead of human\-readable output
52
+ .TP
53
+ \fB\-\-progress\fR
54
+ Show progress even when output is piped to a file or another program
55
+ .TP
56
+ \fB\-\-no\-progress\fR
57
+ Hide progress
58
+ .TP
59
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
60
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
61
+ .br
62
+
63
+ .br
64
+ \fIPossible values:\fR
65
+ .RS 14
66
+ .IP \(bu 2
67
+ off
68
+ .IP \(bu 2
69
+ error
70
+ .IP \(bu 2
71
+ warn
72
+ .IP \(bu 2
73
+ info
74
+ .IP \(bu 2
75
+ debug
76
+ .IP \(bu 2
77
+ trace
78
+ .RE
79
+ .TP
80
+ \fB\-v\fR, \fB\-\-verbose\fR
81
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
82
+ .TP
83
+ \fB\-q\fR, \fB\-\-quiet\fR
84
+ Log errors only
85
+ .TP
86
+ \fB\-\-dep\-trace\fR
87
+ Also log trace output from bundled libraries (for bug reports)
88
+ .TP
89
+ \fB\-\-color\fR
90
+ Keep colors even when output is piped
91
+ .TP
92
+ \fB\-\-no\-color\fR
93
+ Turn colors off
94
+ .TP
95
+ \fB\-y\fR, \fB\-\-yes\fR
96
+ Answer yes to every confirmation instead of asking. Does not choose between candidates
@@ -0,0 +1,76 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-setup 1 "rom-weaver-setup "
4
+ .SH NAME
5
+ rom\-weaver\-setup \- Install the offline identify database
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver setup\fR [\fB\-\-database\-dir\fR] [\fB\-\-json\fR] [\fB\-\-force\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 identify database this build\*(Aqs `identify` command searches.
10
+ .PP
11
+ Run it once after installing rom\-weaver by a method that ships only the
12
+ executable, such as `cargo binstall` or `cargo install`. The Homebrew, scoop,
13
+ npm, and install\-script packages already place the database beside the binary,
14
+ so this only reports what is there.
15
+ .PP
16
+ The download comes from this version\*(Aqs GitHub release and lands in the per\-user
17
+ data directory; `identify database install\-group` adds the optional packs.
18
+ .SH OPTIONS
19
+ .TP
20
+ \fB\-\-database\-dir\fR \fI<DIR>\fR
21
+ Install into this directory instead of the per\-user data directory
22
+ .TP
23
+ \fB\-\-force\fR
24
+ Download the database again even when it is already installed
25
+ .TP
26
+ \fB\-h\fR, \fB\-\-help\fR
27
+ Print help (see a summary with \*(Aq\-h\*(Aq)
28
+ .SH "GLOBAL OPTIONS"
29
+ .TP
30
+ \fB\-\-json\fR
31
+ Print one JSON object per line instead of human\-readable output
32
+ .TP
33
+ \fB\-\-progress\fR
34
+ Show progress even when output is piped to a file or another program
35
+ .TP
36
+ \fB\-\-no\-progress\fR
37
+ Hide progress
38
+ .TP
39
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
40
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
41
+ .br
42
+
43
+ .br
44
+ \fIPossible values:\fR
45
+ .RS 14
46
+ .IP \(bu 2
47
+ off
48
+ .IP \(bu 2
49
+ error
50
+ .IP \(bu 2
51
+ warn
52
+ .IP \(bu 2
53
+ info
54
+ .IP \(bu 2
55
+ debug
56
+ .IP \(bu 2
57
+ trace
58
+ .RE
59
+ .TP
60
+ \fB\-v\fR, \fB\-\-verbose\fR
61
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
62
+ .TP
63
+ \fB\-q\fR, \fB\-\-quiet\fR
64
+ Log errors only
65
+ .TP
66
+ \fB\-\-dep\-trace\fR
67
+ Also log trace output from bundled libraries (for bug reports)
68
+ .TP
69
+ \fB\-\-color\fR
70
+ Keep colors even when output is piped
71
+ .TP
72
+ \fB\-\-no\-color\fR
73
+ Turn colors off
74
+ .TP
75
+ \fB\-y\fR, \fB\-\-yes\fR
76
+ Answer yes to every confirmation instead of asking. Does not choose between candidates
@@ -0,0 +1,74 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-tools-ppf-undo 1 "rom-weaver-tools-ppf-undo "
4
+ .SH NAME
5
+ rom\-weaver\-tools\-ppf\-undo \- Undo a PPF3 patch, using the undo data stored inside it
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver tools ppf\-undo\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] <\fB\-i\fR|\fB\-\-input\fR> <\fB\-\-patch\fR> <\fB\-o\fR|\fB\-\-output\fR>
8
+ .SH DESCRIPTION
9
+ Undo a PPF3 patch, turning a patched ROM back into the original.
10
+ .PP
11
+ Only works when the patch was written with undo data, which is optional in the
12
+ PPF3 format. Without it there is nothing to reverse from.
13
+ .SH OPTIONS
14
+ .TP
15
+ \fB\-i\fR, \fB\-\-input\fR \fI<ROM>\fR
16
+ The already\-patched ROM to undo
17
+ .TP
18
+ \fB\-\-patch\fR \fI<PPF>\fR
19
+ The PPF3 patch that was applied. It must carry undo data
20
+ .TP
21
+ \fB\-o\fR, \fB\-\-output\fR \fI<PATH>\fR
22
+ Where to write the restored ROM
23
+ .TP
24
+ \fB\-h\fR, \fB\-\-help\fR
25
+ Print help (see a summary with \*(Aq\-h\*(Aq)
26
+ .SH "GLOBAL OPTIONS"
27
+ .TP
28
+ \fB\-\-json\fR
29
+ Print one JSON object per line instead of human\-readable output
30
+ .TP
31
+ \fB\-\-progress\fR
32
+ Show progress even when output is piped to a file or another program
33
+ .TP
34
+ \fB\-\-no\-progress\fR
35
+ Hide progress
36
+ .TP
37
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
38
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
39
+ .br
40
+
41
+ .br
42
+ \fIPossible values:\fR
43
+ .RS 14
44
+ .IP \(bu 2
45
+ off
46
+ .IP \(bu 2
47
+ error
48
+ .IP \(bu 2
49
+ warn
50
+ .IP \(bu 2
51
+ info
52
+ .IP \(bu 2
53
+ debug
54
+ .IP \(bu 2
55
+ trace
56
+ .RE
57
+ .TP
58
+ \fB\-v\fR, \fB\-\-verbose\fR
59
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
60
+ .TP
61
+ \fB\-q\fR, \fB\-\-quiet\fR
62
+ Log errors only
63
+ .TP
64
+ \fB\-\-dep\-trace\fR
65
+ Also log trace output from bundled libraries (for bug reports)
66
+ .TP
67
+ \fB\-\-color\fR
68
+ Keep colors even when output is piped
69
+ .TP
70
+ \fB\-\-no\-color\fR
71
+ Turn colors off
72
+ .TP
73
+ \fB\-y\fR, \fB\-\-yes\fR
74
+ 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-tools 1 "rom-weaver-tools "
4
+ .SH NAME
5
+ rom\-weaver\-tools \- One\-off recovery tools
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver tools\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
+ One\-off recovery tools
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\-tools\-ppf\-undo(1)
66
+ Undo a PPF3 patch, using the undo data stored inside it
@@ -0,0 +1,130 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-trim 1 "rom-weaver-trim "
4
+ .SH NAME
5
+ rom\-weaver\-trim \- Cut the padding off a ROM, or put it back
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver trim\fR [\fB\-\-json\fR] [\fB\-o\fR|\fB\-\-output\fR] [\fB\-\-progress\fR] [\fB\-e\fR|\fB\-\-extension\fR] [\fB\-\-no\-progress\fR] [\fB\-\-in\-place\fR] [\fB\-\-log\-level\fR] [\fB\-n\fR|\fB\-\-dry\-run\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-revert\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-no\-recursive\fR] [\fB\-\-color\fR] [\fB\-\-filter\fR] [\fB\-\-no\-color\fR] [\fB\-\-no\-filter\fR] [\fB\-\-no\-extract\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-\-revert\-marker\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-\-force\fR] [\fB\-h\fR|\fB\-\-help\fR] <\fB\-i\fR|\fB\-\-input\fR>
8
+ .SH DESCRIPTION
9
+ Cut the unused padding off the end of a ROM, making the file smaller without
10
+ changing what a console or emulator reads from it.
11
+ .PP
12
+ Works on NDS\-family ROMs (.nds, .dsi, .srl), GBA (.gba), 3DS (.3ds), XISO
13
+ images, and RVZ scrub candidates.
14
+ .PP
15
+ By default a new file is written. \-\-in\-place overwrites the original, and
16
+ \-n/\-\-dry\-run reports what would change without touching anything.
17
+ .PP
18
+ \-\-revert pads a trimmed file back out (NDS, GBA, and 3DS only). To make that
19
+ exact rather than approximate, trim with \-\-revert\-marker, which stores a small
20
+ footer recording what was cut.
21
+ .SH OPTIONS
22
+ .TP
23
+ \fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
24
+ File or folder to trim. Repeat for each one
25
+ .TP
26
+ \fB\-o\fR, \fB\-\-output\fR \fI<OUTPUT>\fR
27
+ Where to write the trimmed file. Only valid with a single trimmable input
28
+ .TP
29
+ \fB\-e\fR, \fB\-\-extension\fR \fI<EXTENSION>\fR
30
+ Save next to each original under this extension. {ext} stands for the original one, as in trim.{ext}
31
+ .TP
32
+ \fB\-\-in\-place\fR
33
+ Overwrite the original instead of writing a new file
34
+ .TP
35
+ \fB\-n\fR, \fB\-\-dry\-run\fR
36
+ Report what would be trimmed without writing anything
37
+ .TP
38
+ \fB\-\-revert\fR
39
+ Pad a trimmed file back to full size. `\-\-untrim` and `\-\-restore` do the same
40
+ thing.
41
+
42
+ If the file carries a revert footer from an earlier \-\-revert\-marker run, the
43
+ original is restored byte for byte. Otherwise the size is worked out from the
44
+ ROM header (NDS and 3DS) or rounded up to the next power of two (GBA), which
45
+ usually matches but is not guaranteed to.
46
+
47
+ XISO and RVZ scrub cannot be reverted.
48
+ .TP
49
+ \fB\-\-no\-recursive\fR
50
+ When an input is a folder, look only at its top level
51
+ .TP
52
+ \fB\-\-filter\fR \fI<FILTER>\fR [default: rom]
53
+ Consider only files that look like a rom or a patch, judged by extension (repeatable, comma\-separable)
54
+ .br
55
+
56
+ .br
57
+ \fIPossible values:\fR
58
+ .RS 14
59
+ .IP \(bu 2
60
+ rom
61
+ .IP \(bu 2
62
+ patch
63
+ .RE
64
+ .TP
65
+ \fB\-\-no\-filter\fR
66
+ Consider every file inside an archive, not just the ones that look like ROMs
67
+ .TP
68
+ \fB\-\-no\-extract\fR
69
+ Do not look inside archives; trim only the files named directly
70
+ .TP
71
+ \fB\-\-revert\-marker\fR
72
+ Add a small footer recording what was cut, so \-\-revert can restore the original exactly
73
+ .TP
74
+ \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
75
+ How many threads to use at most. auto uses every core; a format may still use fewer
76
+ .TP
77
+ \fB\-\-force\fR
78
+ Overwrite the output if it already exists (without this, the command stops instead)
79
+ .TP
80
+ \fB\-h\fR, \fB\-\-help\fR
81
+ Print help (see a summary with \*(Aq\-h\*(Aq)
82
+ .SH "GLOBAL OPTIONS"
83
+ .TP
84
+ \fB\-\-json\fR
85
+ Print one JSON object per line instead of human\-readable output
86
+ .TP
87
+ \fB\-\-progress\fR
88
+ Show progress even when output is piped to a file or another program
89
+ .TP
90
+ \fB\-\-no\-progress\fR
91
+ Hide progress
92
+ .TP
93
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
94
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
95
+ .br
96
+
97
+ .br
98
+ \fIPossible values:\fR
99
+ .RS 14
100
+ .IP \(bu 2
101
+ off
102
+ .IP \(bu 2
103
+ error
104
+ .IP \(bu 2
105
+ warn
106
+ .IP \(bu 2
107
+ info
108
+ .IP \(bu 2
109
+ debug
110
+ .IP \(bu 2
111
+ trace
112
+ .RE
113
+ .TP
114
+ \fB\-v\fR, \fB\-\-verbose\fR
115
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
116
+ .TP
117
+ \fB\-q\fR, \fB\-\-quiet\fR
118
+ Log errors only
119
+ .TP
120
+ \fB\-\-dep\-trace\fR
121
+ Also log trace output from bundled libraries (for bug reports)
122
+ .TP
123
+ \fB\-\-color\fR
124
+ Keep colors even when output is piped
125
+ .TP
126
+ \fB\-\-no\-color\fR
127
+ Turn colors off
128
+ .TP
129
+ \fB\-y\fR, \fB\-\-yes\fR
130
+ Answer yes to every confirmation instead of asking. Does not choose between candidates