lib/libc/gen/nlist.3

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