doc: Add elf_getaroff.3

Signed-off-by: Aaron Merey <amerey@redhat.com>

diff --git a/doc/Makefile.am b/doc/Makefile.am
index fdab8859e6fc976af3ebe8a21508b33dd90973b5..4bffa37679f6d730846e8332296e387d27cfeddb 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -55,6 +55,7 @@ notrans_dist_man3_MANS= elf32_checksum.3 \
                        elf_errmsg.3 \
                        elf_errno.3 \
                        elf_fill.3 \
+                       elf_getaroff.3 \
                        elf_getarsym.3 \
                        elf_getbase.3 \
                        elf_getdata.3 \

diff --git a/doc/elf_getaroff.3 b/doc/elf_getaroff.3
new file mode 100644 (file)
index 0000000..75f4079
--- /dev/null
+++ b/doc/elf_getaroff.3
@@ -0,0 +1,58 @@
+.TH ELF_GETAROFF 3 2025-06-06 "Libelf" "Libelf Programmer's Manual"
+
+.SH NAME
+elf_getaroff \- retrieve the offset of an archive member header
+
+.SH SYNOPSIS
+.nf
+.B #include <libelf.h>
+
+.BI "int64_t elf_getaroff(Elf *" elf ");"
+.fi
+.SH DESCRIPTION
+Return the file offset, in bytes, of the archive member header currently
+referred to by an ELF descriptor.  This is the offset of the member header
+in the parent archive file.  This offset can be used with
+.BR elf_rand .
+
+.SH PARAMETERS
+.TP
+.I elf
+Elf descriptor referring to a member of an archive file header.
+
+.SH RETURN VALUE
+Return the file offset, in bytes, of the archive member header referred
+to by
+.IR elf .
+If
+.I elf
+is NULL or is not a member of an archive,
+return -1.
+
+.SH SEE ALSO
+.BR elf_begin (3),
+.BR elf_next (3),
+.BR elf_rand (3),
+.BR libelf (3),
+.BR elf (5)
+
+.SH ATTRIBUTES
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface      Attribute       Value
+T{
+.na
+.nh
+.BR elf_getaroff ()
+T}     Thread safety   MT-Safe
+.TE
+
+.SH REPORTING BUGS
+Report bugs to <elfutils-devel@sourceware.org> or https://sourceware.org/bugzilla/.
+
+.SH HISTORY
+.B elf_getaroff
+first appeared in elfutils 0.114.  This elfutils libelf function may not be
+found in other libelf implementations.