xref: /freebsd/cddl/usr.bin/ctfdump/ctfdump.1 (revision 924226fba12cc9a228c73b956e1b7fa24c60b055)
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 April 21, 2022
32.Dt CTFDUMP 1
33.Os
34.Sh NAME
35.Nm ctfdump
36.Nd dump the SUNW_ctf section of an ELF file
37.Sh SYNOPSIS
38.Nm
39.Op Fl dfhlsSt
40.Fl u Ar file
41file
42.Sh DESCRIPTION
43The
44.Nm
45utility dumps the contents of the CTF (Compact C Type Format) data section
46(SUNW_ctf) present in an ELF binary file.
47This section was previously created with
48.Xr ctfconvert 1
49or
50.Xr ctfmerge 1 .
51.Pp
52The following options are available:
53.Bl -tag -width indent
54.It Fl d
55Show the data object section.
56.It Fl f
57Show the function section.
58.It Fl h
59Show the header.
60.It Fl l
61Show the label section.
62.It Fl s
63Show the string table.
64.It Fl S
65Show statistics.
66.It Fl t
67Show the type section.
68.It Fl u Ar ufile
69Write the uncompressed CTF data to a raw CTF file called
70.Ar ufile .
71.El
72.Sh EXIT STATUS
73.Ex -std
74.Sh SEE ALSO
75.Xr ctfconvert 1 ,
76.Xr ctfmerge 1 ,
77.Xr ctf 5
78.Sh HISTORY
79The
80.Nm
81utility first appeared in
82.Fx 7.0 .
83.Sh AUTHORS
84The CTF utilities came from OpenSolaris.
85