xref: /freebsd/lib/libc/gen/nlist.3 (revision 315ee00f)
1.\" Copyright (c) 1980, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)nlist.3	8.3 (Berkeley) 4/19/94
29.\"
30.Dd April 19, 1994
31.Dt NLIST 3
32.Os
33.Sh NAME
34.Nm nlist
35.Nd retrieve symbol table name list from an executable file
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In nlist.h
40.Ft int
41.Fn nlist "const char *filename" "struct nlist *nl"
42.Sh DESCRIPTION
43The
44.Fn nlist
45function
46retrieves name list entries from the symbol table of an
47executable file (see
48.Xr a.out 5 ) .
49The argument
50.Fa \&nl
51is set to reference the
52beginning of the list.
53The list is preened of binary and invalid data;
54if an entry in the
55name list is valid, the
56.Fa n_type
57and
58.Fa n_value
59for the entry are copied into the list
60referenced by
61.Fa \&nl .
62No other data is copied.
63The last entry in the list is always
64.Dv NULL .
65.Sh RETURN VALUES
66The number of invalid entries is returned if successful; otherwise,
67if the file
68.Fa filename
69does not exist or is not executable, the returned value is \-1.
70.Sh SEE ALSO
71.Xr elf 5
72.Sh HISTORY
73A
74.Fn nlist
75function appeared in
76.At v6 .
77