binutils/nm.1

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