From 2fa9a3c7683ff45119307554fa71d268039cca3c Mon Sep 17 00:00:00 2001 From: bentley Date: Thu, 25 Mar 2010 21:58:23 -0600 Subject: [PATCH] new sentence, new line see http://marc.info/?l=openbsd-tech&m=126956447409663&w=2 --- man/rgbasm.1 | 13 ++++++++----- man/rgbfix.1 | 37 ++++++++++++++++++++++--------------- man/rgblink.1 | 11 ++++++----- 3 files changed, 36 insertions(+), 25 deletions(-) diff --git a/man/rgbasm.1 b/man/rgbasm.1 index d090b0db..4517b600 100644 --- a/man/rgbasm.1 +++ b/man/rgbasm.1 @@ -17,15 +17,17 @@ .Sh DESCRIPTION The .Nm -program creates an object file from an assembly source file. Its arguments -are as follows: +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. +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. +Change the four characters used for binary constants. +The defaults are 0123. .\" ITEM .It Fl i Ar path Add an include path. @@ -34,7 +36,8 @@ Add an include path. 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. +When padding an image, pad with this value. +The default is 0x00. .El .\" SECTION .Sh EXAMPLES diff --git a/man/rgbfix.1 b/man/rgbfix.1 index 8ae65c38..b995d450 100644 --- a/man/rgbfix.1 +++ b/man/rgbfix.1 @@ -18,17 +18,20 @@ .Sh DESCRIPTION The .Nm -program changes headers of Game Boy ROM images. It also performs other -filetype operations, such as truncation. The arguments are as follows: +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 compatible flag: [0x143] = 0x80. This flag and the +Set the Game Boy Color compatible flag: [0x143] = 0x80. +This flag and the .Fl c flag are mutually exclusive. .\" ITEM .It Fl c -Set the Game Boy Color only flag: [0x143] = 0xC0. This flag and the +Set the Game Boy Color only flag: [0x143] = 0xC0. +This flag and the .Fl C flag are mutually exclusive. .\" ITEM @@ -49,8 +52,8 @@ Set the MBC type, [0x147], to a given value from 0 to 0xFF. Pad the image to a valid size with a given pad value from 0 to 0xFF. .Nm will automatically pick a size from 32KiB, 64KiB, 128KiB, ..., 8192KiB and -give a warning thereafter. The cartridge size byte ([0x148]) will be changed -to reflect this new size. +give a warning thereafter. +The cartridge size byte ([0x148]) will be changed to reflect this new size. .\" ITEM .It Fl q Enable quiet mode, suppressing all text except errors. @@ -63,8 +66,9 @@ Set the SGB flag: [0x146] = 3, and set the old licensee code: [0x14B] = 0x33. .\" ITEM .It Fl t Ar title Set the title string ([0x134\(en0x143]) 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 ( +most 16 characters. +It is recommended to use 15 characters instead, to avoid clashing with the CGB +flag ( .Fl c or .Fl C @@ -77,10 +81,11 @@ Validate the header and fix checksums: the Nintendo character area .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 logo, and (if needed) the -CGB/SGB flags. It is a good idea to pad the image to a valid size as well -("valid" meaning a multiple of 32KiB). +Most values in the ROM header are only cosmetic. +The bare minimum requirements for a workable image are checksums, the Nintendo +logo, and (if needed) the CGB/SGB flags. +It is a good idea to pad the image to a valid size as well ("valid" meaning a +multiple of 32KiB). .Pp The following will make a plain, no-color Game Boy game without checking for a valid size: @@ -88,8 +93,9 @@ a valid size: .D1 $ rgbfix \-v foo.gb .Pp The following will make a SGB-enabled, color-enabled game with a title of -"foobar", and pad it to a multiple of 32KiB. (The Game Boy itself does not -use the title, but some emulators or ROM managers might.) +"foobar", and pad it to a multiple of 32KiB. +(The Game Boy itself does not use the title, but some emulators or ROM managers +might.) .Pp .D1 $ rgbfix \-vCs \-p 0 \-t foobar baz.gb .Pp @@ -108,4 +114,5 @@ The following will duplicate the header (sans global checksum) of the game .Sh HISTORY .Nm was originally released by Carsten Sørensen as a standalone program called -gbfix. It was later integrated with the ASMotor package, which became RGBDS. +gbfix. +It was later integrated with the ASMotor package, which became RGBDS. diff --git a/man/rgblink.1 b/man/rgblink.1 index 0415cd80..dc2f6e6a 100644 --- a/man/rgblink.1 +++ b/man/rgblink.1 @@ -24,8 +24,8 @@ program links objects created by into a single Game Boy ROM file. .Pp By default, HOME sections created by the assembler are placed in the 16KiB -bank 0, and CODE/DATA sections are placed in any bank except bank 0. If your -ROM will only be 32KiB, you can use the +bank 0, and CODE/DATA sections are placed in any bank except bank 0. +If your ROM will only be 32KiB, you can use the .Fl t option to override this. .Pp @@ -36,8 +36,8 @@ The arguments are as follows: 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. +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. @@ -66,7 +66,8 @@ image like so: .D1 $ rgblink \-o bar.gb foo.o .Pp The resulting bar.gb will not have correct checksums (unless you put them in -the assembly source). You should use +the assembly source). +You should use .Xr rgbfix 1 to fix these so that the program will actually run in a Game Boy: .Pp