xref: /freebsd/cddl/usr.bin/ctfconvert/ctfconvert.1 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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 July 7, 2010
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 data and replaces
48the debug section of that file with a CTF section called SUNW_ctf.
49This new section is added to the input file, unless the -o
50option is present.
51You can also opt to keep the original debugging section with the
52-g option.
53.Pp
54The following options are available:
55.Bl -tag -width indent
56.It Fl l Ar label
57Sets the label as
58.Ar label .
59.It Fl L Ar labelenv
60Instructs
61.Nm
62to read the label from the environment variable
63.Ar labelenv .
64.It Fl g
65Don't delete the original debugging section.
66.It Fl i
67Ignore object files built from other languages than C.
68.It Fl s
69Use the .dynsym ELF section instead of the .symtab ELF section.
70.It Fl o Ar outfile
71Write the output to file in
72.Ar outfile .
73.El
74.Sh EXIT STATUS
75.Ex -std
76.Sh SEE ALSO
77.Xr ctfdump 1 ,
78.Xr ctfmerge 1
79.Sh HISTORY
80The
81.Nm
82utility first appeared in
83.Fx 7.0 .
84.Sh AUTHORS
85The CTF utilities came from OpenSolaris.
86