From: Nick Bowler Date: Fri, 1 Dec 2023 04:10:05 +0000 (-0500) Subject: Trivial manual fixes. X-Git-Url: https://git.draconx.ca/gitweb/liblbx.git/commitdiff_plain/HEAD Trivial manual fixes. For literal strings, we need to use \- instead of just - as some troff processors turn plain "-" into "proper" unicode hyphens (as opposed to hyphen-minus), which breaks copy+paste and searching. Ensure that .Os follows .Dt in the mdoc prologue as apparently not doing this results in broken manpage headings with groff 1.23. --- diff --git a/doc/man/lbximg.1 b/doc/man/lbximg.1 index e3a91c1..be1bdf6 100644 --- a/doc/man/lbximg.1 +++ b/doc/man/lbximg.1 @@ -1,6 +1,6 @@ -.Dd September 12, 2021 -.Os liblbx +.Dd November 30, 2023 .Dt LBXIMG \&1 "2ooM Reference Manual" +.Os liblbx .Sh NAME .Nm lbximg .Nd inspect and decode LBX images @@ -24,13 +24,13 @@ can be used to convert some or all of the frames of an LBX image to other image formats. .Sh OPTIONS .Bl -tag -width indent -.It Fl i , -ident +.It Fl i , \-ident Sets the operating mode to identify the image format. -.It Fl d , -decode +.It Fl d , \-decode Sets the operating mode to decode frames to PNG. -.It Fl v , -verbose +.It Fl v , \-verbose Output additional information on standard output. -.It Fl F , -format Ar format +.It Fl F , \-format Ar format Select the desired output format. Some formats may not be available depending on the compile-time settings of .Nm . @@ -60,21 +60,21 @@ bitmap values represent whether or not a pixel is transparent. Black (1) pixels are transparent, white (0) pixels are opaque. This format is extremely inefficient and provided mainly for testing. .El -.It Fl f , -file Ar path +.It Fl f , \-file Ar path Read from the specified .Ar path instead of standard input. -.It Fl -output-prefix Ar string +.It Fl \-output\-prefix Ar string Prefix each output filename with the given string. Filenames are produced by adding a frame number and file extension to the given prefix. The default prefix is .Li out . -.It Fl n , -no-palette +.It Fl n , \-no\-palette Instead of looking up colour indices in the palette, emit a grayscale image where the intensity value of a pixel is equal to the palette index itself. This is mainly useful for debugging the image decoder in .Em liblbx . -.It Fl p , -palette Ar palette_file +.It Fl p , \-palette Ar palette_file Read the base palette from .Ar palette_file . In Moo2, these files are found in @@ -82,30 +82,30 @@ In Moo2, these files are found in Without this option, the base palette is filled with a nice hot pink. Colours in the base palette are superseded by those in the embedded palette and the override palette. -.It Fl O , -override Ar override_file +.It Fl O , \-override Ar override_file Use the embedded palette of an LBX image specified by .Ar override_file as the override palette. One example of where this is used is for selecting the player colour for ship images. Colours in the override palette supersede those in both the base palette and the embedded palette. -.It Fl V , -version +.It Fl V , \-version Print a version message and exit. -.It Fl -usage +.It Fl \-usage Print a short usage message and exit. -.It Fl -help +.It Fl \-help Print a help message and exit .It Ar frameno ... Specifies the frames to decode as a sequence of intervals, with frames indexing from zero. By default, all frames are decoded. Multiplicity is ignored, as is the order in which frames are specified. For example: .Bl -tag -width -.It Nm Li -d 3 6 +.It Nm Li \-d 3 6 Decode frames 3 and 6. -.It Nm Li -d 4-9 +.It Nm Li \-d 4\-9 Decode frames 4 through 9, inclusive -.It Nm Li -d 6-9 1-4 +.It Nm Li \-d 6\-9 1\-4 Decode frames 1 through 9, except for frame 5. -.It Nm Li -d 3- +.It Nm Li \-d 3\- Decode all frames except the first 3. .El .El @@ -113,19 +113,19 @@ Decode all frames except the first 3. After extracting fonts.lbx, mainmenu.lbx, logo.lbx and ships.lbx with .Xr lbxtool 1 : .Bl -tag -width indent -.It Nm Li -ivf logo.lbx.000 +.It Nm Li \-ivf logo.lbx.000 Print some information about the Simtex logo image. -.It Nm Li -dvf mainmenu.lbx.000 -p fonts.lbx.006 +.It Nm Li \-dvf mainmenu.lbx.000 \-p fonts.lbx.006 Decodes all the frames of the main menu panel into a series of PNGs. -.It Nm Li -dvf logo.lbx.001 +.It Nm Li \-dvf logo.lbx.001 Decodes all the frames of the Microprose logo into a series of PNGs. -.It Nm Li -dvf ships.lbx.042 -p fonts.lbx.012 -O ships.lbx.049 +.It Nm Li \-dvf ships.lbx.042 \-p fonts.lbx.012 \-O ships.lbx.049 Decodes an image of a red star fortress. .El .Sh AUTHORS Nick Bowler .Sh COPYRIGHT -Copyright \(co 2008, 2010, 2013, 2021 Nick Bowler +Copyright \(co 2008, 2010, 2013, 2021, 2023 Nick Bowler .Pp Permission is granted to copy, distribute and/or modify this manual under the terms of the GNU General Public License as published by the Free Software diff --git a/doc/man/lbxtool.1 b/doc/man/lbxtool.1 index 63bd254..5b7d2af 100644 --- a/doc/man/lbxtool.1 +++ b/doc/man/lbxtool.1 @@ -1,6 +1,6 @@ -.Dd September 12, 2021 -.Os liblbx +.Dd November 30, 2023 .Dt LBXTOOL \&1 "2ooM Reference Manual" +.Os liblbx .Sh NAME .Nm lbxtool .Nd manipulate LBX archives @@ -17,19 +17,19 @@ using .Em liblbx . .Sh OPTIONS .Bl -tag -width indent -.It Fl l , -list +.It Fl l , \-list Sets the operating mode to list files in the archive. -.It Fl x , -extract +.It Fl x , \-extract Sets the operating mode to extract files from the archive. -.It Fl v , -verbose +.It Fl v , \-verbose Output additional information on standard output. -.It Fl f , -file Ar path +.It Fl f , \-file Ar path Read from the specified .Ar path instead of standard input. -.It Fl V , -version +.It Fl V , \-version Print a version message and exit. -.It Fl H , -help +.It Fl H , \-help Print a help message and exit .It Ar Limit the operation to these files in the archive. By default, all files are @@ -42,7 +42,7 @@ hopefully be lifted in the future. .Sh AUTHORS Nick Bowler .Sh COPYRIGHT -Copyright \(co 2008, 2010, 2021 Nick Bowler +Copyright \(co 2008, 2010, 2021, 2023 Nick Bowler .Pp Permission is granted to copy, distribute and/or modify this manual under the terms of the GNU General Public License as published by the Free Software