xref: /freebsd/usr.bin/clang/llvm-nm/llvm-nm.1 (revision 7750ad47a9a7dbc83f87158464170c8640723293)
$FreeBSD$
Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is turned on, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
. de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} . de IX .. .\}
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "LLVM-NM 1"
LLVM-NM 1 "2012-04-05" "LLVM 3.1" "LLVM Command Guide"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
llvm-nm - list LLVM bitcode file's symbol table
"SYNOPSIS"
Header "SYNOPSIS" \fBllvm-nm [options] [filenames...]
"DESCRIPTION"
Header "DESCRIPTION" The llvm-nm utility lists the names of symbols from the \s-1LLVM\s0 bitcode files, or ar archives containing \s-1LLVM\s0 bitcode files, named on the command line. Each symbol is listed along with some simple information about its provenance. If no file name is specified, or - is used as a file name, llvm-nm will process a bitcode file on its standard input stream.

\fBllvm-nm's default output format is the traditional \s-1BSD\s0 nm output format. Each such output record consists of an (optional) 8-digit hexadecimal address, followed by a type code character, followed by a name, for each symbol. One record is printed per line; fields are separated by spaces. When the address is omitted, it is replaced by 8 spaces.

Type code characters currently supported, and their meanings, are as follows:

"U" 4
Item "U" Named object is referenced but undefined in this bitcode file
"C" 4
Item "C" Common (multiple definitions link together into one def)
"W" 4
Item "W" Weak reference (multiple definitions link together into zero or one definitions)
"t" 4
Item "t" Local function (text) object
"T" 4
Item "T" Global function (text) object
"d" 4
Item "d" Local data object
"D" 4
Item "D" Global data object
"?" 4
Something unrecognizable

Because \s-1LLVM\s0 bitcode files typically contain objects that are not considered to have addresses until they are linked into an executable image or dynamically compiled \*(L"just-in-time\*(R", llvm-nm does not print an address for any symbol, even symbols which are defined in the bitcode file.

"OPTIONS"
Header "OPTIONS"
"-P" 4
Item "-P" Use \s-1POSIX\s0.2 output format. Alias for --format=posix.
"-B (default)" 4
Item "-B (default)" Use \s-1BSD\s0 output format. Alias for --format=bsd.
"-help" 4
Item "-help" Print a summary of command-line options and their meanings.
"--defined-only" 4
Item "--defined-only" Print only symbols defined in this bitcode file (as opposed to symbols which may be referenced by objects in this file, but not defined in this file.)
"--extern-only, -g" 4
Item "--extern-only, -g" Print only symbols whose definitions are external; that is, accessible from other bitcode files.
"--undefined-only, -u" 4
Item "--undefined-only, -u" Print only symbols referenced but not defined in this bitcode file.
"--format=fmt, -f" 4
Item "--format=fmt, -f" Select an output format; fmt may be sysv, posix, or bsd. The default is bsd.
"BUGS"
Header "BUGS" \fBllvm-nm cannot demangle \*(C+ mangled names, like \s-1GNU\s0 nm can.
"EXIT STATUS"
Header "EXIT STATUS" \fBllvm-nm exits with an exit code of zero.
"SEE ALSO"
Header "SEE ALSO" llvm-dis, ar\|(1), nm\|(1)
"AUTHOR"
Header "AUTHOR" Maintained by the \s-1LLVM\s0 Team (<http://llvm.org/>).