mirror of
https://github.com/gbdev/rgbds.git
synced 2025-11-20 10:12:06 +00:00
Fix formatting errors in man pages
As reported by the following command: mandoc -T lint man/* | grep -v "input text line longer than 80 bytes" (One of them also showed up as a warning while setting up Debian packaging.)
This commit is contained in:
18
man/gbz80.7
18
man/gbz80.7
@@ -1317,7 +1317,6 @@ Flags: None affected.
|
|||||||
Rotate bits in register
|
Rotate bits in register
|
||||||
.Ar r8
|
.Ar r8
|
||||||
left, through the carry flag.
|
left, through the carry flag.
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━ Flags ━┓ ┏━━━━━━━ r8 ━━━━━━┓
|
┏━ Flags ━┓ ┏━━━━━━━ r8 ━━━━━━┓
|
||||||
┌─╂─ C ←╂─╂─ b7 ← ... ← b0 ←╂─┐
|
┌─╂─ C ←╂─╂─ b7 ← ... ← b0 ←╂─┐
|
||||||
@@ -1344,7 +1343,6 @@ Set according to result.
|
|||||||
Rotate the byte pointed to by
|
Rotate the byte pointed to by
|
||||||
.Sy HL
|
.Sy HL
|
||||||
left, through the carry flag.
|
left, through the carry flag.
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━ Flags ━┓ ┏━━━━━━ [HL] ━━━━━┓
|
┏━ Flags ━┓ ┏━━━━━━ [HL] ━━━━━┓
|
||||||
┌─╂─ C ←╂─╂─ b7 ← ... ← b0 ←╂─┐
|
┌─╂─ C ←╂─╂─ b7 ← ... ← b0 ←╂─┐
|
||||||
@@ -1362,7 +1360,6 @@ Flags: See
|
|||||||
Rotate register
|
Rotate register
|
||||||
.Sy A
|
.Sy A
|
||||||
left, through the carry flag.
|
left, through the carry flag.
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━ Flags ━┓ ┏━━━━━━━ A ━━━━━━━┓
|
┏━ Flags ━┓ ┏━━━━━━━ A ━━━━━━━┓
|
||||||
┌─╂─ C ←╂─╂─ b7 ← ... ← b0 ←╂─┐
|
┌─╂─ C ←╂─╂─ b7 ← ... ← b0 ←╂─┐
|
||||||
@@ -1389,7 +1386,6 @@ Set according to result.
|
|||||||
Rotate register
|
Rotate register
|
||||||
.Ar r8
|
.Ar r8
|
||||||
left.
|
left.
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━ Flags ━┓ ┏━━━━━━━ r8 ━━━━━━┓
|
┏━ Flags ━┓ ┏━━━━━━━ r8 ━━━━━━┓
|
||||||
┃ C ←╂─┬─╂─ b7 ← ... ← b0 ←╂─┐
|
┃ C ←╂─┬─╂─ b7 ← ... ← b0 ←╂─┐
|
||||||
@@ -1416,7 +1412,6 @@ Set according to result.
|
|||||||
Rotate the byte pointed to by
|
Rotate the byte pointed to by
|
||||||
.Sy HL
|
.Sy HL
|
||||||
left.
|
left.
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━ Flags ━┓ ┏━━━━━━ [HL] ━━━━━┓
|
┏━ Flags ━┓ ┏━━━━━━ [HL] ━━━━━┓
|
||||||
┃ C ←╂─┬─╂─ b7 ← ... ← b0 ←╂─┐
|
┃ C ←╂─┬─╂─ b7 ← ... ← b0 ←╂─┐
|
||||||
@@ -1434,7 +1429,6 @@ Flags: See
|
|||||||
Rotate register
|
Rotate register
|
||||||
.Sy A
|
.Sy A
|
||||||
left.
|
left.
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━ Flags ━┓ ┏━━━━━━━ A ━━━━━━━┓
|
┏━ Flags ━┓ ┏━━━━━━━ A ━━━━━━━┓
|
||||||
┃ C ←╂─┬─╂─ b7 ← ... ← b0 ←╂─┐
|
┃ C ←╂─┬─╂─ b7 ← ... ← b0 ←╂─┐
|
||||||
@@ -1461,7 +1455,6 @@ Set according to result.
|
|||||||
Rotate register
|
Rotate register
|
||||||
.Ar r8
|
.Ar r8
|
||||||
right, through the carry flag.
|
right, through the carry flag.
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓
|
┏━━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓
|
||||||
┌─╂→ b7 → ... → b0 ─╂─╂→ C ─╂─┐
|
┌─╂→ b7 → ... → b0 ─╂─╂→ C ─╂─┐
|
||||||
@@ -1488,7 +1481,6 @@ Set according to result.
|
|||||||
Rotate the byte pointed to by
|
Rotate the byte pointed to by
|
||||||
.Sy HL
|
.Sy HL
|
||||||
right, through the carry flag.
|
right, through the carry flag.
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓
|
┏━━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓
|
||||||
┌─╂→ b7 → ... → b0 ─╂─╂→ C ─╂─┐
|
┌─╂→ b7 → ... → b0 ─╂─╂→ C ─╂─┐
|
||||||
@@ -1506,7 +1498,6 @@ Flags: See
|
|||||||
Rotate register
|
Rotate register
|
||||||
.Sy A
|
.Sy A
|
||||||
right, through the carry flag.
|
right, through the carry flag.
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━━━━━━━ A ━━━━━━━┓ ┏━ Flags ━┓
|
┏━━━━━━━ A ━━━━━━━┓ ┏━ Flags ━┓
|
||||||
┌─╂→ b7 → ... → b0 ─╂─╂→ C ─╂─┐
|
┌─╂→ b7 → ... → b0 ─╂─╂→ C ─╂─┐
|
||||||
@@ -1533,7 +1524,6 @@ Set according to result.
|
|||||||
Rotate register
|
Rotate register
|
||||||
.Ar r8
|
.Ar r8
|
||||||
right.
|
right.
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓
|
┏━━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓
|
||||||
┌─╂→ b7 → ... → b0 ─╂─┬─╂→ C ┃
|
┌─╂→ b7 → ... → b0 ─╂─┬─╂→ C ┃
|
||||||
@@ -1560,7 +1550,6 @@ Set according to result.
|
|||||||
Rotate the byte pointed to by
|
Rotate the byte pointed to by
|
||||||
.Sy HL
|
.Sy HL
|
||||||
right.
|
right.
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓
|
┏━━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓
|
||||||
┌─╂→ b7 → ... → b0 ─╂─┬─╂→ C ┃
|
┌─╂→ b7 → ... → b0 ─╂─┬─╂→ C ┃
|
||||||
@@ -1578,7 +1567,6 @@ Flags: See
|
|||||||
Rotate register
|
Rotate register
|
||||||
.Sy A
|
.Sy A
|
||||||
right.
|
right.
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━━━━━━━ A ━━━━━━━┓ ┏━ Flags ━┓
|
┏━━━━━━━ A ━━━━━━━┓ ┏━ Flags ━┓
|
||||||
┌─╂→ b7 → ... → b0 ─╂─┬─╂→ C ┃
|
┌─╂→ b7 → ... → b0 ─╂─┬─╂→ C ┃
|
||||||
@@ -1708,7 +1696,6 @@ Flags: None affected.
|
|||||||
.Ss SLA r8
|
.Ss SLA r8
|
||||||
Shift Left Arithmetically register
|
Shift Left Arithmetically register
|
||||||
.Ar r8 .
|
.Ar r8 .
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━ Flags ━┓ ┏━━━━━━━ r8 ━━━━━━┓
|
┏━ Flags ━┓ ┏━━━━━━━ r8 ━━━━━━┓
|
||||||
┃ C ←╂─╂─ b7 ← ... ← b0 ←╂─ 0
|
┃ C ←╂─╂─ b7 ← ... ← b0 ←╂─ 0
|
||||||
@@ -1733,7 +1720,6 @@ Set according to result.
|
|||||||
.Ss SLA [HL]
|
.Ss SLA [HL]
|
||||||
Shift Left Arithmetically the byte pointed to by
|
Shift Left Arithmetically the byte pointed to by
|
||||||
.Sy HL .
|
.Sy HL .
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━ Flags ━┓ ┏━━━━━━ [HL] ━━━━━┓
|
┏━ Flags ━┓ ┏━━━━━━ [HL] ━━━━━┓
|
||||||
┃ C ←╂─╂─ b7 ← ... ← b0 ←╂─ 0
|
┃ C ←╂─╂─ b7 ← ... ← b0 ←╂─ 0
|
||||||
@@ -1750,7 +1736,6 @@ Flags: See
|
|||||||
Shift Right Arithmetically register
|
Shift Right Arithmetically register
|
||||||
.Ar r8
|
.Ar r8
|
||||||
.Pq bit 7 of Ar r8 No is unchanged .
|
.Pq bit 7 of Ar r8 No is unchanged .
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓
|
┏━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓
|
||||||
┃ b7 → ... → b0 ─╂─╂→ C ┃
|
┃ b7 → ... → b0 ─╂─╂→ C ┃
|
||||||
@@ -1776,7 +1761,6 @@ Set according to result.
|
|||||||
Shift Right Arithmetically the byte pointed to by
|
Shift Right Arithmetically the byte pointed to by
|
||||||
.Sy HL
|
.Sy HL
|
||||||
.Pq bit 7 of the byte pointed to by Sy HL No is unchanged .
|
.Pq bit 7 of the byte pointed to by Sy HL No is unchanged .
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓
|
┏━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓
|
||||||
┃ b7 → ... → b0 ─╂─╂→ C ┃
|
┃ b7 → ... → b0 ─╂─╂→ C ┃
|
||||||
@@ -1792,7 +1776,6 @@ Flags: See
|
|||||||
.Ss SRL r8
|
.Ss SRL r8
|
||||||
Shift Right Logically register
|
Shift Right Logically register
|
||||||
.Ar r8 .
|
.Ar r8 .
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓
|
┏━━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓
|
||||||
0 ─╂→ b7 → ... → b0 ─╂─╂→ C ┃
|
0 ─╂→ b7 → ... → b0 ─╂─╂→ C ┃
|
||||||
@@ -1817,7 +1800,6 @@ Set according to result.
|
|||||||
.Ss SRL [HL]
|
.Ss SRL [HL]
|
||||||
Shift Right Logically the byte pointed to by
|
Shift Right Logically the byte pointed to by
|
||||||
.Sy HL .
|
.Sy HL .
|
||||||
.Pp
|
|
||||||
.Bd -literal
|
.Bd -literal
|
||||||
┏━━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓
|
┏━━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓
|
||||||
0 ─╂→ b7 → ... → b0 ─╂─╂→ C ┃
|
0 ─╂→ b7 → ... → b0 ─╂─╂→ C ┃
|
||||||
|
|||||||
@@ -344,12 +344,12 @@ and then
|
|||||||
Please report bugs on
|
Please report bugs on
|
||||||
.Lk https://github.com/gbdev/rgbds/issues GitHub .
|
.Lk https://github.com/gbdev/rgbds/issues GitHub .
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr rgbasm 5 ,
|
|
||||||
.Xr rgbfix 1 ,
|
.Xr rgbfix 1 ,
|
||||||
.Xr rgblink 1 ,
|
.Xr rgblink 1 ,
|
||||||
|
.Xr rgbasm 5 ,
|
||||||
|
.Xr gbz80 7 ,
|
||||||
.Xr rgbds 5 ,
|
.Xr rgbds 5 ,
|
||||||
.Xr rgbds 7 ,
|
.Xr rgbds 7
|
||||||
.Xr gbz80 7
|
|
||||||
.Sh HISTORY
|
.Sh HISTORY
|
||||||
.Nm
|
.Nm
|
||||||
was originally written by Carsten S\(/orensen as part of the ASMotor package, and was later packaged in RGBDS by Justin Lloyd.
|
was originally written by Carsten S\(/orensen as part of the ASMotor package, and was later packaged in RGBDS by Justin Lloyd.
|
||||||
|
|||||||
33
man/rgbasm.5
33
man/rgbasm.5
@@ -29,8 +29,8 @@ can be used in its place.
|
|||||||
The syntax is line-based, just as in any other assembler.
|
The syntax is line-based, just as in any other assembler.
|
||||||
Each line may have components in this order:
|
Each line may have components in this order:
|
||||||
.Pp
|
.Pp
|
||||||
.Dl Oo Ar directive Oc Oo Ar ;\ comment Oc
|
.Dl Oo Ar directive Oc Oo ;\ Ns Ar comment Oc
|
||||||
.Dl Oo Ar label: Oc Oo Ar instruction Oo Ar :: instruction ... Oc Oc Oo Ar ;\ comment Oc
|
.Dl Oo Ar label : Oc Oo Ar instruction Oo :: Ar instruction ... Oc Oc Oo ;\ Ns Ar comment Oc
|
||||||
.Pp
|
.Pp
|
||||||
Directives are commands to the assembler itself, such as
|
Directives are commands to the assembler itself, such as
|
||||||
.Ic PRINTLN ,
|
.Ic PRINTLN ,
|
||||||
@@ -406,9 +406,9 @@ There are a number of escape sequences you can use within a string:
|
|||||||
.It Ql \en Ta Newline ($0A)
|
.It Ql \en Ta Newline ($0A)
|
||||||
.It Ql \er Ta Carriage return ($0D)
|
.It Ql \er Ta Carriage return ($0D)
|
||||||
.It Ql \et Ta Tab ($09)
|
.It Ql \et Ta Tab ($09)
|
||||||
.It Qo \e1 Qc \[en] Qo \e9 Qc Ta Macro argument (Only in the body of a macro; see Sx Invoking macros )
|
.It Qo \e1 Qc \[en] Qo \e9 Qc Ta Macro argument Pq Only in the body of a macro; see Sx Invoking macros
|
||||||
.It Ql \e# Ta All Dv _NARG No macro arguments, separated by commas (Only in the body of a macro)
|
.It Ql \e# Ta All Dv _NARG No macro arguments, separated by commas Pq Only in the body of a macro
|
||||||
.It Ql \e@ Ta Label name suffix (Only in the body of a macro or a Ic REPT No block)
|
.It Ql \e@ Ta Label name suffix Pq Only in the body of a macro or a Ic REPT No block
|
||||||
.El
|
.El
|
||||||
(Note that some of those can be used outside of strings, when noted further in this document.)
|
(Note that some of those can be used outside of strings, when noted further in this document.)
|
||||||
.Pp
|
.Pp
|
||||||
@@ -423,9 +423,9 @@ Raw strings are prefixed by a hash
|
|||||||
.Sq # .
|
.Sq # .
|
||||||
Inside them, backslashes and braces are treated like regular characters, so they will not be expanded as macro arguments, interpolated symbols, or escape sequences.
|
Inside them, backslashes and braces are treated like regular characters, so they will not be expanded as macro arguments, interpolated symbols, or escape sequences.
|
||||||
For example, the raw string
|
For example, the raw string
|
||||||
.Ql #"\t\1{s}\"
|
.Ql #"\et\e1{s}\e"
|
||||||
is equivalent to the regular string
|
is equivalent to the regular string
|
||||||
.Ql "\\t\\1\{s}\\" .
|
.Ql "\e\et\e\e1\e{s}\e\e" .
|
||||||
(Note that this prevents raw strings from including the double quote character.)
|
(Note that this prevents raw strings from including the double quote character.)
|
||||||
Raw strings also may be contained in triple quotes for them to be multi-line, so they can include literal newline or quote characters (although still not three quotes in a row).
|
Raw strings also may be contained in triple quotes for them to be multi-line, so they can include literal newline or quote characters (although still not three quotes in a row).
|
||||||
.Pp
|
.Pp
|
||||||
@@ -454,9 +454,9 @@ pattern replaced by interpolating the format
|
|||||||
with its corresponding argument in
|
with its corresponding argument in
|
||||||
.Ar args
|
.Ar args
|
||||||
.Pq So %% Sc is replaced by the So % Sc character .
|
.Pq So %% Sc is replaced by the So % Sc character .
|
||||||
.It Fn INCHARMAP str Ta Returns 1 if Ar str No has an entry in the current charmap, and 0 otherwise.
|
.It Fn INCHARMAP str Ta Returns 1 if Ar str No has an entry in the current charmap, and 0 otherwise .
|
||||||
.It Fn CHARLEN str Ta Returns the number of charmap entries in Ar str No with the current charmap.
|
.It Fn CHARLEN str Ta Returns the number of charmap entries in Ar str No with the current charmap .
|
||||||
.It Fn CHARSUB str pos Ta Returns the substring for the charmap entry at Ar pos No in Ar str No (first character is position 1, last is position -1) with the current charmap.
|
.It Fn CHARSUB str pos Ta Returns the substring for the charmap entry at Ar pos No in Ar str No (first character is position 1, last is position -1) with the current charmap .
|
||||||
.El
|
.El
|
||||||
.Ss Character maps
|
.Ss Character maps
|
||||||
When writing text strings that are meant to be displayed on the Game Boy, the character encoding in the ROM may need to be different than the source file encoding.
|
When writing text strings that are meant to be displayed on the Game Boy, the character encoding in the ROM may need to be different than the source file encoding.
|
||||||
@@ -468,6 +468,7 @@ CHARMAP "<LF>", 10
|
|||||||
CHARMAP "í", 20
|
CHARMAP "í", 20
|
||||||
CHARMAP "A", 128
|
CHARMAP "A", 128
|
||||||
.Ed
|
.Ed
|
||||||
|
.Pp
|
||||||
This would result in
|
This would result in
|
||||||
.Ql db \(dqAmen<LF>\(dq
|
.Ql db \(dqAmen<LF>\(dq
|
||||||
being equivalent to
|
being equivalent to
|
||||||
@@ -483,14 +484,14 @@ and it is automatically selected as the current character map from the beginning
|
|||||||
There is also a character map stack that can be used to save and restore which character map is currently active.
|
There is also a character map stack that can be used to save and restore which character map is currently active.
|
||||||
.Bl -column "NEWCHARMAP name, basename"
|
.Bl -column "NEWCHARMAP name, basename"
|
||||||
.It Sy Command Ta Sy Meaning
|
.It Sy Command Ta Sy Meaning
|
||||||
.It Ic NEWCHARMAP Ar name Ta Creates a new, empty character map called Ar name No and switches to it.
|
.It Ic NEWCHARMAP Ar name Ta Creates a new, empty character map called Ar name No and switches to it .
|
||||||
.It Ic NEWCHARMAP Ar name , basename Ta Creates a new character map called Ar name , No copied from character map Ar basename , No and switches to it.
|
.It Ic NEWCHARMAP Ar name , basename Ta Creates a new character map called Ar name , No copied from character map Ar basename , No and switches to it .
|
||||||
.It Ic SETCHARMAP Ar name Ta Switch to character map Ar name .
|
.It Ic SETCHARMAP Ar name Ta Switch to character map Ar name .
|
||||||
.It Ic PUSHC Ta Push the current character map onto the stack.
|
.It Ic PUSHC Ta Push the current character map onto the stack.
|
||||||
.It Ic POPC Ta Pop a character map off the stack and switch to it.
|
.It Ic POPC Ta Pop a character map off the stack and switch to it.
|
||||||
.El
|
.El
|
||||||
.Pp
|
.Pp
|
||||||
.Sy Note:
|
.Sy Note :
|
||||||
Modifications to a character map take effect immediately from that point onward.
|
Modifications to a character map take effect immediately from that point onward.
|
||||||
.Ss Other functions
|
.Ss Other functions
|
||||||
There are a few other functions that do various useful things:
|
There are a few other functions that do various useful things:
|
||||||
@@ -536,7 +537,7 @@ The result is not constant, since only RGBLINK can compute its value.
|
|||||||
.Ar symbol
|
.Ar symbol
|
||||||
has been defined, FALSE (0) otherwise.
|
has been defined, FALSE (0) otherwise.
|
||||||
String constants are not expanded within the parentheses.
|
String constants are not expanded within the parentheses.
|
||||||
.It Fn HIGH arg Ta Returns the top 8 bits of the operand if Ar arg No is a label or constant, or the top 8-bit register if it is a 16-bit register.
|
.It Fn HIGH arg Ta Returns the top 8 bits of the operand if Ar arg No is a label or constant, or the top 8-bit register if it is a 16-bit register .
|
||||||
.It Fn LOW arg Ta Returns the bottom 8 bits of the operand if Ar arg No is a label or constant, or the bottom 8-bit register if it is a 16-bit register Pq Cm AF No isn't a valid register for this function .
|
.It Fn LOW arg Ta Returns the bottom 8 bits of the operand if Ar arg No is a label or constant, or the bottom 8-bit register if it is a 16-bit register Pq Cm AF No isn't a valid register for this function .
|
||||||
.It Fn ISCONST arg Ta Returns 1 if Ar arg Ap s value is known by RGBASM (e.g. if it can be an argument to
|
.It Fn ISCONST arg Ta Returns 1 if Ar arg Ap s value is known by RGBASM (e.g. if it can be an argument to
|
||||||
.Ic IF ) ,
|
.Ic IF ) ,
|
||||||
@@ -2170,12 +2171,12 @@ Note that
|
|||||||
is a shorthand for
|
is a shorthand for
|
||||||
.Ic ALIGN Ns Bq Ar align , No 0 .
|
.Ic ALIGN Ns Bq Ar align , No 0 .
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
|
.Xr gbz80 7 ,
|
||||||
.Xr rgbasm 1 ,
|
.Xr rgbasm 1 ,
|
||||||
.Xr rgblink 1 ,
|
.Xr rgblink 1 ,
|
||||||
.Xr rgblink 5 ,
|
.Xr rgblink 5 ,
|
||||||
.Xr rgbds 5 ,
|
.Xr rgbds 5 ,
|
||||||
.Xr rgbds 7 ,
|
.Xr rgbds 7
|
||||||
.Xr gbz80 7
|
|
||||||
.Sh HISTORY
|
.Sh HISTORY
|
||||||
.Nm
|
.Nm
|
||||||
was originally written by Carsten S\(/orensen as part of the ASMotor package,
|
was originally written by Carsten S\(/orensen as part of the ASMotor package,
|
||||||
|
|||||||
@@ -116,9 +116,9 @@ Local symbols are stored as their full name
|
|||||||
.It Cm BYTE Ar Type
|
.It Cm BYTE Ar Type
|
||||||
.Bl -column "Value" -compact
|
.Bl -column "Value" -compact
|
||||||
.It Sy Value Ta Sy Meaning
|
.It Sy Value Ta Sy Meaning
|
||||||
.It 0 Ta Sy Local No symbol only used in this file.
|
.It 0 Ta Sy Local No symbol only used in this file .
|
||||||
.It 1 Ta Sy Import No of an exported symbol (by name) from another object file.
|
.It 1 Ta Sy Import No of an exported symbol (by name) from another object file .
|
||||||
.It 2 Ta Sy Exported No symbol visible from other object files.
|
.It 2 Ta Sy Exported No symbol visible from other object files .
|
||||||
.El
|
.El
|
||||||
.It Cm IF Ar Type No \(!= 1
|
.It Cm IF Ar Type No \(!= 1
|
||||||
If the symbol is defined in this object file...
|
If the symbol is defined in this object file...
|
||||||
|
|||||||
14
man/rgbgfx.1
14
man/rgbgfx.1
@@ -172,7 +172,7 @@ The numbers must be separated by commas; space is allowed around all punctuation
|
|||||||
The first number pair specifies the X and Y coordinates of the top-left pixel that will be processed (anything above it or to its left will be ignored).
|
The first number pair specifies the X and Y coordinates of the top-left pixel that will be processed (anything above it or to its left will be ignored).
|
||||||
The second number pair specifies how many tiles to process horizontally and vertically, respectively.
|
The second number pair specifies how many tiles to process horizontally and vertically, respectively.
|
||||||
.Pp
|
.Pp
|
||||||
.Sy Fl L Sy is ignored in reverse mode , No no padding is inserted .
|
.Fl L Sy is ignored in reverse mode , No no padding is inserted .
|
||||||
.It Fl m , Fl Fl mirror-tiles
|
.It Fl m , Fl Fl mirror-tiles
|
||||||
Deduplicate tiles that are symmetrical mirror images of each other.
|
Deduplicate tiles that are symmetrical mirror images of each other.
|
||||||
Only one of each unique tile will be saved in the tile data file, with mirror images counting as duplicates.
|
Only one of each unique tile will be saved in the tile data file, with mirror images counting as duplicates.
|
||||||
@@ -265,7 +265,8 @@ Same as
|
|||||||
.Fl t Ar base_path Ns .tilemap
|
.Fl t Ar base_path Ns .tilemap
|
||||||
.Pq see Sx Automatic output paths .
|
.Pq see Sx Automatic output paths .
|
||||||
.It Fl u , Fl Fl unique-tiles
|
.It Fl u , Fl Fl unique-tiles
|
||||||
Deduplicate identical tiles. Only one of each unique tile will be saved in the tile data file.
|
Deduplicate identical tiles.
|
||||||
|
Only one of each unique tile will be saved in the tile data file.
|
||||||
Useful with a tile map
|
Useful with a tile map
|
||||||
.Pq see Fl t
|
.Pq see Fl t
|
||||||
to keep track of the duplicated tiles.
|
to keep track of the duplicated tiles.
|
||||||
@@ -540,16 +541,17 @@ is the input image path
|
|||||||
.Pq or the output tile data path from Fl o , No if Fl O No was given
|
.Pq or the output tile data path from Fl o , No if Fl O No was given
|
||||||
with its extension, if any, removed.
|
with its extension, if any, removed.
|
||||||
.Pp
|
.Pp
|
||||||
For example, these two are equivalent:
|
For example, these two commands are equivalent:
|
||||||
.Bd -literal -indent Ds
|
.Bd -literal -offset indent
|
||||||
$ rgbgfx img/player.png -o build/player.2bpp -P
|
$ rgbgfx img/player.png -o build/player.2bpp -P
|
||||||
$ rgbgfx img/player.png -o build/player.2bpp -p img/player.pal
|
$ rgbgfx img/player.png -o build/player.2bpp -p img/player.pal
|
||||||
|
.Ed
|
||||||
.Pp
|
.Pp
|
||||||
And so are these two:
|
And so are these two:
|
||||||
.Bd -literal -indent Ds
|
.Bd -literal -offset indent
|
||||||
$ rgbgfx img/player.png -o build/player.2bpp -O -P
|
$ rgbgfx img/player.png -o build/player.2bpp -O -P
|
||||||
$ rgbgfx img/player.png -o build/player.2bpp -p build/player.pal
|
$ rgbgfx img/player.png -o build/player.2bpp -p build/player.pal
|
||||||
.El
|
.Ed
|
||||||
.Sh REVERSE MODE
|
.Sh REVERSE MODE
|
||||||
.Nm
|
.Nm
|
||||||
can produce a PNG image from valid data.
|
can produce a PNG image from valid data.
|
||||||
|
|||||||
@@ -15,7 +15,6 @@ All reserved keywords (bank types and command names) are case-insensitive; all s
|
|||||||
Any line can contain a comment starting with
|
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
|
|
||||||
.Bd -literal -offset indent
|
.Bd -literal -offset indent
|
||||||
; This line is a comment
|
; This line is a comment
|
||||||
ROMX $F ; start a bank
|
ROMX $F ; start a bank
|
||||||
@@ -84,7 +83,7 @@ will align to $100
|
|||||||
will increase the address by the specified non-negative amount.
|
will increase the address by the specified non-negative amount.
|
||||||
.El
|
.El
|
||||||
.Pp
|
.Pp
|
||||||
.Sy Note:
|
.Sy Note :
|
||||||
The bank, alignment, address and type of sections can be specified both in the source code and in the linker script.
|
The bank, alignment, address and type of sections can be specified both in the source code and in the linker script.
|
||||||
For a section to be able to be placed with the linker script, the bank, address and alignment must be left unassigned in the source code or be compatible with what is specified in the linker script.
|
For a section to be able to be placed with the linker script, the bank, address and alignment must be left unassigned in the source code or be compatible with what is specified in the linker script.
|
||||||
For example,
|
For example,
|
||||||
|
|||||||
Reference in New Issue
Block a user