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