Fix minor formatting issues:

- make document title match filename;
- remove hard sentence breaks, whitespace at EOL, and double whitespace;
- sort SEE ALSO xrefs, adding missing section numbers;
- fix a misspelled macro name.
This commit is contained in:
Ruslan Ermilov 2006-11-13 09:46:16 +00:00
parent 7134f7ea44
commit cd9e086e93
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=164253
42 changed files with 79 additions and 78 deletions

View File

@ -436,7 +436,8 @@ set by function
.Ss Error Handling
In case an error is encountered, these library functions set an
internal error number and signal the presence of the error by
returning an special return value. The application can check the
returning an special return value.
The application can check the
current error number by calling
.Xr elf_errno 3 .
A human readable description of the recorded error is available by

View File

@ -25,7 +25,7 @@
.\"
.Dd June 21, 2006
.Os
.Dt ELF 3
.Dt ELF_BEGIN 3
.Sh NAME
.Nm elf_begin
.Nd open an ELF file or ar(1) archive

View File

@ -25,7 +25,7 @@
.\"
.Dd August 9, 2006
.Os
.Dt ELF 3
.Dt ELF_CNTL 3
.Sh NAME
.Nm elf_cntl
.Nd control an elf file descriptor

View File

@ -25,7 +25,7 @@
.\"
.Dd June 29, 2006
.Os
.Dt ELF 3
.Dt ELF_END 3
.Sh NAME
.Nm elf_end
.Nd release an ELF descriptor

View File

@ -25,7 +25,7 @@
.\"
.Dd June 11, 2006
.Os
.Dt ELF 3
.Dt ELF_ERRMSG 3
.Sh NAME
.Nm elf_errmsg ,
.Nm elf_errno

View File

@ -25,7 +25,7 @@
.\"
.Dd June 11, 2006
.Os
.Dt ELF 3
.Dt ELF_FILL 3
.Sh NAME
.Nm elf_fill
.Nd set fill byte for inter-section padding
@ -49,4 +49,4 @@ flag is not set for the ELF file.
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf_flagelf 3 ,
.Xr gelf 3
.Xr gelf 3

View File

@ -25,7 +25,7 @@
.\"
.Dd August 10, 2006
.Os
.Dt ELF 3
.Dt ELF_FLAGDATA 3
.Sh NAME
.Nm elf_flagdata ,
.Nm elf_flagehdr ,
@ -139,14 +139,14 @@ was called without a program header being allocated.
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf_newdata 3 ,
.Xr elf_update 3 ,
.Xr elf32_newehdr 3 ,
.Xr elf32_newphdr 3 ,
.Xr elf32_newshdr 3 ,
.Xr elf64_newehdr 3 ,
.Xr elf64_newphdr 3 ,
.Xr elf64_newshdr 3 ,
.Xr elf_newdata 3 ,
.Xr elf_update 3 ,
.Xr gelf 3 ,
.Xr gelf_newehdr 3 ,
.Xr gelf_newphdr 3 ,

View File

@ -25,7 +25,7 @@
.\"
.Dd August 15, 2006
.Os
.Dt ELF 3
.Dt ELF_GETARHDR 3
.Sh NAME
.Nm elf_getarhdr
.Nd retrieve ar(1) header for an archive member
@ -94,4 +94,4 @@ archive.
.Xr elf 3 ,
.Xr elf_begin 3 ,
.Xr elf_getarsym 3 ,
.Xr elf_memory 3
.Xr elf_memory 3

View File

@ -25,7 +25,7 @@
.\"
.Dd August 15, 2006
.Os
.Dt ELF 3
.Dt ELF_GETARSYM 3
.Sh NAME
.Nm elf_getarsym
.Nd retrieve the symbol table of an archive

View File

@ -25,7 +25,7 @@
.\"
.Dd June 11, 2006
.Os
.Dt ELF 3
.Dt ELF_GETBASE 3
.Sh NAME
.Nm elf_getbase
.Nd get the base offset for an object file
@ -64,4 +64,4 @@ is not an ELF descriptor for an archive member.
.Xr elf_getarhdr 3 ,
.Xr elf_getident 3 ,
.Xr elf_rawfile 3 ,
.Xr gelf 3
.Xr gelf 3

View File

@ -25,7 +25,7 @@
.\"
.Dd August 26, 2006
.Os
.Dt ELF 3
.Dt ELF_GETDATA 3
.Sh NAME
.Nm elf_getdata ,
.Nm elf_newdata ,
@ -99,7 +99,7 @@ Section
.Ar scn
must be associated with an ELF file opened for writing.
If the application has not requested full control of layout by
setting the
setting the
.Dv ELF_F_LAYOUT
flag on descriptor
.Ar elf ,

View File

@ -25,7 +25,7 @@
.\"
.Dd July 3, 2006
.Os
.Dt ELF 3
.Dt ELF_GETIDENT 3
.Sh NAME
.Nm elf_getident
.Nd return the initial bytes of a file
@ -70,14 +70,14 @@ was called before a call to
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf32_getehdr 3 ,
.Xr elf64_getehdr 3 ,
.Xr elf_getarhdr 3 ,
.Xr elf_getbase 3 ,
.Xr elf_getflags 3 ,
.Xr elf_kind 3 ,
.Xr elf_rawfile 3 ,
.Xr elf_update 3 ,
.Xr elf32_getehdr ,
.Xr elf64_getehdr ,
.Xr gelf 3 ,
.Xr gelf_getclass 3 ,
.Xr gelf_getehdr 3

View File

@ -25,7 +25,7 @@
.\"
.Dd August 26, 2006
.Os
.Dt ELF 3
.Dt ELF_GETSCN 3
.Sh NAME
.Nm elf_getscn ,
.Nm elf_ndxscn ,

View File

@ -25,7 +25,7 @@
.\"
.Dd October 31, 2006
.Os
.Dt ELF 3
.Dt ELF_GETSHNUM 3
.Sh NAME
.Nm elf_getshnum
.Nd return the number of sections in an ELF file
@ -70,9 +70,9 @@ lacks an ELF Executable header.
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf32_getehdr 3 ,
.Xr elf64_getehdr 3 ,
.Xr elf_getident 3 ,
.Xr elf_getshstrndx 3 ,
.Xr elf32_getehdr ,
.Xr elf64_getehdr ,
.Xr gelf 3 ,
.Xr gelf_getehdr 3

View File

@ -25,7 +25,7 @@
.\"
.Dd October 31, 2006
.Os
.Dt ELF 3
.Dt ELF_GETSHSTRNDX 3
.Sh NAME
.Nm elf_getshstrndx ,
.Nm elf_setshstrndx
@ -79,9 +79,9 @@ contained a value in the reserved range of section indices.
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf32_getehdr 3 ,
.Xr elf64_getehdr 3 ,
.Xr elf_getident 3 ,
.Xr elf_getshnum 3 ,
.Xr elf32_getehdr ,
.Xr elf64_getehdr ,
.Xr gelf 3 ,
.Xr gelf_getehdr 3

View File

@ -25,7 +25,7 @@
.\"
.Dd August 15, 2006
.Os
.Dt ELF 3
.Dt ELF_HASH 3
.Sh NAME
.Nm elf_hash
.Nd compute a hash value for a string
@ -54,4 +54,4 @@ The library internally uses unsigned 32 bit arithmetic to compute
the hash value.
.Sh SEE ALSO
.Xr elf 3 ,
.Xr gelf 3
.Xr gelf 3

View File

@ -25,7 +25,7 @@
.\"
.Dd June 1, 2006
.Os
.Dt ELF 3
.Dt ELF_KIND 3
.Sh NAME
.Nm elf_kind
.Nd determine ELF file type
@ -66,6 +66,6 @@ or an error occurred when processing.
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf_getident 3 ,
.Xr elf_begin 3 ,
.Xr gelf 3
.Xr elf_getident 3 ,
.Xr gelf 3

View File

@ -25,7 +25,7 @@
.\"
.Dd June 28, 2006
.Os
.Dt ELF 3
.Dt ELF_MEMORY 3
.Sh NAME
.Nm elf_memory
.Nd process an ELF or ar(1) archive mapped into memory

View File

@ -25,7 +25,7 @@
.\"
.Dd June 17, 2006
.Os
.Dt ELF 3
.Dt ELF_NEXT 3
.Sh NAME
.Nm elf_next
.Nd provide sequential access to the next archive member

View File

@ -25,7 +25,7 @@
.\"
.Dd June 17, 2006
.Os
.Dt ELF 3
.Dt ELF_RAND 3
.Sh NAME
.Nm elf_rand
.Nd provide sequential access to the next archive member

View File

@ -25,7 +25,7 @@
.\"
.Dd July 3, 2006
.Os
.Dt ELF 3
.Dt ELF_RAWFILE 3
.Sh NAME
.Nm elf_rawfile
.Nd return uninterpreted contents of an ELF file

View File

@ -25,7 +25,7 @@
.\"
.Dd August 29, 2006
.Os
.Dt ELF 3
.Dt ELF_STRPTR 3
.Sh NAME
.Nm elf_strptr
.Nd retrieve a string pointer in a string table
@ -86,7 +86,7 @@ Offset
.Ar stroffset
indexed a region that was not covered by any Elf_Data
descriptor.
.Iq Bq Er ELF_E_DATA
.It Bq Er ELF_E_DATA
An erroneous
.Vt Elf_Data
descriptor was part of the section specified by argument
@ -104,9 +104,9 @@ contained a malformed section header.
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf_getdata 3 ,
.Xr elf_rawdata 3 ,
.Xr elf32_getshdr 3 ,
.Xr elf64_getshdr 3 ,
.Xr elf_getdata 3 ,
.Xr elf_rawdata 3 ,
.Xr gelf 3 ,
.Xr gelf_getshdr 3

View File

@ -25,7 +25,7 @@
.\"
.Dd August 29, 2006
.Os
.Dt ELF 3
.Dt ELF_UPDATE 3
.Sh NAME
.Nm elf_update
.Nd update an ELF descriptor
@ -39,7 +39,7 @@
Function
.Fn elf_update
causes the library to recalculate the structure of an ELF
object and optionally write out the image of the object
object and optionally write out the image of the object
to file.
.Pp
Argument
@ -254,15 +254,6 @@ descriptor with an unsupported version.
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf_cntl 3 ,
.Xr elf_fill 3 ,
.Xr elf_flagehdr 3 ,
.Xr elf_flagelf 3 ,
.Xr elf_getscn 3 ,
.Xr elf_getdata 3 ,
.Xr elf_newscn 3 ,
.Xr elf_newdata 3 ,
.Xr elf_rawdata 3 ,
.Xr elf32_getehdr 3 ,
.Xr elf32_getphdr 3 ,
.Xr elf32_newehdr 3 ,
@ -271,6 +262,15 @@ descriptor with an unsupported version.
.Xr elf64_getphdr 3 ,
.Xr elf64_newehdr 3 ,
.Xr elf64_newphdr 3 ,
.Xr elf_cntl 3 ,
.Xr elf_fill 3 ,
.Xr elf_flagehdr 3 ,
.Xr elf_flagelf 3 ,
.Xr elf_getdata 3 ,
.Xr elf_getscn 3 ,
.Xr elf_newdata 3 ,
.Xr elf_newscn 3 ,
.Xr elf_rawdata 3 ,
.Xr gelf 3 ,
.Xr gelf_newehdr 3 ,
.Xr gelf_newphdr 3 ,

View File

@ -25,7 +25,7 @@
.\"
.Dd June 1, 2006
.Os
.Dt ELF 3
.Dt ELF_VERSION 3
.Sh NAME
.Nm elf_version
.Nd retrieve or set ELF library operating version

View File

@ -25,7 +25,7 @@
.\"
.Dd August 29, 2006
.Os
.Dt ELF 3
.Dt GELF_CHECKSUM 3
.Sh NAME
.Nm elf32_checksum ,
.Nm elf64_checksum ,
@ -112,4 +112,4 @@ The ELF object was of an unsupported version.
.Sh SEE ALSO
.Xr strip 1 ,
.Xr elf 3 ,
.Xr gelf 3
.Xr gelf 3

View File

@ -25,7 +25,7 @@
.\"
.Dd July 3, 2006
.Os
.Dt ELF 3
.Dt GELF_FSIZE 3
.Sh NAME
.Nm gelf_fsize ,
.Nm elf32_fsize ,
@ -90,4 +90,4 @@ is not a supported version.
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr gelf 3
.Xr gelf 3

View File

@ -25,7 +25,7 @@
.\"
.Dd August 29, 2006
.Os
.Dt ELF 3
.Dt GELF_GETCAP 3
.Sh NAME
.Nm gelf_getcap ,
.Nm gelf_update_cap

View File

@ -25,7 +25,7 @@
.\"
.Dd July 3, 2006
.Os
.Dt GELF 3
.Dt GELF_GETCLASS 3
.Sh NAME
.Nm gelf_getclass
.Nd retrieve the class of an ELF descriptor

View File

@ -25,7 +25,7 @@
.\"
.Dd August 29, 2006
.Os
.Dt ELF 3
.Dt GELF_GETDYN 3
.Sh NAME
.Nm gelf_getdyn ,
.Nm gelf_update_dyn

View File

@ -25,7 +25,7 @@
.\"
.Dd July 6, 2006
.Os
.Dt ELF 3
.Dt GELF_GETEHDR 3
.Sh NAME
.Nm elf32_getehdr ,
.Nm elf64_getehdr ,
@ -110,10 +110,10 @@ had an unsupported ELF version number.
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf_getident 3 ,
.Xr elf_flagehdr 3 ,
.Xr elf32_newehdr 3 ,
.Xr elf64_newehdr 3 ,
.Xr elf_flagehdr 3 ,
.Xr elf_getident 3 ,
.Xr gelf 3 ,
.Xr gelf_newehdr 3 ,
.Xr elf 5

View File

@ -25,7 +25,7 @@
.\"
.Dd August 29, 2006
.Os
.Dt ELF 3
.Dt GELF_GETMOVE 3
.Sh NAME
.Nm gelf_getmove ,
.Nm gelf_update_move

View File

@ -25,7 +25,7 @@
.\"
.Dd August 25, 2006
.Os
.Dt ELF 3
.Dt GELF_GETPHDR 3
.Sh NAME
.Nm elf32_getphdr ,
.Nm elf64_getphdr ,
@ -125,11 +125,11 @@ was of an unsupported version.
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf_flagphdr 3 ,
.Xr elf32_getehdr 3 ,
.Xr elf32_newphdr 3 ,
.Xr elf64_getehdr 3 ,
.Xr elf64_newphdr 3 ,
.Xr elf_flagphdr 3 ,
.Xr gelf 3 ,
.Xr gelf_getehdr 3 ,
.Xr gelf_newphdr 3 ,

View File

@ -25,7 +25,7 @@
.\"
.Dd August 29, 2006
.Os
.Dt ELF 3
.Dt GELF_GETREL 3
.Sh NAME
.Nm gelf_getrel ,
.Nm gelf_update_rel

View File

@ -25,7 +25,7 @@
.\"
.Dd August 29, 2006
.Os
.Dt ELF 3
.Dt GELF_GETRELA 3
.Sh NAME
.Nm gelf_getrela ,
.Nm gelf_update_rela

View File

@ -25,7 +25,7 @@
.\"
.Dd August 27, 2006
.Os
.Dt ELF 3
.Dt GELF_GETSHDR 3
.Sh NAME
.Nm elf32_getshdr ,
.Nm elf64_getshdr ,

View File

@ -25,7 +25,7 @@
.\"
.Dd August 29, 2006
.Os
.Dt ELF 3
.Dt GELF_GETSYM 3
.Sh NAME
.Nm gelf_getsym ,
.Nm gelf_update_sym

View File

@ -25,7 +25,7 @@
.\"
.Dd August 29, 2006
.Os
.Dt ELF 3
.Dt GELF_GETSYMINFO 3
.Sh NAME
.Nm gelf_getsyminfo ,
.Nm gelf_update_syminfo

View File

@ -25,7 +25,7 @@
.\"
.Dd November 5, 2006
.Os
.Dt ELF 3
.Dt GELF_GETSYMSHNDX 3
.Sh NAME
.Nm gelf_getsymshndx ,
.Nm gelf_update_symshndx

View File

@ -25,7 +25,7 @@
.\"
.Dd July 6, 2006
.Os
.Dt ELF 3
.Dt GELF_NEWEHDR 3
.Sh NAME
.Nm elf32_newehdr ,
.Nm elf64_newehdr ,
@ -170,11 +170,11 @@ had an unsupported ELF version number.
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf32_getehdr 3 ,
.Xr elf64_getehdr 3 ,
.Xr elf_flagdata 3 ,
.Xr elf_getident 3 ,
.Xr elf_update 3 ,
.Xr elf32_getehdr 3 ,
.Xr elf64_getehdr 3 ,
.Xr elf_version 3 ,
.Xr gelf 3 ,
.Xr gelf_getehdr 3 ,

View File

@ -25,7 +25,7 @@
.\"
.Dd August 25, 2006
.Os
.Dt ELF 3
.Dt GELF_NEWPHDR 3
.Sh NAME
.Nm elf32_newphdr ,
.Nm elf64_newphdr ,
@ -127,11 +127,11 @@ before using these APIs.
.El
.Sh SEE ALSO
.Xr elf 3 ,
.Xr elf_flagphdr 3 ,
.Xr elf32_getphdr 3 ,
.Xr elf32_newehdr 3 ,
.Xr elf64_getphdr 3 ,
.Xr elf64_newehdr 3 ,
.Xr elf_flagphdr 3 ,
.Xr gelf 3 ,
.Xr gelf_getphdr 3 ,
.Xr gelf_newehdr 3 ,

View File

@ -25,7 +25,7 @@
.\"
.Dd August 27, 2006
.Os
.Dt ELF 3
.Dt GELF_UPDATE_EHDR 3
.Sh NAME
.Nm gelf_update_ehdr ,
.Nm gelf_update_phdr ,

View File

@ -25,7 +25,7 @@
.\"
.Dd July 24, 2006
.Os
.Dt ELF 3
.Dt GELF_XLATETOF 3
.Sh NAME
.Nm elf32_xlate ,
.Nm elf64_xlate ,