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\(em\&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 "[\|" \-s | \-\-print\-armap "\|]"
  21 .RB "[\|" \-o | \-\-print\-file\-name "\|]"
  22 .RB "[\|" \-n | \-\-numeric\-sort "\|]"
  23 .RB "[\|" \-p | \-\-no\-sort "\|]"
  24 .RB "[\|" \-r | \-\-reverse\-sort "\|]"
  25 .RB "[\|" \-u | \-\-undefined\-only "\|]"
  26 .RB "[\|" "\-\-target="\c
  27 .I bfdname\c
  28 \&\|]
  29 .RB "[\|" \c
  30 .I objfile\c
  31 \&.\|.\|.\|]
  32 .ad b
  33 .hy 1
  34 .SH DESCRIPTION
  35 GNU \c
  36 .B nm\c
  37 \& will list the symbols from object files \c
  38 .I objfile\c
  39 \&.
  40
  41 .SH OPTIONS
  42 The long and short forms of options, shown here as alternatives, are
  43 equivalent.
  44
  45 .TP
  46 .IR "objfile" .\|.\|.
  47 Object files whose symbols are to be listed.  If no object files are
  48 listed as arguments, \c
  49 .B nm\c
  50 \& assumes `\|\c
  51 .B a.out\c
  52 \|'.
  53
  54 .TP
  55 .B \-a
  56 .TP
  57 .B \-\-debug\-syms
  58 Display debugger-only symbols; normally these are not listed.
  59
  60 .TP
  61 .B \-g
  62 .TP
  63 .B \-\-extern\-only
  64 Display only external symbols.
  65
  66 .TP
  67 .B \-p
  68 .TP
  69 .B \-\-no\-sort
  70 Don't bother to sort the symbols in any order; just print them in the
  71 order encountered.
  72
  73 .TP
  74 .B \-n
  75 .TP
  76 .B \-\-numeric\-sort
  77 Sort symbols numerically by their addresses, not alphabetically by their
  78 names.
  79
  80 .TP
  81 .B \-s
  82 .TP
  83 .B \-\-print\-armap
  84 When listing symbols from archive members, include the index: a mapping
  85 (stored in the archive by \c
  86 .B ar\c
  87 \& or \c
  88 .B ranlib\c
  89 \&) of what modules
  90 contain definitions for what names.
  91
  92 .TP
  93 .B \-o
  94 .TP
  95 .B \-\-print\-file\-name
  96 Precede each symbol by the name of the input file where it was found,
  97 rather than identifying the input file once only before all of its
  98 symbols.
  99
 100 .TP
 101 .B \-r
 102 .TP
 103 .B \-\-reverse\-sort
 104 Reverse the sense of the sort (whether numeric or alphabetic); let the
 105 last come first.
 106
 107 .TP
 108 .BI "\-\-target " "bfdname"\c
 109 \&
 110 Specify an object code format other than your system's default format.
 111 See
 112 .BR objdump ( 1 ),
 113 for information on listing available formats.
 114
 115 .TP
 116 .B \-u
 117 .TP
 118 .B \-\-undefined\-only
 119 Display only undefined symbols (those external to each object file).
 120
 121 .PP
 122
 123 .SH "SEE ALSO"
 124 .RB "`\|" binutils "\|'"
 125 entry in
 126 .B
 127 info\c
 128 \&;
 129 .I
 130 The GNU Binary Utilities\c
 131 \&, Roland H. Pesch (October 1991);
 132 .BR ar "(" 1 "),"
 133 .BR objdump ( 1 ),
 134 .BR ranlib "(" 1 ")."
 135
 136
 137 .SH COPYING
 138 Copyright (c) 1991 Free Software Foundation, Inc.
 139 .PP
 140 Permission is granted to make and distribute verbatim copies of
 141 this manual provided the copyright notice and this permission notice
 142 are preserved on all copies.
 143 .PP
 144 Permission is granted to copy and distribute modified versions of this
 145 manual under the conditions for verbatim copying, provided that the
 146 entire resulting derived work is distributed under the terms of a
 147 permission notice identical to this one.
 148 .PP
 149 Permission is granted to copy and distribute translations of this
 150 manual into another language, under the above conditions for modified
 151 versions, except that this permission notice may be included in
 152 translations approved by the Free Software Foundation instead of in
 153 the original English.