xref: /freebsd/cddl/usr.bin/ctfconvert/ctfconvert.1 (revision 2008043f386721d58158e37e0d7e50df8095942d)
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.Dd April 21, 2022
30.Dt CTFCONVERT 1
31.Os
32.Sh NAME
33.Nm ctfconvert
34.Nd convert debug data to CTF data
35.Sh SYNOPSIS
36.Nm
37.Op Fl gis
38.Fl l Ar label
39.Fl L Ar labelenv
40.Op Fl o Ar outfile
41object_file
42.Sh DESCRIPTION
43The
44.Nm
45utility converts debug information from a binary file to CTF (Compact C Type
46Format) data and replaces the debug section of that file with a CTF section
47called SUNW_ctf.
48This new section is added to the input file, unless the -o
49option is present.
50You can also opt to keep the original debugging section with the
51-g option.
52.Pp
53The following options are available:
54.Bl -tag -width indent
55.It Fl l Ar label
56Sets the label as
57.Ar label .
58.It Fl L Ar labelenv
59Instructs
60.Nm
61to read the label from the environment variable
62.Ar labelenv .
63.It Fl g
64Don't delete the original debugging section.
65.It Fl i
66Ignore object files built from other languages than C.
67.It Fl s
68Use the .dynsym ELF section instead of the .symtab ELF section.
69.It Fl o Ar outfile
70Write the output to file in
71.Ar outfile .
72.El
73.Sh EXIT STATUS
74.Ex -std
75.Sh SEE ALSO
76.Xr ctfdump 1 ,
77.Xr ctfmerge 1 ,
78.Xr ctf 5
79.Sh HISTORY
80The
81.Nm
82utility first appeared in
83.Fx 7.0 .
84.Sh AUTHORS
85The CTF utilities came from OpenSolaris.
86