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

Fix formatting errors in man pages

Browse Source 
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:
ISSOtm
2023-11-23 18:05:55 +01:00
parent a218622d73
commit 27c1237daa
6 changed files with 32 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
man/gbz80.7
View File

@@ -1317,7 +1317,6 @@ Flags: None affected.
Rotate bits in register
.Ar r8
left, through the carry flag.
.Pp
.Bd -literal
┏━ Flags ━┓ ┏━━━━━━━ r8 ━━━━━━┓
┌─╂─ C ←╂─╂─ b7 ← ... ← b0 ←╂─┐
@@ -1344,7 +1343,6 @@ Set according to result.
Rotate the byte pointed to by
.Sy HL
left, through the carry flag.
.Pp
.Bd -literal
┏━ Flags ━┓ ┏━━━━━━ [HL] ━━━━━┓
┌─╂─ C ←╂─╂─ b7 ← ... ← b0 ←╂─┐
@@ -1362,7 +1360,6 @@ Flags: See
Rotate register
.Sy A
left, through the carry flag.
.Pp
.Bd -literal
┏━ Flags ━┓ ┏━━━━━━━ A ━━━━━━━┓
┌─╂─ C ←╂─╂─ b7 ← ... ← b0 ←╂─┐
@@ -1389,7 +1386,6 @@ Set according to result.
Rotate register
.Ar r8
left.
.Pp
.Bd -literal
┏━ Flags ━┓ ┏━━━━━━━ r8 ━━━━━━┓
┃ C ←╂─┬─╂─ b7 ← ... ← b0 ←╂─┐
@@ -1416,7 +1412,6 @@ Set according to result.
Rotate the byte pointed to by
.Sy HL
left.
.Pp
.Bd -literal
┏━ Flags ━┓ ┏━━━━━━ [HL] ━━━━━┓
┃ C ←╂─┬─╂─ b7 ← ... ← b0 ←╂─┐
@@ -1434,7 +1429,6 @@ Flags: See
Rotate register
.Sy A
left.
.Pp
.Bd -literal
┏━ Flags ━┓ ┏━━━━━━━ A ━━━━━━━┓
┃ C ←╂─┬─╂─ b7 ← ... ← b0 ←╂─┐
@@ -1461,7 +1455,6 @@ Set according to result.
Rotate register
.Ar r8
right, through the carry flag.
.Pp
.Bd -literal
┏━━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓
┌─╂→ b7 → ... → b0 ─╂─╂→ C ─╂─┐
@@ -1488,7 +1481,6 @@ Set according to result.
Rotate the byte pointed to by
.Sy HL
right, through the carry flag.
.Pp
.Bd -literal
┏━━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓
┌─╂→ b7 → ... → b0 ─╂─╂→ C ─╂─┐
@@ -1506,7 +1498,6 @@ Flags: See
Rotate register
.Sy A
right, through the carry flag.
.Pp
.Bd -literal
┏━━━━━━━ A ━━━━━━━┓ ┏━ Flags ━┓
┌─╂→ b7 → ... → b0 ─╂─╂→ C ─╂─┐
@@ -1533,7 +1524,6 @@ Set according to result.
Rotate register
.Ar r8
right.
.Pp
.Bd -literal
┏━━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓
┌─╂→ b7 → ... → b0 ─╂─┬─╂→ C ┃
@@ -1560,7 +1550,6 @@ Set according to result.
Rotate the byte pointed to by
.Sy HL
right.
.Pp
.Bd -literal
┏━━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓
┌─╂→ b7 → ... → b0 ─╂─┬─╂→ C ┃
@@ -1578,7 +1567,6 @@ Flags: See
Rotate register
.Sy A
right.
.Pp
.Bd -literal
┏━━━━━━━ A ━━━━━━━┓ ┏━ Flags ━┓
┌─╂→ b7 → ... → b0 ─╂─┬─╂→ C ┃
@@ -1708,7 +1696,6 @@ Flags: None affected.
.Ss SLA r8
Shift Left Arithmetically register
.Ar r8 .
.Pp
.Bd -literal
┏━ Flags ━┓ ┏━━━━━━━ r8 ━━━━━━┓
┃ C ←╂─╂─ b7 ← ... ← b0 ←╂─ 0
@@ -1733,7 +1720,6 @@ Set according to result.
.Ss SLA [HL]
Shift Left Arithmetically the byte pointed to by
.Sy HL .
.Pp
.Bd -literal
┏━ Flags ━┓ ┏━━━━━━ [HL] ━━━━━┓
┃ C ←╂─╂─ b7 ← ... ← b0 ←╂─ 0
@@ -1750,7 +1736,6 @@ Flags: See
Shift Right Arithmetically register
.Ar r8
.Pq bit 7 of Ar r8 No is unchanged .
.Pp
.Bd -literal
┏━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓
┃ b7 → ... → b0 ─╂─╂→ C ┃
@@ -1776,7 +1761,6 @@ Set according to result.
Shift Right Arithmetically the byte pointed to by
.Sy HL
.Pq bit 7 of the byte pointed to by Sy HL No is unchanged .
.Pp
.Bd -literal
┏━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓
┃ b7 → ... → b0 ─╂─╂→ C ┃
@@ -1792,7 +1776,6 @@ Flags: See
.Ss SRL r8
Shift Right Logically register
.Ar r8 .
.Pp
.Bd -literal
┏━━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓
0 ─╂→ b7 → ... → b0 ─╂─╂→ C ┃
@@ -1817,7 +1800,6 @@ Set according to result.
.Ss SRL [HL]
Shift Right Logically the byte pointed to by
.Sy HL .
.Pp
.Bd -literal
┏━━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓
0 ─╂→ b7 → ... → b0 ─╂─╂→ C ┃

6
man/rgbasm.1
View File

@@ -344,12 +344,12 @@ and then
Please report bugs on
.Lk https://github.com/gbdev/rgbds/issues GitHub .
.Sh SEE ALSO
.Xr rgbasm 5 ,
.Xr rgbfix 1 ,
.Xr rgblink 1 ,
.Xr rgbasm 5 ,
.Xr gbz80 7 ,
.Xr rgbds 5 ,
.Xr rgbds 7 ,
.Xr gbz80 7
.Xr rgbds 7
.Sh HISTORY
.Nm
was originally written by Carsten S\(/orensen as part of the ASMotor package, and was later packaged in RGBDS by Justin Lloyd.

19
man/rgbasm.5
View File

@@ -29,8 +29,8 @@ can be used in its place.
The syntax is line-based, just as in any other assembler.
Each line may have components in this order:
.Pp
.Dl Oo Ar directive Oc Oo Ar ;\ comment Oc
.Dl Oo Ar label: Oc Oo Ar instruction Oo Ar :: instruction ... Oc 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 ;\ Ns Ar comment Oc
.Pp
Directives are commands to the assembler itself, such as
.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 \er Ta Carriage return ($0D)
.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 Ql \e# Ta All Dv _NARG No macro arguments, separated by commas (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 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 Pq Only in the body of a macro
.It Ql \e@ Ta Label name suffix Pq Only in the body of a macro or a Ic REPT No block
.El
(Note that some of those can be used outside of strings, when noted further in this document.)
.Pp
@@ -423,9 +423,9 @@ Raw strings are prefixed by a hash
.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.
For example, the raw string
.Ql #"\t\1{s}\"
.Ql #"\et\e1{s}\e"
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.)
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
@@ -468,6 +468,7 @@ CHARMAP "<LF>", 10
CHARMAP "&iacute", 20
CHARMAP "A", 128
.Ed
.Pp
This would result in
.Ql db \(dqAmen<LF>\(dq
being equivalent to
@@ -2170,12 +2171,12 @@ Note that
is a shorthand for
.Ic ALIGN Ns Bq Ar align , No 0 .
.Sh SEE ALSO
.Xr gbz80 7 ,
.Xr rgbasm 1 ,
.Xr rgblink 1 ,
.Xr rgblink 5 ,
.Xr rgbds 5 ,
.Xr rgbds 7 ,
.Xr gbz80 7
.Xr rgbds 7
.Sh HISTORY
.Nm
was originally written by Carsten S\(/orensen as part of the ASMotor package,

14
man/rgbgfx.1
View File

@@ -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 second number pair specifies how many tiles to process horizontally and vertically, respectively.
.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
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.
@@ -265,7 +265,8 @@ Same as
.Fl t Ar base_path Ns .tilemap
.Pq see Sx Automatic output paths .
.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
.Pq see Fl t
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
with its extension, if any, removed.
.Pp
For example, these two are equivalent:
.Bd -literal -indent Ds
For example, these two commands are equivalent:
.Bd -literal -offset indent
$ rgbgfx img/player.png -o build/player.2bpp -P
$ rgbgfx img/player.png -o build/player.2bpp -p img/player.pal
.Ed
.Pp
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 -p build/player.pal
.El
.Ed
.Sh REVERSE MODE
.Nm
can produce a PNG image from valid data.

1
man/rgblink.5
View File

@@ -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
.Ql \&;
that ends at the end of the line.
.Pp
.Bd -literal -offset indent
; This line is a comment
ROMX $F ; start a bank