mirror of
https://github.com/gbdev/rgbds.git
synced 2025-11-27 21:42:06 +00:00
Use proper style to document long opts
Correct mandoc style is to use `Fl \-`, not `Fl Fl`, apparently.
This commit is contained in:
@@ -54,34 +54,34 @@ can be a path to a file, or
|
||||
to read from standard input.
|
||||
.Pp
|
||||
Note that options can be abbreviated as long as the abbreviation is unambiguous:
|
||||
.Fl Fl verb
|
||||
.Fl \-verb
|
||||
is
|
||||
.Fl Fl verbose ,
|
||||
.Fl \-verbose ,
|
||||
but
|
||||
.Fl Fl ver
|
||||
.Fl \-ver
|
||||
is invalid because it could also be
|
||||
.Fl Fl version .
|
||||
.Fl \-version .
|
||||
The arguments are as follows:
|
||||
.Bl -tag -width Ds
|
||||
.It Fl d , Fl Fl dmg
|
||||
.It Fl d , Fl \-dmg
|
||||
Enable DMG mode.
|
||||
Prohibit the use of sections that doesn't exist on a DMG, such as VRAM bank 1.
|
||||
This option automatically enables
|
||||
.Fl w .
|
||||
.It Fl l Ar linker_script , Fl Fl linkerscript Ar linker_script
|
||||
.It Fl l Ar linker_script , Fl \-linkerscript Ar linker_script
|
||||
Specify a linker script file that tells the linker how sections must be placed in the ROM.
|
||||
The attributes assigned in the linker script must be consistent with any assigned in the code.
|
||||
See
|
||||
.Xr rgblink 5
|
||||
for more information about the linker script format.
|
||||
.It Fl M , Fl Fl no-sym-in-map
|
||||
.It Fl M , Fl \-no-sym-in-map
|
||||
If specified, the map file will not list symbols, only sections.
|
||||
.It Fl m Ar map_file , Fl Fl map Ar map_file
|
||||
.It Fl m Ar map_file , Fl \-map Ar map_file
|
||||
Write a map file to the given filename, listing how sections and symbols were assigned.
|
||||
.It Fl n Ar sym_file , Fl Fl sym Ar sym_file
|
||||
.It Fl n Ar sym_file , Fl \-sym Ar sym_file
|
||||
Write a symbol file to the given filename, listing the address of all exported symbols.
|
||||
Several external programs can use this information, for example to help debugging ROMs.
|
||||
.It Fl O Ar overlay_file , Fl Fl overlay Ar overlay_file
|
||||
.It Fl O Ar overlay_file , Fl \-overlay Ar overlay_file
|
||||
If specified, sections will be overlaid "on top" of the ROM image
|
||||
.Ar overlay_file :
|
||||
empty space between sections will be filled by the corresponding bytes from
|
||||
@@ -90,15 +90,15 @@ This is useful to patch an existing ROM.
|
||||
Note that all sections must be fixed (forced bank
|
||||
.Sy and
|
||||
address)!
|
||||
.It Fl o Ar out_file , Fl Fl output Ar out_file
|
||||
.It Fl o Ar out_file , Fl \-output Ar out_file
|
||||
Write the ROM image to the given file.
|
||||
.It Fl p Ar pad_value , Fl Fl pad Ar pad_value
|
||||
.It Fl p Ar pad_value , Fl \-pad Ar pad_value
|
||||
When inserting padding between sections, pad with this value.
|
||||
Has no effect if
|
||||
.Fl O
|
||||
is specified.
|
||||
The default is 0.
|
||||
.It Fl S Ar spec , Fl Fl scramble Ar spec
|
||||
.It Fl S Ar spec , Fl \-scramble Ar spec
|
||||
Enables a different
|
||||
.Dq scrambling
|
||||
algorithm for placing sections.
|
||||
@@ -106,22 +106,22 @@ See
|
||||
.Sx Scrambling algorithm
|
||||
below for an explanation and a description of
|
||||
.Ar spec .
|
||||
.It Fl s Ar symbol , Fl Fl smart Ar symbol
|
||||
.It Fl s Ar symbol , Fl \-smart Ar symbol
|
||||
This option is ignored.
|
||||
It was supposed to perform smart linking but fell into disrepair, and so has been removed.
|
||||
It will be reimplemented at some point.
|
||||
.It Fl t , Fl Fl tiny
|
||||
.It Fl t , Fl \-tiny
|
||||
Expand the ROM0 section size from 16 KiB to the full 32 KiB assigned to ROM.
|
||||
ROMX sections that are fixed to a bank other than 1 become errors, other ROMX sections are treated as ROM0.
|
||||
Useful for ROMs that fit in 32 KiB.
|
||||
.It Fl V , Fl Fl version
|
||||
.It Fl V , Fl \-version
|
||||
Print the version of the program and exit.
|
||||
.It Fl v , Fl Fl verbose
|
||||
.It Fl v , Fl \-verbose
|
||||
Verbose: enable printing more information to standard error.
|
||||
.It Fl w , Fl Fl wramx
|
||||
.It Fl w , Fl \-wramx
|
||||
Expand the WRAM0 section size from 4 KiB to the full 8 KiB assigned to WRAM.
|
||||
WRAMX sections that are fixed to a bank other than 1 become errors, other WRAMX sections are treated as WRAM0.
|
||||
.It Fl x , Fl Fl nopad
|
||||
.It Fl x , Fl \-nopad
|
||||
Disables padding the end of the final file.
|
||||
This option automatically enables
|
||||
.Fl t .
|
||||
|
||||
Reference in New Issue
Block a user