binutils/nm.1

   1 .\" Copyright (c) 1991 Free Software Foundation
   2 .\" See section COPYING for conditions for redistribution
   3 .TH nm 1 "5 November 1991" "cygnus support" "GNU Development Tools"
   4 .de BP
   5 .sp
   6 .ti \-.2i
   7 \(**
   8 ..
   9
  10 .SH NAME
  11 nm \- list symbols from object files.
  12
  13 .SH SYNOPSIS
  14 .hy 0
  15 .na
  16 .TP
  17 .B nm
  18 .RB "[\|" \-a | \-\-debug\-syms "\|]"
  19 .RB "[\|" \-g | \-\-extern\-only "\|]"
  20 .RB "[\|" \-B "\|]"
  21 .RB "[\|" \-C | \-\-demangle "\|]"
  22 .RB "[\|" \-D | \-\-dynamic "\|]"
  23 .RB "[\|" \-s | \-\-print\-armap "\|]"
  24 .RB "[\|" \-o | \-\-print\-file\-name "\|]"
  25 .RB "[\|" \-n | \-\-numeric\-sort "\|]"
  26 .RB "[\|" \-p | \-\-no\-sort "\|]"
  27 .RB "[\|" \-r | \-\-reverse\-sort "\|]"
  28 .RB "[\|" \-\-size\-sort "\|]"
  29 .RB "[\|" \-u | \-\-undefined\-only "\|]"
  30 .RB "[\|" \-\-help "\|]"
  31 .RB "[\|" \-\-version "\|]"
  32 .RB "[\|" "\-t \fIradix" | \-\-radix=\fIradix "\|]"
  33 .RB "[\|" \-P | --portability "\|]"
  34 .RB "[\|" "\-f \fIformat" | \-\-format=\fIformat "\|]"
  35 .RB "[\|" "\-\-target=\fIbfdname" "\|]"
  36 .RB "[\|" \c
  37 .I objfile\c
  38 \&.\|.\|.\|]
  39 .ad b
  40 .hy 1
  41 .SH DESCRIPTION
  42 GNU \c
  43 .B nm\c
  44 \& lists the symbols from object files \c
  45 .I objfile\c
  46 \&.  If no object files are given as arguments, \c
  47 .B nm\c
  48 \& assumes `\|\c
  49 .B a.out\c
  50 \|'.
  51
  52 .SH OPTIONS
  53 The long and short forms of options, shown here as alternatives, are
  54 equivalent.
  55
  56 .TP
  57 .B \-A
  58 .TP
  59 .B \-o
  60 .TP
  61 .B \-\-print\-file\-name
  62 Precede each symbol by the name of the input file where it was found,
  63 rather than identifying the input file once only before all of its
  64 symbols.
  65
  66 .TP
  67 .B \-a
  68 .TP
  69 .B \-\-debug\-syms
  70 Display debugger-only symbols; normally these are not listed.
  71
  72 .TP
  73 .B \-B
  74 The same as
  75 .B \-\-format=bsd
  76 (for compatibility with the MIPS \fBnm\fP).
  77
  78 .TP
  79 .B \-C
  80 .TP
  81 .B \-\-demangle
  82 Decode (\fIdemangle\fP) low-level symbol names into user-level names.
  83 Besides removing any initial underscore prepended by the system, this
  84 makes C++ function names readable.
  85
  86 .TP
  87 .B \-D
  88 .TP
  89 .B \-\-dynamic
  90 Display the dynamic symbols rather than the normal symbols.  This is
  91 only meaningful for dynamic objects, such as certain types of shared
  92 libraries.
  93
  94 .TP
  95 .B "\-f \fIformat"
  96 Use the output format \fIformat\fP, which can be ``bsd'',
  97 ``sysv'', or ``posix''.  The default is `bsd''.
  98 Only the first character of \fIformat\fP is significant; it can be
  99 either upper or lower case.
 100
 101 .TP
 102 .B \-g
 103 .TP
 104 .B \-\-extern\-only
 105 Display only external symbols.
 106
 107 .TP
 108 .B \-n
 109 .TP
 110 .B \-v
 111 .TP
 112 .B \-\-numeric\-sort
 113 Sort symbols numerically by their addresses, not alphabetically by their
 114 names.
 115
 116 .TP
 117 .B \-p
 118 .TP
 119 .B \-\-no\-sort
 120 Don't bother to sort the symbols in any order; just print them in the
 121 order encountered.
 122
 123 .TP
 124 .B \-P
 125 .TP
 126 .B \-\-portability
 127 Use the POSIX.2 standard output format instead of the default format.
 128 Equivalent to ``\-f posix''.
 129
 130 .TP
 131 .B \-s
 132 .TP
 133 .B \-\-print\-armap
 134 When listing symbols from archive members, include the index: a mapping
 135 (stored in the archive by \c
 136 .B ar\c
 137 \& or \c
 138 .B ranlib\c
 139 \&) of what modules
 140 contain definitions for what names.
 141
 142 .TP
 143 .B \-r
 144 .TP
 145 .B \-\-reverse\-sort
 146 Reverse the sense of the sort (whether numeric or alphabetic); let the
 147 last come first.
 148
 149 .TP
 150 .B \-\-size\-sort
 151 Sort symbols by size.  The size is computed as the difference between
 152 the value of the symbol and the value of the symbol with the next higher
 153 value.  The size of the symbol is printed, rather than the value.
 154
 155 .TP
 156 .B "\-t \fIradix"
 157 .TP
 158 .B "\-\-radix=\fIradix"
 159 Use \fIradix\fP as the radix for printing the symbol values.  It must be
 160 ``d'' for decimal, ``o'' for octal, or ``x'' for hexadecimal.
 161
 162 .TP
 163 .BI "\-\-target=" "bfdname"\c
 164 \&
 165 Specify an object code format other than your system's default format.
 166 See
 167 .BR objdump ( 1 ),
 168 for information on listing available formats.
 169
 170 .TP
 171 .B \-u
 172 .TP
 173 .B \-\-undefined\-only
 174 Display only undefined symbols (those external to each object file).
 175
 176 .TP
 177 .B \-V
 178 .TP
 179 .B \-\-version
 180 Show the version number of
 181 .B nm
 182 and exit.
 183
 184 .TP
 185 .B \-\-help
 186 Show a summary of the options to
 187 .B nm
 188 and exit.
 189
 190 .SH "SEE ALSO"
 191 .RB "`\|" binutils "\|'"
 192 entry in
 193 .B
 194 info\c
 195 \&;
 196 .I
 197 The GNU Binary Utilities\c
 198 \&, Roland H. Pesch (October 1991);
 199 .BR ar "(" 1 "),"
 200 .BR objdump ( 1 ),
 201 .BR ranlib "(" 1 ")."
 202
 203
 204 .SH COPYING
 205 Copyright (c) 1991 Free Software Foundation, Inc.
 206 .PP
 207 Permission is granted to make and distribute verbatim copies of
 208 this manual provided the copyright notice and this permission notice
 209 are preserved on all copies.
 210 .PP
 211 Permission is granted to copy and distribute modified versions of this
 212 manual under the conditions for verbatim copying, provided that the
 213 entire resulting derived work is distributed under the terms of a
 214 permission notice identical to this one.
 215 .PP
 216 Permission is granted to copy and distribute translations of this
 217 manual into another language, under the above conditions for modified
 218 versions, except that this permission notice may be included in
 219 translations approved by the Free Software Foundation instead of in
 220 the original English.