[unix-history] / usr / src / usr.bin / nm / nm.1

.\" Copyright (c) 1980, 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)nm.1	6.7 (Berkeley) 7/30/91
.\"
.Dd July 30, 1991
.Dt NM 1
.Os BSD 4
.Sh NAME
.Nm nm
.Nd display name list (symbol table)
.Sh SYNOPSIS
.Nm nm
.Op Fl agnopruw
.Ar
.Sh DESCRIPTION
The symbol table (name list) of each object in
.Ar file(s)
is displayed.
If a library (archive) is given,
.Nm 
displays a list for each
object archive member.
If
.Ar file
is not present,
.Nm
searches for the file
.Pa a.out
and if present, displays the symbol
table for
.Pa a.out .
.Bl -tag -width flag
.It Fl a
Display symbol table entries inserted for use by debuggers.
.It Fl g
Restrict display to external (global) symbols.
.It Fl n
Present results in numerical order.
.It Fl o
Display full path or library name of object on every line.
.It Fl p
Do not sort at all.
.It Fl r
Reverse order sort.
.It Fl u
Display undefined symbols only.
.It Fl w
Warn about non-object archive members.
Normally, nm will silently ignore all archive members which are not
object files.
.El
.Pp
Each symbol name is preceded by its value (a blank field if the symbol
is undefined) and one of the following letters:
.Pp
.Bl -tag -width Ds -compact -offset indent
.It Fl
debugger symbol table entries (see the
.Fl a
option).
.It Li A
absolute
.It Li B
bss segment symbol
.It Li C
common symbol
.It Li D
data segment symbol
.It Li f
file name
.It Li T
text segment symbol
.It Li U
undefined
.El
.Pp
If the symbol is local (non-external) the type letter is in lower case.
The output is sorted alphabetically.
.Sh SEE ALSO
.Xr ar 1 ,
.Xr ar 5 ,
.Xr a.out 5 ,
.Xr stab 5
.Sh HISTORY
An
.Nm nm
command appeared in
.At v6 .
Commit	Line	Data
7b089094 WJ	1	.\" Copyright (c) 1980, 1990 The Regents of the University of California.
	2	.\" 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 6.7 (Berkeley) 7/30/91
	33	.\"
	34	.Dd July 30, 1991
	35	.Dt NM 1
	36	.Os BSD 4
	37	.Sh NAME
	38	.Nm nm
	39	.Nd display name list (symbol table)
	40	.Sh SYNOPSIS
	41	.Nm nm
	42	.Op Fl agnopruw
	43	.Ar
	44	.Sh DESCRIPTION
	45	The symbol table (name list) of each object in
	46	.Ar file(s)
	47	is displayed.
	48	If a library (archive) is given,
	49	.Nm
	50	displays a list for each
	51	object archive member.
	52	If
	53	.Ar file
	54	is not present,
	55	.Nm
	56	searches for the file
	57	.Pa a.out
	58	and if present, displays the symbol
	59	table for
	60	.Pa a.out .
	61	.Bl -tag -width flag
	62	.It Fl a
	63	Display symbol table entries inserted for use by debuggers.
	64	.It Fl g
65	Restrict display to external (global) symbols.
66	.It Fl n
67	Present results in numerical order.
68	.It Fl o
69	Display full path or library name of object on every line.
70	.It Fl p
71	Do not sort at all.
72	.It Fl r
73	Reverse order sort.
74	.It Fl u
75	Display undefined symbols only.
76	.It Fl w
77	Warn about non-object archive members.
78	Normally, nm will silently ignore all archive members which are not
79	object files.
80	.El
81	.Pp
82	Each symbol name is preceded by its value (a blank field if the symbol
83	is undefined) and one of the following letters:
84	.Pp
85	.Bl -tag -width Ds -compact -offset indent
86	.It Fl
87	debugger symbol table entries (see the
88	.Fl a
89	option).
90	.It Li A
91	absolute
92	.It Li B
93	bss segment symbol
94	.It Li C
95	common symbol
96	.It Li D
97	data segment symbol
98	.It Li f
99	file name
100	.It Li T
101	text segment symbol
102	.It Li U
103	undefined
104	.El
105	.Pp
106	If the symbol is local (non-external) the type letter is in lower case.
107	The output is sorted alphabetically.
108	.Sh SEE ALSO
109	.Xr ar 1 ,
110	.Xr ar 5 ,
111	.Xr a.out 5 ,
112	.Xr stab 5
113	.Sh HISTORY
114	An
115	.Nm nm
116	command appeared in
117	.At v6 .