usr.bin/nm/nm.1aout

   1 .\" Copyright (c) 1980, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)nm.1        8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD: src/usr.bin/nm/nm.1aout,v 1.9.2.2 2001/08/16 13:16:59 ru Exp $
  34 .\" $DragonFly: src/usr.bin/nm/Attic/nm.1aout,v 1.2 2003/06/17 04:29:30 dillon Exp $
  35 .\"
  36 .Dd June 6, 1993
  37 .Dt NM 1
  38 .Os
  39 .Sh NAME
  40 .Nm nm
  41 .Nd display name list (symbol table)
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl agnoprtuwW
  45 .Op Ar
  46 .Sh DESCRIPTION
  47 The symbol table (name list) of each object in
  48 .Ar file Ns (s)
  49 is displayed.
  50 If a library (archive) is given,
  51 .Nm
  52 displays a list for each
  53 object archive member.
  54 If
  55 .Ar file
  56 is not present,
  57 .Nm
  58 searches for the file
  59 .Pa a.out
  60 and if present, displays the symbol
  61 table for
  62 .Pa a.out .
  63 .Bl -tag -width flag
  64 .It Fl a
  65 Display symbol table entries inserted for use by debuggers.
  66 .It Fl g
  67 Restrict display to external (global) symbols.
  68 .It Fl n
  69 Present results in numerical order.
  70 .It Fl o
  71 Display full path or library name of object on every line.
  72 .It Fl p
  73 Do not sort at all.
  74 .It Fl r
  75 Reverse order sort.
  76 .It Fl t
  77 Output in tabular format more suitable for other programs digestive system.
  78 .It Fl u
  79 Display undefined symbols only.
  80 .It Fl w
  81 Warn about non-object archive members.
  82 Normally, nm will silently ignore all archive members which are not
  83 object files.
  84 .It Fl W
  85 Include an extra column in the output with a ``W'' indicating weak symbols.
  86 .El
  87 .Pp
  88 Each symbol name is preceded by its value (a blank field if the symbol
  89 is undefined) and one of the following letters:
  90 .Pp
  91 .Bl -tag -width Ds -compact -offset indent
  92 .It Fl
  93 debugger symbol table entries (see the
  94 .Fl a
  95 option).
  96 .It Li A
  97 absolute
  98 .It Li B
  99 bss segment symbol
 100 .It Li C
 101 common symbol
 102 .It Li D
 103 data segment symbol
 104 .It Li f
 105 file name
 106 .It Li I
 107 indirect reference symbol
 108 .It Li T
 109 text segment symbol
 110 .It Li U
 111 undefined
 112 .It Li W
 113 warn if next symbol is referenced
 114 .El
 115 .Pp
 116 If the symbol is local (non-external) the type letter is in lower case.
 117 The output is sorted alphabetically.
 118 .Sh KEYWORDS
 119 The following is a complete list of keywords and their meaning.
 120 The keyword is uppercase for external, lowercase for internal symbols.
 121 Only uppercase keywords are shown here.
 122 .Pp
 123 .Bl -tag -width sigignore -compact
 124 .It A
 125 Absolute Address
 126 .It B
 127 BSS Segment
 128 .It C
 129 Common Reference
 130 .It D
 131 Data Segment
 132 .It F
 133 Filename (external only)
 134 .It w
 135 Warning refs (internal only)
 136 .It I
 137 Alias definition
 138 .It T
 139 Text Segment
 140 .It U
 141 Undefined
 142 .It ?
 143 None of the above
 144 .El
 145 .Sh SEE ALSO
 146 .Xr ar 1 ,
 147 .Xr a.out 5 ,
 148 .Xr ar 5 ,
 149 .Xr stab 5
 150 .Sh HISTORY
 151 An
 152 .Nm
 153 command appeared in
 154 .At v1 .