etdump.1: Polish + xref cd9660(4)

+ correct misfile in section 8
+ rewrite the document descirption to include -9660
+ markup command modifiers as such instead of bold
+ markup variables as defined variables, enabling apropos
+ correct option syntax in description section
+ unwrap list offsets for legibility
+ fix line wrapping for standard BSD console
+ crossreference cd9660(4) and vis versa
+ tag SPDX for both manuals

MFC after:		3 days
Reviewed by:		mhorne
Approved by:		mhorne (mentor)
Differential Revision:	https://reviews.freebsd.org/D48513
This commit is contained in:
Alexander Ziaee 2025-01-18 21:04:36 -05:00
parent 3bf433f141
commit 283be95ea2
No known key found for this signature in database
GPG key ID: 0A8F850BCDEF4511
2 changed files with 34 additions and 23 deletions

View file

@ -1,4 +1,6 @@
.\"
.\" SPDX-License-Identifier: BSD-3-Clause
.\"
.\" Copyright (c) 2017 Enji Cooper
.\"
.\" Redistribution and use in source and binary forms, with or without
@ -23,7 +25,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd April 25, 2023
.Dd January 18, 2025
.Dt CD9660 4
.Os
.Sh NAME
@ -57,6 +59,7 @@ volume located on
.Pp
.Dl "mount -t cd9660 /dev/cd0 /mnt"
.Sh SEE ALSO
.Xr etdump 1 ,
.Xr nmount 2 ,
.Xr unmount 2 ,
.Xr cd 4 ,

View file

@ -1,3 +1,6 @@
.\"
.\" SPDX-License-Identifier: BSD-2-Clause
.\"
.\" Copyright (c) 2018 iXsystems, Inc
.\" All rights reserved.
.\"
@ -22,51 +25,54 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd April 25, 2018
.Dt ETDUMP 8
.Dd January 18, 2025
.Dt ETDUMP 1
.Os
.Sh NAME
.Nm etdump
.Nd Dump El Torito boot catalog information from ISO images
.Nd dump ISO-9660 El Torito boot catalog information
.Sh SYNOPSIS
.Nm
.Op Fl f Ar format
.Op Fl o Ar file
.Ar
.Sh DESCRIPTION
This program reads El Torito boot catalog information from an ISO image and
outputs it in various formats.
It can be used to check the catalog in an image or to output catalog data in
a format that can be used by other tools such as shell scripts.
This program reads El Torito boot catalog information
from an ISO-9660 image and outputs it in various formats.
It can be used to check the catalog in an image or
to output catalog data in a format that can be used by other tools
such as shell scripts.
.Pp
Supported options are:
.Bl -tag -width flag
.It Fl f Ar format Fl -format Ar format
.It Fl f Ar format | Fl -format Ar format
Select the output format.
Supported output formats are:
.Bl -tag -width shell -offset indent
.It Sy text
.Bl -tag -width indent
.It Cm text
Human-readable text (default)
.It Sy shell
Each boot entry is emitted as a string suitable for passing to a sh-compatible
eval command.
.It Cm shell
Each boot entry is emitted as a string
suitable for passing to a sh-compatible eval command.
The variables emitted are:
.Bl -tag -width et_platform -offset indent
.It et_platform
.Bl -tag -width "et_platform"
.It Dv et_platform
The platform ID from the section header.
Set to 'default' for the initial (default) entry.
.It et_system
.It Dv et_system
The system ID from the boot entry.
.It et_lba
.It Dv et_lba
The starting LBA (2048-byte blocks) of the boot image.
.It et_sectors
.It Dv et_sectors
The number of sectors (512-byte sectors) that comprise the boot image.
.El
.El
.It Fl o Ar file Fl -output Ar file
.It Fl o Ar file | Fl -output Ar file
Write output to
.Ar file .
If '-' is specified then standard out is used.
If
.Ql -
is specified then standard out is used.
.El
.Sh EXAMPLES
To see what entries are in a given boot catalog run
@ -87,14 +93,16 @@ Section header: efi, final
Media type: no emulation
.Ed
.Pp
To use the output in a shell script a for loop can be used to iterate over the
entries returned using eval:
To use the output in a shell script a for loop can be used
to iterate over the entries returned using eval:
.Bd -literal -offset indent
for entry in `etdump --format shell bootonly.iso`; do
eval $entry
echo $et_platform $et_system $et_lba $et_sectors
done
.Ed
.Sh SEE ALSO
.Xr cd9660 4
.Sh HISTORY
The
.Nm