Signed-off-by: Aaron Merey <ame...@redhat.com> --- doc/elf32_xlatetof.3 | 61 ++++++++++++++++++++++++++++++++++++++++++++ doc/elf64_xlatetof.3 | 61 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 122 insertions(+) create mode 100644 doc/elf32_xlatetof.3 create mode 100644 doc/elf64_xlatetof.3
diff --git a/doc/elf32_xlatetof.3 b/doc/elf32_xlatetof.3 new file mode 100644 index 00000000..a33471f4 --- /dev/null +++ b/doc/elf32_xlatetof.3 @@ -0,0 +1,61 @@ +.TH ELF32_XLATETOF 3 2024-08-14 "Libelf" "Libelf Programmer's Manual" + +.SH NAME +elf32_xlatetof \- translate ELF32 data to file representation + +.SH SYNOPSIS +.B #include <libelf.h> + +.BI "int elf32_xlatetof(Elf_Data *" dst ", const Elf_Data *" src ", unsigned int " encoding ");" + +.SH DESCRIPTION +Translate ELF32 data from its memory representation to its file representation. + +.SH PARAMETERS +.TP +.I dst +Destination where the translated data will be stored. + +.TP +.I src +Source data in its memory representation. + +.TP +.I encoding +The encoding of the destination data. +.I encoding +can be either +.B ELFDATA2LSB +(two's complement little-endian) or +.B ELFDATA2MSB +(two's complement big-endian). + +.SH RETURN VALUE +Return +.I dest +on success. If an error occurs, return NULL and sets a libelf error code. + +.SH SEE ALSO +.BR elf_errno (3), +.BR elf32_xlatetom (3), +.BR elf64_xlatetof (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_xlatetof () +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_xlatetof.3 b/doc/elf64_xlatetof.3 new file mode 100644 index 00000000..4af26c91 --- /dev/null +++ b/doc/elf64_xlatetof.3 @@ -0,0 +1,61 @@ +.TH ELF64_XLATETOF 3 2024-08-14 "Libelf" "Libelf Programmer's Manual" + +.SH NAME +elf64_xlatetof \- translate ELF64 data to file representation + +.SH SYNOPSIS +.B #include <libelf.h> + +.BI "int elf64_xlatetof(Elf_Data *" dst ", const Elf_Data *" src ", unsigned int " encoding ");" + +.SH DESCRIPTION +Translate ELF64 data from its memory representation to its file representation. + +.SH PARAMETERS +.TP +.I dst +Destination where the translated data will be stored. + +.TP +.I src +Source data in its memory representation. + +.TP +.I encoding +The encoding of the destination data. +.I encoding +can be either +.B ELFDATA2LSB +(two's complement little-endian) or +.B ELFDATA2MSB +(two's complement big-endian). + +.SH RETURN VALUE +Return +.I dest +on success. If an error occurs, return NULL and sets a libelf error code. + +.SH SEE ALSO +.BR elf_errno (3), +.BR elf32_xlatetof (3), +.BR elf64_xlatetom (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_xlatetof () +T} Thread safety MT-Safe +.TE + +.SH REPORTING BUGS +Report bugs to <elfutils-devel@sourceware.org> or https://sourceware.org/bugzilla/. -- 2.46.0