@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
package/docs/man/rom-weaver-identify-database-install-group.1 ADDED
@@ -0,0 +1,71 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-identify-database-install-group 1 "rom-weaver-identify-database-install-group "
4
+ .SH NAME
5
+ rom\-weaver\-identify\-database\-install\-group \- Download and install one optional identify pack group
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver identify database install\-group\fR [\fB\-\-from\fR] [\fB\-\-json\fR] [\fB\-\-database\-dir\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] <\fIGROUP\fR>
8
+ .SH DESCRIPTION
9
+ Download and install one optional identify pack group
10
+ .SH OPTIONS
11
+ .TP
12
+ \fB\-\-from\fR \fI<ARCHIVE>\fR
13
+ Local group archive; omit to download the archive for this version
14
+ .TP
15
+ \fB\-\-database\-dir\fR \fI<DIR>\fR
16
+ Identify database directory. Defaults to the per\-user data directory
17
+ .TP
18
+ \fB\-h\fR, \fB\-\-help\fR
19
+ Print help
20
+ .TP
21
+ <\fIGROUP\fR>
22
+ Optional identify pack group to install
23
+ .SH "GLOBAL OPTIONS"
24
+ .TP
25
+ \fB\-\-json\fR
26
+ Print one JSON object per line instead of human\-readable output
27
+ .TP
28
+ \fB\-\-progress\fR
29
+ Show progress even when output is piped to a file or another program
30
+ .TP
31
+ \fB\-\-no\-progress\fR
32
+ Hide progress
33
+ .TP
34
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
35
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
36
+ .br
37
+
38
+ .br
39
+ \fIPossible values:\fR
40
+ .RS 14
41
+ .IP \(bu 2
42
+ off
43
+ .IP \(bu 2
44
+ error
45
+ .IP \(bu 2
46
+ warn
47
+ .IP \(bu 2
48
+ info
49
+ .IP \(bu 2
50
+ debug
51
+ .IP \(bu 2
52
+ trace
53
+ .RE
54
+ .TP
55
+ \fB\-v\fR, \fB\-\-verbose\fR
56
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
57
+ .TP
58
+ \fB\-q\fR, \fB\-\-quiet\fR
59
+ Log errors only
60
+ .TP
61
+ \fB\-\-dep\-trace\fR
62
+ Also log trace output from bundled libraries (for bug reports)
63
+ .TP
64
+ \fB\-\-color\fR
65
+ Keep colors even when output is piped
66
+ .TP
67
+ \fB\-\-no\-color\fR
68
+ Turn colors off
69
+ .TP
70
+ \fB\-y\fR, \fB\-\-yes\fR
71
+ Answer yes to every confirmation instead of asking. Does not choose between candidates
package/docs/man/rom-weaver-identify-database-install.1 ADDED
@@ -0,0 +1,74 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-identify-database-install 1 "rom-weaver-identify-database-install "
4
+ .SH NAME
5
+ rom\-weaver\-identify\-database\-install \- Download and install one Redump system pack (or \-\-all)
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver identify database install\fR [\fB\-\-all\fR] [\fB\-\-json\fR] [\fB\-\-from\fR] [\fB\-\-progress\fR] [\fB\-\-database\-dir\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] [\fISYSTEM\fR]
8
+ .SH DESCRIPTION
9
+ Download and install one Redump system pack (or \-\-all)
10
+ .SH OPTIONS
11
+ .TP
12
+ \fB\-\-all\fR
13
+ Install every platform in the dump
14
+ .TP
15
+ \fB\-\-from\fR \fI<ZIP>\fR
16
+ Local Redump DAT ZIP file; omit to download from Redump
17
+ .TP
18
+ \fB\-\-database\-dir\fR \fI<DIR>\fR
19
+ Identify database directory. Defaults to the per\-user data directory
20
+ .TP
21
+ \fB\-h\fR, \fB\-\-help\fR
22
+ Print help
23
+ .TP
24
+ [\fISYSTEM\fR]
25
+ Canonical platform name or alias
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
package/docs/man/rom-weaver-identify-database-list.1 ADDED
@@ -0,0 +1,65 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-identify-database-list 1 "rom-weaver-identify-database-list "
4
+ .SH NAME
5
+ rom\-weaver\-identify\-database\-list \- List every catalog platform, its source, and whether its pack is installed
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver identify database list\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
+ List every catalog platform, its source, and whether its pack is installed
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
package/docs/man/rom-weaver-identify-database-path.1 ADDED
@@ -0,0 +1,65 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-identify-database-path 1 "rom-weaver-identify-database-path "
4
+ .SH NAME
5
+ rom\-weaver\-identify\-database\-path \- Print the identify database directory
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver identify database path\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
+ Print the identify database directory
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
package/docs/man/rom-weaver-identify-database-remove.1 ADDED
@@ -0,0 +1,68 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-identify-database-remove 1 "rom-weaver-identify-database-remove "
4
+ .SH NAME
5
+ rom\-weaver\-identify\-database\-remove \- Remove one system\*(Aqs installed pack
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver identify database remove\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] <\fISYSTEM\fR>
8
+ .SH DESCRIPTION
9
+ Remove one system\*(Aqs installed pack
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
+ <\fISYSTEM\fR>
19
+ Canonical platform name or alias
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
package/docs/man/rom-weaver-identify-database-status.1 ADDED
@@ -0,0 +1,65 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-identify-database-status 1 "rom-weaver-identify-database-status "
4
+ .SH NAME
5
+ rom\-weaver\-identify\-database\-status \- List the installed pack files: slug, format, size, and sha256
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver identify database status\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
+ List the installed pack files: slug, format, size, and sha256
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
package/docs/man/rom-weaver-identify-database-update.1 ADDED
@@ -0,0 +1,71 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-identify-database-update 1 "rom-weaver-identify-database-update "
4
+ .SH NAME
5
+ rom\-weaver\-identify\-database\-update \- Download and update installed Redump system packs
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver identify database update\fR [\fB\-\-from\fR] [\fB\-\-json\fR] [\fB\-\-database\-dir\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] [\fISYSTEM\fR]
8
+ .SH DESCRIPTION
9
+ Download and update installed Redump system packs
10
+ .SH OPTIONS
11
+ .TP
12
+ \fB\-\-from\fR \fI<ZIP>\fR
13
+ Local Redump DAT ZIP file; omit to download from Redump
14
+ .TP
15
+ \fB\-\-database\-dir\fR \fI<DIR>\fR
16
+ Identify database directory. Defaults to the per\-user data directory
17
+ .TP
18
+ \fB\-h\fR, \fB\-\-help\fR
19
+ Print help
20
+ .TP
21
+ [\fISYSTEM\fR]
22
+ Canonical platform name or alias; omit to update every installed pack
23
+ .SH "GLOBAL OPTIONS"
24
+ .TP
25
+ \fB\-\-json\fR
26
+ Print one JSON object per line instead of human\-readable output
27
+ .TP
28
+ \fB\-\-progress\fR
29
+ Show progress even when output is piped to a file or another program
30
+ .TP
31
+ \fB\-\-no\-progress\fR
32
+ Hide progress
33
+ .TP
34
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
35
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
36
+ .br
37
+
38
+ .br
39
+ \fIPossible values:\fR
40
+ .RS 14
41
+ .IP \(bu 2
42
+ off
43
+ .IP \(bu 2
44
+ error
45
+ .IP \(bu 2
46
+ warn
47
+ .IP \(bu 2
48
+ info
49
+ .IP \(bu 2
50
+ debug
51
+ .IP \(bu 2
52
+ trace
53
+ .RE
54
+ .TP
55
+ \fB\-v\fR, \fB\-\-verbose\fR
56
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
57
+ .TP
58
+ \fB\-q\fR, \fB\-\-quiet\fR
59
+ Log errors only
60
+ .TP
61
+ \fB\-\-dep\-trace\fR
62
+ Also log trace output from bundled libraries (for bug reports)
63
+ .TP
64
+ \fB\-\-color\fR
65
+ Keep colors even when output is piped
66
+ .TP
67
+ \fB\-\-no\-color\fR
68
+ Turn colors off
69
+ .TP
70
+ \fB\-y\fR, \fB\-\-yes\fR
71
+ Answer yes to every confirmation instead of asking. Does not choose between candidates
package/docs/man/rom-weaver-identify-database.1 ADDED
@@ -0,0 +1,90 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-identify-database 1 "rom-weaver-identify-database "
4
+ .SH NAME
5
+ rom\-weaver\-identify\-database \- Manage the installed identify database packs
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver identify database\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
+ Manage the installed identify database packs
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\-identify\-database\-list(1)
66
+ List every catalog platform, its source, and whether its pack is installed
67
+ .TP
68
+ rom\-weaver\-identify\-database\-status(1)
69
+ List the installed pack files: slug, format, size, and sha256
70
+ .TP
71
+ rom\-weaver\-identify\-database\-path(1)
72
+ Print the identify database directory
73
+ .TP
74
+ rom\-weaver\-identify\-database\-remove(1)
75
+ Remove one system\*(Aqs installed pack
76
+ .TP
77
+ rom\-weaver\-identify\-database\-import\-redump(1)
78
+ Build identify packs from local Redump DAT ZIP files
79
+ .TP
80
+ rom\-weaver\-identify\-database\-install\-all(1)
81
+ Install the full identify database for this rom\-weaver version
82
+ .TP
83
+ rom\-weaver\-identify\-database\-install\-group(1)
84
+ Download and install one optional identify pack group
85
+ .TP
86
+ rom\-weaver\-identify\-database\-install(1)
87
+ Download and install one Redump system pack (or \-\-all)
88
+ .TP
89
+ rom\-weaver\-identify\-database\-update(1)
90
+ Download and update installed Redump system packs
package/docs/man/rom-weaver-identify.1 ADDED
@@ -0,0 +1,123 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH rom-weaver-identify 1 "rom-weaver-identify "
4
+ .SH NAME
5
+ rom\-weaver\-identify \- Identify a ROM title from its checksums
6
+ .SH SYNOPSIS
7
+ \fBrom\-weaver identify\fR [\fB\-i\fR|\fB\-\-input\fR] [\fB\-\-json\fR] [\fB\-\-hash\fR] [\fB\-\-progress\fR] [\fB\-\-no\-progress\fR] [\fB\-\-size\fR] [\fB\-d\fR|\fB\-\-database\fR] [\fB\-\-log\-level\fR] [\fB\-\-system\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-\-offline\fR] [\fB\-q\fR|\fB\-\-quiet\fR] [\fB\-\-database\-dir\fR] [\fB\-\-dep\-trace\fR] [\fB\-\-color\fR] [\fB\-\-exhaustive\-database\-search\fR] [\fB\-\-no\-color\fR] [\fB\-s\fR|\fB\-\-select\fR] [\fB\-y\fR|\fB\-\-yes\fR] [\fB\-\-filter\fR] [\fB\-\-no\-extract\fR] [\fB\-\-no\-ignore\fR] [\fB\-\-no\-trim\-fix\fR] [\fB\-j\fR|\fB\-\-threads\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fIsubcommands\fR]
8
+ .SH DESCRIPTION
9
+ Identify a ROM title from its checksums and local RWFP1 database packs.
10
+ .PP
11
+ Archives are opened automatically. The command checks the raw ROM and its
12
+ common header and byte\-order variants. Repeat \-\-database to search more than
13
+ one system pack, or install packs with `identify database` and let the
14
+ detected platform pick the pack. Nothing is uploaded.
15
+ .SH OPTIONS
16
+ .TP
17
+ \fB\-i\fR, \fB\-\-input\fR \fI<INPUT>\fR
18
+ ROM to identify. Use \- to read from stdin
19
+ .TP
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)
22
+ .TP
23
+ \fB\-\-size\fR \fI<BYTES>\fR
24
+ Exact byte size to pair with \-\-hash, narrowing the lookup to records of that size
25
+ .TP
26
+ \fB\-d\fR, \fB\-\-database\fR \fI<PACK>\fR
27
+ RWFP1 identify pack, raw or Brotli, to search instead of the built\-in data (repeatable)
28
+ .TP
29
+ \fB\-\-system\fR \fI<SYSTEM>\fR
30
+ Search only this system\*(Aqs pack. Takes a canonical platform name or a common alias (e.g. `snes`, `psx`)
31
+ .TP
32
+ \fB\-\-offline\fR
33
+ Assert that identify performs no network access (it never does natively; this flag records the guarantee)
34
+ .TP
35
+ \fB\-\-database\-dir\fR \fI<DIR>\fR
36
+ Directory of installed identify packs (*.pack plus optional catalog.json). Defaults to the per\-user data directory
37
+ .TP
38
+ \fB\-\-exhaustive\-database\-search\fR
39
+ Search every installed pack instead of only the packs the detected platform routes to
40
+ .TP
41
+ \fB\-s\fR, \fB\-\-select\fR \fI<SELECT>\fR
42
+ Pick which file inside the archive to use, by exact name, prefix, or glob (repeatable)
43
+ .TP
44
+ \fB\-\-filter\fR \fI<FILTER>\fR
45
+ Consider only files that look like a rom or a patch, judged by extension (repeatable, comma\-separable)
46
+ .br
47
+
48
+ .br
49
+ \fIPossible values:\fR
50
+ .RS 14
51
+ .IP \(bu 2
52
+ rom
53
+ .IP \(bu 2
54
+ patch
55
+ .RE
56
+ .TP
57
+ \fB\-\-no\-extract\fR
58
+ Do not look inside archives; identify the file itself
59
+ .TP
60
+ \fB\-\-no\-ignore\fR
61
+ Also consider files normally skipped inside archives: readmes, images, checksum sidecars, and OS clutter such as .DS_Store
62
+ .TP
63
+ \fB\-\-no\-trim\-fix\fR
64
+ Skip extra checksums for trimmed and untrimmed ROM forms
65
+ .TP
66
+ \fB\-j\fR, \fB\-\-threads\fR \fI<auto|N>\fR [default: auto]
67
+ How many threads to use at most. auto uses every core; a format may still use fewer
68
+ .TP
69
+ \fB\-h\fR, \fB\-\-help\fR
70
+ Print help (see a summary with \*(Aq\-h\*(Aq)
71
+ .SH "GLOBAL OPTIONS"
72
+ .TP
73
+ \fB\-\-json\fR
74
+ Print one JSON object per line instead of human\-readable output
75
+ .TP
76
+ \fB\-\-progress\fR
77
+ Show progress even when output is piped to a file or another program
78
+ .TP
79
+ \fB\-\-no\-progress\fR
80
+ Hide progress
81
+ .TP
82
+ \fB\-\-log\-level\fR \fI<LOG_LEVEL>\fR
83
+ How much rom\-weaver logs to stderr. Separate from the normal output [default: off]
84
+ .br
85
+
86
+ .br
87
+ \fIPossible values:\fR
88
+ .RS 14
89
+ .IP \(bu 2
90
+ off
91
+ .IP \(bu 2
92
+ error
93
+ .IP \(bu 2
94
+ warn
95
+ .IP \(bu 2
96
+ info
97
+ .IP \(bu 2
98
+ debug
99
+ .IP \(bu 2
100
+ trace
101
+ .RE
102
+ .TP
103
+ \fB\-v\fR, \fB\-\-verbose\fR
104
+ Log more: \-v for info, \-vv for debug, \-vvv for trace
105
+ .TP
106
+ \fB\-q\fR, \fB\-\-quiet\fR
107
+ Log errors only
108
+ .TP
109
+ \fB\-\-dep\-trace\fR
110
+ Also log trace output from bundled libraries (for bug reports)
111
+ .TP
112
+ \fB\-\-color\fR
113
+ Keep colors even when output is piped
114
+ .TP
115
+ \fB\-\-no\-color\fR
116
+ Turn colors off
117
+ .TP
118
+ \fB\-y\fR, \fB\-\-yes\fR
119
+ Answer yes to every confirmation instead of asking. Does not choose between candidates
120
+ .SH SUBCOMMANDS
121
+ .TP
122
+ rom\-weaver\-identify\-database(1)
123
+ Manage the installed identify database packs