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