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