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

Remove unnecessary comments from manpage sources

Browse Source
This commit is contained in:
Anthony J. Bentley
2011-04-10 00:15:35 -06:00
parent 9a9d071024
commit 009ac34f32
5 changed files with 0 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/asm/rgbasm.1
View File

@@ -4,7 +4,6 @@
.Sh NAME .Sh NAME
.Nm rgbasm .Nm rgbasm
.Nd Game Boy assembler .Nd Game Boy assembler
.\" SECTION
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm rgbasm .Nm rgbasm
.Op Fl b Ar chars .Op Fl b Ar chars
@@ -13,33 +12,26 @@
.Op Fl o Ar outfile .Op Fl o Ar outfile
.Op Fl p Ar pad_value .Op Fl p Ar pad_value
.Ar file .Ar file
.\" SECTION
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
program creates an object file from an assembly source file. program creates an object file from an assembly source file.
Its arguments are as follows: Its arguments are as follows:
.Bl -tag -width Ds .Bl -tag -width Ds
.\" ITEM
.It Fl b Ar chars .It Fl b Ar chars
Change the two characters used for binary constants. Change the two characters used for binary constants.
The defaults are 01. The defaults are 01.
.\" ITEM
.It Fl g Ar chars .It Fl g Ar chars
Change the four characters used for binary constants. Change the four characters used for binary constants.
The defaults are 0123. The defaults are 0123.
.\" ITEM
.It Fl i Ar path .It Fl i Ar path
Add an include path. Add an include path.
.\" ITEM
.It Fl o Ar outfile .It Fl o Ar outfile
Write an object file to the given filename. Write an object file to the given filename.
.\" ITEM
.It Fl p Ar pad_value .It Fl p Ar pad_value
When padding an image, pad with this value. When padding an image, pad with this value.
The default is 0x00. The default is 0x00.
.El .El
.\" SECTION
.Sh EXAMPLES .Sh EXAMPLES
Assembling a basic source file is simple: Assembling a basic source file is simple:
.Pp .Pp
@@ -50,14 +42,12 @@ run through
.Xr rgblink 1 .Xr rgblink 1
and and
.Xr rgbfix 1 . .Xr rgbfix 1 .
.\" SECTION
.Sh SEE ALSO .Sh SEE ALSO
.Xr rgbds 7 , .Xr rgbds 7 ,
.Xr rgbfix 1 , .Xr rgbfix 1 ,
.Xr rgblib 1 , .Xr rgblib 1 ,
.Xr rgblink 1 , .Xr rgblink 1 ,
.Xr gbz80 7 .Xr gbz80 7
.\" SECTION
.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,

17
src/fix/rgbfix.1
View File

@@ -4,7 +4,6 @@
.Sh NAME .Sh NAME
.Nm rgbfix .Nm rgbfix
.Nd Game Boy checksum fixer .Nd Game Boy checksum fixer
.\" SECTION
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm rgbfix .Nm rgbfix
.Op Fl Ccjsv .Op Fl Ccjsv
@@ -16,7 +15,6 @@
.Op Fl r Ar ram_size .Op Fl r Ar ram_size
.Op Fl t Ar title_str .Op Fl t Ar title_str
.Ar file .Ar file
.\" SECTION
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
@@ -24,7 +22,6 @@ program changes headers of Game Boy ROM images.
It also performs other filetype operations, such as truncation. It also performs other filetype operations, such as truncation.
The arguments are as follows: The arguments are as follows:
.Bl -tag -width Ds .Bl -tag -width Ds
.\" ITEM
.It Fl C .It Fl C
Set the Game Boy Color\(enonly flag: Set the Game Boy Color\(enonly flag:
.Ad 0x143 .Ad 0x143
@@ -32,7 +29,6 @@ Set the Game Boy Color\(enonly flag:
If both this and the If both this and the
.Fl c .Fl c
flag are set, this takes precedence. flag are set, this takes precedence.
.\" ITEM
.It Fl c .It Fl c
Set the Game Boy Color\(encompatible flag: Set the Game Boy Color\(encompatible flag:
.Ad 0x143 .Ad 0x143
@@ -42,33 +38,27 @@ If both this and the
flag are set, flag are set,
.Fl C .Fl C
takes precedence. takes precedence.
.\" ITEM
.It Fl j .It Fl j
Set the non-Japanese region flag: Set the non-Japanese region flag:
.Ad 0x14A .Ad 0x14A
= 1. = 1.
.\" ITEM
.It Fl k Ar licensee_str .It Fl k Ar licensee_str
Set the new licensee string Set the new licensee string
.Pq Ad 0x144 \(en Ad 0x145] .Pq Ad 0x144 \(en Ad 0x145]
to a given string, truncated to at most two characters. to a given string, truncated to at most two characters.
.\" ITEM
.It Fl l Ar licensee_id .It Fl l Ar licensee_id
Set the old licensee code, Set the old licensee code,
.Ad 0x14B , .Ad 0x14B ,
to a given value from 0 to 0xFF. to a given value from 0 to 0xFF.
This value is deprecated and should be set to 0x33 in all new software. This value is deprecated and should be set to 0x33 in all new software.
.\" ITEM
.It Fl m Ar mbc_type .It Fl m Ar mbc_type
Set the MBC type, Set the MBC type,
.Ad 0x147 , .Ad 0x147 ,
to a given value from 0 to 0xFF. to a given value from 0 to 0xFF.
.\" ITEM
.It Fl n Ar rom_version .It Fl n Ar rom_version
Set the ROM version, Set the ROM version,
.Ad 0x14C , .Ad 0x14C ,
to a given value from 0 to 0xFF. to a given value from 0 to 0xFF.
.\" ITEM
.It Fl p Ar pad_value .It Fl p Ar pad_value
Pad the image to a valid size with a given pad value from 0 to 0xFF. Pad the image to a valid size with a given pad value from 0 to 0xFF.
.Nm .Nm
@@ -77,17 +67,14 @@ give a warning thereafter.
The cartridge size byte The cartridge size byte
.Pq Ad 0x148 .Pq Ad 0x148
will be changed to reflect this new size. will be changed to reflect this new size.
.\" ITEM
.It Fl r Ar ram_size .It Fl r Ar ram_size
Set the RAM size, Set the RAM size,
.Ad 0x149 , .Ad 0x149 ,
to a given value from 0 to 0xFF. to a given value from 0 to 0xFF.
.\" ITEM
.It Fl s .It Fl s
Set the SGB flag: Set the SGB flag:
.Ad 0x146 .Ad 0x146
= 3. = 3.
.\" ITEM
.It Fl t Ar title .It Fl t Ar title
Set the title string Set the title string
.Pq Ad 0x134 \(en Ad 0x143 .Pq Ad 0x134 \(en Ad 0x143
@@ -98,7 +85,6 @@ flag (
or or
.Fl C .Fl C
.Ns ). .Ns ).
.\" ITEM
.It Fl v .It Fl v
Validate the header and fix checksums: the Nintendo character area Validate the header and fix checksums: the Nintendo character area
.Pq Ad 0x104 \(en Ad 0x133 , .Pq Ad 0x104 \(en Ad 0x133 ,
@@ -107,7 +93,6 @@ the header checksum
and the global checksum and the global checksum
.Pq Ad 0x14E \(en Ad 0x14F . .Pq Ad 0x14E \(en Ad 0x14F .
.El .El
.\" SECTION
.Sh EXAMPLES .Sh EXAMPLES
Most values in the ROM header are only cosmetic. Most values in the ROM header are only cosmetic.
The bare minimum requirements for a workable image are checksums, the Nintendo 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": "Survival Kids":
.Pp .Pp
.D1 $ rgbfix \-cjsv \-k A4 \-m 0x1B \-p 0xFF \-r 3 \-t SURVIVALKIDAVKE SurvivalKids.gbc .D1 $ rgbfix \-cjsv \-k A4 \-m 0x1B \-p 0xFF \-r 3 \-t SURVIVALKIDAVKE SurvivalKids.gbc
.\" SECTION
.Sh SEE ALSO .Sh SEE ALSO
.Xr rgbds 7 , .Xr rgbds 7 ,
.Xr rgbasm 1 , .Xr rgbasm 1 ,
.Xr rgblib 1 , .Xr rgblib 1 ,
.Xr rgblink 1 , .Xr rgblink 1 ,
.Xr gbz80 7 .Xr gbz80 7
.\" SECTION
.Sh HISTORY .Sh HISTORY
.Nm .Nm
was originally released by Carsten S\(/orensen as a standalone program called was originally released by Carsten S\(/orensen as a standalone program called

8
src/lib/rgblib.1
View File

@@ -4,40 +4,32 @@
.Sh NAME .Sh NAME
.Nm rgblib .Nm rgblib
.Nd Game Boy library manager .Nd Game Boy library manager
.\" SECTION
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm rgblib .Nm rgblib
.Ar library .Ar library
.Op add | delete | extract | list .Op add | delete | extract | list
.Ar module ... .Ar module ...
.\" SECTION
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
program manages libraries for use with program manages libraries for use with
.Xr rgblink 1 . .Xr rgblink 1 .
.Bl -tag -width Ds .Bl -tag -width Ds
.\" ITEM
.It add .It add
Add the given modules to the library. Add the given modules to the library.
.\" ITEM
.It delete .It delete
Delete the given modules from the library. Delete the given modules from the library.
.\" ITEM
.It extract .It extract
Extract the given modules from the library. Extract the given modules from the library.
.\" ITEM
.It list .It list
List all the modules in the library. List all the modules in the library.
.El .El
.\" SECTION
.Sh SEE ALSO .Sh SEE ALSO
.Xr rgbds 7 , .Xr rgbds 7 ,
.Xr rgbasm 1 , .Xr rgbasm 1 ,
.Xr rgbfix 1 , .Xr rgbfix 1 ,
.Xr rgblink 1 , .Xr rgblink 1 ,
.Xr gbz80 7 .Xr gbz80 7
.\" SECTION
.Sh HISTORY .Sh HISTORY
.Nm .Nm
was originally released by Carsten S\(/orensen as part of the ASMotor package, was originally released by Carsten S\(/orensen as part of the ASMotor package,

12
src/link/rgblink.1
View File

@@ -4,7 +4,6 @@
.Sh NAME .Sh NAME
.Nm rgblink .Nm rgblink
.Nd Game Boy linker .Nd Game Boy linker
.\" SECTION
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm rgblink .Nm rgblink
.Op Fl t .Op Fl t
@@ -15,7 +14,6 @@
.Op Fl p Ar pad_value .Op Fl p Ar pad_value
.Op Fl s Ar symbol .Op Fl s Ar symbol
.Ar .Ar
.\" SECTION
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
@@ -31,34 +29,26 @@ option to override this.
.Pp .Pp
The arguments are as follows: The arguments are as follows:
.Bl -tag -width Ds .Bl -tag -width Ds
.\" ITEM
.It Fl l Ar library .It Fl l Ar library
Include a referenced library module created with Include a referenced library module created with
.Xr rgblib 1 . .Xr rgblib 1 .
Note that specified libraries will be included only if needed\(emthat is, if Note that specified libraries will be included only if needed\(emthat is, if
a SECTION from a library is referenced by an object file. a SECTION from a library is referenced by an object file.
Only the relevant SECTION will be included, rather than the entire module. Only the relevant SECTION will be included, rather than the entire module.
.\" ITEM
.It Fl m Ar mapfile .It Fl m Ar mapfile
Write a mapfile to the given filename. Write a mapfile to the given filename.
.\" ITEM
.It Fl n Ar symfile .It Fl n Ar symfile
Write a symbol file to the given filename. Write a symbol file to the given filename.
.\" ITEM
.It Fl o Ar outfile .It Fl o Ar outfile
Write ROM image to the given filename. Write ROM image to the given filename.
.\" ITEM
.It Fl p Ar pad_value .It Fl p Ar pad_value
When padding an image, pad with this value. The default is 0x00. When padding an image, pad with this value. The default is 0x00.
.\" ITEM
.It Fl s Ar symbol .It Fl s Ar symbol
??? ???
.\" ITEM
.It Fl t .It Fl t
Write a tiny (32KiB) ROM file. This forces all DATA/CODE sections to be of 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. type HOME, and increases the HOME section size from 16KiB to 32KiB.
.El .El
.\" SECTION
.Sh EXAMPLES .Sh EXAMPLES
All you need for a basic ROM is an object file, which can be made into a ROM All you need for a basic ROM is an object file, which can be made into a ROM
image like so: image like so:
@@ -72,14 +62,12 @@ You should use
to fix these so that the program will actually run in a Game Boy: to fix these so that the program will actually run in a Game Boy:
.Pp .Pp
.D1 $ rgbfix \-v bar.gb .D1 $ rgbfix \-v bar.gb
.\" SECTION
.Sh SEE ALSO .Sh SEE ALSO
.Xr rgbds 7 , .Xr rgbds 7 ,
.Xr rgbasm 1 , .Xr rgbasm 1 ,
.Xr rgbfix 1 , .Xr rgbfix 1 ,
.Xr rgblib 1 , .Xr rgblib 1 ,
.Xr gbz80 7 .Xr gbz80 7
.\" SECTION
.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,

3
src/rgbds.7
View File

@@ -4,21 +4,18 @@
.Sh NAME .Sh NAME
.Nm rgbds .Nm rgbds
.Nd Rednex Game Boy Development System .Nd Rednex Game Boy Development System
.\" SECTION
.Sh Examples .Sh Examples
To get a working ROM image from a single assembly source file: To get a working ROM image from a single assembly source file:
.Pp .Pp
.D1 $ rgbasm \-o bar.o foo.asm .D1 $ rgbasm \-o bar.o foo.asm
.D1 $ rgblink \-o baz.gb bar.o .D1 $ rgblink \-o baz.gb bar.o
.D1 $ rgbfix \-v \-p 0 baz.gb .D1 $ rgbfix \-v \-p 0 baz.gb
.\" SECTION
.Sh SEE ALSO .Sh SEE ALSO
.Xr rgbasm 1 , .Xr rgbasm 1 ,
.Xr rgbfix 1 , .Xr rgbfix 1 ,
.Xr rgblib 1 , .Xr rgblib 1 ,
.Xr rgblink 1 , .Xr rgblink 1 ,
.Xr gbz80 7 .Xr gbz80 7
.\" SECTION
.Sh HISTORY .Sh HISTORY
.Nm .Nm
grew out of the ASMotor package released by Carsten S\(/orensen. grew out of the ASMotor package released by Carsten S\(/orensen.