(yywrap): Define as function if not defined as a macro.

[binutils.git] / binutils / nm.1

diff --git a/binutils/nm.1 b/binutils/nm.1
index 26ed5a0f90044ac929a246c64730ac3e4185cd1b..aedabb4e27743a2b6bb60f1357ae9f782cf4234b 100644 (file)
--- a/binutils/nm.1
+++ b/binutils/nm.1
@@ -8,7 +8,7 @@
 ..
 
 .SH NAME
-nm\(em\&list symbols from object files.
+nm \- list symbols from object files.
 
 .SH SYNOPSIS
 .hy 0
@@ -17,15 +17,21 @@ nm\(em\&list symbols from object files.
 .B nm
 .RB "[\|" \-a | \-\-debug\-syms "\|]" 
 .RB "[\|" \-g | \-\-extern\-only "\|]"
+.RB "[\|" \-B "\|]"  
+.RB "[\|" \-C | \-\-demangle "\|]" 
+.RB "[\|" \-D | \-\-dynamic "\|]" 
 .RB "[\|" \-s | \-\-print\-armap "\|]" 
 .RB "[\|" \-o | \-\-print\-file\-name "\|]"  
 .RB "[\|" \-n | \-\-numeric\-sort "\|]" 
 .RB "[\|" \-p | \-\-no\-sort "\|]"
 .RB "[\|" \-r | \-\-reverse\-sort "\|]" 
 .RB "[\|" \-u | \-\-undefined\-only "\|]"  
-.RB "[\|" "\-\-target="\c
-.I bfdname\c
-\&\|]
+.RB "[\|" \-\-help "\|]"  
+.RB "[\|" \-\-version "\|]"  
+.RB "[\|" "\-t \fIradix" | \-\-radix=\fIradix "\|]"
+.RB "[\|" \-P | --portability "\|]"
+.RB "[\|" "\-f \fIformat" | \-\-format=\fIformat "\|]"
+.RB "[\|" "\-\-target=\fIbfdname" "\|]"
 .RB "[\|" \c
 .I objfile\c
 \&.\|.\|.\|]
@@ -34,22 +40,27 @@ nm\(em\&list symbols from object files.
 .SH DESCRIPTION
 GNU \c
 .B nm\c
-\& will list the symbols from object files \c
+\& lists the symbols from object files \c
 .I objfile\c
-\&.
+\&.  If no object files are given as arguments, \c
+.B nm\c
+\& assumes `\|\c
+.B a.out\c
+\|'.
 
 .SH OPTIONS
 The long and short forms of options, shown here as alternatives, are
 equivalent.
 
 .TP
-.IR "objfile" .\|.\|.
-Object files whose symbols are to be listed.  If no object files are
-listed as arguments, \c
-.B nm\c
-\& assumes `\|\c
-.B a.out\c
-\|'.
+.B \-A
+.TP
+.B \-o
+.TP
+.B \-\-print\-file\-name 
+Precede each symbol by the name of the input file where it was found,
+rather than identifying the input file once only before all of its
+symbols. 
 
 .TP
 .B \-a
@@ -57,12 +68,50 @@ listed as arguments, \c
 .B \-\-debug\-syms 
 Display debugger-only symbols; normally these are not listed.
 
+.TP
+.B \-B
+The same as
+.B \-\-format=bsd
+(for compatibility with the MIPS \fBnm\fP).
+
+.TP
+.B \-C
+.TP
+.B \-\-demangle
+Decode (\fIdemangle\fP) low-level symbol names into user-level names.
+Besides removing any initial underscore prepended by the system, this
+makes C++ function names readable.
+
+.TP
+.B \-D
+.TP
+.B \-\-dynamic
+Display the dynamic symbols rather than the normal symbols.  This is
+only meaningful for dynamic objects, such as certain types of shared
+libraries.
+
+.TP
+.B "\-f \fIformat"
+Use the output format \fIformat\fP, which can be ``bsd'',
+``sysv'', or ``posix''.  The default is `bsd''.
+Only the first character of \fIformat\fP is significant; it can be
+either upper or lower case.
+
 .TP
 .B \-g
 .TP
 .B \-\-extern\-only 
 Display only external symbols.
 
+.TP
+.B \-n
+.TP
+.B \-v
+.TP
+.B \-\-numeric\-sort 
+Sort symbols numerically by their addresses, not alphabetically by their
+names. 
+
 .TP
 .B \-p
 .TP
@@ -71,11 +120,11 @@ Don't bother to sort the symbols in any order; just print them in the
 order encountered.
 
 .TP
-.B \-n
+.B \-P
 .TP
-.B \-\-numeric\-sort 
-Sort symbols numerically by their addresses, not alphabetically by their
-names. 
+.B \-\-portability
+Use the POSIX.2 standard output format instead of the default format.
+Equivalent to ``\-f posix''.
 
 .TP
 .B \-s
@@ -89,14 +138,6 @@ When listing symbols from archive members, include the index: a mapping
 \&) of what modules
 contain definitions for what names.
 
-.TP
-.B \-o
-.TP
-.B \-\-print\-file\-name 
-Precede each symbol by the name of the input file where it was found,
-rather than identifying the input file once only before all of its
-symbols. 
-
 .TP
 .B \-r
 .TP
@@ -105,7 +146,14 @@ Reverse the sense of the sort (whether numeric or alphabetic); let the
 last come first.
 
 .TP
-.BI "\-\-target " "bfdname"\c
+.B "\-t \fIradix"
+.TP
+.B "\-\-radix=\fIradix"
+Use \fIradix\fP as the radix for printing the symbol values.  It must be
+``d'' for decimal, ``o'' for octal, or ``x'' for hexadecimal.
+
+.TP
+.BI "\-\-target=" "bfdname"\c
 \&
 Specify an object code format other than your system's default format.
 See 
@@ -118,7 +166,19 @@ for information on listing available formats.
 .B \-\-undefined\-only 
 Display only undefined symbols (those external to each object file).
 
-.PP
+.TP
+.B \-V
+.TP
+.B \-\-version
+Show the version number of
+.B nm
+and exit.
+
+.TP
+.B \-\-help
+Show a summary of the options to
+.B nm
+and exit.
 
 .SH "SEE ALSO"
 .RB "`\|" binutils "\|'"