1.\" $OpenBSD: nlist.3,v 1.10 2007/05/31 19:19:28 jmc 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. Neither the name of the University nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.Dd $Mdocdate: May 31 2007 $ 31.Dt NLIST 3 32.Os 33.Sh NAME 34.Nm nlist 35.Nd retrieve symbol table name list from an executable file 36.Sh SYNOPSIS 37.Fd #include <nlist.h> 38.Ft int 39.Fn nlist "const char *filename" "struct nlist *nl" 40.Sh DESCRIPTION 41The 42.Fn nlist 43function retrieves name list entries from the symbol table of an 44executable file. 45(See 46.Xr a.out 5 . ) 47The argument 48.Fa \&nl 49is set to reference the 50beginning of the list. 51The list is preened of binary and invalid data; 52if an entry in the 53name list is valid, the 54.Fa n_type 55and 56.Fa n_value 57for the entry are copied into the list 58referenced by 59.Fa \&nl . 60No other data is copied. 61The last entry in the list always has its 62.Fa n_name 63field set to 64.Dv NULL . 65.Sh RETURN VALUES 66The number of invalid entries is returned if successful; otherwise, 67if the file 68.Fa filename 69does not exist or is not an executable, the returned value is \-1. 70.Sh SEE ALSO 71.Xr a.out 5 72.Sh HISTORY 73A 74.Fn nlist 75function appeared in 76.At v6 . 77