BSD 4_3 release
[unix-history] / usr / man / man3 / nlist.3
index bb5b48a..a061d3c 100644 (file)
@@ -1,29 +1,29 @@
-.TH NLIST 3 
+.\" Copyright (c) 1980 Regents of the University of California.
+.\" All rights reserved.  The Berkeley software License Agreement
+.\" specifies the terms and conditions for redistribution.
+.\"
+.\"    @(#)nlist.3     6.1 (Berkeley) 5/15/85
+.\"
+.TH NLIST 3  "May 15, 1985"
+.UC 4
 .SH NAME
 nlist \- get entries from name list
 .SH SYNOPSIS
 .SH NAME
 nlist \- get entries from name list
 .SH SYNOPSIS
-.B #include <a.out.h>
-.br
+.nf
+.B #include <nlist.h>
+.PP
 .B nlist(filename, nl)
 .B nlist(filename, nl)
-.br
 .B char *filename;
 .B char *filename;
-.DT
-.nf
-.ft 3
-struct nlist nl[ ];
+.B struct nlist nl[];
 .fi
 .SH DESCRIPTION
 .I Nlist
 .fi
 .SH DESCRIPTION
 .I Nlist
-examines the name list in
-the given executable output file
-and selectively extracts a
-list of values.
-The name list consists of
-an array of structures containing names,
+examines the name list in the given executable output file
+and selectively extracts a list of values.
+The name list consists of an array of structures containing names,
 types and values.
 The list is terminated with a null name.
 types and values.
 The list is terminated with a null name.
-Each name is looked up in the name list of
-the file.
+Each name is looked up in the name list of the file.
 If the name is found, the type and value of the
 name are inserted in the next two fields.
 If the name is not found, both entries are set to 0.
 If the name is found, the type and value of the
 name are inserted in the next two fields.
 If the name is not found, both entries are set to 0.
@@ -31,15 +31,13 @@ See
 .IR a.out (5)
 for the structure declaration.
 .PP
 .IR a.out (5)
 for the structure declaration.
 .PP
-This subroutine is useful for
-examining the system name list kept in
-the file
+This subroutine is useful for examining the system name list kept in the file
 .BR /vmunix .
 .BR /vmunix .
-In this way programs can obtain system addresses
-that are up to date.
+In this way programs can obtain system addresses that are up to date.
 .SH "SEE ALSO"
 a.out(5)
 .SH DIAGNOSTICS
 .SH "SEE ALSO"
 a.out(5)
 .SH DIAGNOSTICS
-All
-type entries are set to 0 if the file cannot be found
-or if it is not a valid namelist.
+If the file cannot be found or if it is not a valid namelist \-1 is returned;
+otherwise, the number of unfound namelist entries is returned.
+.PP
+The type entry is set to 0 if the symbol is not found.