xref: /freebsd/cddl/usr.bin/ctfconvert/ctfconvert.1 (revision 349cc55c9796c4596a5b9904cd3281af295f878f)
1.\"
2.\" Copyright (c) 2010 The FreeBSD Foundation
3.\" All rights reserved.
4.\"
5.\" This software was developed by Rui Paulo under sponsorship from the
6.\" FreeBSD Foundation.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.\" $FreeBSD$
30.\"
31.Dd April 21, 2022
32.Dt CTFCONVERT 1
33.Os
34.Sh NAME
35.Nm ctfconvert
36.Nd convert debug data to CTF data
37.Sh SYNOPSIS
38.Nm
39.Op Fl gis
40.Fl l Ar label
41.Fl L Ar labelenv
42.Op Fl o Ar outfile
43object_file
44.Sh DESCRIPTION
45The
46.Nm
47utility converts debug information from a binary file to CTF (Compact C Type
48Format) data and replaces the debug section of that file with a CTF section
49called SUNW_ctf.
50This new section is added to the input file, unless the -o
51option is present.
52You can also opt to keep the original debugging section with the
53-g option.
54.Pp
55The following options are available:
56.Bl -tag -width indent
57.It Fl l Ar label
58Sets the label as
59.Ar label .
60.It Fl L Ar labelenv
61Instructs
62.Nm
63to read the label from the environment variable
64.Ar labelenv .
65.It Fl g
66Don't delete the original debugging section.
67.It Fl i
68Ignore object files built from other languages than C.
69.It Fl s
70Use the .dynsym ELF section instead of the .symtab ELF section.
71.It Fl o Ar outfile
72Write the output to file in
73.Ar outfile .
74.El
75.Sh EXIT STATUS
76.Ex -std
77.Sh SEE ALSO
78.Xr ctfdump 1 ,
79.Xr ctfmerge 1 ,
80.Xr ctf 5
81.Sh HISTORY
82The
83.Nm
84utility first appeared in
85.Fx 7.0 .
86.Sh AUTHORS
87The CTF utilities came from OpenSolaris.
88