MFC:
[dragonfly.git] / lib / libc / gen / nlist.3
blob42cb20e4fa42dfcf1a01dc3adc65b78c3d6f1f10
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. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)nlist.3     8.3 (Berkeley) 4/19/94
33 .\" $FreeBSD: src/lib/libc/gen/nlist.3,v 1.4.2.3 2001/12/14 18:33:51 ru Exp $
34 .\" $DragonFly: src/lib/libc/gen/nlist.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
35 .\"
36 .Dd April 19, 1994
37 .Dt NLIST 3
38 .Os
39 .Sh NAME
40 .Nm nlist
41 .Nd retrieve symbol table name list from an executable file
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In nlist.h
46 .Ft int
47 .Fn nlist "const char *filename" "struct nlist *nl"
48 .Sh DESCRIPTION
49 The
50 .Fn nlist
51 function
52 retrieves name list entries from the symbol table of an
53 executable file (see
54 .Xr a.out 5 ) .
55 The argument
56 .Fa \&nl
57 is set to reference the
58 beginning of the list.
59 The list is preened of binary and invalid data;
60 if an entry in the
61 name list is valid, the
62 .Fa n_type
63 and
64 .Fa n_value
65 for the entry are copied into the list
66 referenced by
67 .Fa \&nl .
68 No other data is copied.
69 The last entry in the list is always
70 .Dv NULL .
71 .Sh RETURN VALUES
72 The number of invalid entries is returned if successful; otherwise,
73 if the file
74 .Fa filename
75 does not exist or is not executable, the returned value is \-1.
76 .Sh SEE ALSO
77 .Xr a.out 5
78 .Sh HISTORY
80 .Fn nlist
81 function appeared in
82 .At v6 .