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