Initial import from FreeBSD RELENG_4:
[games.git] / usr.bin / nm / nm.1aout
1 .\" Copyright (c) 1980, 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)nm.1        8.1 (Berkeley) 6/6/93
33 .\" $FreeBSD: src/usr.bin/nm/nm.1aout,v 1.9.2.2 2001/08/16 13:16:59 ru Exp $
34 .\"
35 .Dd June 6, 1993
36 .Dt NM 1
37 .Os
38 .Sh NAME
39 .Nm nm
40 .Nd display name list (symbol table)
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl agnoprtuwW
44 .Op Ar
45 .Sh DESCRIPTION
46 The symbol table (name list) of each object in
47 .Ar file Ns (s)
48 is displayed.
49 If a library (archive) is given,
50 .Nm 
51 displays a list for each
52 object archive member.
53 If
54 .Ar file
55 is not present,
56 .Nm
57 searches for the file
58 .Pa a.out
59 and if present, displays the symbol
60 table for
61 .Pa a.out .
62 .Bl -tag -width flag
63 .It Fl a
64 Display symbol table entries inserted for use by debuggers.
65 .It Fl g
66 Restrict display to external (global) symbols.
67 .It Fl n
68 Present results in numerical order.
69 .It Fl o
70 Display full path or library name of object on every line.
71 .It Fl p
72 Do not sort at all.
73 .It Fl r
74 Reverse order sort.
75 .It Fl t
76 Output in tabular format more suitable for other programs digestive system.
77 .It Fl u
78 Display undefined symbols only.
79 .It Fl w
80 Warn about non-object archive members.
81 Normally, nm will silently ignore all archive members which are not
82 object files.
83 .It Fl W
84 Include an extra column in the output with a ``W'' indicating weak symbols.
85 .El
86 .Pp
87 Each symbol name is preceded by its value (a blank field if the symbol
88 is undefined) and one of the following letters:
89 .Pp
90 .Bl -tag -width Ds -compact -offset indent
91 .It Fl
92 debugger symbol table entries (see the
93 .Fl a
94 option).
95 .It Li A
96 absolute
97 .It Li B
98 bss segment symbol
99 .It Li C
100 common symbol
101 .It Li D
102 data segment symbol
103 .It Li f
104 file name
105 .It Li I
106 indirect reference symbol
107 .It Li T
108 text segment symbol
109 .It Li U
110 undefined
111 .It Li W
112 warn if next symbol is referenced
113 .El
114 .Pp
115 If the symbol is local (non-external) the type letter is in lower case.
116 The output is sorted alphabetically.
117 .Sh KEYWORDS
118 The following is a complete list of keywords and their meaning.
119 The keyword is uppercase for external, lowercase for internal symbols.
120 Only uppercase keywords are shown here.
121 .Pp
122 .Bl -tag -width sigignore -compact
123 .It A
124 Absolute Address
125 .It B
126 BSS Segment
127 .It C
128 Common Reference
129 .It D
130 Data Segment
131 .It F
132 Filename (external only)
133 .It w
134 Warning refs (internal only)
135 .It I
136 Alias definition
137 .It T
138 Text Segment
139 .It U
140 Undefined
141 .It ?
142 None of the above
143 .El
144 .Sh SEE ALSO
145 .Xr ar 1 ,
146 .Xr a.out 5 ,
147 .Xr ar 5 ,
148 .Xr stab 5
149 .Sh HISTORY
150 An
151 .Nm
152 command appeared in
153 .At v1 .