llvm.org GIT mirror llvm / 697ce12
[docs][llvm-nm] Improve some wording In particular, the --debug-syms switch really doesn't have anything to do with debuggers, so I've updated the document accordingly. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@365461 91177308-0d34-0410-b5e6-96231b3b80d8 James Henderson a month ago
1 changed file(s) with 13 addition(s) and 15 deletion(s). Raw diff Collapse all Expand all
1010 DESCRIPTION
1111 -----------
1212
13 The :program:`llvm-nm` utility lists the names of symbols from the LLVM bitcode
14 files, object files, or :program:`ar` archives containing them, named on the
15 command line. Each symbol is listed along with some simple information about
16 its provenance. If no filename is specified, *a.out* is used as the input.
17 If *-* is used as a filename, :program:`llvm-nm` will read a file from its
18 standard input stream.
13 The :program:`llvm-nm` utility lists the names of symbols from LLVM bitcode
14 files, object files, and archives. Each symbol is listed along with some simple
15 information about its provenance. If no filename is specified, *a.out* is used
16 as the input. If *-* is used as a filename, :program:`llvm-nm` will read a file
17 from its standard input stream.
1918
2019 :program:`llvm-nm`'s default output format is the traditional BSD :program:`nm`
21 output format. Each such output record consists of an (optional) 8-digit
20 output format. Each such output record consists of an (optional) 8-digit
2221 hexadecimal address, followed by a type code character, followed by a name, for
23 each symbol. One record is printed per line; fields are separated by spaces.
22 each symbol. One record is printed per line; fields are separated by spaces.
2423 When the address is omitted, it is replaced by 8 spaces.
2524
26 Type code characters currently supported, and their meanings, are as follows.
27 Where both lower and upper-case characters are listed for the same meaning, a
28 lower-case character represents a local symbol, whilst an upper-case character
29 represents a global (external) symbol:
30
25 The supported type code characters are as follows. Where both lower and
26 upper-case characters are listed for the same meaning, a lower-case character
27 represents a local symbol, whilst an upper-case character represents a global
28 (external) symbol:
3129
3230 a, A
3331
129127
130128 .. option:: --debug-syms, -a
131129
132 Show all symbols, even debugger only.
130 Show all symbols, even those usually suppressed.
133131
134132 .. option:: --defined-only, -U
135133
179177
180178 .. option:: --no-sort, -p
181179
182 Shows symbols in order encountered.
180 Shows symbols in the order encountered.
183181
184182 .. option:: --no-weak, -W
185183