ctfconvert.1: Minor cleanup

Alphabetize option table to improve first glance access.
Markup semantics to differentiate them and add them to apropos.

MFC after:		3 days
Reviewed by:		Pau Amma <pauamma@gundo.com>
Approved by:		mhorne (mentor, implicit)
Differential Revision:	https://reviews.freebsd.org/D49883
This commit is contained in:
Alexander Ziaee 2025-04-17 20:41:29 -04:00
parent 7b34c48e03
commit 3fd42db26c
No known key found for this signature in database
GPG key ID: 0A8F850BCDEF4511

View file

@ -1,4 +1,6 @@
.\"
.\" SPDX-License-Identifier: BSD-2-Clause
.\"
.\" Copyright (c) 2010 The FreeBSD Foundation
.\" All rights reserved.
.\"
@ -31,44 +33,48 @@
.Os
.Sh NAME
.Nm ctfconvert
.Nd convert debug data to CTF data
.Nd convert debug data to Compact C Type Format data
.Sh SYNOPSIS
.Nm
.Op Fl gis
.Fl l Ar label
.Fl L Ar labelenv
.Fl l Ar label
.Op Fl o Ar outfile
object_file
.Sh DESCRIPTION
The
.Nm
utility converts debug information from a binary file to CTF (Compact C Type
Format) data and replaces the debug section of that file with a CTF section
utility converts debug information from a binary file to CTF
.Pq Compact C Type Format
data and replaces the debug section of that file with a CTF section
called SUNW_ctf.
This new section is added to the input file, unless the -o
This new section is added to the input file, unless the
.Fl o
option is present.
You can also opt to keep the original debugging section with the
-g option.
.Fl g
option.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl l Ar label
Sets the label as
.Ar label .
.It Fl L Ar labelenv
Instructs
.Nm
to read the label from the environment variable
.Ar labelenv .
.Bl -tag -width "-L labelenv"
.It Fl g
Don't delete the original debugging section.
.It Fl i
Ignore object files built from other languages than C.
.It Fl s
Use the .dynsym ELF section instead of the .symtab ELF section.
.It Fl L Ar labelenv
Instructs
.Nm
to read the label from the
.Ev labelenv
environment variable.
.It Fl l Ar label
Sets the label as
.Ar label .
.It Fl o Ar outfile
Write the output to file in
.Ar outfile .
.It Fl s
Use the .dynsym ELF section instead of the .symtab ELF section.
.El
.Sh EXIT STATUS
.Ex -std