BSD 3 development
[unix-history] / usr / man / man3 / nlist.3
CommitLineData
c392c345
BJ
1.TH NLIST 3
2.SH NAME
3nlist \- get entries from name list
4.SH SYNOPSIS
5.B #include <a.out.h>
6.br
7.B nlist(filename, nl)
8.br
9.B char *filename;
10.DT
11.nf
12.ft 3
13struct nlist nl[ ];
14.fi
15.SH DESCRIPTION
16.I Nlist
17examines the name list in
18the given executable output file
19and selectively extracts a
20list of values.
21The name list consists of
22an array of structures containing names,
23types and values.
24The list is terminated with a null name.
25Each name is looked up in the name list of
26the file.
27If the name is found, the type and value of the
28name are inserted in the next two fields.
29If the name is not found, both entries are set to 0.
30See
31.IR a.out (5)
32for the structure declaration.
33.PP
34This subroutine is useful for
35examining the system name list kept in
36the file
37.BR /vmunix .
38In this way programs can obtain system addresses
39that are up to date.
40.SH "SEE ALSO"
41a.out(5)
42.SH DIAGNOSTICS
43All
44type entries are set to 0 if the file cannot be found
45or if it is not a valid namelist.