xref: /freebsd/packages/ctf/ctf.ucl (revision bb75b0d581f74e22a68d7868ad1f5da1146a8de0)
1*bb75b0d5SLexi Winter/*
2*bb75b0d5SLexi Winter * SPDX-License-Identifier: ISC
3*bb75b0d5SLexi Winter *
4*bb75b0d5SLexi Winter * Copyright (c) 2025 Lexi Winter <ivy@FreeBSD.org>
5*bb75b0d5SLexi Winter *
6*bb75b0d5SLexi Winter * Permission to use, copy, modify, and distribute this software for any
7*bb75b0d5SLexi Winter * purpose with or without fee is hereby granted, provided that the above
8*bb75b0d5SLexi Winter * copyright notice and this permission notice appear in all copies.
9*bb75b0d5SLexi Winter *
10*bb75b0d5SLexi Winter * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11*bb75b0d5SLexi Winter * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12*bb75b0d5SLexi Winter * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13*bb75b0d5SLexi Winter * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14*bb75b0d5SLexi Winter * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15*bb75b0d5SLexi Winter * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16*bb75b0d5SLexi Winter * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17*bb75b0d5SLexi Winter */
18*bb75b0d5SLexi Winter
19*bb75b0d5SLexi Winter/*
20*bb75b0d5SLexi Winter * Note: Do not use the text from ctf(5) to describe this package, since that
21*bb75b0d5SLexi Winter * text is licensed under the CDDL.
22*bb75b0d5SLexi Winter */
23*bb75b0d5SLexi Winter
24*bb75b0d5SLexi Wintercomment = "Compact C Type Format (CTF)"
25*bb75b0d5SLexi Winter
26*bb75b0d5SLexi Winterdesc = <<EOD
27*bb75b0d5SLexi WinterThe Compact C Type Format (CTF) is a method of encoding type information for C
28*bb75b0d5SLexi Winterprograms inside ELF objects.  Compared to the common DWARF debug symbol format,
29*bb75b0d5SLexi WinterCTF is intended specifically for runtime program analyzers such as DTrace.
30*bb75b0d5SLexi Winter
31*bb75b0d5SLexi WinterThis package provides the ctfconvert(1), ctfdump(1) and ctfmerge(1) utilities
32*bb75b0d5SLexi Winterwhich are used to work with CTF data, and the libctf library which allows
33*bb75b0d5SLexi Winterapplications to access CTF debugging information programmatically.
34*bb75b0d5SLexi WinterEOD
35