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