NM(1)
π nm(1) β GNU Development Tools
okay bestie, welcome to nm, aka the manual page for nm from the GNU Development Tools lineup. this is the tool that reads your object files and tells you what symbols are hiding in there. it's giving detective energy and honestly? iconic. let's get into it π΅οΈββοΈβ¨
β¨ NAME β¨
nm β list symbols from object files
like, that's the whole job. it looks inside object files and lists out the symbols. simple queen behavior π
πΈ SYNOPSIS πΈ
nm [-A|-o|--print-file-name]
[-a|--debug-syms]
[-B|--format=bsd]
[-C|--demangle[=style]]
[-D|--dynamic]
[-fformat|--format=format]
[-g|--extern-only]
[-h|--help]
[--ifunc-chars=CHARS]
[-j|--format=just-symbols]
[-l|--line-numbers] [--inlines]
[-n|-v|--numeric-sort]
[-P|--portability]
[-p|--no-sort]
[-r|--reverse-sort]
[-S|--print-size]
[-s|--print-armap]
[-t radix|--radix=radix]
[-u|--undefined-only]
[-U|--defined-only]
[-V|--version]
[-W|--no-weak]
[-X 32_64]
[--no-demangle]
[--no-recurse-limit|--recurse-limit]]
[--plugin name]
[--size-sort]
[--special-syms]
[--synthetic]
[--target=bfdname]
[--unicode=method]
[--with-symbol-versions]
[--without-symbol-versions]
[objfile...]
look at all those flags, she's got range π
(and yes, the ]] at the end of the recurse-limit line is exactly how it's written here β we don't fix, we report π«‘)
π¦ DESCRIPTION π¦
GNU nm lists the symbols from object files objfile... . and here's the little detail that gets people every time: if no object files are listed as arguments, nm assumes the file a.out. no cap, it just goes looking for a.out on its own π
so for each symbol, nm shows you a few things. let's break it down π
β what you get for every symbol
- The symbol value, in the radix selected by options (see below), or hexadecimal by default.
- The symbol type.
- The symbol name. (plus version info if there is any β more on that at the bottom π)
π the symbol types (the alphabet lore)
At least the following types are used β others are used as well, depending on the object file format. and here's the vibe check rule: if lowercase, the symbol is usually local; if uppercase, the symbol is global (external). there are however a few lowercase symbols that are shown for special global symbols (u, v and w). exceptions to every rule, honestly main character energy π
Aβ The symbol's value is absolute, and will not be changed by further linking.B,bβ The symbol is in the BSS data section. This section typically contains zero-initialized or uninitialized data, although the exact behavior is system dependent.C,cβ The symbol is common. Common symbols are uninitialized data. When linking, multiple common symbols may appear with the same name. If the symbol is defined anywhere, the common symbols are treated as undefined references. The lower caseccharacter is used when the symbol is in a special section for small commons.D,dβ The symbol is in the initialized data section.G,gβ The symbol is in an initialized data section for small objects. Some object file formats permit more efficient access to small data objects, such as a globalintvariable as opposed to a large global array.iβ For PE format files this indicates that the symbol is in a section specific to the implementation of DLLs.
For ELF format files this indicates that the symbol is an indirect function. This is a GNU extension to the standard set of ELF symbol types. It indicates a symbol which if referenced by a relocation does not evaluate to its address, but instead must be invoked at runtime. The runtime execution will then return the value to be used in the relocation.
Note β the actual symbols display for GNU indirect symbols is controlled by the --ifunc-chars command line option. If this option has been provided then the first character in the string will be used for global indirect function symbols. If the string contains a second character then that will be used for local indirect function symbols.
Iβ The symbol is an indirect reference to another symbol.Nβ The symbol is a debugging symbol.nβ The symbol is in a non-data, non-code, non-debug read-only section.pβ The symbol is in a stack unwind section.R,rβ The symbol is in a read only data section.S,sβ The symbol is in an uninitialized or zero-initialized data section for small objects.T,tβ The symbol is in the text (code) section.Uβ The symbol is undefined.uβ The symbol is a unique global symbol. This is a GNU extension to the standard set of ELF symbol bindings. For such a symbol the dynamic linker will make sure that in the entire process there is just one symbol with this name and type in use. one of one, literally π₯V,vβ The symbol is a weak object. When a weak defined symbol is linked with a normal defined symbol, the normal defined symbol is used with no error. When a weak undefined symbol is linked and the symbol is not defined, the value of the weak symbol becomes zero with no error. On some systems, uppercase indicates that a default value has been specified.W,wβ The symbol is a weak symbol that has not been specifically tagged as a weak object symbol. When a weak defined symbol is linked with a normal defined symbol, the normal defined symbol is used with no error. When a weak undefined symbol is linked and the symbol is not defined, the value of the symbol is determined in a system-specific manner without error. On some systems, uppercase indicates that a default value has been specified.-β The symbol is a stabs symbol in ana.outobject file. In this case, the next values printed are the stabsotherfield, the stabsdescfield, and the stab type. Stabs symbols are used to hold debugging information.?β The symbol type is unknown, or object file format specific.
π§ the symbol name + version tea
The symbol name. If a symbol has version information associated with it, then the version information is displayed as well. π«
- If the versioned symbol is undefined or hidden from linker, the version string is displayed as a suffix to the symbol name, preceded by an
@character. For examplefoo@VER_1. - If the version is the default version to be used when resolving unversioned references to the symbol, then it is displayed as a suffix preceded by two
@characters. For examplefoo@@VER_2.
double @ means default, single @ means the other thing. iykyk π
more coming, bestie β don't go anywhere ππ«Ά
β¨ OPTIONS β¨
okay bestie, real talk before we get into the flag buffet: the long and short forms of these options are equivalent β same energy, same result, pick whichever one feels cuter in your shell π
-A,-o,--print-file-nameβ puts the name of the input file (or archive member) in front of every symbol where it was found, instead of naming the input file just once before all its symbols. slay.-a,--debug-symsβ shows all the symbols, even the debugger-only ones. normally those donβt get listed at all, so this is the βno secretsβ mode π«Ά-Bβ literally the same as--format=bsd, kept for compatibility with the MIPS version ofnm.-C,--demangle[=style]β decodes (demangles) those low-level symbol names into user-level names. it strips any initial underscore that the system prepended, and makes C++ function names actually readable. different compilers have different mangling styles, so the optional style argument lets you pick the right demangling style for your compiler β¨--no-demangleβ does not demangle low-level symbol names. this is the default, bestie.--recurse-limit,--no-recurse-limit,--recursion-limit,--no-recursion-limitβ turns a limit on or off for how much recursion happens while demangling strings. bc name mangling formats allow an infinite level of recursion, itβs possible to create strings whose decoding will exhaust the stack space available on the host machine and trigger a memory fault π the limit tries to stop that by restricting recursion to 2048 levels of nesting. the default is for this limit to be enabled, but you might need to disable it to demangle truly complicated names. note: if you disable the recursion limit, stack exhaustion is possible, and bug reports about that kind of event will be rejected. like, read the room π-D,--dynamicβ shows the dynamic symbols instead of the normal symbols. this only actually means something for dynamic objects, like certain types of shared libraries.-f format,--format=formatβ use the output format format, which can be"bsd","sysv","posix"or"just-symbols". the default is"bsd". only the first character of format is significant, and it can be upper or lower case. iconic.-g,--extern-onlyβ displays only external symbols. keeping it exclusive π-h,--helpβ shows a summary of the options tonmand exits. the βhelp me help youβ button.--ifunc-chars=CHARSβ when displaying GNU indirect function symbols,nmdefaults to using the"i"character for both local indirect functions and global indirect functions. this option lets you specify a string with one or two characters: the first character is used for global indirect function symbols, and the second character (if present) is used for local indirect function symbols. custom lettering, no cap π-jβ same as--format=just-symbols. simple, clean, just symbols.-l,--line-numbersβ for each symbol, tries to find a filename and line number using debugging information. for a defined symbol, it looks for the line number of the address of the symbol. for an undefined symbol, it looks for the line number of a relocation entry that refers to the symbol. if it finds line number info, it prints it after the other symbol info. detective mode π--inlinesβ when-lis active, if the address belongs to a function that was inlined, this option also prints the source information for all enclosing scopes back to the first non-inlined function. example: if"main"inlines"callee1"which inlines"callee2", and the address is from"callee2", the source info for"callee1"and"main"also gets printed. the whole family tree, exposed πΈ-n,-v,--numeric-sortβ sorts symbols numerically by their addresses, instead of alphabetically by their names. numbers first, letters later.-p,--no-sortβ does not bother sorting the symbols in any order; prints them in the order encountered. chaos mode, but make it intentional π-P,--portabilityβ uses the POSIX.2 standard output format instead of the default format. equivalent to-f posix.-r,--reverse-sortβ reverses the order of the sort (whether numeric or alphabetic); the last comes first. plot twist π₯-S,--print-sizeβ prints both the value and the size of defined symbols for the"bsd"output style. this option has no effect for object formats that donβt record symbol sizes, unless--size-sortis also used β in that case a calculated size is displayed. math-ish, but make it cute.-s,--print-armapβ when listing symbols from archive members, includes the index: a mapping (stored in the archive byarorranlib) of which modules contain definitions for which names. the archiveβs little address book π-t radix,--radix=radixβ uses radix as the radix for printing symbol values. it must bedfor decimal,ofor octal, orxfor hexadecimal. pick your numeral vibe.-u,--undefined-onlyβ displays only undefined symbols (those external to each object file). by default, both defined and undefined symbols are displayed.-U,--defined-onlyβ displays only defined symbols for each object file. by default, both defined and undefined symbols are displayed. the mirror twin of-uπͺ-V,--versionβ shows the version number ofnmand exits. proof of identity.-Xβ this option is ignored for compatibility with the AIX version ofnm. it takes one parameter, which must be the string32_64. the default mode of AIXnmcorresponds to-X 32, which is not supported by GNUnm. noted, bestie.--plugin nameβ loads the plugin called name to add support for extra target types. this option is only available if the toolchain has been built with plugin support enabled. if--pluginis not provided, but plugin support has been enabled, thennmiterates over the files in${libdir}/bfd-pluginsin alphabetic order and the first plugin that claims the object in question is used. please note that this plugin search directory is not the one used byldβs-pluginoption. in order to makenmuse the linker plugin, it must be copied into the${libdir}/bfd-pluginsdirectory. for GCC-based compilations the linker plugin is calledliblto_plugin.so.0.0.0; for Clang-based compilations it is calledLLVMgold.so. the GCC plugin is always backwards compatible with earlier versions, so it is sufficient to just copy the newest one. plugin lore, unlocked π--size-sortβ sorts symbols by size. for ELF objects, symbol sizes are read from the ELF; for other object types, symbol sizes are computed as the difference between the value of the symbol and the value of the symbol with the next higher value. if the"bsd"output format is used, the size of the symbol is printed rather than the value, and-Smust be used in order for both size and value to be printed. note: this option does not work if--undefined-onlyhas been enabled, because undefined symbols have no size. canβt measure what isnβt there, bestie π--special-symsβ displays symbols that have a target-specific special meaning. these symbols are usually used by the target for some special processing and are not normally helpful when included in normal symbol lists. for example, for ARM targets this option would skip the mapping symbols used to mark transitions between ARM code, THUMB code and data. special little guys, handled.--syntheticβ includes synthetic symbols in the output. these are special symbols created by the linker for various purposes. theyβre not shown by default since theyβre not part of the binaryβs original source code. manufactured, but make it visible β¨--unicode=[default|invalid|locale|escape|hex|highlight]β controls the display of UTF-8 encoded multibyte characters in strings. the default (--unicode=default) gives them no special treatment.--unicode=localedisplays the sequence in the current locale, which may or may not support them.--unicode=hexand--unicode=invaliddisplay them as hex byte sequences enclosed by either angle brackets or curly braces.--unicode=escapedisplays them as escape sequences (\uxxxx), and--unicode=highlightdisplays them as escape sequences highlighted in red (if supported by the output device). the colouring is intended to draw attention to the presence of unicode sequences where they might not be expected. rainbow anxiety, but useful π-W,--no-weakβ does not display weak symbols. weak symbols, respectfully, not invited.--with-symbol-versions,--without-symbol-versionsβ enables or disables the display of symbol version information. the version string is displayed as a suffix to the symbol name, preceded by an@character β for examplefoo@VER_1. if the version is the default version to be used when resolving unversioned references to the symbol, then itβs displayed as a suffix preceded by two@characters β for examplefoo@@VER_2. by default, symbol version information is displayed. the@situation is real π--target=bfdnameβ specifies an object code format other than your systemβs default format. switching lanes.@fileβ reads command-line options from file. the options read are inserted in place of the original@fileoption. if file does not exist, or cannot be read, then the option is treated literally and not removed. options in file are separated by whitespace. a whitespace character may be included in an option by surrounding the entire option in either single or double quotes. any character (including a backslash) may be included by prefixing the character to be included with a backslash. the file may itself contain additional@fileoptions; any such options will be processed recursively. file-ception, fr fr π
πΈ SEE ALSO πΈ
ar(1), objdump(1), ranlib(1), and the Info entries for binutils. go read the extended universe, iykyk π«Ά
π COPYRIGHT π
Copyright (c) 1991-2026 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
π this iconic little page is from binutils-2.47, dated 2026-09-30 β and yes, NM(1) ate, no crumbs π
π¦ where this page comes from
- arch rolling: riscv64-elf-binutils 2.47-1 Β· GPL
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms