share/man/man3lib/libelf.3lib

   1 '\" te
   2 .\" Copyright (c) 2009, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH LIBELF 3LIB "Jun 18, 2009"
   7 .SH NAME
   8 libelf \- ELF access library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lelf\fR [ \fIlibrary\fR... ]
  13 #include <\fBlibelf.h\fR>
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 Functions in this library provide routines to manipulate \fBELF\fR (Executable
  20 and Linking Format) object files, archive files, and archive members. The
  21 header provides type and function declarations for all library services.
  22 .SH INTERFACES
  23 .sp
  24 .LP
  25 The shared object \fBlibelf.so.1\fR provides the public interfaces defined
  26 below. See \fBIntro\fR(3) for additional information on shared object
  27 interfaces.
  28 .sp
  29
  30 .sp
  31 .TS
  32 l l
  33 l l .
  34 \fBelf32_checksum\fR    \fBelf32_fsize\fR
  35 \fBelf32_getehdr\fR     \fBelf32_getphdr\fR
  36 \fBelf32_getshdr\fR     \fBelf32_newehdr\fR
  37 \fBelf32_newphdr\fR     \fBelf32_xlatetof\fR
  38 \fBelf32_xlatetom\fR    \fBelf64_checksum\fR
  39 \fBelf64_fsize\fR       \fBelf64_getehdr\fR
  40 \fBelf64_getphdr\fR     \fBelf64_getshdr\fR
  41 \fBelf64_newehdr\fR     \fBelf64_newphdr\fR
  42 \fBelf64_xlatetof\fR    \fBelf64_xlatetom\fR
  43 \fBelf_begin\fR \fBelf_cntl\fR
  44 \fBelf_end\fR   \fBelf_errmsg\fR
  45 \fBelf_errno\fR \fBelf_fill\fR
  46 \fBelf_flagdata\fR      \fBelf_flagehdr\fR
  47 \fBelf_flagelf\fR       \fBelf_flagphdr\fR
  48 \fBelf_flagscn\fR       \fBelf_flagshdr\fR
  49 \fBelf_getarhdr\fR      \fBelf_getarsym\fR
  50 \fBelf_getbase\fR       \fBelf_getdata\fR
  51 \fBelf_getident\fR      \fBelf_getphdrnum\fR
  52 \fBelf_getphnum\fR      \fBelf_getscn\fR
  53 \fBelf_getshdrnum\fR    \fBelf_getshdrstrndx\fR
  54 \fBelf_getshnum\fR      \fBelf_getshstrndx\fR
  55 \fBelf_hash\fR  \fBelf_kind\fR
  56 \fBelf_memory\fR        \fBelf_ndxscn\fR
  57 \fBelf_newdata\fR       \fBelf_newscn\fR
  58 \fBelf_next\fR  \fBelf_nextscn\fR
  59 \fBelf_rand\fR  \fBelf_rawdata\fR
  60 \fBelf_rawfile\fR       \fBelf_strptr\fR
  61 \fBelf_update\fR        \fBelf_version\fR
  62 \fBgelf_checksum\fR     \fBgelf_fsize\fR
  63 \fBgelf_getcap\fR       \fBgelf_getclass\fR
  64 \fBgelf_getdyn\fR       \fBgelf_getehdr\fR
  65 \fBgelf_getmove\fR      \fBgelf_getphdr\fR
  66 \fBgelf_getrel\fR       \fBgelf_getrela\fR
  67 \fBgelf_getshdr\fR      \fBgelf_getsym\fR
  68 \fBgelf_getsyminfo\fR   \fBgelf_getsymshndx\fR
  69 \fBgelf_newehdr\fR      \fBgelf_newphdr\fR
  70 \fBgelf_update_cap\fR   \fBgelf_update_dyn\fR
  71 \fBgelf_update_ehdr\fR  \fBgelf_update_move\fR
  72 \fBgelf_update_phdr\fR  \fBgelf_update_rel\fR
  73 \fBgelf_update_rela\fR  \fBgelf_update_shdr\fR
  74 \fBgelf_update_sym\fR   \fBgelf_update_symshndx\fR
  75 \fBgelf_update_syminfo\fR       \fBgelf_xlatetof\fR
  76 \fBgelf_xlatetom\fR     \fBnlist\fR
  77 .TE
  78
  79 .SH FILES
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB/lib/libelf.so.1\fR\fR
  84 .ad
  85 .RS 23n
  86 shared object
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB/lib/64/libelf.so.1\fR\fR
  93 .ad
  94 .RS 23n
  95 64-bit shared object
  96 .RE
  97
  98 .SH ATTRIBUTES
  99 .sp
 100 .LP
 101 See \fBattributes\fR(5) for descriptions of the following attributes:
 102 .sp
 103
 104 .sp
 105 .TS
 106 box;
 107 c | c
 108 l | l .
 109 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 110 _
 111 MT-Level        Safe
 112 .TE
 113
 114 .SH SEE ALSO
 115 .sp
 116 .LP
 117 \fBpvs\fR(1), \fBIntro\fR(3), \fBelf\fR(3ELF), \fBgelf\fR(3ELF),
 118 \fBattributes\fR(5)