Use proper style to document long opts

Correct mandoc style is to use `Fl \-`, not `Fl Fl`, apparently.
2025-11-20 10:12:06 +00:00 · 2023-11-24 21:41:06 +01:00
parent 6f0defbfe5
commit c5721b749c
4 changed files with 90 additions and 90 deletions
--- a/man/rgbasm.1
+++ b/man/rgbasm.1
@@ -39,19 +39,19 @@ 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 b Ar chars , Fl Fl binary-digits Ar chars
+.It Fl b Ar chars , Fl \-binary-digits Ar chars
 Change the two characters used for binary constants.
 The defaults are 01.
-.It Fl D Ar name Ns Oo = Ns Ar value Oc , Fl Fl define Ar name Ns Oo = Ns Ar value Oc
+.It Fl D Ar name Ns Oo = Ns Ar value Oc , Fl \-define Ar name Ns Oo = Ns Ar value Oc
 Add a string symbol to the compiled source code.
 This is equivalent to
 .Ql Ar name Ic EQUS No \(dq Ns Ar value Ns \(dq
@@ -60,21 +60,21 @@ in code, or
 if
 .Ar value
 is not specified.
-.It Fl E , Fl Fl export-all
+.It Fl E , Fl \-export-all
 Export all labels, including unreferenced and local labels.
-.It Fl g Ar chars , Fl Fl gfx-chars Ar chars
+.It Fl g Ar chars , Fl \-gfx-chars Ar chars
 Change the four characters used for gfx constants.
 The defaults are 0123.
-.It Fl H , Fl Fl nop-after-halt
+.It Fl H , Fl \-nop-after-halt
 Inserts a
 .Ic nop
 instruction immediately after any
 .Ic halt
 instruction.
 This option is deprecated and will be removed in the next version.
-.It Fl h , Fl Fl halt-without-nop
+.It Fl h , Fl \-halt-without-nop
 This option is redundant and will be removed in the next version.
-.It Fl I Ar path , Fl Fl include Ar path
+.It Fl I Ar path , Fl \-include Ar path
 Add a new
 .Dq include path ;
 .Ar path
@@ -89,15 +89,15 @@ is attempted,
 first looks up the provided path from its working directory; if this fails, it tries again from each of the
 .Dq include path
 directories, in the order they were provided.
-.It Fl L , Fl Fl preserve-ld
+.It Fl L , Fl \-preserve-ld
 This option is redundant and will be removed in the next version.
-.It Fl l , Fl Fl auto-ldh
+.It Fl l , Fl \-auto-ldh
 Optimize loads of the form
 .Ic LD [$FF00+n8],A
 into the opcode
 .Ic LDH [$FF00+n8],A .
 This option is deprecated and will be removed in the next version.
-.It Fl M Ar depend_file , Fl Fl dependfile Ar depend_file
+.It Fl M Ar depend_file , Fl \-dependfile Ar depend_file
 Print
 .Xr make 1
 dependencies to
@@ -138,34 +138,34 @@ but additionally escapes any special
 .Xr make 1
 characters, essentially
 .Sq $ .
-.It Fl o Ar out_file , Fl Fl output Ar out_file
+.It Fl o Ar out_file , Fl \-output Ar out_file
 Write an object file to the given filename.
-.It Fl P Ar include_file , Fl Fl preinclude Ar include_file
+.It Fl P Ar include_file , Fl \-preinclude Ar include_file
 Pre-include a file.
 This acts as if a
 .Ql Ic INCLUDE Qq Ar include_file
 was read before the input
 .Ar asmfile .
-.It Fl p Ar pad_value , Fl Fl pad-value Ar pad_value
+.It Fl p Ar pad_value , Fl \-pad-value Ar pad_value
 Use this as the value for
 .Ic DS
 directives in ROM sections, unless overridden.
 The default is 0x00.
-.It Fl Q Ar fix_precision , Fl Fl q-precision Ar fix_precision
+.It Fl Q Ar fix_precision , Fl \-q-precision Ar fix_precision
 Use this as the precision of fixed-point numbers after the decimal point, unless they specify their own precision.
 The default is 16, so fixed-point numbers are Q16.16 (since they are 32-bit integers).
 The argument may start with a
 .Ql \&.
 to match the Q notation, for example,
 .Ql Fl Q Ar .16 .
-.It Fl r Ar recursion_depth , Fl Fl recursion-depth Ar recursion_depth
+.It Fl r Ar recursion_depth , Fl \-recursion-depth Ar recursion_depth
 Specifies the recursion depth past which RGBASM will assume being in an infinite loop.
 The default is 64.
-.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
 Be verbose.
-.It Fl W Ar warning , Fl Fl warning Ar warning
+.It Fl W Ar warning , Fl \-warning Ar warning
 Set warning flag
 .Ar warning .
 A warning message will be printed if
--- a/man/rgbfix.1
+++ b/man/rgbfix.1
@@ -43,31 +43,31 @@ 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 color-o
+.Fl \-color-o
 is
-.Fl Fl color-only ,
+.Fl \-color-only ,
 but
-.Fl Fl color
+.Fl \-color
 is invalid because it could also be
-.Fl Fl color-compatible .
+.Fl \-color-compatible .
 Options later in the command line override those set earlier.
 Accepted options are as follows:
 .Bl -tag -width Ds
-.It Fl C , Fl Fl color-only
+.It Fl C , Fl \-color-only
 Set the Game Boy Color\(enonly flag
 .Pq Ad 0x143
 to 0xC0.
 This overrides
 .Fl c
 if it was set prior.
-.It Fl c , Fl Fl color-compatible
+.It Fl c , Fl \-color-compatible
 Set the Game Boy Color\(encompatible flag:
 .Pq Ad 0x143
 to 0x80.
 This overrides
 .Fl c
 if it was set prior.
-.It Fl f Ar fix_spec , Fl Fl fix-spec Ar fix_spec
+.It Fl f Ar fix_spec , Fl \-fix-spec Ar fix_spec
 Fix certain header values that the Game Boy checks for correctness.
 Alternatively, intentionally trash these values by writing their binary inverse instead.
 .Ar fix_spec
@@ -90,26 +90,26 @@ Fix the global checksum
 .It Cm G
 Trash the global checksum.
 .El
-.It Fl i Ar game_id , Fl Fl game-id Ar game_id
+.It Fl i Ar game_id , Fl \-game-id Ar game_id
 Set the game ID string
 .Pq Ad 0x13F Ns \(en Ns Ad 0x142
 to a given string.
 If it's longer than 4 chars, it will be truncated, and a warning emitted.
-.It Fl j , Fl Fl non-japanese
+.It Fl j , Fl \-non-japanese
 Set the non-Japanese region flag
 .Pq Ad 0x14A
 to 0x01.
-.It Fl k Ar licensee_str , Fl Fl new-licensee Ar licensee_str
+.It Fl k Ar licensee_str , Fl \-new-licensee Ar licensee_str
 Set the new licensee string
 .Pq Ad 0x144 Ns \(en Ns Ad 0x145
 to a given string.
 If it's longer than 2 chars, it will be truncated, and a warning emitted.
-.It Fl l Ar licensee_id , Fl Fl old-licensee Ar licensee_id
+.It Fl l Ar licensee_id , Fl \-old-licensee Ar licensee_id
 Set the old licensee code
 .Pq Ad 0x14B
 to a given value from 0 to 0xFF.
 This value is deprecated and should be set to 0x33 in all new software.
-.It Fl m Ar mbc_type , Fl Fl mbc-type Ar mbc_type
+.It Fl m Ar mbc_type , Fl \-mbc-type Ar mbc_type
 Set the MBC type
 .Pq Ad 0x147
 to a given value from 0 to 0xFF.
@@ -122,13 +122,13 @@ Any amount of whitespace (space and tabs) is allowed around plus signs, and the
 There are special considerations to take for the TPP1 mapper; see the
 .Sx TPP1
 section below.
-.It Fl n Ar rom_version , Fl Fl rom-version Ar rom_version
+.It Fl n Ar rom_version , Fl \-rom-version Ar rom_version
 Set the ROM version
 .Pq Ad 0x14C
 to a given value from 0 to 0xFF.
-.It Fl O , Fl Fl overwrite
+.It Fl O , Fl \-overwrite
 Allow overwriting different non-zero bytes in the header without a warning being emitted.
-.It Fl p Ar pad_value , Fl Fl pad-value Ar pad_value
+.It Fl p Ar pad_value , Fl \-pad-value Ar pad_value
 Pad the ROM image to a valid size with a given pad value from 0 to 255 (0xFF).
 .Nm
 will automatically pick a size from 32 KiB, 64 KiB, 128 KiB, ..., 8192 KiB.
@@ -136,11 +136,11 @@ The cartridge size byte
 .Pq Ad 0x148
 will be changed to reflect this new size.
 The recommended padding value is 0xFF, to speed up writing the ROM to flash chips, and to avoid "nop slides" into VRAM.
-.It Fl r Ar ram_size , Fl Fl ram-size Ar ram_size
+.It Fl r Ar ram_size , Fl \-ram-size Ar ram_size
 Set the RAM size
 .Pq Ad 0x149
 to a given value from 0 to 0xFF.
-.It Fl s , Fl Fl sgb-compatible
+.It Fl s , Fl \-sgb-compatible
 Set the SGB flag
 .Pq Ad 0x146
 to 0x03.
@@ -148,7 +148,7 @@ This flag will be ignored by the SGB unless the old licensee code is 0x33!
 If this is given as well as
 .Fl l ,
 but is not set to 0x33, a warning will be printed.
-.It Fl t Ar title , Fl Fl title Ar title
+.It Fl t Ar title , Fl \-title Ar title
 Set the title string
 .Pq Ad 0x134 Ns \(en Ns Ad 0x143
 to a given string.
@@ -160,9 +160,9 @@ is specified, 15 characters if the CGB flag
 or
 .Fl C )
 is specified but the game ID is not, and 16 characters otherwise.
-.It Fl V , Fl Fl version
+.It Fl V , Fl \-version
 Print the version of the program and exit.
-.It Fl v , Fl Fl validate
+.It Fl v , Fl \-validate
 Equivalent to
 .Fl f Cm lhg .
 .El
--- a/man/rgbgfx.1
+++ b/man/rgbgfx.1
@@ -40,13 +40,13 @@ convert each of those squares into 1bpp or 2bpp tile data, and save all of the t
 It also has options to generate a tile map, attribute map, and/or palette set as well; more on that and how the conversion process can be tweaked below.
 .Sh ARGUMENTS
 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 .
 .Pp
 .Nm
 accepts decimal, binary, and hexadecimal numbers in option arguments.
@@ -82,7 +82,7 @@ Using standard input or output more than once in a single command will likely pr
 .Pp
 The following options are accepted:
 .Bl -tag -width Ds
-.It Fl a Ar attrmap , Fl Fl attr-map Ar attrmap
+.It Fl a Ar attrmap , Fl \-attr-map Ar attrmap
 Generate an attribute map, which is a file containing tile
 .Dq attributes .
 For each square of the input image, its corresponding attribute map byte contains the mirroring bits (if
@@ -98,20 +98,20 @@ The output is written just like the tile map (see
 follows the same order
 .Pq Fl Z ,
 and has the same size.
-.It Fl A , Fl Fl auto-attr-map
+.It Fl A , Fl \-auto-attr-map
 Same as
 .Fl a Ar base_path Ns .attrmap
 .Pq see Sx Automatic output paths .
-.It Fl b Ar base_ids , Fl Fl base-tiles Ar base_ids
+.It Fl b Ar base_ids , Fl \-base-tiles Ar base_ids
 Set the base IDs for tile map output.
 .Ar base_ids
 should be one or two numbers between 0 and 255, separated by a comma; they are for bank 0 and bank 1 respectively.
 Both default to 0.
-.It Fl C , Fl Fl color-curve
+.It Fl C , Fl \-color-curve
 When generating palettes, use a color curve mimicking the Game Boy Color's screen.
 The resulting colors may look closer to the input image's
 .Sy on hardware and accurate emulators .
-.It Fl c Ar color_spec , Fl Fl colors Ar color_spec
+.It Fl c Ar color_spec , Fl \-colors Ar color_spec
 Use the specified color palettes instead of having
 .Nm
 automatically determine some.
@@ -158,10 +158,10 @@ See
 .Sx PALETTE SPECIFICATION FORMATS
 for a list of formats and their descriptions.
 .El
-.It Fl d Ar depth , Fl Fl depth Ar depth
+.It Fl d Ar depth , Fl \-depth Ar depth
 Set the bit depth of the output tile data, in bits per pixel (bpp), either 1 or 2 (the default).
 This changes how tile data is output, and the maximum number of colors per palette (2 and 4 respectively).
-.It Fl L Ar slice , Fl Fl slice Ar slice
+.It Fl L Ar slice , Fl \-slice Ar slice
 Only process a given rectangle of the image.
 This is useful for example if the input image is a sheet of some sort, and you want to convert each cel individually.
 The default is to process the whole image as-is.
@@ -173,7 +173,7 @@ The first number pair specifies the X and Y coordinates of the top-left pixel th
 The second number pair specifies how many tiles to process horizontally and vertically, respectively.
 .Pp
 .Fl L Sy is ignored in reverse mode , No no padding is inserted .
-.It Fl m , Fl Fl mirror-tiles
+.It Fl m , 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.
 Tiles are checked for horizontal, vertical, and horizontal-vertical mirroring.
@@ -184,7 +184,7 @@ and
 to keep track of the duplicated tiles and the dimension(s) mirrored.
 Implies
 .Fl u .
-.It Fl N Ar nb_tiles , Fl Fl nb-tiles Ar nb_tiles
+.It Fl N Ar nb_tiles , Fl \-nb-tiles Ar nb_tiles
 Set a maximum number of tiles that can be placed in each VRAM bank.
 .Ar nb_tiles
 should be one or two numbers between 0 and 256, separated by a comma; if the latter is omitted, it defaults to 0.
@@ -196,7 +196,7 @@ will abort.
 If
 .Fl N
 is not specified, no limit will be set on the amount of tiles placed in bank 0, and tiles will not be placed in bank 1.
-.It Fl n Ar nb_pals , Fl Fl nb-palettes Ar nb_pals
+.It Fl n Ar nb_pals , Fl \-nb-palettes Ar nb_pals
 Abort if more than
 .Ar nb_pals
 palettes are generated.
@@ -204,31 +204,31 @@ This may not be more than 256.
 .Pp
 Note that attribute map output only has 3 bits for the palette ID, so a limit higher than 8 may yield incomplete data unless relying on a palette map
 .Pq see Fl q .
-.It Fl O , Fl Fl group-outputs
+.It Fl O , Fl \-group-outputs
 Sets the
 .Sq base path
 to be the output tile data path from
 .Fl o
 instead of the input image path
 .Pq see Sx Automatic output paths .
-.It Fl o Ar out_file , Fl Fl output Ar out_file
+.It Fl o Ar out_file , Fl \-output Ar out_file
 Output the tile data in native 2bpp format or in 1bpp
 .Pq depending on Fl d
 to this file.
-.It Fl p Ar pal_file , Fl Fl palette Ar pal_file
+.It Fl p Ar pal_file , Fl \-palette Ar pal_file
 Output the image's palette set to this file.
-.It Fl P , Fl Fl auto-palette
+.It Fl P , Fl \-auto-palette
 Same as
 .Fl p Ar base_path Ns .pal
 .Pq see Sx Automatic output paths .
-.It Fl q Ar pal_file , Fl Fl palette-map Ar pal_file
+.It Fl q Ar pal_file , Fl \-palette-map Ar pal_file
 Output the image's palette map to this file.
 This is useful if the input image contains more than 8 palettes, as the attribute map only contains the lower 3 bits of the palette indices.
-.It Fl Q , Fl Fl auto-palette-map
+.It Fl Q , Fl \-auto-palette-map
 Same as
 .Fl q Ar base_path Ns .palmap
 .Pq see Sx Automatic output paths .
-.It Fl r Ar width , Fl Fl reverse Ar width
+.It Fl r Ar width , Fl \-reverse Ar width
 Switches
 .Nm
 into
@@ -243,13 +243,13 @@ below for details.
 .Pp
 .Ar width
 is the width of the image to generate, in tiles.
-.It Fl s Ar nb_colors , Fl Fl palette-size Ar nb_colors
+.It Fl s Ar nb_colors , Fl \-palette-size Ar nb_colors
 Specify how many colors each palette contains, including the transparent one if any.
 .Ar nb_colors
 cannot be more than
 .Ql 1 << Ar depth
 .Pq see Fl d .
-.It Fl t Ar tilemap , Fl Fl tilemap Ar tilemap
+.It Fl t Ar tilemap , Fl \-tilemap Ar tilemap
 Generate a file of tile indices.
 For each square of the input image, its corresponding tile map byte contains the index of the associated tile in the tile data file.
 The IDs wrap around from 255 back to 0, and do not include the bank bit; use
@@ -260,11 +260,11 @@ Useful in combination with
 and/or
 .Fl m
 to keep track of duplicate tiles.
-.It Fl T , Fl Fl auto-tilemap
+.It Fl T , Fl \-auto-tilemap
 Same as
 .Fl t Ar base_path Ns .tilemap
 .Pq see Sx Automatic output paths .
-.It Fl u , Fl Fl unique-tiles
+.It Fl u , Fl \-unique-tiles
 Deduplicate identical tiles.
 Only one of each unique tile will be saved in the tile data file.
 Useful with a tile map
@@ -276,9 +276,9 @@ Note that if this option is enabled, no guarantee is made on the order in which
 be consistent across identical runs of a given
 .Nm
 release, the same is not true for different releases.
-.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
 Be verbose.
 The verbosity level is increased by one each time the flag is specified, with each level including the previous:
 .Bl -enum -width 2n -compact
@@ -295,7 +295,7 @@ Some internal debug printing is enabled.
 The verbosity level does not go past 6.
 .Pp
 Note that verbose output is only intended to be consumed by humans, and may change without notice between RGBDS releases; relying on those for scripts is not advised.
-.It Fl x Ar quantity , Fl Fl trim-end Ar quantity
+.It Fl x Ar quantity , Fl \-trim-end Ar quantity
 Do not output the last
 .Ar quantity
 tiles to the tile data file; no other output is affected.
@@ -315,7 +315,7 @@ was enabled, so you probably don't want to use this option in combination with
 Note also that the tiles that don't get output will not count towards
 .Fl N Ap s
 limit.
-.It Fl Z , Fl Fl columns
+.It Fl Z , Fl \-columns
 Read squares from the PNG in column-major order (column by column), instead of the default row-major order (line by line).
 This primarily affects tile map and attribute map output, although it may also change generated tile data and palettes.
 .El
--- a/man/rgblink.1
+++ b/man/rgblink.1
@@ -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 .