[src/trunk]: src/usr.sbin/installboot installboot(8): fix up markup

[uwe <uwe%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/45f5f0f19066
branches:  trunk
changeset: 375860:45f5f0f19066
user:      uwe <uwe%NetBSD.org@localhost>
date:      Wed May 17 01:35:00 2023 +0000

description:
installboot(8): fix up markup

Don't overuse .Sy - when everything is highlighted, nothing is.  Use
.Ic for options &c to get correct PostScript output (both are bold in
plain text).

Use Aq Ar inside .Pa, as both Pa and Ar are rendered as underscored
text in plain text output, and the distinction is lost.

Don't set examples in bold, but give them .Pp space around - they are
much easier to read this way.

Use consistent -width in FILES.

diffstat:

 usr.sbin/installboot/installboot.8 |  766 +++++++++++++++++++++---------------
 1 files changed, 443 insertions(+), 323 deletions(-)

diffs (truncated from 1332 to 300 lines):

diff -r dc65a6e18bab -r 45f5f0f19066 usr.sbin/installboot/installboot.8
--- a/usr.sbin/installboot/installboot.8        Tue May 16 22:00:23 2023 +0000
+++ b/usr.sbin/installboot/installboot.8        Wed May 17 01:35:00 2023 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: installboot.8,v 1.106 2023/05/16 21:52:42 lukem Exp $
+.\"    $NetBSD: installboot.8,v 1.107 2023/05/17 01:35:00 uwe Exp $
 .\"
 .\" Copyright (c) 2002-2023 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -27,6 +27,11 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
+.
+.\" Prevent accidental hyphenation after the hyphen in "U-Boot"
+.\" Usage: \*(UB
+.ds UB U\(hyBoot
+.
 .Dd May 16, 2023
 .Dt INSTALLBOOT 8
 .Os
@@ -73,7 +78,7 @@ into
 .Ar filesystem ,
 or disable an existing bootstrap in
 .Ar filesystem .
-.Ss Traditional Nx boot
+.Ss Traditional NetBSD boot
 Generally,
 .Nx
 disk bootstrap software consists of two parts: a
@@ -86,7 +91,10 @@ and a
 bootstrap program that usually resides as an ordinary file in the file system.
 .Pp
 When booting, the primary bootstrap program is loaded and invoked by
-the machine's PROM or BIOS.
+the machine's
+.Tn PROM
+or
+.Tn BIOS .
 After receiving control of the system it loads and runs the secondary
 bootstrap program, which in turn loads and runs the kernel.
 The secondary bootstrap may allow control over various boot parameters
@@ -95,18 +103,23 @@ passed to the kernel.
 Perform the following steps to make a file system bootable:
 .Bl -enum
 .It
-Copy the secondary bootstrap (usually
-.Pa /usr/mdec/boot. Ns Sy MACHINE
+Copy the secondary bootstrap
+.Po
+usually
+.Pa /usr/mdec/boot. Ns Aq Ar MACHINE\^
 or
-.Pa /usr/mdec/boot )
+.Pa /usr/mdec/boot
+.Pc
 to the root directory of the target file system.
 .
 .It
 Use
 .Nm
 to install the primary bootstrap program
-(usually
-.Pa /usr/mdec/bootxx_ Ns Sy FSTYPE )
+.Po
+usually
+.Pa /usr/mdec/bootxx_ Ns Aq Ar FSTYPE\^
+.Pc
 into
 .Ar filesystem .
 .Pp
@@ -142,44 +155,63 @@ information to
 Information about known boards and their requirements is loaded from a
 database at run-time.
 Sometimes these platforms also require the use of 3rd-party boot loader
-software, such as
-.Sy U-Boot .
+software, such as \*(UB.
 To support these platforms,
 .Nm
 scans known locations for these 3rd-party boot loader packages for
 database overlays that contain additional board-specific boot loader
 installation information in a file called
-.Sq installboot.plist .
+.Pa installboot.plist .
 .Pp
 The following platforms have this requirement and utilize this database
 overlay feature:
 .Sy evbarm .
 .Ss UEFI boot
-On platforms that boot with UEFI, there is a single boot loader in the
-EFI system partition at
-.Pa EFI/boot/boot Ns Va ARCH Ns Pa .efi
+On platforms that boot with
+.Tn UEFI ,
+there is a single boot loader in the
+.Tn EFI
+system partition at
+.Pa EFI/boot/boot Ns Ao Ar ARCH\^ Ac Ns Pa .efi
 where
-.Va ARCH
-is the UEFI name for the architecture, such as
-.Li ia32 Pq Nx Ns /i386 ,
-.Li x64 Pq Nx Ns /amd64 ,
+.Ar ARCH
+is the
+.Tn UEFI
+name for the architecture, such as
+.Li ia32
+.Pq Nx Ns /i386 ,
+.Li x64
+.Pq Nx Ns /amd64 ,
 or
-.Li aa64 Pq Nx Ns /aarch64 .
+.Li aa64
+.Pq Nx Ns /aarch64 .
 .Pp
 .Nm
-is not needed for UEFI boot.
-However, it may be used on a platform that supports UEFI boot to make a
+is not needed for
+.Tn UEFI
+boot.
+However, it may be used on a platform that supports
+.Tn UEFI
+boot to make a
 hybrid image that can be booted
 .Em either
-with UEFI boot or with, e.g., BIOS or U-Boot.
-Hybrid images may also require a special GPT for BIOS boot; see
+with
+.Tn UEFI
+boot or with, e.g.,
+.Tn BIOS
+or \*(UB.
+Hybrid images may also require a special
+.Tn GPT
+for
+.Tn BIOS
+boot; see
 .Xr gpt 8 .
 .Ss Options
 The options and arguments recognized by
 .Nm
 are as follows:
 .
-.Bl -tag -width "optionsxxx"
+.Bl -tag -width Fl
 .
 .It Fl B Ar s2bno
 When hard-coding the blocks of
@@ -194,9 +226,11 @@ by examining
 .Ar filesystem .
 If this option is supplied,
 .Ar secondary
-should refer to an actual secondary bootstrap (rather than the
-file name of the one present in
-.Ar filesystem )
+should refer to an actual secondary bootstrap
+.Po
+rather than the file name of the one present in
+.Ar filesystem
+.Pc
 so that its size can be determined.
 .
 .It Fl b Ar s1bno
@@ -206,7 +240,11 @@ at block number
 .Ar s1bno
 instead of the default location for the machine and file system type.
 .Sy [ alpha ,
-.Sy i386/amd64 (bootxx_fat16 only) ,
+.Sy i386/amd64
+.Po
+.Pa bootxx_fat16
+only
+.Pc ,
 .Sy pmax ,
 .Sy vax ]
 .
@@ -215,7 +253,9 @@ Clear (remove) any existing bootstrap in
 .
 .It Fl e
 Edit the options of an existing bootstrap.
-This can be used to change the options in bootxx_xxxfs files,
+This can be used to change the options in
+.Pa bootxx_ Ns Aq Ar FSTYPE\^
+files,
 raw disk partitions, and the
 .Pa pxeboot_ia32.bin
 file.
@@ -238,30 +278,30 @@ as the target machine type.
 The default machine is determined from
 .Xr uname 3
 and then
-.Ev MACHINE .
-The following machines are currently supported by
-.Nm :
+.Ev MACHINE
+environment variable.
+The following machines are currently supported:
 .Bd -ragged -offset indent
-.Sy alpha ,
-.Sy amd64 ,
-.Sy amiga ,
-.Sy evbarm ,
-.Sy ews4800mips ,
-.Sy hp300 ,
-.Sy hppa ,
-.Sy i386 ,
-.Sy landisk ,
-.Sy macppc ,
-.Sy news68k ,
-.Sy newsmips ,
-.Sy next68k ,
-.Sy pmax ,
-.Sy sparc ,
-.Sy sparc64 ,
-.Sy sun2 ,
-.Sy sun3 ,
-.Sy vax ,
-.Sy x68k
+.Ic alpha ,
+.Ic amd64 ,
+.Ic amiga ,
+.Ic evbarm ,
+.Ic ews4800mips ,
+.Ic hp300 ,
+.Ic hppa ,
+.Ic i386 ,
+.Ic landisk ,
+.Ic macppc ,
+.Ic news68k ,
+.Ic newsmips ,
+.Ic next68k ,
+.Ic pmax ,
+.Ic sparc ,
+.Ic sparc64 ,
+.Ic sun2 ,
+.Ic sun3 ,
+.Ic vax ,
+.Ic x68k
 .Ed
 .
 .
@@ -274,17 +314,18 @@ Machine specific
 .Nm
 options, comma separated.
 .Pp
-Supported options are (with the machines for they are valid in brackets):
+Supported options are
+.Pq with the machines for they are valid in brackets :
 .
-.Bl -tag -offset indent -width alphasum
+.Bl -tag -width Ic
 .
-.It Sy alphasum
+.It Ic alphasum
 .Sy [ alpha ]
 Recalculate and restore the Alpha checksum.
 This is the default for
 .Nx Ns /alpha .
 .
-.It Sy append
+.It Ic append
 .Sy [ alpha ,
 .Sy pmax ,
 .Sy vax ]
@@ -294,7 +335,7 @@ to the end of
 .Ar filesystem ,
 which must be a regular file in this case.
 .
-.It Sy board Ns Op = Ns Ar type
+.It Ic board Ns Op Ns Li = Ns Ar type
 .Sy [ evbarm ]
 Specify the board type used to determine the correct boot loader image
 and installation procedure.
@@ -303,55 +344,57 @@ If omitted,
 will attempt to guess the board type based on system information if run
 natively.
 .
-.It Sy bootconf
+.It Ic bootconf
 .Sy [ amd64 ,
 .Sy i386 ]
 (Don't) read a
-.Dq boot.cfg
+.Pa boot.cfg
 file.
 .
-.It Sy command= Ns Ar commandline
+.It Ic command Ns Li = Ns Ar commandline
 .Sy [ amiga ]
 Modify the default boot command line.
 .
-.It Sy console= Ns Ar name
+.It Ic console Ns Li = Ns Ar name
 .Sy [ amd64 ,
 .Sy i386 ]
 Set the console device.
 .Ar name