@@ -3,7 +3,7 @@ <h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a><
33< table class ="Nm ">
44 < tr >
55 < td > < code class ="Nm "> rgbfix</ code > </ td >
6- < td > [< code class ="Fl "> < a href ="#h "> -h</ a > < a href ="#j "> j</ a > < a href ="#O "> O</ a > < a href ="#s "> s</ a > < a href ="#V "> V</ a > < a href ="#v "> v</ a > </ code > ] [< code class ="Fl "> < a href ="#C "> -C</ a > </ code > |
6+ < td > [< code class ="Fl "> < a href ="#h "> -h</ a > < a href ="#j "> j</ a > < a href ="#O "> O</ a > < a href ="#s "> s</ a > < a href ="#V "> V</ a > < a href ="#v "> v</ a > < a href =" #w " > w </ a > < /code > ] [< code class ="Fl "> < a href ="#C "> -C</ a > </ code > |
77 < code class ="Fl "> < a href ="#c "> -c</ a > </ code > ] [< code class ="Fl "> < a href ="#f "> -f</ a > </ code >
88 < var class ="Ar "> fix_spec</ var > ] [< code class ="Fl "> < a href ="#i "> -i</ a > </ code >
99 < var class ="Ar "> game_id</ var > ] [< code class ="Fl "> < a href ="#k "> -k</ a > </ code >
@@ -15,7 +15,8 @@ <h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a><
1515 < var class ="Ar "> out_file</ var > ] [< code class ="Fl "> < a href ="#p "> -p</ a > </ code >
1616 < var class ="Ar "> pad_value</ var > ] [< code class ="Fl "> < a href ="#r "> -r</ a > </ code >
1717 < var class ="Ar "> ram_size</ var > ] [< code class ="Fl "> < a href ="#t "> -t</ a > </ code >
18- < var class ="Ar "> title_str</ var > ] [< var class ="Ar "> file ...</ var > ]</ td >
18+ < var class ="Ar "> title_str</ var > ] [< code class ="Fl "> < a href ="#W "> -W</ a > </ code >
19+ < var class ="Ar "> warning</ var > ] [< var class ="Ar "> file ...</ var > ]</ td >
1920 </ tr >
2021</ table >
2122</ section >
@@ -82,8 +83,7 @@ <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIP
8283 < var class ="Ar "> game_id</ var > </ dt >
8384 < dd > Set the game ID string
8485 (< span class ="Ad "> 0x13F</ span > –< span class ="Ad "> 0x142</ span > ) to a
85- given string. If it's longer than 4 chars, it will be truncated, and a
86- warning emitted.</ dd >
86+ given string. If it's longer than 4 characters, it will be truncated.</ dd >
8787 < dt id ="j "> < a class ="permalink " href ="#j "> < code class ="Fl "> -j</ code > </ a > ,
8888 < code class ="Fl "> --non-japanese</ code > </ dt >
8989 < dd > Set the non-Japanese region flag (< span class ="Ad "> 0x14A</ span > ) to
@@ -93,8 +93,7 @@ <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIP
9393 < var class ="Ar "> licensee_str</ var > </ dt >
9494 < dd > Set the new licensee string
9595 (< span class ="Ad "> 0x144</ span > –< span class ="Ad "> 0x145</ span > ) to a
96- given string. If it's longer than 2 chars, it will be truncated, and a
97- warning emitted.</ dd >
96+ given string. If it's longer than 2 characters, it will be truncated.</ dd >
9897 < dt id ="L~2 "> < a class ="permalink " href ="#L~2 "> < code class ="Fl "> -L</ code > </ a >
9998 < var class ="Ar "> logo_file</ var > , < code class ="Fl "> --logo</ code >
10099 < var class ="Ar "> logo_file</ var > </ dt >
@@ -114,7 +113,8 @@ <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIP
114113 to 0xFF.
115114 < p class ="Pp "> This value may also be an MBC name. The list of accepted names
116115 can be obtained by passing
117- ‘< code class ="Li "> < code class ="Cm "> help</ code > </ code > ’ as
116+ ‘< code class ="Li "> < code class ="Cm "> help</ code > </ code > ’ or
117+ ‘< code class ="Li "> < code class ="Cm "> list</ code > </ code > ’ as
118118 the argument. Any amount of whitespace (space and tabs) is allowed
119119 around plus signs, and the order of "components" is free, as
120120 long as the MBC name is first. There are special considerations to take
@@ -128,8 +128,7 @@ <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIP
128128 0 to 0xFF.</ dd >
129129 < dt id ="O "> < a class ="permalink " href ="#O "> < code class ="Fl "> -O</ code > </ a > ,
130130 < code class ="Fl "> --overwrite</ code > </ dt >
131- < dd > Allow overwriting different non-zero bytes in the header without a warning
132- being emitted.</ dd >
131+ < dd > Alias for < code class ="Fl "> -Wno-overwrite</ code > .</ dd >
133132 < dt id ="o "> < a class ="permalink " href ="#o "> < code class ="Fl "> -o</ code > </ a >
134133 < var class ="Ar "> out_file</ var > , < code class ="Fl "> --output</ code >
135134 < var class ="Ar "> out_file</ var > </ dt >
@@ -153,25 +152,85 @@ <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIP
153152 < dt id ="s "> < a class ="permalink " href ="#s "> < code class ="Fl "> -s</ code > </ a > ,
154153 < code class ="Fl "> --sgb-compatible</ code > </ dt >
155154 < dd > Set the SGB flag (< span class ="Ad "> 0x146</ span > ) to 0x03. This flag will
156- be ignored by the SGB unless the old licensee code is 0x33! If this is
157- given as well as < code class ="Fl "> -l</ code > , but is not set to 0x33, a
158- warning will be printed.</ dd >
155+ be ignored by the SGB unless the old licensee code
156+ (< code class ="Fl "> --l</ code > ) is 0x33!</ dd >
159157 < dt id ="t "> < a class ="permalink " href ="#t "> < code class ="Fl "> -t</ code > </ a >
160158 < var class ="Ar "> title</ var > , < code class ="Fl "> --title</ code >
161159 < var class ="Ar "> title</ var > </ dt >
162160 < dd > Set the title string
163161 (< span class ="Ad "> 0x134</ span > –< span class ="Ad "> 0x143</ span > ) to a
164- given string. If the title is longer than the max length, it will be
165- truncated, and a warning emitted . The max length is 11 characters if the
166- game ID (< code class ="Fl "> -i</ code > ) is specified, 15 characters if the
167- CGB flag (< code class ="Fl "> -c</ code > or < code class ="Fl "> -C</ code > ) is
168- specified but the game ID is not, and 16 characters otherwise.</ dd >
162+ given string. If the title is longer than the maximum length, it will be
163+ truncated. The max length is 11 characters if the game ID
164+ (< code class ="Fl "> -i</ code > ) is specified, 15 characters if the CGB flag
165+ (< code class ="Fl "> -c</ code > or < code class ="Fl "> -C</ code > ) is specified
166+ but the game ID is not, and 16 characters otherwise.</ dd >
169167 < dt id ="V "> < a class ="permalink " href ="#V "> < code class ="Fl "> -V</ code > </ a > ,
170168 < code class ="Fl "> --version</ code > </ dt >
171169 < dd > Print the version of the program and exit.</ dd >
172170 < dt id ="v "> < a class ="permalink " href ="#v "> < code class ="Fl "> -v</ code > </ a > ,
173171 < code class ="Fl "> --validate</ code > </ dt >
174172 < dd > Equivalent to < code class ="Fl "> -f</ code > < code class ="Cm "> lhg</ code > .</ dd >
173+ < dt id ="W "> < a class ="permalink " href ="#W "> < code class ="Fl "> -W</ code > </ a >
174+ < var class ="Ar "> warning</ var > , < code class ="Fl "> --warning</ code >
175+ < var class ="Ar "> warning</ var > </ dt >
176+ < dd > Set warning flag < var class ="Ar "> warning</ var > . A warning message will be
177+ printed if < var class ="Ar "> warning</ var > is an unknown warning flag. See
178+ the < a class ="Sx " href ="#DIAGNOSTICS "> DIAGNOSTICS</ a > section for a list
179+ of warnings.</ dd >
180+ < dt id ="w "> < a class ="permalink " href ="#w "> < code class ="Fl "> -w</ code > </ a > </ dt >
181+ < dd > Disable all warning output, even when turned into errors.</ dd >
182+ </ dl >
183+ </ section >
184+ < section class ="Sh ">
185+ < h2 class ="Sh " id ="DIAGNOSTICS "> < a class ="permalink " href ="#DIAGNOSTICS "> DIAGNOSTICS</ a > </ h2 >
186+ < p class ="Pp "> Warnings are diagnostic messages that indicate possibly erroneous
187+ behavior that does not necessarily compromise the header-fixing process. The
188+ following options alter the way warnings are processed.</ p >
189+ < dl class ="Bl-tag ">
190+ < dt id ="Werror "> < a class ="permalink " href ="#Werror "> < code class ="Fl "> -Werror</ code > </ a > </ dt >
191+ < dd > Make all warnings into errors. This can be negated as
192+ < code class ="Fl "> -Wno-error</ code > to prevent turning all warnings into
193+ errors.</ dd >
194+ < dt id ="Werror= "> < a class ="permalink " href ="#Werror= "> < code class ="Fl "> -Werror=</ code > </ a > </ dt >
195+ < dd > Make the specified warning or meta warning into an error. A warning's name
196+ is appended (example: < code class ="Fl "> -Werror=overwrite</ code > ), and this
197+ warning is implicitly enabled and turned into an error. This can be
198+ negated as < code class ="Fl "> -Wno-error=</ code > to prevent turning a
199+ specified warning into an error, even if < code class ="Fl "> -Werror</ code >
200+ is in effect.</ dd >
201+ </ dl >
202+ < p class ="Pp "> The following warnings are “meta” warnings, that
203+ enable a collection of other warnings. If a specific warning is toggled via
204+ a meta flag and a specific one, the more specific one takes priority. The
205+ position on the command-line acts as a tie breaker, the last one taking
206+ effect.</ p >
207+ < dl class ="Bl-tag ">
208+ < dt id ="Wall "> < a class ="permalink " href ="#Wall "> < code class ="Fl "> -Wall</ code > </ a > </ dt >
209+ < dd > This enables warnings that are likely to indicate an error or undesired
210+ behavior, and that can easily be fixed.</ dd >
211+ < dt id ="Weverything "> < a class ="permalink " href ="#Weverything "> < code class ="Fl "> -Weverything</ code > </ a > </ dt >
212+ < dd > Enables literally every warning.</ dd >
213+ </ dl >
214+ < p class ="Pp "> The following warnings are actual warning flags; with each
215+ description, the corresponding warning flag is included. Note that each of
216+ these flag also has a negation (for example,
217+ < code class ="Fl "> -Wtruncation</ code > enables the warning that
218+ < code class ="Fl "> -Wno-truncation</ code > disables; and
219+ < code class ="Fl "> -Wall</ code > enables every warning that
220+ < code class ="Fl "> -Wno-all</ code > disables). Only the non-default flag is
221+ listed here. Ignoring the “no-” prefix, entries are listed
222+ alphabetically.</ p >
223+ < dl class ="Bl-tag ">
224+ < dt id ="Wno-mbc "> < a class ="permalink " href ="#Wno-mbc "> < code class ="Fl "> -Wno-mbc</ code > </ a > </ dt >
225+ < dd > Warn when there are inconsistencies with or caveats about the specified
226+ MBC type.</ dd >
227+ < dt id ="Wno-overwrite "> < a class ="permalink " href ="#Wno-overwrite "> < code class ="Fl "> -Wno-overwrite</ code > </ a > </ dt >
228+ < dd > Warn when overwriting different non-zero bytes in the header.</ dd >
229+ < dt id ="Wno-sgb "> < a class ="permalink " href ="#Wno-sgb "> < code class ="Fl "> -Wno-sgb</ code > </ a > </ dt >
230+ < dd > Warn when the SGB flag (< code class ="Fl "> -s</ code > ) conflicts with the old
231+ licensee code (< code class ="Fl "> -l</ code > ).</ dd >
232+ < dt id ="Wno-truncation "> < a class ="permalink " href ="#Wno-truncation "> < code class ="Fl "> -Wno-truncation</ code > </ a > </ dt >
233+ < dd > Warn when truncating values to fit the available space.</ dd >
175234</ dl >
176235</ section >
177236< section class ="Sh ">
@@ -220,8 +279,7 @@ <h3 class="Ss" id="MBC_name"><a class="permalink" href="#MBC_name">MBC
220279 however, ‘< code class ="Li "> RAM</ code > ’ should not be
221280 specified, as the TPP1 mapper implicitly requests RAM if a non-zero RAM size
222281 is specified. Therefore, < code class ="Nm "> rgbfix</ code > will ignore the
223- ‘< code class ="Li "> RAM</ code > ’ feature on a TPP1 mapper with a
224- warning.</ p >
282+ ‘< code class ="Li "> RAM</ code > ’ feature on a TPP1 mapper.</ p >
225283</ section >
226284< section class ="Ss ">
227285< h3 class ="Ss " id ="Special_considerations "> < a class ="permalink " href ="#Special_considerations "> Special
0 commit comments