mirror of
https://github.com/gbdev/rgbds.git
synced 2025-11-20 18:22:07 +00:00
Fix documentation in HTML format
For some reason, `No` looks weird in the HTML version of the docs. Some other random fixes. Tables in src/asm/rgbasm.5 are still broken in the HTML docs. Signed-off-by: Antonio Niño Díaz <antonio_nd@outlook.com>
This commit is contained in:
@@ -12,7 +12,7 @@
|
|||||||
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
.\"
|
.\"
|
||||||
.Dd April 12, 2017
|
.Dd April 16, 2017
|
||||||
.Dt RGBASM 5
|
.Dt RGBASM 5
|
||||||
.Os RGBDS Manual
|
.Os RGBDS Manual
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
@@ -79,7 +79,7 @@ Valid banks range from 0 to 15.
|
|||||||
.It Sy WRAM0
|
.It Sy WRAM0
|
||||||
A general-purpose RAM section.
|
A general-purpose RAM section.
|
||||||
Mapped to memory at $C000–$CFFF, or $C000-$DFFF if DMG mode is enabled in
|
Mapped to memory at $C000–$CFFF, or $C000-$DFFF if DMG mode is enabled in
|
||||||
.Xr rgblink 1.
|
.Xr rgblink 1 .
|
||||||
Can only allocate memory, not fill it.
|
Can only allocate memory, not fill it.
|
||||||
.It Sy WRAMX
|
.It Sy WRAMX
|
||||||
A banked general-purpose RAM section.
|
A banked general-purpose RAM section.
|
||||||
@@ -87,7 +87,7 @@ Mapped to memory at $D000–$DFFF.
|
|||||||
Can only allocate memory, not fill it.
|
Can only allocate memory, not fill it.
|
||||||
Valid banks range from 1 to 7.
|
Valid banks range from 1 to 7.
|
||||||
Not available if DMG mode is enabled in
|
Not available if DMG mode is enabled in
|
||||||
.Xr rgblink 1.
|
.Xr rgblink 1 .
|
||||||
.It Sy OAM
|
.It Sy OAM
|
||||||
An object attributes RAM section.
|
An object attributes RAM section.
|
||||||
Mapped to memory at $FE00-$FE9F.
|
Mapped to memory at $FE00-$FE9F.
|
||||||
@@ -444,7 +444,8 @@ to
|
|||||||
if you perform further calculations on them.
|
if you perform further calculations on them.
|
||||||
For instance, if you pass 1 + 2 as the first argument and then do
|
For instance, if you pass 1 + 2 as the first argument and then do
|
||||||
.Ic PRINTV
|
.Ic PRINTV
|
||||||
.Ic \[rs]1 Li * 2
|
.Ic \[rs]1
|
||||||
|
* 2
|
||||||
you will get the value 5 on screen and not 6 as you might have expected.
|
you will get the value 5 on screen and not 6 as you might have expected.
|
||||||
.Pp
|
.Pp
|
||||||
In reality, up to 256 arguments can be passed to a macro, but you can only use
|
In reality, up to 256 arguments can be passed to a macro, but you can only use
|
||||||
@@ -550,7 +551,8 @@ Consequently,
|
|||||||
.Ic DB
|
.Ic DB
|
||||||
and
|
and
|
||||||
.Ic DW
|
.Ic DW
|
||||||
can be used in a Sy WRAM0/WRAMX/HRAM/VRAM/SRAM
|
can be used in a
|
||||||
|
.Sy WRAM0 No / Sy WRAMX No / Sy HRAM No / Sy VRAM No / Sy SRAM
|
||||||
section.
|
section.
|
||||||
.Ss Declaring variables in a RAM section
|
.Ss Declaring variables in a RAM section
|
||||||
.Ic DS
|
.Ic DS
|
||||||
|
|||||||
@@ -12,7 +12,7 @@
|
|||||||
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
.\"
|
.\"
|
||||||
.Dd April 8, 2017
|
.Dd April 16, 2017
|
||||||
.Dt RGBFIX 1
|
.Dt RGBFIX 1
|
||||||
.Os RGBDS Manual
|
.Os RGBDS Manual
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
@@ -102,7 +102,10 @@ Set the title string
|
|||||||
to a given string, truncated to at most 16 characters.
|
to a given string, truncated to at most 16 characters.
|
||||||
It is recommended to use 15 characters instead, to avoid clashing with the CGB
|
It is recommended to use 15 characters instead, to avoid clashing with the CGB
|
||||||
flag
|
flag
|
||||||
.Pq Fl c No or Fl C .
|
.Po Fl c
|
||||||
|
or
|
||||||
|
.Fl C
|
||||||
|
.Pc .
|
||||||
If both this and the game ID are set, the game ID will overwrite the
|
If both this and the game ID are set, the game ID will overwrite the
|
||||||
overlapping portion of the title.
|
overlapping portion of the title.
|
||||||
.It Fl v
|
.It Fl v
|
||||||
|
|||||||
638
src/gbz80.7
638
src/gbz80.7
File diff suppressed because it is too large
Load Diff
@@ -12,7 +12,7 @@
|
|||||||
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
.\"
|
.\"
|
||||||
.Dd April 12, 2017
|
.Dd April 16, 2017
|
||||||
.Dt RGBLINK 5
|
.Dt RGBLINK 5
|
||||||
.Os RGBDS Manual
|
.Os RGBDS Manual
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
@@ -33,27 +33,33 @@ Any line can contain a comment starting with
|
|||||||
.Ql \&;
|
.Ql \&;
|
||||||
that ends at the end of the line:
|
that ends at the end of the line:
|
||||||
.Pp
|
.Pp
|
||||||
ROMX $F ; This is a comment
|
.Bd -literal -offset indent
|
||||||
"Functions to read array"
|
ROMX $F ; This is a comment
|
||||||
ALIGN 8
|
"Functions to read array"
|
||||||
"Array aligned to 256 bytes"
|
ALIGN 8
|
||||||
|
"Array aligned to 256 bytes"
|
||||||
|
|
||||||
WRAMX 2
|
WRAMX 2
|
||||||
"Some variables"
|
"Some variables"
|
||||||
|
.Ed
|
||||||
.Pp
|
.Pp
|
||||||
Numbers can be in decimal or hexadecimal format (the prefix is
|
Numbers can be in decimal or hexadecimal format (the prefix is
|
||||||
.Ql $ ) .
|
.Ql $ ) .
|
||||||
It is an error if any bank or command is found before setting a bank.
|
It is an error if any bank or command is found before setting a bank.
|
||||||
.Pp
|
.Pp
|
||||||
Files can be included by using the
|
Files can be included by using the
|
||||||
.Ar INCLUDE No keyword followed by a string with the path of the file that has
|
.Ar INCLUDE
|
||||||
to be included.
|
keyword followed by a string with the path of the file that has to be included.
|
||||||
.Pp
|
.Pp
|
||||||
The possible bank types are:
|
The possible bank types are:
|
||||||
.Sy ROM0 , ROMX , VRAM , WRAM0 , WRAMX , OAM No and Sy HRAM .
|
.Sy ROM0 , ROMX , VRAM , WRAM0 , WRAMX , OAM
|
||||||
|
and
|
||||||
|
.Sy HRAM .
|
||||||
Types
|
Types
|
||||||
.Sy ROMX , VRAM , WRAMX No and Sy SRAM No are banked, which means that it is
|
.Sy ROMX , VRAM , WRAMX
|
||||||
needed to specify a bank after the type.
|
and
|
||||||
|
.Sy SRAM
|
||||||
|
are banked, which means that it is needed to specify a bank after the type.
|
||||||
.Pp
|
.Pp
|
||||||
When a new bank statement is found, sections found after it will be placed
|
When a new bank statement is found, sections found after it will be placed
|
||||||
right from the beginning of that bank.
|
right from the beginning of that bank.
|
||||||
@@ -61,15 +67,20 @@ If the linkerscript switches to a different bank and then it comes back to the
|
|||||||
previous one it will continue from the last address that was used.
|
previous one it will continue from the last address that was used.
|
||||||
.Pp
|
.Pp
|
||||||
The only two commands are
|
The only two commands are
|
||||||
.Ar ORG No and Ar ALIGN :
|
.Ar ORG
|
||||||
|
and
|
||||||
|
.Ar ALIGN :
|
||||||
.Bl -bullet
|
.Bl -bullet
|
||||||
.It
|
.It
|
||||||
.Ar ORG No sets the address in which new sections will be placed.
|
.Ar ORG
|
||||||
|
sets the address in which new sections will be placed.
|
||||||
It can not be lower than the current address.
|
It can not be lower than the current address.
|
||||||
.It
|
.It
|
||||||
.Ar ALIGN No will increase the address until it is aligned to the specified
|
.Ar ALIGN
|
||||||
boundary (it tries to set to 0 the number of bits specified after the command:
|
will increase the address until it is aligned to the specified boundary (it
|
||||||
.Ar ALIGN No 8 No will align to No $100 ) .
|
tries to set to 0 the number of bits specified after the command:
|
||||||
|
.Sy ALIGN 8
|
||||||
|
will align to $100).
|
||||||
.El
|
.El
|
||||||
.Pp
|
.Pp
|
||||||
Note: The bank, alignment, address and type of sections can be specified both
|
Note: The bank, alignment, address and type of sections can be specified both
|
||||||
|
|||||||
Reference in New Issue
Block a user