diff --git a/llvm/docs/CommandGuide/llvm-nm.rst b/llvm/docs/CommandGuide/llvm-nm.rst --- a/llvm/docs/CommandGuide/llvm-nm.rst +++ b/llvm/docs/CommandGuide/llvm-nm.rst @@ -122,23 +122,21 @@ .. program:: llvm-nm -.. option:: -B (default) +.. option:: -B - Use BSD output format. Alias for `--format=bsd`. - -.. option:: -P - - Use POSIX.2 output format. Alias for `--format=posix`. + Use BSD output format. Alias for ``--format=bsd``. .. option:: --debug-syms, -a Show all symbols, even debugger only. -.. option:: --defined-only +.. option:: --defined-only, -U + + Print only symbols defined in this file. - Print only symbols defined in this file (as opposed to - symbols which may be referenced by objects in this file, but not - defined in this file.) +.. option:: --demangle, -C + + Demangle symbol names. .. option:: --dynamic, -D @@ -146,14 +144,10 @@ .. option:: --extern-only, -g - Print only symbols whose definitions are external; that is, accessible - from other files. - -.. option:: --no-weak, -W - - Don't print any weak symbols in the output. + Print only symbols whose definitions are external; that is, accessible from + other files. -.. option:: --format=format, -f format +.. option:: --format=, -f Select an output format; *format* may be *sysv*, *posix*, *darwin*, or *bsd*. The default is *bsd*. @@ -162,14 +156,46 @@ Print a summary of command-line options and their meanings. +.. option:: --help-list + + Print an uncategorized summary of command-line options and their meanings. + +.. option:: --just-symbol-name, -j + + Print just the symbol names. + +.. option:: -m + + Use Darwin format. Alias for ``--format=darwin``. + +.. option:: --no-demangle + + Don't demangle symbol names. This is the default. + +.. option:: --no-llvm-bc + + Disable the LLVM bitcode reader. + .. option:: --no-sort, -p Shows symbols in order encountered. +.. option:: --no-weak, -W + + Don't print weak symbols. + .. option:: --numeric-sort, -n, -v Sort symbols by address. +.. option:: --portability, -P + + Use POSIX.2 output format. Alias for ``--format=posix``. + +.. option:: --print-armap, -M + + Print the archive symbol table, in addition to the symbols. + .. option:: --print-file-name, -A, -o Precede each symbol with the file it came from. @@ -178,23 +204,67 @@ Show symbol size as well as address (not applicable for Mach-O). +.. option:: --radix=, -t + + Specify the radix of the symbol address(es). Values accepted are *d* (decimal), + *x* (hexadecimal) and *o* (octal). + +.. option:: --reverse-sort, -r + + Sort symbols in reverse order. + .. option:: --size-sort Sort symbols by size. +.. option:: --special-syms + + Ignored. For GNU compatibility only. + .. option:: --undefined-only, -u - Print only symbols referenced but not defined in this file. + Print only undefined symbols. + +.. option:: --version + + Display the version of this program. Does not stack with other commands. -.. option:: --radix=RADIX, -t +.. option:: --without-aliases - Specify the radix of the symbol address(es). Values accepted d(decimal), - x(hexadecimal) and o(octal). + Exclude aliases from the output. .. option:: @ Read command-line options from response file ``. +MACH-O SPECIFIC OPTIONS +----------------------- + +.. option:: --add-dyldinfo + + Add symbols from the dyldinfo, if they are not already in the symbol table. + This is the default. + +.. option:: --arch= + + Dump the symbols from the specified architecture(s). + +.. option:: --dyldinfo-only + + Dump only symbols from the dyldinfo. + +.. option:: --no-dyldinfo + + Do not add any symbols from the dyldinfo. + +.. option:: -s= + + Dump only symbols from this segment and section name. + +.. option:: -x + + Print symbol entry in hex. + BUGS ----