xref: /freebsd/cddl/usr.bin/ctfmerge/ctfmerge.1 (revision 4f8f43b06ed07e96a250855488cc531799d5b78f)
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 CTFMERGE 1
31.Os
32.Sh NAME
33.Nm ctfmerge
34.Nd merge several CTF data sections into one
35.Sh SYNOPSIS
36.Nm
37.Op Fl fgstv
38.Fl l Ar label
39.Fl L Ar labelenv
40.Fl o Ar outfile
41file ...
42.Nm
43.Op Fl fgstv
44.Fl l Ar label
45.Fl L Ar labelenv
46.Fl o Ar outfile
47.Fl d Ar uniqfile
48.Op Fl g
49.Op Fl D Ar uniqlabel
50file ...
51.Nm
52.Op Fl fgstv
53.Fl l Ar label
54.Fl L Ar labelenv
55.Fl o Ar outfile
56.Fl w Ar withfile
57file ...
58.Nm
59.Op Fl g
60.Fl c Ar srcfile
61.Ar destfile
62.Sh DESCRIPTION
63The
64.Nm
65utility merges several CTF (Compact C Type Format) data sections from several
66files into one output file, unifying common data.
67.Pp
68The following options are available:
69.Bl -tag -width indent
70.It Fl f
71Match global symbols to global CTF data.
72.It Fl g
73Don't delete the original debugging sections.
74.It Fl s
75Use the .dynsym ELF section instead of the .symtab ELF section.
76.It Fl t
77Make sure that all object files have a CTF section.
78.It Fl v
79Enable verbose mode.
80.It Fl l Ar label
81Sets the label as
82.Ar label .
83.It Fl L Ar labelenv
84Instructs
85.Nm
86to read the label from the environment variable
87.Ar labelenv .
88.It Fl o Ar outfile
89Use
90.Ar outfile
91to store the merged CTF data.
92.It Fl d Ar uniqfile
93Uniquify against
94.Ar uniqfile .
95.It Fl d Ar uniqlabel
96Uniquify against label
97.Ar uniqlabel
98.It Fl w Ar withfile
99Additive merge with
100.Ar withfile .
101.It Fl c Ar srcfile Ar destfile
102Copy CTF data from
103.Ar srcfile
104into
105.Ar destfile .
106.El
107.Sh EXIT STATUS
108.Ex -std
109.Sh SEE ALSO
110.Xr ctfconvert 1 ,
111.Xr ctfdump 1 ,
112.Xr ctf 5
113.Sh HISTORY
114The
115.Nm
116utility first appeared in
117.Fx 7.0 .
118.Sh AUTHORS
119The CTF utilities came from OpenSolaris.
120