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