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