83 lines
2.8 KiB
Groff
83 lines
2.8 KiB
Groff
.\" $NetBSD: nlist.3,v 1.7 1999/03/22 19:44:43 garbled Exp $
|
|
.\"
|
|
.\" Copyright (c) 1980, 1991, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)nlist.3 8.3 (Berkeley) 4/19/94
|
|
.\"
|
|
.Dd April 19, 1994
|
|
.Dt NLIST 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm nlist
|
|
.Nd retrieve symbol table name list from an executable file
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.Fd #include <nlist.h>
|
|
.Ft int
|
|
.Fn nlist "const char *filename" "struct nlist *nl"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn nlist
|
|
function
|
|
retrieves name list entries from the symbol table of an
|
|
executable file. (See
|
|
.Xr a.out 5 . )
|
|
The argument
|
|
.Fa \&nl
|
|
is set to reference the
|
|
beginning of the list.
|
|
The list is preened of binary and invalid data;
|
|
if an entry in the
|
|
name list is valid, the
|
|
.Fa n_type
|
|
and
|
|
.Fa n_value
|
|
for the entry are copied into the list
|
|
referenced by
|
|
.Fa \&nl .
|
|
No other data is copied.
|
|
The last entry in the list is always
|
|
.Dv NULL .
|
|
.Sh RETURN VALUES
|
|
The number of invalid entries is returned if successful; otherwise,
|
|
if the file
|
|
.Fa filename
|
|
does not exist or is not executable, the returned value is \-1.
|
|
.Sh SEE ALSO
|
|
.Xr a.out 5
|
|
.Sh HISTORY
|
|
A
|
|
.Fn nlist
|
|
function appeared in
|
|
.At v6 .
|