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