usr.bin/clang/llvm-nm/llvm-nm.1

   1 .\" $FreeBSD$
   2 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
   3 .\"
   4 .\" Standard preamble:
   5 .\" ========================================================================
   6 .de Sp \" Vertical space (when we can't use .PP)
   7 .if t .sp .5v
   8 .if n .sp
   9 ..
  10 .de Vb \" Begin verbatim text
  11 .ft CW
  12 .nf
  13 .ne \\$1
  14 ..
  15 .de Ve \" End verbatim text
  16 .ft R
  17 .fi
  18 ..
  19 .\" Set up some character translations and predefined strings.  \*(-- will
  20 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  21 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  22 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  23 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  24 .\" nothing in troff, for use with C<>.
  25 .tr \(*W-
  26 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  27 .ie n \{\
  28 .    ds -- \(*W-
  29 .    ds PI pi
  30 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  31 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  32 .    ds L" ""
  33 .    ds R" ""
  34 .    ds C` ""
  35 .    ds C' ""
  36 'br\}
  37 .el\{\
  38 .    ds -- \|\(em\|
  39 .    ds PI \(*p
  40 .    ds L" ``
  41 .    ds R" ''
  42 'br\}
  43 .\"
  44 .\" Escape single quotes in literal strings from groff's Unicode transform.
  45 .ie \n(.g .ds Aq \(aq
  46 .el       .ds Aq '
  47 .\"
  48 .\" If the F register is turned on, we'll generate index entries on stderr for
  49 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  50 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  51 .\" output yourself in some meaningful fashion.
  52 .ie \nF \{\
  53 .    de IX
  54 .    tm Index:\\$1\t\\n%\t"\\$2"
  55 ..
  56 .    nr % 0
  57 .    rr F
  58 .\}
  59 .el \{\
  60 .    de IX
  61 ..
  62 .\}
  63 .\"
  64 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  65 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  66 .    \" fudge factors for nroff and troff
  67 .if n \{\
  68 .    ds #H 0
  69 .    ds #V .8m
  70 .    ds #F .3m
  71 .    ds #[ \f1
  72 .    ds #] \fP
  73 .\}
  74 .if t \{\
  75 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  76 .    ds #V .6m
  77 .    ds #F 0
  78 .    ds #[ \&
  79 .    ds #] \&
  80 .\}
  81 .    \" simple accents for nroff and troff
  82 .if n \{\
  83 .    ds ' \&
  84 .    ds ` \&
  85 .    ds ^ \&
  86 .    ds , \&
  87 .    ds ~ ~
  88 .    ds /
  89 .\}
  90 .if t \{\
  91 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  92 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  93 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  94 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  95 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  96 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  97 .\}
  98 .    \" troff and (daisy-wheel) nroff accents
  99 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 100 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 101 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 102 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 103 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 104 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 105 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 106 .ds ae a\h'-(\w'a'u*4/10)'e
 107 .ds Ae A\h'-(\w'A'u*4/10)'E
 108 .    \" corrections for vroff
 109 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 110 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 111 .    \" for low resolution devices (crt and lpr)
 112 .if \n(.H>23 .if \n(.V>19 \
 113 \{\
 114 .    ds : e
 115 .    ds 8 ss
 116 .    ds o a
 117 .    ds d- d\h'-1'\(ga
 118 .    ds D- D\h'-1'\(hy
 119 .    ds th \o'bp'
 120 .    ds Th \o'LP'
 121 .    ds ae ae
 122 .    ds Ae AE
 123 .\}
 124 .rm #[ #] #H #V #F C
 125 .\" ========================================================================
 126 .\"
 127 .IX Title "LLVM-NM 1"
 128 .TH LLVM-NM 1 "2011-10-17" "LLVM 3.0" "LLVM Command Guide"
 129 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 130 .\" way too many mistakes in technical documents.
 131 .if n .ad l
 132 .nh
 133 .SH "NAME"
 134 llvm\-nm \- list LLVM bitcode file's symbol table
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 \&\fBllvm-nm\fR [\fIoptions\fR] [\fIfilenames...\fR]
 138 .SH "DESCRIPTION"
 139 .IX Header "DESCRIPTION"
 140 The \fBllvm-nm\fR utility lists the names of symbols from the \s-1LLVM\s0 bitcode files,
 141 or \fBar\fR archives containing \s-1LLVM\s0 bitcode files, named on the command line.
 142 Each symbol is listed along with some simple information about its provenance.
 143 If no file name is specified, or \fI\-\fR is used as a file name, \fBllvm-nm\fR will
 144 process a bitcode file on its standard input stream.
 145 .PP
 146 \&\fBllvm-nm\fR's default output format is the traditional \s-1BSD\s0 \fBnm\fR output format.
 147 Each such output record consists of an (optional) 8\-digit hexadecimal address,
 148 followed by a type code character, followed by a name, for each symbol. One
 149 record is printed per line; fields are separated by spaces. When the address is
 150 omitted, it is replaced by 8 spaces.
 151 .PP
 152 Type code characters currently supported, and their meanings, are as follows:
 153 .IP "U" 4
 154 .IX Item "U"
 155 Named object is referenced but undefined in this bitcode file
 156 .IP "C" 4
 157 .IX Item "C"
 158 Common (multiple definitions link together into one def)
 159 .IP "W" 4
 160 .IX Item "W"
 161 Weak reference (multiple definitions link together into zero or one definitions)
 162 .IP "t" 4
 163 .IX Item "t"
 164 Local function (text) object
 165 .IP "T" 4
 166 .IX Item "T"
 167 Global function (text) object
 168 .IP "d" 4
 169 .IX Item "d"
 170 Local data object
 171 .IP "D" 4
 172 .IX Item "D"
 173 Global data object
 174 .IP "?" 4
 175 Something unrecognizable
 176 .PP
 177 Because \s-1LLVM\s0 bitcode files typically contain objects that are not considered to
 178 have addresses until they are linked into an executable image or dynamically
 179 compiled \*(L"just-in-time\*(R", \fBllvm-nm\fR does not print an address for any symbol,
 180 even symbols which are defined in the bitcode file.
 181 .SH "OPTIONS"
 182 .IX Header "OPTIONS"
 183 .IP "\fB\-P\fR" 4
 184 .IX Item "-P"
 185 Use \s-1POSIX\s0.2 output format. Alias for \fB\-\-format=posix\fR.
 186 .IP "\fB\-B\fR    (default)" 4
 187 .IX Item "-B    (default)"
 188 Use \s-1BSD\s0 output format. Alias for \fB\-\-format=bsd\fR.
 189 .IP "\fB\-help\fR" 4
 190 .IX Item "-help"
 191 Print a summary of command-line options and their meanings.
 192 .IP "\fB\-\-defined\-only\fR" 4
 193 .IX Item "--defined-only"
 194 Print only symbols defined in this bitcode file (as opposed to
 195 symbols which may be referenced by objects in this file, but not
 196 defined in this file.)
 197 .IP "\fB\-\-extern\-only\fR, \fB\-g\fR" 4
 198 .IX Item "--extern-only, -g"
 199 Print only symbols whose definitions are external; that is, accessible
 200 from other bitcode files.
 201 .IP "\fB\-\-undefined\-only\fR, \fB\-u\fR" 4
 202 .IX Item "--undefined-only, -u"
 203 Print only symbols referenced but not defined in this bitcode file.
 204 .IP "\fB\-\-format=\fR\fIfmt\fR, \fB\-f\fR" 4
 205 .IX Item "--format=fmt, -f"
 206 Select an output format; \fIfmt\fR may be \fIsysv\fR, \fIposix\fR, or \fIbsd\fR. The
 207 default is \fIbsd\fR.
 208 .SH "BUGS"
 209 .IX Header "BUGS"
 210 \&\fBllvm-nm\fR cannot demangle \*(C+ mangled names, like \s-1GNU\s0 \fBnm\fR can.
 211 .SH "EXIT STATUS"
 212 .IX Header "EXIT STATUS"
 213 \&\fBllvm-nm\fR exits with an exit code of zero.
 214 .SH "SEE ALSO"
 215 .IX Header "SEE ALSO"
 216 llvm-dis, \fIar\fR\|(1), \fInm\fR\|(1)
 217 .SH "AUTHOR"
 218 .IX Header "AUTHOR"
 219 Maintained by the \s-1LLVM\s0 Team (<http://llvm.org/>).