xref: /freebsd/contrib/elftoolchain/libelftc/elftc.3 (revision 44e86fbdcf5a3e625095652a3d0ab99532e54eea)
1a85fe12eSEd Maste.\" Copyright (c) 2012 Joseph Koshy.  All rights reserved.
2a85fe12eSEd Maste.\"
3a85fe12eSEd Maste.\" Redistribution and use in source and binary forms, with or without
4a85fe12eSEd Maste.\" modification, are permitted provided that the following conditions
5a85fe12eSEd Maste.\" are met:
6a85fe12eSEd Maste.\" 1. Redistributions of source code must retain the above copyright
7a85fe12eSEd Maste.\"    notice, this list of conditions and the following disclaimer.
8a85fe12eSEd Maste.\" 2. Redistributions in binary form must reproduce the above copyright
9a85fe12eSEd Maste.\"    notice, this list of conditions and the following disclaimer in the
10a85fe12eSEd Maste.\"    documentation and/or other materials provided with the distribution.
11a85fe12eSEd Maste.\"
12a85fe12eSEd Maste.\" This software is provided by Joseph Koshy ``as is'' and
13a85fe12eSEd Maste.\" any express or implied warranties, including, but not limited to, the
14a85fe12eSEd Maste.\" implied warranties of merchantability and fitness for a particular purpose
15a85fe12eSEd Maste.\" are disclaimed.  in no event shall Joseph Koshy be liable
16a85fe12eSEd Maste.\" for any direct, indirect, incidental, special, exemplary, or consequential
17a85fe12eSEd Maste.\" damages (including, but not limited to, procurement of substitute goods
18a85fe12eSEd Maste.\" or services; loss of use, data, or profits; or business interruption)
19a85fe12eSEd Maste.\" however caused and on any theory of liability, whether in contract, strict
20a85fe12eSEd Maste.\" liability, or tort (including negligence or otherwise) arising in any way
21a85fe12eSEd Maste.\" out of the use of this software, even if advised of the possibility of
22a85fe12eSEd Maste.\" such damage.
23a85fe12eSEd Maste.\"
24ae500c1fSEd Maste.\" $Id: elftc.3 3645 2018-10-15 20:17:14Z jkoshy $
25a85fe12eSEd Maste.\"
26*57d7e4ccSEd Maste.Dd February 12, 2020
27a85fe12eSEd Maste.Dt ELFTC 3
28ae500c1fSEd Maste.Os
29a85fe12eSEd Maste.Sh NAME
30a85fe12eSEd Maste.Nm elftc
31a85fe12eSEd Maste.Nd support routines used in the Elftoolchain project
32a85fe12eSEd Maste.Sh LIBRARY
33a85fe12eSEd Maste.Lb libelftc
34a85fe12eSEd Maste.Sh SYNOPSIS
35a85fe12eSEd Maste.In libelftc.h
36a85fe12eSEd Maste.Sh DESCRIPTION
37a85fe12eSEd MasteThe
38a85fe12eSEd Maste.Lb libelftc
39a85fe12eSEd Masteprovides support routines used for developing the utilities in the
40a85fe12eSEd MasteElftoolchain source tree.
41a85fe12eSEd Maste.Pp
42a85fe12eSEd MasteThis manual page serves as an overview of the functionality in this
43a85fe12eSEd Mastelibrary.
44a85fe12eSEd MasteAdditional reference information may be found in the individual
45a85fe12eSEd Mastemanual pages for the functions listed below.
46a85fe12eSEd Maste.Ss Functional Grouping
47a85fe12eSEd Maste.Bl -tag -width indent
48a85fe12eSEd Maste.It "Binary Object Handling"
49ae500c1fSEd Maste.Bl -tag -compact -width indent
50a85fe12eSEd Maste.It Fn elftc_bfd_find_target
51a85fe12eSEd MasteLocate a binary object descriptor.
52a85fe12eSEd Maste.It Fn elftc_bfd_target_class
53a85fe12eSEd MasteQuery the ELF class for a binary object descriptor.
54a85fe12eSEd Maste.It Fn elftc_bfd_target_byteorder
55a85fe12eSEd MasteQuery the byte order for a binary object descriptor.
56a85fe12eSEd Maste.It Fn elftc_bfd_target_flavor
57a85fe12eSEd MasteQuery the object format for a binary object descriptor.
58a85fe12eSEd Maste.It Fn elftc_bfd_target_machine
59a85fe12eSEd MasteQuery the target machine for a binary object descriptor.
60*57d7e4ccSEd Maste.It Fn elftc_bfd_target_osabi
61*57d7e4ccSEd MasteQuery the target osabi for a binary object descriptor.
62a85fe12eSEd Maste.El
63a85fe12eSEd Maste.It "C++ support"
64ae500c1fSEd Maste.Bl -tag -compact -width indent
65a85fe12eSEd Maste.It Fn elftc_demangle
66a85fe12eSEd MasteDecodes a symbol name encoded according to the encoding rules for the
67a85fe12eSEd MasteC++ language.
68a85fe12eSEd Maste.El
69a85fe12eSEd Maste.It "Programming conveniences"
70ae500c1fSEd Maste.Bl -tag -compact -width indent
71a85fe12eSEd Maste.It Fn elftc_copyfile
72a85fe12eSEd MasteCopies the contents of a file to another.
73a85fe12eSEd Maste.It Fn elftc_set_timestamp
74a85fe12eSEd MastePortably set the time stamps on a file.
75a85fe12eSEd Maste.El
76a85fe12eSEd Maste.It "Project Configuration"
77ae500c1fSEd Maste.Bl -tag -compact -width indent
78a85fe12eSEd Maste.It Fn elftc_version
79a85fe12eSEd MasteReturns a project-wide identifier string that encodes the source
80a85fe12eSEd Masterevision of the source tree.
81a85fe12eSEd Maste.El
82a85fe12eSEd Maste.El
83a85fe12eSEd Maste.Sh SEE ALSO
84a85fe12eSEd Maste.Xr dwarf 3 ,
85a85fe12eSEd Maste.Xr elf 3
86