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

Overhaul man pages

Browse Source
This commit is contained in:
ISSOtm
2020-03-19 21:23:34 +01:00
parent 51e225cd75
commit 7955447ca4
3 changed files with 743 additions and 695 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/asm/rgbasm.1
View File

@@ -51,9 +51,9 @@ The defaults are 01.
.It Fl D Ar name Ns Oo = Ns Ar value Oc , Fl Fl define Ar name Ns Oo = Ns Ar value Oc .It Fl D Ar name Ns Oo = Ns Ar value Oc , Fl Fl define Ar name Ns Oo = Ns Ar value Oc
Add a string symbol to the compiled source code. Add a string symbol to the compiled source code.
This is equivalent to This is equivalent to
.Ql Ar name Ic EQUS Qq Ar value .Ql Ar name Ic EQUS \(dq Ns Ar value Ns \(dq
in code, or in code, or
.Ql Ar name Ic EQUS Qq 1 .Ql Ar name Ic EQUS \(dq1\(dq
if if
.Ar value .Ar value
is not specified. is not specified.
@@ -182,7 +182,7 @@ This warning is enabled by
Warn when obsolete constructs such as the Warn when obsolete constructs such as the
.Ic jp [hl] .Ic jp [hl]
instruction or instruction or
.Cm HOME .Ic HOME
section type are encountered. section type are encountered.
This warning is enabled by This warning is enabled by
.Fl Wextra . .Fl Wextra .
@@ -201,18 +201,14 @@ for
You can assemble a source file in two ways. You can assemble a source file in two ways.
Straightforward way: Straightforward way:
.Pp .Pp
.Bd -literal -offset indent .Dl $ rgbasm -o bar.o foo.asm
$ rgbasm -o bar.o foo.asm
.Ed
.Pp .Pp
Pipes way: Pipes way:
.Pp .Pp
.Bd -literal -offset indent .Dl $ cat foo.asm | rgbasm -o bar.o -
$ cat foo.asm | rgbasm -o bar.o - .Dl $ rgbasm -o bar.o - < foo.asm
$ rgbasm -o bar.o - < foo.asm
.Ed
.Pp .Pp
The resulting object file is not yet a usable ROM image \(em it must first be run through The resulting object file is not yet a usable ROM image\(emit must first be run through
.Xr rgblink 1 .Xr rgblink 1
and then and then
.Xr rgbfix 1 . .Xr rgbfix 1 .

1404
src/asm/rgbasm.5
View File

File diff suppressed because it is too large Load Diff

16
src/link/rgblink.1
View File

@@ -41,7 +41,7 @@ option to change this.
Similarly, WRAM0 sections are placed in the first 4 KiB of WRAM Similarly, WRAM0 sections are placed in the first 4 KiB of WRAM
.Pq Dq bank 0 , .Pq Dq bank 0 ,
and WRAMX sections are placed in any bank of the last 4 KiB. and WRAMX sections are placed in any bank of the last 4 KiB.
If your ROM doesn't use banked, WRAM you can use the If your ROM doesn't use banked WRAM, you can use the
.Fl w .Fl w
option to change this. option to change this.
.Pp .Pp
@@ -93,14 +93,14 @@ The default is 0.
This option is ignored. This option is ignored.
It was supposed to perform smart linking but fell into disrepair, and so has been removed. It was supposed to perform smart linking but fell into disrepair, and so has been removed.
It will be reimplemented at some point. It will be reimplemented at some point.
.It Fl t , Fl tiny .It Fl t , Fl Fl tiny
Expand the ROM0 section size from 16 KiB to the full 32 KiB assigned to ROM and prohibit the use of ROMX sections. Expand the ROM0 section size from 16 KiB to the full 32 KiB assigned to ROM and prohibit the use of ROMX sections.
Useful for ROMs that fit in 32 KiB. Useful for ROMs that fit in 32 KiB.
.It Fl V , Fl version .It Fl V , Fl Fl version
Print the version of the program and exit. Print the version of the program and exit.
.It Fl v , Fl verbose .It Fl v , Fl Fl verbose
Verbose: enable printing more information to standard error. Verbose: enable printing more information to standard error.
.It Fl w , Fl wramx .It Fl w , Fl Fl wramx
Expand the WRAM0 section size from 4 KiB to the full 8 KiB assigned to WRAM and prohibit the use of WRAMX sections. Expand the WRAM0 section size from 4 KiB to the full 8 KiB assigned to WRAM and prohibit the use of WRAMX sections.
.El .El
.Sh EXAMPLES .Sh EXAMPLES
@@ -115,11 +115,13 @@ 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:
.Pp .Pp
.D1 $ rgbfix -v bar.gb .Dl $ rgbfix -v bar.gb
.Ed
.Pp .Pp
Here is a more complete example: Here is a more complete example:
.Pp .Pp
.D1 $ rgblink -o bin/game.gb -n bin/game.sym -p 0xFF obj/title.o obj/engine.o .Dl $ rgblink -o bin/game.gb -n bin/game.sym -p 0xFF obj/title.o obj/engine.o
.Ed
.Sh BUGS .Sh BUGS
Please report bugs on Please report bugs on
.Lk https://github.com/rednex/rgbds/issues GitHub . .Lk https://github.com/rednex/rgbds/issues GitHub .