Skip to content

Commit a0bb830

Browse files
Rangi42Rangi42
committed
More consistent man page descriptions for CLI options
1 parent 7654c6e commit a0bb830

File tree

4 files changed

+206
-54
lines changed

4 files changed

+206
-54
lines changed

‎man/rgbasm.1‎

Lines changed: 54 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,22 +36,67 @@ The
3636
program creates an RGB object file from an assembly source file.
3737
The object file format is documented in
3838
.Xr rgbds 5 .
39-
.Pp
40-
The input
41-
.Ar asmfile
42-
can be a path to a file, or
43-
.Cm \-
44-
to read from standard input.
45-
.Pp
46-
Note that options can be abbreviated as long as the abbreviation is unambiguous:
39+
.Sh ARGUMENTS
40+
.Nm
41+
accepts the usual short and long options, such as
42+
.Fl V
43+
and
44+
.Fl -version .
45+
Options later in the command line override those set earlier, except for when duplicate options are considered an error.
46+
Options can be abbreviated as long as the abbreviation is unambiguous:
4747
.Fl \-verb
4848
is
4949
.Fl \-verbose ,
5050
but
5151
.Fl \-ver
5252
is invalid because it could also be
5353
.Fl \-version .
54-
The arguments are as follows:
54+
.Pp
55+
Unless otherwise noted, passing
56+
.Ql -
57+
(a single dash) as a file name makes
58+
.Nm
59+
use standard input (for input files) or standard output (for output files).
60+
To suppress this behavior, and open a file in the current directory actually called
61+
.Ql - ,
62+
pass
63+
.Ql ./-
64+
instead.
65+
Using standard input or output for more than one file in a single command may produce unexpected results.
66+
.Pp
67+
.Nm
68+
accepts decimal, hexadecimal, octal, and binary for numeric option arguments.
69+
Decimal numbers are written as usual; hexadecimal numbers must be prefixed with either
70+
.Ql $
71+
or
72+
.Ql 0x ;
73+
octal numbers must be prefixed with either
74+
.Ql &
75+
or
76+
.Ql 0o ;
77+
and binary numbers must be prefixed with either
78+
.Ql %
79+
or
80+
.Ql 0b .
81+
(The prefixes
82+
.Ql $
83+
and
84+
.Ql &
85+
will likely need escaping or quoting to avoid being interpreted by the shell.)
86+
Leading zeros (after the base prefix, if any) are accepted, and letters are not case-sensitive.
87+
For example, all of these are equivalent:
88+
.Ql 42 ,
89+
.Ql 042 ,
90+
.Ql 0x2A ,
91+
.Ql 0X2A ,
92+
.Ql 0x2a ,
93+
.Ql &52 ,
94+
.Ql 0o52 ,
95+
.Ql 0O052 ,
96+
.Ql 0b00101010 ,
97+
.Ql 0B101010 .
98+
.Pp
99+
The following options are accepted:
55100
.Bl -tag -width Ds
56101
.It Fl B Ar param , Fl \-backtrace Ar param
57102
Configures how location backtraces are printed if warnings or errors occur.

‎man/rgbfix.1‎

Lines changed: 58 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -39,23 +39,67 @@ Developers are advised to fill those fields with 0x00 bytes in their source code
3939
.Nm ,
4040
and to have already populated whichever fields they don't specify using
4141
.Nm .
42-
.Pp
43-
The input
44-
.Ar file
45-
can be a path to a file, or
46-
.Cm \-
47-
to read from standard input.
48-
.Pp
49-
Note that options can be abbreviated as long as the abbreviation is unambiguous:
50-
.Fl \-verb
42+
.Sh ARGUMENTS
43+
.Nm
44+
accepts the usual short and long options, such as
45+
.Fl V
46+
and
47+
.Fl -version .
48+
Options later in the command line override those set earlier, except for when duplicate options are considered an error.
49+
Options can be abbreviated as long as the abbreviation is unambiguous:
50+
.Fl \-ver
5151
is
52-
.Fl \-verbose ,
52+
.Fl \-version ,
5353
but
54-
.Fl \-ver
54+
.Fl \-v
5555
is invalid because it could also be
56-
.Fl \-version .
57-
Options later in the command line override those set earlier.
58-
Accepted options are as follows:
56+
.Fl \-validate .
57+
.Pp
58+
Unless otherwise noted, passing
59+
.Ql -
60+
(a single dash) as a file name makes
61+
.Nm
62+
use standard input (for input files) or standard output (for output files).
63+
To suppress this behavior, and open a file in the current directory actually called
64+
.Ql - ,
65+
pass
66+
.Ql ./-
67+
instead.
68+
Using standard input or output for more than one file in a single command may produce unexpected results.
69+
.Pp
70+
.Nm
71+
accepts decimal, hexadecimal, octal, and binary for numeric option arguments.
72+
Decimal numbers are written as usual; hexadecimal numbers must be prefixed with either
73+
.Ql $
74+
or
75+
.Ql 0x ;
76+
octal numbers must be prefixed with either
77+
.Ql &
78+
or
79+
.Ql 0o ;
80+
and binary numbers must be prefixed with either
81+
.Ql %
82+
or
83+
.Ql 0b .
84+
(The prefixes
85+
.Ql $
86+
and
87+
.Ql &
88+
will likely need escaping or quoting to avoid being interpreted by the shell.)
89+
Leading zeros (after the base prefix, if any) are accepted, and letters are not case-sensitive.
90+
For example, all of these are equivalent:
91+
.Ql 42 ,
92+
.Ql 042 ,
93+
.Ql 0x2A ,
94+
.Ql 0X2A ,
95+
.Ql 0x2a ,
96+
.Ql &52 ,
97+
.Ql 0o52 ,
98+
.Ql 0O052 ,
99+
.Ql 0b00101010 ,
100+
.Ql 0B101010 .
101+
.Pp
102+
The following options are accepted:
59103
.Bl -tag -width Ds
60104
.It Fl C , Fl \-color-only
61105
Set the Game Boy Color\(enonly flag

‎man/rgbgfx.1‎

Lines changed: 40 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,13 @@ is to divide the input PNG into 8\[tmu]8 pixel
4343
convert each of those squares into 1bpp or 2bpp tile data, and save all of the tile data in a file.
4444
It also has options to generate a tile map, attribute map, and/or palette set as well; more on that and how the conversion process can be tweaked below.
4545
.Sh ARGUMENTS
46-
Note that options can be abbreviated as long as the abbreviation is unambiguous:
46+
.Nm
47+
accepts the usual short and long options, such as
48+
.Fl V
49+
and
50+
.Fl -version .
51+
Options later in the command line override those set earlier, except for when duplicate options are considered an error.
52+
Options can be abbreviated as long as the abbreviation is unambiguous:
4753
.Fl \-verb
4854
is
4955
.Fl \-verbose ,
@@ -52,26 +58,6 @@ but
5258
is invalid because it could also be
5359
.Fl \-version .
5460
.Pp
55-
.Nm
56-
accepts decimal, binary, and hexadecimal numbers in option arguments.
57-
Decimal numbers are written as usual; binary numbers must be prefixed with either
58-
.Ql %
59-
or
60-
.Ql 0b ,
61-
and hexadecimal numbers must be prefixed with either
62-
.Ql $
63-
(which will likely need escaping or quoting to avoid being interpreted by the shell), or
64-
.Ql 0x .
65-
Leading zeros (after the base prefix, if any) are accepted, and letters are not case-sensitive.
66-
All of these are equivalent:
67-
.Ql 42 ,
68-
.Ql 042 ,
69-
.Ql 0b00101010 ,
70-
.Ql 0B101010 ,
71-
.Ql 0x2A ,
72-
.Ql 0X2A ,
73-
.Ql 0x2a .
74-
.Pp
7561
Unless otherwise noted, passing
7662
.Ql -
7763
(a single dash) as a file name makes
@@ -82,7 +68,39 @@ To suppress this behavior, and open a file in the current directory actually cal
8268
pass
8369
.Ql ./-
8470
instead.
85-
Using standard input or output more than once in a single command will likely produce unexpected results.
71+
Using standard input or output for more than one file in a single command may produce unexpected results.
72+
.Pp
73+
.Nm
74+
accepts decimal, hexadecimal, octal, and binary for numeric option arguments.
75+
Decimal numbers are written as usual; hexadecimal numbers must be prefixed with either
76+
.Ql $
77+
or
78+
.Ql 0x ;
79+
octal numbers must be prefixed with either
80+
.Ql &
81+
or
82+
.Ql 0o ;
83+
and binary numbers must be prefixed with either
84+
.Ql %
85+
or
86+
.Ql 0b .
87+
(The prefixes
88+
.Ql $
89+
and
90+
.Ql &
91+
will likely need escaping or quoting to avoid being interpreted by the shell.)
92+
Leading zeros (after the base prefix, if any) are accepted, and letters are not case-sensitive.
93+
For example, all of these are equivalent:
94+
.Ql 42 ,
95+
.Ql 042 ,
96+
.Ql 0x2A ,
97+
.Ql 0X2A ,
98+
.Ql 0x2a ,
99+
.Ql &52 ,
100+
.Ql 0o52 ,
101+
.Ql 0O052 ,
102+
.Ql 0b00101010 ,
103+
.Ql 0B101010 .
86104
.Pp
87105
The following options are accepted:
88106
.Bl -tag -width Ds

‎man/rgblink.1‎

Lines changed: 54 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,22 +48,67 @@ Also, if your ROM is designed for a monochrome Game Boy, you can make sure that
4848
option, which implies
4949
.Fl w
5050
but also prohibits the use of banked VRAM.
51-
.Pp
52-
The input
53-
.Ar file
54-
can be a path to a file, or
55-
.Cm \-
56-
to read from standard input.
57-
.Pp
58-
Note that options can be abbreviated as long as the abbreviation is unambiguous:
51+
.Sh ARGUMENTS
52+
.Nm
53+
accepts the usual short and long options, such as
54+
.Fl V
55+
and
56+
.Fl -version .
57+
Options later in the command line override those set earlier, except for when duplicate options are considered an error.
58+
Options can be abbreviated as long as the abbreviation is unambiguous:
5959
.Fl \-verb
6060
is
6161
.Fl \-verbose ,
6262
but
6363
.Fl \-ver
6464
is invalid because it could also be
6565
.Fl \-version .
66-
The arguments are as follows:
66+
.Pp
67+
Unless otherwise noted, passing
68+
.Ql -
69+
(a single dash) as a file name makes
70+
.Nm
71+
use standard input (for input files) or standard output (for output files).
72+
To suppress this behavior, and open a file in the current directory actually called
73+
.Ql - ,
74+
pass
75+
.Ql ./-
76+
instead.
77+
Using standard input or output for more than one file in a single command may produce unexpected results.
78+
.Pp
79+
.Nm
80+
accepts decimal, hexadecimal, octal, and binary for numeric option arguments.
81+
Decimal numbers are written as usual; hexadecimal numbers must be prefixed with either
82+
.Ql $
83+
or
84+
.Ql 0x ;
85+
octal numbers must be prefixed with either
86+
.Ql &
87+
or
88+
.Ql 0o ;
89+
and binary numbers must be prefixed with either
90+
.Ql %
91+
or
92+
.Ql 0b .
93+
(The prefixes
94+
.Ql $
95+
and
96+
.Ql &
97+
will likely need escaping or quoting to avoid being interpreted by the shell.)
98+
Leading zeros (after the base prefix, if any) are accepted, and letters are not case-sensitive.
99+
For example, all of these are equivalent:
100+
.Ql 42 ,
101+
.Ql 042 ,
102+
.Ql 0x2A ,
103+
.Ql 0X2A ,
104+
.Ql 0x2a ,
105+
.Ql &52 ,
106+
.Ql 0o52 ,
107+
.Ql 0O052 ,
108+
.Ql 0b00101010 ,
109+
.Ql 0B101010 .
110+
.Pp
111+
The following options are accepted:
67112
.Bl -tag -width Ds
68113
.It Fl B Ar param , Fl \-backtrace Ar param
69114
Configures how location backtraces are printed if warnings or errors occur.

0 commit comments

Comments
 (0)