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.\" $FreeBSD: src/lib/libc/gen/nlist.3,v 1.4.2.3 2001/12/14 18:33:51 ru Exp $ 30.\" $DragonFly: src/lib/libc/gen/nlist.3,v 1.2 2003/06/17 04:26:42 dillon Exp $ 31.\" 32.Dd April 19, 1994 33.Dt NLIST 3 34.Os 35.Sh NAME 36.Nm nlist 37.Nd retrieve symbol table name list from an executable file 38.Sh LIBRARY 39.Lb libc 40.Sh SYNOPSIS 41.In nlist.h 42.Ft int 43.Fn nlist "const char *filename" "struct nlist *nl" 44.Sh DESCRIPTION 45The 46.Fn nlist 47function 48retrieves name list entries from the symbol table of an 49executable file (see 50.Xr a.out 5 ) . 51The argument 52.Fa \&nl 53is set to reference the 54beginning of the list. 55The list is preened of binary and invalid data; 56if an entry in the 57name list is valid, the 58.Fa n_type 59and 60.Fa n_value 61for the entry are copied into the list 62referenced by 63.Fa \&nl . 64No other data is copied. 65The last entry in the list is always 66.Dv NULL . 67.Sh RETURN VALUES 68The number of invalid entries is returned if successful; otherwise, 69if the file 70.Fa filename 71does not exist or is not executable, the returned value is \-1. 72.Sh SEE ALSO 73.Xr a.out 5 74.Sh HISTORY 75A 76.Fn nlist 77function appeared in 78.At v6 . 79