Signed-off-by: Aaron Merey <ame...@redhat.com> --- doc/elf32_getphdr.3 | 45 +++++++++++++++++++++++++++++++++++++++++++++ doc/elf64_getphdr.3 | 45 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+) create mode 100644 doc/elf32_getphdr.3 create mode 100644 doc/elf64_getphdr.3
diff --git a/doc/elf32_getphdr.3 b/doc/elf32_getphdr.3 new file mode 100644 index 00000000..7245f81b --- /dev/null +++ b/doc/elf32_getphdr.3 @@ -0,0 +1,45 @@ +.TH ELF32_GETPHDR 3 2024-08-14 "Libelf" "Libelf Programmer's Manual" + +.SH NAME +elf32_getphdr \- retrieve the program header table for an ELF32 object file + +.SH SYNOPSIS +.B #include <libelf.h> + +.BI "Elf32_Phdr *elf32_getphdr(Elf *" elf ");" + +.SH DESCRIPTION +Retrieve the program header table for the given ELF descriptor +.I elf. + +.SH PARAMETERS +.TP +.I elf +ELF descriptor from which to retrieve the program header table. + +.SH RETURN VALUE +On success, return a pointer to the program header table. On failure, return NULL and set a libelf error code. + +.SH SEE ALSO +.BR elf_errno (3), +.BR elf64_getphdr (3), +.BR libelf (3), +.BR elf (5) + +.SH ATTRIBUTES +For an explanation of the terms used in this section, see +.BR attributes (7). +.TS +allbox; +lbx lb lb +l l l. +Interface Attribute Value +T{ +.na +.nh +.BR elf32_getphdr () +T} Thread safety MT-Safe +.TE + +.SH REPORTING BUGS +Report bugs to <elfutils-devel@sourceware.org> or https://sourceware.org/bugzilla/. diff --git a/doc/elf64_getphdr.3 b/doc/elf64_getphdr.3 new file mode 100644 index 00000000..b27c8de3 --- /dev/null +++ b/doc/elf64_getphdr.3 @@ -0,0 +1,45 @@ +.TH ELF64_GETPHDR 3 2024-08-14 "Libelf" "Libelf Programmer's Manual" + +.SH NAME +elf64_getphdr \- retrieve the program header table for an ELF64 object file + +.SH SYNOPSIS +.B #include <libelf.h> + +.BI "Elf64_Phdr *elf64_getphdr(Elf *" elf ");" + +.SH DESCRIPTION +Retrieve the program header table for the given ELF descriptor +.I elf. + +.SH PARAMETERS +.TP +.I elf +ELF descriptor from which to retrieve the program header table. + +.SH RETURN VALUE +On success, return a pointer to the program header table. On failure, return NULL and set a libelf error code. + +.SH SEE ALSO +.BR elf_errno (3), +.BR elf32_getphdr (3), +.BR libelf (3), +.BR elf (5) + +.SH ATTRIBUTES +For an explanation of the terms used in this section, see +.BR attributes (7). +.TS +allbox; +lbx lb lb +l l l. +Interface Attribute Value +T{ +.na +.nh +.BR elf64_getphdr () +T} Thread safety MT-Safe +.TE + +.SH REPORTING BUGS +Report bugs to <elfutils-devel@sourceware.org> or https://sourceware.org/bugzilla/. -- 2.46.0