* cplus_dem.c: Add gnat demangler. Add java to demangle style
[binutils-gdb.git] / binutils / nm.1
1 .\" Copyright (c) 1991, 2000 Free Software Foundation
2 .\" See section COPYING for conditions for redistribution
3 .TH nm 1 "5 November 1991" "Free Software Foundation" "GNU Development Tools"
4 .de BP
5 .sp
6 .ti \-.2i
7 \(**
8 ..
9
10 .SH NAME
11 nm \- list symbols from object files.
12
13 .SH SYNOPSIS
14 .hy 0
15 .na
16 .TP
17 .B nm
18 .RB "[\|" \-a | \-\-debug\-syms "\|]"
19 .RB "[\|" \-g | \-\-extern\-only "\|]"
20 .RB "[\|" \-B "\|]"
21 .RB "[\|" \-C | \-\-demangle "\|]"
22 .RB "[\|" \-D | \-\-dynamic "\|]"
23 .RB "[\|" \-s | \-\-print\-armap "\|]"
24 .RB "[\|" \-o | \-\-print\-file\-name "\|]"
25 .RB "[\|" \-n | \-\-numeric\-sort "\|]"
26 .RB "[\|" \-p | \-\-no\-sort "\|]"
27 .RB "[\|" \-r | \-\-reverse\-sort "\|]"
28 .RB "[\|" \-\-size\-sort "\|]"
29 .RB "[\|" \-u | \-\-undefined\-only "\|]"
30 .RB "[\|" \-l | \-\-line\-numbers "\|]"
31 .RB "[\|" \-\-help "\|]"
32 .RB "[\|" \-\-version "\|]"
33 .RB "[\|" "\-t \fIradix" | \-\-radix=\fIradix "\|]"
34 .RB "[\|" \-P | --portability "\|]"
35 .RB "[\|" "\-f \fIformat" | \-\-format=\fIformat "\|]"
36 .RB "[\|" "\-\-target=\fIbfdname" "\|]"
37 .RB "[\|" \c
38 .I objfile\c
39 \&.\|.\|.\|]
40 .ad b
41 .hy 1
42 .SH DESCRIPTION
43 GNU \c
44 .B nm\c
45 \& lists the symbols from object files \c
46 .I objfile\c
47 \&. If no object files are given as arguments, \c
48 .B nm\c
49 \& assumes `\|\c
50 .B a.out\c
51 \|'.
52
53 .SH OPTIONS
54 The long and short forms of options, shown here as alternatives, are
55 equivalent.
56
57 .TP
58 .B \-A
59 .TP
60 .B \-o
61 .TP
62 .B \-\-print\-file\-name
63 Precede each symbol by the name of the input file where it was found,
64 rather than identifying the input file once only before all of its
65 symbols.
66
67 .TP
68 .B \-a
69 .TP
70 .B \-\-debug\-syms
71 Display debugger-only symbols; normally these are not listed.
72
73 .TP
74 .B \-B
75 The same as
76 .B \-\-format=bsd
77 (for compatibility with the MIPS \fBnm\fP).
78
79 .TP
80 .B \-C
81 .TP
82 .B \-\-demangle
83 Decode (\fIdemangle\fP) low-level symbol names into user-level names.
84 Besides removing any initial underscore prepended by the system, this
85 makes C++ function names readable.
86
87 .TP
88 .B \-D
89 .TP
90 .B \-\-dynamic
91 Display the dynamic symbols rather than the normal symbols. This is
92 only meaningful for dynamic objects, such as certain types of shared
93 libraries.
94
95 .TP
96 .B "\-f \fIformat"
97 Use the output format \fIformat\fP, which can be ``bsd'',
98 ``sysv'', or ``posix''. The default is ``bsd''.
99 Only the first character of \fIformat\fP is significant; it can be
100 either upper or lower case.
101
102 .TP
103 .B \-g
104 .TP
105 .B \-\-extern\-only
106 Display only external symbols.
107
108 .TP
109 .B \-n
110 .TP
111 .B \-v
112 .TP
113 .B \-\-numeric\-sort
114 Sort symbols numerically by their addresses, not alphabetically by their
115 names.
116
117 .TP
118 .B \-p
119 .TP
120 .B \-\-no\-sort
121 Don't bother to sort the symbols in any order; just print them in the
122 order encountered.
123
124 .TP
125 .B \-P
126 .TP
127 .B \-\-portability
128 Use the POSIX.2 standard output format instead of the default format.
129 Equivalent to ``\-f posix''.
130
131 .TP
132 .B \-s
133 .TP
134 .B \-\-print\-armap
135 When listing symbols from archive members, include the index: a mapping
136 (stored in the archive by \c
137 .B ar\c
138 \& or \c
139 .B ranlib\c
140 \&) of what modules
141 contain definitions for what names.
142
143 .TP
144 .B \-r
145 .TP
146 .B \-\-reverse\-sort
147 Reverse the sense of the sort (whether numeric or alphabetic); let the
148 last come first.
149
150 .TP
151 .B \-\-size\-sort
152 Sort symbols by size. The size is computed as the difference between
153 the value of the symbol and the value of the symbol with the next higher
154 value. The size of the symbol is printed, rather than the value.
155
156 .TP
157 .B "\-t \fIradix"
158 .TP
159 .B "\-\-radix=\fIradix"
160 Use \fIradix\fP as the radix for printing the symbol values. It must be
161 ``d'' for decimal, ``o'' for octal, or ``x'' for hexadecimal.
162
163 .TP
164 .BI "\-\-target=" "bfdname"
165 Specify an object code format other than your system's default format.
166 See
167 .BR objdump ( 1 ),
168 for information on listing available formats.
169
170 .TP
171 .B \-u
172 .TP
173 .B \-\-undefined\-only
174 Display only undefined symbols (those external to each object file).
175
176 .TP
177 .B \-l
178 .TP
179 .B \-\-line\-numbers
180 For each symbol, use debugging information to try to find a filename and
181 line number. For a defined symbol, look for the line number of the
182 address of the symbol. For an undefined symbol, look for the line
183 number of a relocation entry which refers to the symbol. If line number
184 information can be found, print it after the other symbol information.
185
186 .TP
187 .B \-V
188 .TP
189 .B \-\-version
190 Show the version number of
191 .B nm
192 and exit.
193
194 .TP
195 .B \-\-help
196 Show a summary of the options to
197 .B nm
198 and exit.
199
200 .SH "SEE ALSO"
201 .RB "`\|" binutils "\|'"
202 entry in
203 .B
204 info\c
205 \&;
206 .I
207 The GNU Binary Utilities\c
208 \&, Roland H. Pesch (October 1991);
209 .BR ar "(" 1 "),"
210 .BR objdump ( 1 ),
211 .BR ranlib "(" 1 ")."
212
213
214 .SH COPYING
215 Copyright (c) 1991, 2000 Free Software Foundation, Inc.
216 .PP
217 This document is distributed under the terms of the GNU Free
218 Documenation License. That license is described in the GNU Free
219 Documentation License section.
220
221 .SH GNU Free Documentation License
222 Version 1.1, March 2000
223
224 Copyright (C) 2000 Free Software Foundation, Inc.
225 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
226
227 Everyone is permitted to copy and distribute verbatim
228 copies of this license document, but changing it is
229 not allowed.
230 .PP
231 0. PREAMBLE
232 .PP
233 The purpose of this License is to make a manual, textbook, or other
234 written document "free" in the sense of freedom: to assure everyone
235 the effective freedom to copy and redistribute it, with or without
236 modifying it, either commercially or noncommercially. Secondarily,
237 this License preserves for the author and publisher a way to get
238 credit for their work, while not being considered responsible for
239 modifications made by others.
240 .PP
241 This License is a kind of "copyleft", which means that derivative
242 works of the document must themselves be free in the same sense. It
243 complements the GNU General Public License, which is a copyleft
244 license designed for free software.
245 .PP
246 We have designed this License in order to use it for manuals for free
247 software, because free software needs free documentation: a free
248 program should come with manuals providing the same freedoms that the
249 software does. But this License is not limited to software manuals;
250 it can be used for any textual work, regardless of subject matter or
251 whether it is published as a printed book. We recommend this License
252 principally for works whose purpose is instruction or reference.
253 .PP
254 1. APPLICABILITY AND DEFINITIONS
255 .PP
256 This License applies to any manual or other work that contains a
257 notice placed by the copyright holder saying it can be distributed
258 under the terms of this License. The "Document", below, refers to any
259 such manual or work. Any member of the public is a licensee, and is
260 addressed as "you".
261 .PP
262 A "Modified Version" of the Document means any work containing the
263 Document or a portion of it, either copied verbatim, or with
264 modifications and/or translated into another language.
265 .PP
266 A "Secondary Section" is a named appendix or a front-matter section of
267 the Document that deals exclusively with the relationship of the
268 publishers or authors of the Document to the Document's overall subject
269 (or to related matters) and contains nothing that could fall directly
270 within that overall subject. (For example, if the Document is in part a
271 textbook of mathematics, a Secondary Section may not explain any
272 mathematics.) The relationship could be a matter of historical
273 connection with the subject or with related matters, or of legal,
274 commercial, philosophical, ethical or political position regarding
275 them.
276 .PP
277 The "Invariant Sections" are certain Secondary Sections whose titles
278 are designated, as being those of Invariant Sections, in the notice
279 that says that the Document is released under this License.
280 .PP
281 The "Cover Texts" are certain short passages of text that are listed,
282 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
283 the Document is released under this License.
284 .PP
285 A "Transparent" copy of the Document means a machine-readable copy,
286 represented in a format whose specification is available to the
287 general public, whose contents can be viewed and edited directly and
288 straightforwardly with generic text editors or (for images composed of
289 pixels) generic paint programs or (for drawings) some widely available
290 drawing editor, and that is suitable for input to text formatters or
291 for automatic translation to a variety of formats suitable for input
292 to text formatters. A copy made in an otherwise Transparent file
293 format whose markup has been designed to thwart or discourage
294 subsequent modification by readers is not Transparent. A copy that is
295 not "Transparent" is called "Opaque".
296 .PP
297 Examples of suitable formats for Transparent copies include plain
298 ASCII without markup, Texinfo input format, LaTeX input format, SGML
299 or XML using a publicly available DTD, and standard-conforming simple
300 HTML designed for human modification. Opaque formats include
301 PostScript, PDF, proprietary formats that can be read and edited only
302 by proprietary word processors, SGML or XML for which the DTD and/or
303 processing tools are not generally available, and the
304 machine-generated HTML produced by some word processors for output
305 purposes only.
306 .PP
307 The "Title Page" means, for a printed book, the title page itself,
308 plus such following pages as are needed to hold, legibly, the material
309 this License requires to appear in the title page. For works in
310 formats which do not have any title page as such, "Title Page" means
311 the text near the most prominent appearance of the work's title,
312 preceding the beginning of the body of the text.
313 .PP
314 2. VERBATIM COPYING
315 .PP
316 You may copy and distribute the Document in any medium, either
317 commercially or noncommercially, provided that this License, the
318 copyright notices, and the license notice saying this License applies
319 to the Document are reproduced in all copies, and that you add no other
320 conditions whatsoever to those of this License. You may not use
321 technical measures to obstruct or control the reading or further
322 copying of the copies you make or distribute. However, you may accept
323 compensation in exchange for copies. If you distribute a large enough
324 number of copies you must also follow the conditions in section 3.
325 .PP
326 You may also lend copies, under the same conditions stated above, and
327 you may publicly display copies.
328 .PP
329 3. COPYING IN QUANTITY
330 .PP
331 If you publish printed copies of the Document numbering more than 100,
332 and the Document's license notice requires Cover Texts, you must enclose
333 the copies in covers that carry, clearly and legibly, all these Cover
334 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
335 the back cover. Both covers must also clearly and legibly identify
336 you as the publisher of these copies. The front cover must present
337 the full title with all words of the title equally prominent and
338 visible. You may add other material on the covers in addition.
339 Copying with changes limited to the covers, as long as they preserve
340 the title of the Document and satisfy these conditions, can be treated
341 as verbatim copying in other respects.
342 .PP
343 If the required texts for either cover are too voluminous to fit
344 legibly, you should put the first ones listed (as many as fit
345 reasonably) on the actual cover, and continue the rest onto adjacent
346 pages.
347 .PP
348 If you publish or distribute Opaque copies of the Document numbering
349 more than 100, you must either include a machine-readable Transparent
350 copy along with each Opaque copy, or state in or with each Opaque copy
351 a publicly-accessible computer-network location containing a complete
352 Transparent copy of the Document, free of added material, which the
353 general network-using public has access to download anonymously at no
354 charge using public-standard network protocols. If you use the latter
355 option, you must take reasonably prudent steps, when you begin
356 distribution of Opaque copies in quantity, to ensure that this
357 Transparent copy will remain thus accessible at the stated location
358 until at least one year after the last time you distribute an Opaque
359 copy (directly or through your agents or retailers) of that edition to
360 the public.
361 .PP
362 It is requested, but not required, that you contact the authors of the
363 Document well before redistributing any large number of copies, to give
364 them a chance to provide you with an updated version of the Document.
365 .PP
366 4. MODIFICATIONS
367 .PP
368 You may copy and distribute a Modified Version of the Document under
369 the conditions of sections 2 and 3 above, provided that you release
370 the Modified Version under precisely this License, with the Modified
371 Version filling the role of the Document, thus licensing distribution
372 and modification of the Modified Version to whoever possesses a copy
373 of it. In addition, you must do these things in the Modified Version:
374 .PP
375 A. Use in the Title Page (and on the covers, if any) a title distinct
376 from that of the Document, and from those of previous versions
377 (which should, if there were any, be listed in the History section
378 of the Document). You may use the same title as a previous version
379 if the original publisher of that version gives permission.
380 .PP
381 B. List on the Title Page, as authors, one or more persons or entities
382 responsible for authorship of the modifications in the Modified
383 Version, together with at least five of the principal authors of the
384 Document (all of its principal authors, if it has less than five).
385 .PP
386 C. State on the Title page the name of the publisher of the
387 Modified Version, as the publisher.
388 .PP
389 D. Preserve all the copyright notices of the Document.
390 .PP
391 E. Add an appropriate copyright notice for your modifications
392 adjacent to the other copyright notices.
393 .PP
394 F. Include, immediately after the copyright notices, a license notice
395 giving the public permission to use the Modified Version under the
396 terms of this License, in the form shown in the Addendum below.
397 Preserve in that license notice the full lists of Invariant Sections
398 and required Cover Texts given in the Document's license notice.
399 .PP
400 H. Include an unaltered copy of this License.
401 .PP
402 I. Preserve the section entitled "History", and its title, and add to
403 it an item stating at least the title, year, new authors, and
404 publisher of the Modified Version as given on the Title Page. If
405 there is no section entitled "History" in the Document, create one
406 stating the title, year, authors, and publisher of the Document as
407 given on its Title Page, then add an item describing the Modified
408 Version as stated in the previous sentence.
409 .PP
410 J. Preserve the network location, if any, given in the Document for
411 public access to a Transparent copy of the Document, and likewise
412 the network locations given in the Document for previous versions
413 it was based on. These may be placed in the "History" section.
414 You may omit a network location for a work that was published at
415 least four years before the Document itself, or if the original
416 publisher of the version it refers to gives permission.
417 .PP
418 K. In any section entitled "Acknowledgements" or "Dedications",
419 preserve the section's title, and preserve in the section all the
420 substance and tone of each of the contributor acknowledgements
421 and/or dedications given therein.
422 .PP
423 L. Preserve all the Invariant Sections of the Document,
424 unaltered in their text and in their titles. Section numbers
425 or the equivalent are not considered part of the section titles.
426 .PP
427 M. Delete any section entitled "Endorsements". Such a section
428 may not be included in the Modified Version.
429 .PP
430 N. Do not retitle any existing section as "Endorsements"
431 or to conflict in title with any Invariant Section.
432 .PP
433 If the Modified Version includes new front-matter sections or
434 appendices that qualify as Secondary Sections and contain no material
435 copied from the Document, you may at your option designate some or all
436 of these sections as invariant. To do this, add their titles to the
437 list of Invariant Sections in the Modified Version's license notice.
438 These titles must be distinct from any other section titles.
439 .PP
440 You may add a section entitled "Endorsements", provided it contains
441 nothing but endorsements of your Modified Version by various
442 parties--for example, statements of peer review or that the text has
443 been approved by an organization as the authoritative definition of a
444 standard.
445 .PP
446 You may add a passage of up to five words as a Front-Cover Text, and a
447 passage of up to 25 words as a Back-Cover Text, to the end of the list
448 of Cover Texts in the Modified Version. Only one passage of
449 Front-Cover Text and one of Back-Cover Text may be added by (or
450 through arrangements made by) any one entity. If the Document already
451 includes a cover text for the same cover, previously added by you or
452 by arrangement made by the same entity you are acting on behalf of,
453 you may not add another; but you may replace the old one, on explicit
454 permission from the previous publisher that added the old one.
455 .PP
456 The author(s) and publisher(s) of the Document do not by this License
457 give permission to use their names for publicity for or to assert or
458 imply endorsement of any Modified Version.
459 .PP
460
461 5. COMBINING DOCUMENTS
462 .PP
463 You may combine the Document with other documents released under this
464 License, under the terms defined in section 4 above for modified
465 versions, provided that you include in the combination all of the
466 Invariant Sections of all of the original documents, unmodified, and
467 list them all as Invariant Sections of your combined work in its
468 license notice.
469 .PP
470 The combined work need only contain one copy of this License, and
471 multiple identical Invariant Sections may be replaced with a single
472 copy. If there are multiple Invariant Sections with the same name but
473 different contents, make the title of each such section unique by
474 adding at the end of it, in parentheses, the name of the original
475 author or publisher of that section if known, or else a unique number.
476 Make the same adjustment to the section titles in the list of
477 Invariant Sections in the license notice of the combined work.
478 .PP
479 In the combination, you must combine any sections entitled "History"
480 in the various original documents, forming one section entitled
481 "History"; likewise combine any sections entitled "Acknowledgements",
482 and any sections entitled "Dedications". You must delete all sections
483 entitled "Endorsements."
484 .PP
485
486 6. COLLECTIONS OF DOCUMENTS
487 .PP
488 You may make a collection consisting of the Document and other documents
489 released under this License, and replace the individual copies of this
490 License in the various documents with a single copy that is included in
491 the collection, provided that you follow the rules of this License for
492 verbatim copying of each of the documents in all other respects.
493 .PP
494 You may extract a single document from such a collection, and distribute
495 it individually under this License, provided you insert a copy of this
496 License into the extracted document, and follow this License in all
497 other respects regarding verbatim copying of that document.
498 .PP
499
500 7. AGGREGATION WITH INDEPENDENT WORKS
501 .PP
502 A compilation of the Document or its derivatives with other separate
503 and independent documents or works, in or on a volume of a storage or
504 distribution medium, does not as a whole count as a Modified Version
505 of the Document, provided no compilation copyright is claimed for the
506 compilation. Such a compilation is called an "aggregate", and this
507 License does not apply to the other self-contained works thus compiled
508 with the Document, on account of their being thus compiled, if they
509 are not themselves derivative works of the Document.
510 .PP
511 If the Cover Text requirement of section 3 is applicable to these
512 copies of the Document, then if the Document is less than one quarter
513 of the entire aggregate, the Document's Cover Texts may be placed on
514 covers that surround only the Document within the aggregate.
515 Otherwise they must appear on covers around the whole aggregate.
516 .PP
517
518 8. TRANSLATION
519 .PP
520 Translation is considered a kind of modification, so you may
521 distribute translations of the Document under the terms of section 4.
522 Replacing Invariant Sections with translations requires special
523 permission from their copyright holders, but you may include
524 translations of some or all Invariant Sections in addition to the
525 original versions of these Invariant Sections. You may include a
526 translation of this License provided that you also include the
527 original English version of this License. In case of a disagreement
528 between the translation and the original English version of this
529 License, the original English version will prevail.
530 .PP
531
532 9. TERMINATION
533 .PP
534 You may not copy, modify, sublicense, or distribute the Document except
535 as expressly provided for under this License. Any other attempt to
536 copy, modify, sublicense or distribute the Document is void, and will
537 automatically terminate your rights under this License. However,
538 parties who have received copies, or rights, from you under this
539 License will not have their licenses terminated so long as such
540 parties remain in full compliance.
541 .PP
542
543 10. FUTURE REVISIONS OF THIS LICENSE
544 .PP
545 The Free Software Foundation may publish new, revised versions
546 of the GNU Free Documentation License from time to time. Such new
547 versions will be similar in spirit to the present version, but may
548 differ in detail to address new problems or concerns. See
549 http://www.gnu.org/copyleft/.
550 .PP
551 Each version of the License is given a distinguishing version number.
552 If the Document specifies that a particular numbered version of this
553 License "or any later version" applies to it, you have the option of
554 following the terms and conditions either of that specified version or
555 of any later version that has been published (not as a draft) by the
556 Free Software Foundation. If the Document does not specify a version
557 number of this License, you may choose any version ever published (not
558 as a draft) by the Free Software Foundation.
559 .PP
560
561 ADDENDUM: How to use this License for your documents
562 .PP
563 To use this License in a document you have written, include a copy of
564 the License in the document and put the following copyright and
565 license notices just after the title page:
566 .PP
567 Copyright (c) YEAR YOUR NAME.
568 Permission is granted to copy, distribute and/or
569 modify this document under the terms of the GNU
570 Free Documentation License, Version 1.1 or any later
571 version published by the Free Software Foundation;
572 with the Invariant Sections being LIST THEIR TITLES,
573 with the Front-Cover Texts being LIST, and with the
574 Back-Cover Texts being LIST. A copy of the license
575 is included in the section entitled "GNU Free
576 Documentation License".
577 .PP
578 If you have no Invariant Sections, write "with no Invariant Sections"
579 instead of saying which ones are invariant. If you have no
580 Front-Cover Texts, write "no Front-Cover Texts" instead of
581 "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
582 .PP
583 If your document contains nontrivial examples of program code, we
584 recommend releasing these examples in parallel under your choice of
585 free software license, such as the GNU General Public License,
586 to permit their use in free software.