Annotation of src/usr.bin/nm/nm.1, Revision 1.1.1.1
1.1 deraadt 1: .\" $NetBSD: nm.1,v 1.3 1995/08/31 23:41:58 jtc Exp $
2: .\"
3: .\" Copyright (c) 1980, 1990, 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. 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: .\"
34: .\" @(#)nm.1 8.1 (Berkeley) 6/6/93
35: .\"
36: .Dd June 6, 1993
37: .Dt NM 1
38: .Os BSD 4
39: .Sh NAME
40: .Nm nm
41: .Nd display name list (symbol table)
42: .Sh SYNOPSIS
43: .Nm nm
44: .Op Fl agnopruw
45: .Ar
46: .Sh DESCRIPTION
47: The symbol table (name list) of each object in
48: .Ar file(s)
49: is displayed.
50: If a library (archive) is given,
51: .Nm
52: displays a list for each
53: object archive member.
54: If
55: .Ar file
56: is not present,
57: .Nm
58: searches for the file
59: .Pa a.out
60: and if present, displays the symbol
61: table for
62: .Pa a.out .
63: .Bl -tag -width flag
64: .It Fl a
65: Display symbol table entries inserted for use by debuggers.
66: .It Fl g
67: Restrict display to external (global) symbols.
68: .It Fl n
69: Present results in numerical order.
70: .It Fl o
71: Display full path or library name of object on every line.
72: .It Fl p
73: Do not sort at all.
74: .It Fl r
75: Reverse order sort.
76: .It Fl u
77: Display undefined symbols only.
78: .It Fl w
79: Warn about non-object archive members.
80: Normally, nm will silently ignore all archive members which are not
81: object files.
82: .El
83: .Pp
84: Each symbol name is preceded by its value (a blank field if the symbol
85: is undefined) and one of the following letters:
86: .Pp
87: .Bl -tag -width Ds -compact -offset indent
88: .It Fl
89: debugger symbol table entries (see the
90: .Fl a
91: option).
92: .It Li A
93: absolute
94: .It Li B
95: bss segment symbol
96: .It Li C
97: common symbol
98: .It Li D
99: data segment symbol
100: .It Li f
101: file name
102: .It Li T
103: text segment symbol
104: .It Li U
105: undefined
106: .El
107: .Pp
108: If the symbol is local (non-external) the type letter is in lower case.
109: The output is sorted alphabetically.
110: .Sh SEE ALSO
111: .Xr ar 1 ,
112: .Xr ar 5 ,
113: .Xr a.out 5 ,
114: .Xr stab 5
115: .Sh HISTORY
116: An
117: .Nm nm
118: command appeared in
119: .At v6 .