mirror of
https://github.com/gbdev/rgbds.git
synced 2025-11-20 18:22:07 +00:00
Remove unnecessary comments from manpage sources
This commit is contained in:
@@ -4,7 +4,6 @@
|
||||
.Sh NAME
|
||||
.Nm rgbasm
|
||||
.Nd Game Boy assembler
|
||||
.\" SECTION
|
||||
.Sh SYNOPSIS
|
||||
.Nm rgbasm
|
||||
.Op Fl b Ar chars
|
||||
@@ -13,33 +12,26 @@
|
||||
.Op Fl o Ar outfile
|
||||
.Op Fl p Ar pad_value
|
||||
.Ar file
|
||||
.\" SECTION
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
program creates an object file from an assembly source file.
|
||||
Its arguments are as follows:
|
||||
.Bl -tag -width Ds
|
||||
.\" ITEM
|
||||
.It Fl b Ar chars
|
||||
Change the two characters used for binary constants.
|
||||
The defaults are 01.
|
||||
.\" ITEM
|
||||
.It Fl g Ar chars
|
||||
Change the four characters used for binary constants.
|
||||
The defaults are 0123.
|
||||
.\" ITEM
|
||||
.It Fl i Ar path
|
||||
Add an include path.
|
||||
.\" ITEM
|
||||
.It Fl o Ar outfile
|
||||
Write an object file to the given filename.
|
||||
.\" ITEM
|
||||
.It Fl p Ar pad_value
|
||||
When padding an image, pad with this value.
|
||||
The default is 0x00.
|
||||
.El
|
||||
.\" SECTION
|
||||
.Sh EXAMPLES
|
||||
Assembling a basic source file is simple:
|
||||
.Pp
|
||||
@@ -50,14 +42,12 @@ run through
|
||||
.Xr rgblink 1
|
||||
and
|
||||
.Xr rgbfix 1 .
|
||||
.\" SECTION
|
||||
.Sh SEE ALSO
|
||||
.Xr rgbds 7 ,
|
||||
.Xr rgbfix 1 ,
|
||||
.Xr rgblib 1 ,
|
||||
.Xr rgblink 1 ,
|
||||
.Xr gbz80 7
|
||||
.\" SECTION
|
||||
.Sh HISTORY
|
||||
.Nm
|
||||
was originally written by Carsten S\(/orensen as part of the ASMotor package,
|
||||
|
||||
@@ -4,7 +4,6 @@
|
||||
.Sh NAME
|
||||
.Nm rgbfix
|
||||
.Nd Game Boy checksum fixer
|
||||
.\" SECTION
|
||||
.Sh SYNOPSIS
|
||||
.Nm rgbfix
|
||||
.Op Fl Ccjsv
|
||||
@@ -16,7 +15,6 @@
|
||||
.Op Fl r Ar ram_size
|
||||
.Op Fl t Ar title_str
|
||||
.Ar file
|
||||
.\" SECTION
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
@@ -24,7 +22,6 @@ program changes headers of Game Boy ROM images.
|
||||
It also performs other filetype operations, such as truncation.
|
||||
The arguments are as follows:
|
||||
.Bl -tag -width Ds
|
||||
.\" ITEM
|
||||
.It Fl C
|
||||
Set the Game Boy Color\(enonly flag:
|
||||
.Ad 0x143
|
||||
@@ -32,7 +29,6 @@ Set the Game Boy Color\(enonly flag:
|
||||
If both this and the
|
||||
.Fl c
|
||||
flag are set, this takes precedence.
|
||||
.\" ITEM
|
||||
.It Fl c
|
||||
Set the Game Boy Color\(encompatible flag:
|
||||
.Ad 0x143
|
||||
@@ -42,33 +38,27 @@ If both this and the
|
||||
flag are set,
|
||||
.Fl C
|
||||
takes precedence.
|
||||
.\" ITEM
|
||||
.It Fl j
|
||||
Set the non-Japanese region flag:
|
||||
.Ad 0x14A
|
||||
= 1.
|
||||
.\" ITEM
|
||||
.It Fl k Ar licensee_str
|
||||
Set the new licensee string
|
||||
.Pq Ad 0x144 \(en Ad 0x145]
|
||||
to a given string, truncated to at most two characters.
|
||||
.\" ITEM
|
||||
.It Fl l Ar licensee_id
|
||||
Set the old licensee code,
|
||||
.Ad 0x14B ,
|
||||
to a given value from 0 to 0xFF.
|
||||
This value is deprecated and should be set to 0x33 in all new software.
|
||||
.\" ITEM
|
||||
.It Fl m Ar mbc_type
|
||||
Set the MBC type,
|
||||
.Ad 0x147 ,
|
||||
to a given value from 0 to 0xFF.
|
||||
.\" ITEM
|
||||
.It Fl n Ar rom_version
|
||||
Set the ROM version,
|
||||
.Ad 0x14C ,
|
||||
to a given value from 0 to 0xFF.
|
||||
.\" ITEM
|
||||
.It Fl p Ar pad_value
|
||||
Pad the image to a valid size with a given pad value from 0 to 0xFF.
|
||||
.Nm
|
||||
@@ -77,17 +67,14 @@ give a warning thereafter.
|
||||
The cartridge size byte
|
||||
.Pq Ad 0x148
|
||||
will be changed to reflect this new size.
|
||||
.\" ITEM
|
||||
.It Fl r Ar ram_size
|
||||
Set the RAM size,
|
||||
.Ad 0x149 ,
|
||||
to a given value from 0 to 0xFF.
|
||||
.\" ITEM
|
||||
.It Fl s
|
||||
Set the SGB flag:
|
||||
.Ad 0x146
|
||||
= 3.
|
||||
.\" ITEM
|
||||
.It Fl t Ar title
|
||||
Set the title string
|
||||
.Pq Ad 0x134 \(en Ad 0x143
|
||||
@@ -98,7 +85,6 @@ flag (
|
||||
or
|
||||
.Fl C
|
||||
.Ns ).
|
||||
.\" ITEM
|
||||
.It Fl v
|
||||
Validate the header and fix checksums: the Nintendo character area
|
||||
.Pq Ad 0x104 \(en Ad 0x133 ,
|
||||
@@ -107,7 +93,6 @@ the header checksum
|
||||
and the global checksum
|
||||
.Pq Ad 0x14E \(en Ad 0x14F .
|
||||
.El
|
||||
.\" SECTION
|
||||
.Sh EXAMPLES
|
||||
Most values in the ROM header are only cosmetic.
|
||||
The bare minimum requirements for a workable image are checksums, the Nintendo
|
||||
@@ -131,14 +116,12 @@ The following will duplicate the header (sans global checksum) of the game
|
||||
"Survival Kids":
|
||||
.Pp
|
||||
.D1 $ rgbfix \-cjsv \-k A4 \-m 0x1B \-p 0xFF \-r 3 \-t SURVIVALKIDAVKE SurvivalKids.gbc
|
||||
.\" SECTION
|
||||
.Sh SEE ALSO
|
||||
.Xr rgbds 7 ,
|
||||
.Xr rgbasm 1 ,
|
||||
.Xr rgblib 1 ,
|
||||
.Xr rgblink 1 ,
|
||||
.Xr gbz80 7
|
||||
.\" SECTION
|
||||
.Sh HISTORY
|
||||
.Nm
|
||||
was originally released by Carsten S\(/orensen as a standalone program called
|
||||
|
||||
@@ -4,40 +4,32 @@
|
||||
.Sh NAME
|
||||
.Nm rgblib
|
||||
.Nd Game Boy library manager
|
||||
.\" SECTION
|
||||
.Sh SYNOPSIS
|
||||
.Nm rgblib
|
||||
.Ar library
|
||||
.Op add | delete | extract | list
|
||||
.Ar module ...
|
||||
.\" SECTION
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
program manages libraries for use with
|
||||
.Xr rgblink 1 .
|
||||
.Bl -tag -width Ds
|
||||
.\" ITEM
|
||||
.It add
|
||||
Add the given modules to the library.
|
||||
.\" ITEM
|
||||
.It delete
|
||||
Delete the given modules from the library.
|
||||
.\" ITEM
|
||||
.It extract
|
||||
Extract the given modules from the library.
|
||||
.\" ITEM
|
||||
.It list
|
||||
List all the modules in the library.
|
||||
.El
|
||||
.\" SECTION
|
||||
.Sh SEE ALSO
|
||||
.Xr rgbds 7 ,
|
||||
.Xr rgbasm 1 ,
|
||||
.Xr rgbfix 1 ,
|
||||
.Xr rgblink 1 ,
|
||||
.Xr gbz80 7
|
||||
.\" SECTION
|
||||
.Sh HISTORY
|
||||
.Nm
|
||||
was originally released by Carsten S\(/orensen as part of the ASMotor package,
|
||||
|
||||
@@ -4,7 +4,6 @@
|
||||
.Sh NAME
|
||||
.Nm rgblink
|
||||
.Nd Game Boy linker
|
||||
.\" SECTION
|
||||
.Sh SYNOPSIS
|
||||
.Nm rgblink
|
||||
.Op Fl t
|
||||
@@ -15,7 +14,6 @@
|
||||
.Op Fl p Ar pad_value
|
||||
.Op Fl s Ar symbol
|
||||
.Ar
|
||||
.\" SECTION
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
@@ -31,34 +29,26 @@ option to override this.
|
||||
.Pp
|
||||
The arguments are as follows:
|
||||
.Bl -tag -width Ds
|
||||
.\" ITEM
|
||||
.It Fl l Ar library
|
||||
Include a referenced library module created with
|
||||
.Xr rgblib 1 .
|
||||
Note that specified libraries will be included only if needed\(emthat is, if
|
||||
a SECTION from a library is referenced by an object file.
|
||||
Only the relevant SECTION will be included, rather than the entire module.
|
||||
.\" ITEM
|
||||
.It Fl m Ar mapfile
|
||||
Write a mapfile to the given filename.
|
||||
.\" ITEM
|
||||
.It Fl n Ar symfile
|
||||
Write a symbol file to the given filename.
|
||||
.\" ITEM
|
||||
.It Fl o Ar outfile
|
||||
Write ROM image to the given filename.
|
||||
.\" ITEM
|
||||
.It Fl p Ar pad_value
|
||||
When padding an image, pad with this value. The default is 0x00.
|
||||
.\" ITEM
|
||||
.It Fl s Ar symbol
|
||||
???
|
||||
.\" ITEM
|
||||
.It Fl t
|
||||
Write a tiny (32KiB) ROM file. This forces all DATA/CODE sections to be of
|
||||
type HOME, and increases the HOME section size from 16KiB to 32KiB.
|
||||
.El
|
||||
.\" SECTION
|
||||
.Sh EXAMPLES
|
||||
All you need for a basic ROM is an object file, which can be made into a ROM
|
||||
image like so:
|
||||
@@ -72,14 +62,12 @@ You should use
|
||||
to fix these so that the program will actually run in a Game Boy:
|
||||
.Pp
|
||||
.D1 $ rgbfix \-v bar.gb
|
||||
.\" SECTION
|
||||
.Sh SEE ALSO
|
||||
.Xr rgbds 7 ,
|
||||
.Xr rgbasm 1 ,
|
||||
.Xr rgbfix 1 ,
|
||||
.Xr rgblib 1 ,
|
||||
.Xr gbz80 7
|
||||
.\" SECTION
|
||||
.Sh HISTORY
|
||||
.Nm
|
||||
was originally written by Carsten S\(/orensen as part of the ASMotor package,
|
||||
|
||||
@@ -4,21 +4,18 @@
|
||||
.Sh NAME
|
||||
.Nm rgbds
|
||||
.Nd Rednex Game Boy Development System
|
||||
.\" SECTION
|
||||
.Sh Examples
|
||||
To get a working ROM image from a single assembly source file:
|
||||
.Pp
|
||||
.D1 $ rgbasm \-o bar.o foo.asm
|
||||
.D1 $ rgblink \-o baz.gb bar.o
|
||||
.D1 $ rgbfix \-v \-p 0 baz.gb
|
||||
.\" SECTION
|
||||
.Sh SEE ALSO
|
||||
.Xr rgbasm 1 ,
|
||||
.Xr rgbfix 1 ,
|
||||
.Xr rgblib 1 ,
|
||||
.Xr rgblink 1 ,
|
||||
.Xr gbz80 7
|
||||
.\" SECTION
|
||||
.Sh HISTORY
|
||||
.Nm
|
||||
grew out of the ASMotor package released by Carsten S\(/orensen.
|
||||
|
||||
Reference in New Issue
Block a user