1.\" $NetBSD: nlist.3,v 1.8 2002/02/07 07:00:16 ross Exp $ 2.\" 3.\" Copyright (c) 1980, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)nlist.3 8.3 (Berkeley) 4/19/94 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.Fd #include \*[Lt]nlist.h\*[Gt] 46.Ft int 47.Fn nlist "const char *filename" "struct nlist *nl" 48.Sh DESCRIPTION 49The 50.Fn nlist 51function 52retrieves name list entries from the symbol table of an 53executable file. (See 54.Xr a.out 5 . ) 55The argument 56.Fa \&nl 57is set to reference the 58beginning of the list. 59The list is preened of binary and invalid data; 60if an entry in the 61name list is valid, the 62.Fa n_type 63and 64.Fa n_value 65for the entry are copied into the list 66referenced by 67.Fa \&nl . 68No other data is copied. 69The last entry in the list is always 70.Dv NULL . 71.Sh RETURN VALUES 72The number of invalid entries is returned if successful; otherwise, 73if the file 74.Fa filename 75does not exist or is not executable, the returned value is \-1. 76.Sh SEE ALSO 77.Xr a.out 5 78.Sh HISTORY 79A 80.Fn nlist 81function appeared in 82.At v6 . 83