mirror of
https://github.com/opnsense/src.git
synced 2026-05-28 04:12:45 -04:00
Add man pages for the CTF tools.
Sponsored by: The FreeBSD Foundation
This commit is contained in:
Rui Paulo
parent
d999d7ae4f
commit
8be96e101f
6 changed files with 288 additions and 3 deletions
|
|
@ -6,7 +6,6 @@
|
|||
DEBUG_FLAGS= -g
|
||||
|
||||
PROG= ctfconvert
|
||||
NO_MAN=
|
||||
SRCS= alist.c \
|
||||
ctf.c \
|
||||
ctfconvert.c \
|
||||
|
|
|
|||
85
cddl/usr.bin/ctfconvert/ctfconvert.1
Normal file
85
cddl/usr.bin/ctfconvert/ctfconvert.1
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
.\"
|
||||
.\" Copyright (c) 2010 The FreeBSD Foundation
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" This software was developed by Rui Paulo under sponsorship from the
|
||||
.\" FreeBSD Foundation.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd July 7, 2010
|
||||
.Dt CTFCONVERT 1
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ctfconvert
|
||||
.Nd convert debug data to CTF data
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Op Fl gis
|
||||
.Fl l Ar label
|
||||
.Fl L Ar labelenv
|
||||
.Op Fl o Ar outfile
|
||||
object_file
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
utility converts debug information from a binary file to CTF data and replaces
|
||||
the debug section of that file with a CTF section called SUNW_ctf.
|
||||
This new section is added to the input file, unless the -o
|
||||
option is present.
|
||||
You can also opt to keep the original debugging section with the
|
||||
-g option.
|
||||
.Pp
|
||||
The following options are available:
|
||||
.Bl -tag -width indent
|
||||
.It Fl l Ar label
|
||||
Sets the label as
|
||||
.Ar label .
|
||||
.It Fl L Ar labelenv
|
||||
Instructs
|
||||
.Nm
|
||||
to read the label from the environment variable
|
||||
.Ar labelenv .
|
||||
.It Fl g
|
||||
Don't delete the original debugging section.
|
||||
.It Fl i
|
||||
Ignore object files built from other languages than C.
|
||||
.It Fl s
|
||||
Use the .dynsym ELF section instead of the .symtab ELF section.
|
||||
.It Fl o Ar outfile
|
||||
Write the output to file in
|
||||
.Ar outfile .
|
||||
.El
|
||||
.Sh EXIT STATUS
|
||||
.Ex -std
|
||||
.Sh SEE ALSO
|
||||
.Xr ctfmerge 1 ,
|
||||
.Xr ctfdump 1
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
utility first appeared in
|
||||
.Fx 7.0 .
|
||||
.Sh AUTHORS
|
||||
The CTF utilities came from OpenSolaris.
|
||||
|
|
@ -4,7 +4,6 @@
|
|||
.PATH: ${.CURDIR}/../../../cddl/contrib/opensolaris/tools/ctf/dump
|
||||
|
||||
PROG= ctfdump
|
||||
NO_MAN=
|
||||
SRCS= dump.c \
|
||||
symbol.c \
|
||||
utils.c
|
||||
|
|
|
|||
83
cddl/usr.bin/ctfdump/ctfdump.1
Normal file
83
cddl/usr.bin/ctfdump/ctfdump.1
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
.\"
|
||||
.\" Copyright (c) 2010 The FreeBSD Foundation
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" This software was developed by Rui Paulo under sponsorship from the
|
||||
.\" FreeBSD Foundation.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd July 7, 2010
|
||||
.Dt CTFDUMP 1
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ctfdump
|
||||
.Nd dump the SUNW_ctf section of an ELF file
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Op Fl dfhlsSt
|
||||
.Fl u Ar file
|
||||
file
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
utility dumps the contents of the CTF data section (SUNW_ctf) present in
|
||||
an ELF binary file.
|
||||
This section was previously created with
|
||||
.Xr ctfconvert 1
|
||||
or
|
||||
.Xr ctfmerge 1 .
|
||||
.Pp
|
||||
The following options are available:
|
||||
.Bl -tag -width indent
|
||||
.It Fl d
|
||||
Show the data object section.
|
||||
.It Fl f
|
||||
Show the function section.
|
||||
.It Fl h
|
||||
Show the header.
|
||||
.It Fl l
|
||||
Show the label section.
|
||||
.It Fl s
|
||||
Show the string table.
|
||||
.It Fl S
|
||||
Show statistics.
|
||||
.It Fl t
|
||||
Show the type section.
|
||||
.It Fl u Ar ufile
|
||||
Write the uncompressed CTF data to a raw CTF file called
|
||||
.Ar ufile .
|
||||
.El
|
||||
.Sh EXIT STATUS
|
||||
.Ex -std
|
||||
.Sh SEE ALSO
|
||||
.Xr ctfconvert 1 ,
|
||||
.Xr ctfmerge 1
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
utility first appeared in
|
||||
.Fx 7.0 .
|
||||
.Sh AUTHORS
|
||||
The CTF utilities came from OpenSolaris.
|
||||
|
|
@ -4,7 +4,6 @@
|
|||
.PATH: ${.CURDIR}/../../../cddl/contrib/opensolaris/tools/ctf/cvt
|
||||
|
||||
PROG= ctfmerge
|
||||
NO_MAN=
|
||||
SRCS= alist.c \
|
||||
barrier.c \
|
||||
ctf.c \
|
||||
|
|
|
|||
120
cddl/usr.bin/ctfmerge/ctfmerge.1
Normal file
120
cddl/usr.bin/ctfmerge/ctfmerge.1
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
.\"
|
||||
.\" Copyright (c) 2010 The FreeBSD Foundation
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" This software was developed by Rui Paulo under sponsorship from the
|
||||
.\" FreeBSD Foundation.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd July 7, 2010
|
||||
.Dt CTFMERGE 1
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ctfmerge
|
||||
.Nd merge several CTF data sections into one
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Op Fl fgstv
|
||||
.Fl l Ar label
|
||||
.Fl L Ar labelenv
|
||||
.Fl o Ar outfile
|
||||
file ...
|
||||
.Nm
|
||||
.Op Fl fgstv
|
||||
.Fl l Ar label
|
||||
.Fl L Ar labelenv
|
||||
.Fl o Ar outfile
|
||||
.Fl d Ar uniqfile
|
||||
.Op Fl g
|
||||
.Op Fl D Ar uniqlabel
|
||||
file ...
|
||||
.Nm
|
||||
.Op Fl fgstv
|
||||
.Fl l Ar label
|
||||
.Fl L Ar labelenv
|
||||
.Fl o Ar outfile
|
||||
.Fl w Ar withfile
|
||||
file ...
|
||||
.Nm
|
||||
.Op Fl g
|
||||
.Fl c Ar srcfile
|
||||
.Ar destfile
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
utility merges several CTF data sections from several files into one
|
||||
output file, unifying common data.
|
||||
.Pp
|
||||
The following options are available:
|
||||
.Bl -tag -width indent
|
||||
.It Fl f
|
||||
Match global symbols to global CTF data.
|
||||
.It Fl g
|
||||
Don't delete the original debugging sections.
|
||||
.It Fl s
|
||||
Use the .dynsym ELF section instead of the .symtab ELF section.
|
||||
.It Fl t
|
||||
Make sure that all object files have a CTF section.
|
||||
.It Fl v
|
||||
Enable verbose mode.
|
||||
.It Fl l Ar label
|
||||
Sets the label as
|
||||
.Ar label .
|
||||
.It Fl L Ar labelenv
|
||||
Instructs
|
||||
.Nm
|
||||
to read the label from the environment variable
|
||||
.Ar labelenv .
|
||||
.It Fl o Ar outfile
|
||||
Use
|
||||
.Ar outfile
|
||||
to store the merged CTF data.
|
||||
.It Fl d Ar uniqfile
|
||||
Uniquify against
|
||||
.Ar uniqfile .
|
||||
.It Fl d Ar uniqlabel
|
||||
Uniquify against label
|
||||
.Ar uniqlabel
|
||||
.It Fl w Ar withfile
|
||||
Additive merge with
|
||||
.Ar withfile .
|
||||
.It Fl c Ar srcfile Ar destfile
|
||||
Copy CTF data from
|
||||
.Ar srcfile
|
||||
into
|
||||
.Ar destfile .
|
||||
.El
|
||||
.Sh EXIT STATUS
|
||||
.Ex -std
|
||||
.Sh SEE ALSO
|
||||
.Xr ctfconvert 1 ,
|
||||
.Xr ctfdump 1
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
utility first appeared in
|
||||
.Fx 7.0 .
|
||||
.Sh AUTHORS
|
||||
The CTF utilities came from OpenSolaris.
|
||||
Loading…
Reference in a new issue