From bb24b9c26d2930e26f8acdf84262d573d254b7d2 Mon Sep 17 00:00:00 2001 From: Brian Gaeke Date: Thu, 16 Oct 2003 18:03:24 +0000 Subject: [PATCH] Add command guide (It's like a man page translated into html, but without the translation...) for the new llvm-nm tool. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@9162 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CommandGuide/llvm-nm.html | 116 +++++++++++++++++++++++++++++++++ 1 file changed, 116 insertions(+) create mode 100644 docs/CommandGuide/llvm-nm.html diff --git a/docs/CommandGuide/llvm-nm.html b/docs/CommandGuide/llvm-nm.html new file mode 100644 index 00000000000..0f150275c58 --- /dev/null +++ b/docs/CommandGuide/llvm-nm.html @@ -0,0 +1,116 @@ + + +LLVM: llvm-nm tool + + + + +

LLVM: llvm-nm tool

+
+ +

NAME

+llvm-nm + +

SYNOPSIS

+llvm-nm [options] [filenames...] + +

DESCRIPTION

+ +

The llvm-nm utility lists the names of symbols from the +LLVM bytecode files named on the command line, along with some +ancillary information about each symbol.

+ +

llvm-nm's default output format is the traditional BSD +nm(1) 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:

+ + + + + + + + + + +
UNamed object is referenced but undefined in this + bytecode file
CCommon (multiple defs link together into one + def)
WWeak reference (multiple defs link together into zero or + one defs)
tLocal function (text) object
TGlobal function (text) object
dLocal data object
DGlobal data object
?Something unrecognizable
+ +

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

+ +

OPTIONS

+ + + +

BUGS

+ +llvm-nm cannot currently see inside ar(1) library +archive files, like nm(1) can. It cannot demangle C++ mangled +names, like GNU nm(1) can. + +

EXIT STATUS

+ +llvm-nm exits with an exit code of zero. + +

SEE ALSO

+ +llvm-dis, +ar(1), +nm(1) + +
+Maintained by the LLVM Team. + + +