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