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
|
||||
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
.\"
|
||||
.Dd April 12, 2017
|
||||
.Dd April 16, 2017
|
||||
.Dt RGBASM 5
|
||||
.Os RGBDS Manual
|
||||
.Sh NAME
|
||||
@@ -444,7 +444,8 @@ to
|
||||
if you perform further calculations on them.
|
||||
For instance, if you pass 1 + 2 as the first argument and then do
|
||||
.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.
|
||||
.Pp
|
||||
In reality, up to 256 arguments can be passed to a macro, but you can only use
|
||||
@@ -550,7 +551,8 @@ Consequently,
|
||||
.Ic DB
|
||||
and
|
||||
.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.
|
||||
.Ss Declaring variables in a RAM section
|
||||
.Ic DS
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
.\"
|
||||
.Dd April 8, 2017
|
||||
.Dd April 16, 2017
|
||||
.Dt RGBFIX 1
|
||||
.Os RGBDS Manual
|
||||
.Sh NAME
|
||||
@@ -102,7 +102,10 @@ Set the title string
|
||||
to a given string, truncated to at most 16 characters.
|
||||
It is recommended to use 15 characters instead, to avoid clashing with the CGB
|
||||
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
|
||||
overlapping portion of the title.
|
||||
.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
|
||||
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
.\"
|
||||
.Dd April 12, 2017
|
||||
.Dd April 16, 2017
|
||||
.Dt RGBLINK 5
|
||||
.Os RGBDS Manual
|
||||
.Sh NAME
|
||||
@@ -33,6 +33,7 @@ Any line can contain a comment starting with
|
||||
.Ql \&;
|
||||
that ends at the end of the line:
|
||||
.Pp
|
||||
.Bd -literal -offset indent
|
||||
ROMX $F ; This is a comment
|
||||
"Functions to read array"
|
||||
ALIGN 8
|
||||
@@ -40,20 +41,25 @@ that ends at the end of the line:
|
||||
|
||||
WRAMX 2
|
||||
"Some variables"
|
||||
.Ed
|
||||
.Pp
|
||||
Numbers can be in decimal or hexadecimal format (the prefix is
|
||||
.Ql $ ) .
|
||||
It is an error if any bank or command is found before setting a bank.
|
||||
.Pp
|
||||
Files can be included by using the
|
||||
.Ar INCLUDE No keyword followed by a string with the path of the file that has
|
||||
to be included.
|
||||
.Ar INCLUDE
|
||||
keyword followed by a string with the path of the file that has to be included.
|
||||
.Pp
|
||||
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
|
||||
.Sy ROMX , VRAM , WRAMX No and Sy SRAM No are banked, which means that it is
|
||||
needed to specify a bank after the type.
|
||||
.Sy ROMX , VRAM , WRAMX
|
||||
and
|
||||
.Sy SRAM
|
||||
are banked, which means that it is needed to specify a bank after the type.
|
||||
.Pp
|
||||
When a new bank statement is found, sections found after it will be placed
|
||||
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.
|
||||
.Pp
|
||||
The only two commands are
|
||||
.Ar ORG No and Ar ALIGN :
|
||||
.Ar ORG
|
||||
and
|
||||
.Ar ALIGN :
|
||||
.Bl -bullet
|
||||
.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
|
||||
.Ar ALIGN No will increase the address until it is aligned to the specified
|
||||
boundary (it tries to set to 0 the number of bits specified after the command:
|
||||
.Ar ALIGN No 8 No will align to No $100 ) .
|
||||
.Ar ALIGN
|
||||
will increase the address until it is aligned to the specified boundary (it
|
||||
tries to set to 0 the number of bits specified after the command:
|
||||
.Sy ALIGN 8
|
||||
will align to $100).
|
||||
.El
|
||||
.Pp
|
||||
Note: The bank, alignment, address and type of sections can be specified both
|
||||
|
||||
Reference in New Issue
Block a user