gbdev/rgbds
1
0
Fork 0
mirror of https://github.com/gbdev/rgbds.git synced 2025-11-21 18:52:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

In manuals, use wrapping macros instead of literal parens, etc.

Browse Source
This commit is contained in:
Anthony J. Bentley
2011-04-10 00:37:58 -06:00
parent abf8f8255a
commit ba30863b73
2 changed files with 17 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/fix/rgbfix.1
View File

@@ -94,8 +94,8 @@ and the global checksum
Most values in the ROM header are only cosmetic. Most values in the ROM header are only cosmetic.
The bare minimum requirements for a workable image are checksums, the Nintendo The bare minimum requirements for a workable image are checksums, the Nintendo
logo, and (if needed) the CGB/SGB flags. logo, and (if needed) the CGB/SGB flags.
It is a good idea to pad the image to a valid size as well ("valid" meaning a It is a good idea to pad the image to a valid size as well
multiple of 32KiB). .Pq Dq valid No meaning a multiple of 32KiB .
.Pp .Pp
The following will make a plain, no-color Game Boy game without checking for The following will make a plain, no-color Game Boy game without checking for
a valid size: a valid size:
@@ -103,14 +103,19 @@ a valid size:
.D1 $ rgbfix \-v foo.gb .D1 $ rgbfix \-v foo.gb
.Pp .Pp
The following will make a SGB-enabled, color-enabled game with a title of The following will make a SGB-enabled, color-enabled game with a title of
"foobar", and pad it to a multiple of 32KiB. .Dq foobar ,
(The Game Boy itself does not use the title, but some emulators or ROM managers and pad it to a multiple of 32KiB.
might.) .Po
The Game Boy itself does not use the title, but some emulators or ROM managers
might.
.Pc
.Pp .Pp
.D1 $ rgbfix \-vcs \-p 0 \-t foobar baz.gb .D1 $ rgbfix \-vcs \-p 0 \-t foobar baz.gb
.Pp .Pp
The following will duplicate the header (sans global checksum) of the game The following will duplicate the header
"Survival Kids": .Pq sans global checksum
of the game
.Dq Survival Kids :
.Pp .Pp
.D1 $ rgbfix \-cjsv \-k A4 \-m 0x1B \-p 0xFF \-r 3 \-t SURVIVALKIDAVKE SurvivalKids.gbc .D1 $ rgbfix \-cjsv \-k A4 \-m 0x1B \-p 0xFF \-r 3 \-t SURVIVALKIDAVKE SurvivalKids.gbc
.Sh SEE ALSO .Sh SEE ALSO

8
src/link/rgblink.1
View File

@@ -46,7 +46,9 @@ When padding an image, pad with this value. The default is 0x00.
.It Fl s Ar symbol .It Fl s Ar symbol
??? ???
.It Fl t .It Fl t
Write a tiny (32KiB) ROM file. This forces all DATA/CODE sections to be of Write a tiny
.Pq 32KiB
ROM file. This forces all DATA/CODE sections to be of
type HOME, and increases the HOME section size from 16KiB to 32KiB. type HOME, and increases the HOME section size from 16KiB to 32KiB.
.El .El
.Sh EXAMPLES .Sh EXAMPLES
@@ -55,8 +57,8 @@ image like so:
.Pp .Pp
.D1 $ rgblink \-o bar.gb foo.o .D1 $ rgblink \-o bar.gb foo.o
.Pp .Pp
The resulting bar.gb will not have correct checksums (unless you put them in The resulting bar.gb will not have correct checksums
the assembly source). .Pq unless you put them in the assembly source .
You should use You should use
.Xr rgbfix 1 .Xr rgbfix 1
to fix these so that the program will actually run in a Game Boy: to fix these so that the program will actually run in a Game Boy: