1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
8 * Binutils: (binutils). The GNU binary utilities "ar", "objcopy",
9 "objdump", "nm", "nlmconv", "size",
10 "strings", "strip", and "ranlib".
16 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 1997 Free Software Foundation, Inc.
18 Permission is granted to make and distribute verbatim copies of
19 this manual provided the copyright notice and this permission notice
20 are preserved on all copies.
23 Permission is granted to process this file through TeX and print the
24 results, provided the printed document carries a copying permission
25 notice identical to this one except for the removal of this paragraph
26 (this paragraph not being relevant to the printed manual).
30 Permission is granted to copy and distribute modified versions of this
31 manual under the conditions for verbatim copying, provided also that
32 the entire resulting derived work is distributed under the terms of a
33 permission notice identical to this one.
35 Permission is granted to copy and distribute translations of this manual
36 into another language, under the above conditions for modified versions.
41 @c This file documents the GNU binary utilities "ar", "ld", "objcopy",
42 @c "objdump", "nm", "size", "strings", "strip", and "ranlib".
44 @c Copyright (C) 1991, 92, 93, 94, 95, 96, 1997 Free Software Foundation, Inc.
46 @c This text may be freely distributed under the terms of the GNU
47 @c General Public License.
50 @setchapternewpage odd
51 @settitle @sc{gnu} Binary Utilities
54 @title The @sc{gnu} Binary Utilities
55 @subtitle Version @value{VERSION}
58 @author Roland H. Pesch
59 @author Jeffrey M. Osier
60 @author Cygnus Support
64 {\parskip=0pt \hfill Cygnus Support\par \hfill
65 \TeX{}info \texinfoversion\par }
68 @vskip 0pt plus 1filll
69 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 1997 Free Software Foundation, Inc.
71 Permission is granted to make and distribute verbatim copies of
72 this manual provided the copyright notice and this permission notice
73 are preserved on all copies.
75 Permission is granted to copy and distribute modified versions of this
76 manual under the conditions for verbatim copying, provided also that
77 the entire resulting derived work is distributed under the terms of a
78 permission notice identical to this one.
80 Permission is granted to copy and distribute translations of this manual
81 into another language, under the above conditions for modified versions.
88 This brief manual contains preliminary documentation for the @sc{gnu} binary
89 utilities (collectively version @value{VERSION}):
94 Create, modify, and extract from archives
97 List symbols from object files
100 Copy and translate object files
103 Display information from object files
106 Generate index to archive contents
109 List file section sizes and total size
112 List printable strings from files
118 Demangle encoded C++ symbols
121 Convert addresses into file names and line numbers
124 Convert object code into a Netware Loadable Module
129 * ar:: Create, modify, and extract from archives
130 * nm:: List symbols from object files
131 * objcopy:: Copy and translate object files
132 * objdump:: Display information from object files
133 * ranlib:: Generate index to archive contents
134 * size:: List section sizes and total size
135 * strings:: List printable strings from files
136 * strip:: Discard symbols
137 * c++filt:: Filter to demangle encoded C++ symbols
138 * addr2line:: Convert addresses to file and line
139 * nlmconv:: Converts object code into an NLM
140 * Selecting The Target System:: How these utilities determine the target.
141 * Reporting Bugs:: Reporting Bugs
150 @cindex collections of files
152 ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
153 ar -M [ <mri-script ]
156 The @sc{gnu} @code{ar} program creates, modifies, and extracts from
157 archives. An @dfn{archive} is a single file holding a collection of
158 other files in a structure that makes it possible to retrieve
159 the original individual files (called @dfn{members} of the archive).
161 The original files' contents, mode (permissions), timestamp, owner, and
162 group are preserved in the archive, and can be restored on
166 @sc{gnu} @code{ar} can maintain archives whose members have names of any
167 length; however, depending on how @code{ar} is configured on your
168 system, a limit on member-name length may be imposed for compatibility
169 with archive formats maintained with other tools. If it exists, the
170 limit is often 15 characters (typical of formats related to a.out) or 16
171 characters (typical of formats related to coff).
174 @code{ar} is considered a binary utility because archives of this sort
175 are most often used as @dfn{libraries} holding commonly needed
179 @code{ar} creates an index to the symbols defined in relocatable
180 object modules in the archive when you specify the modifier @samp{s}.
181 Once created, this index is updated in the archive whenever @code{ar}
182 makes a change to its contents (save for the @samp{q} update operation).
183 An archive with such an index speeds up linking to the library, and
184 allows routines in the library to call each other without regard to
185 their placement in the archive.
187 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
188 table. If an archive lacks the table, another form of @code{ar} called
189 @code{ranlib} can be used to add just the table.
191 @cindex compatibility, @code{ar}
192 @cindex @code{ar} compatibility
193 @sc{gnu} @code{ar} is designed to be compatible with two different
194 facilities. You can control its activity using command-line options,
195 like the different varieties of @code{ar} on Unix systems; or, if you
196 specify the single command-line option @samp{-M}, you can control it
197 with a script supplied via standard input, like the MRI ``librarian''
201 * ar cmdline:: Controlling @code{ar} on the command line
202 * ar scripts:: Controlling @code{ar} with a script
207 @section Controlling @code{ar} on the command line
210 ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
213 @cindex Unix compatibility, @code{ar}
214 When you use @code{ar} in the Unix style, @code{ar} insists on at least two
215 arguments to execute: one keyletter specifying the @emph{operation}
216 (optionally accompanied by other keyletters specifying
217 @emph{modifiers}), and the archive name to act on.
219 Most operations can also accept further @var{member} arguments,
220 specifying particular files to operate on.
222 @sc{gnu} @code{ar} allows you to mix the operation code @var{p} and modifier
223 flags @var{mod} in any order, within the first command-line argument.
225 If you wish, you may begin the first command-line argument with a
228 @cindex operations on archive
229 The @var{p} keyletter specifies what operation to execute; it may be
230 any of the following, but you must specify only one of them:
234 @cindex deleting from archive
235 @emph{Delete} modules from the archive. Specify the names of modules to
236 be deleted as @var{member}@dots{}; the archive is untouched if you
237 specify no files to delete.
239 If you specify the @samp{v} modifier, @code{ar} lists each module
243 @cindex moving in archive
244 Use this operation to @emph{move} members in an archive.
246 The ordering of members in an archive can make a difference in how
247 programs are linked using the library, if a symbol is defined in more
250 If no modifiers are used with @code{m}, any members you name in the
251 @var{member} arguments are moved to the @emph{end} of the archive;
252 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
253 specified place instead.
256 @cindex printing from archive
257 @emph{Print} the specified members of the archive, to the standard
258 output file. If the @samp{v} modifier is specified, show the member
259 name before copying its contents to standard output.
261 If you specify no @var{member} arguments, all the files in the archive are
265 @cindex quick append to archive
266 @emph{Quick append}; add the files @var{member}@dots{} to the end of
267 @var{archive}, without checking for replacement.
269 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
270 operation; new members are always placed at the end of the archive.
272 The modifier @samp{v} makes @code{ar} list each file as it is appended.
274 Since the point of this operation is speed, the archive's symbol table
275 index is not updated, even if it already existed; you can use @samp{ar s} or
276 @code{ranlib} explicitly to update the symbol table index.
279 @cindex replacement in archive
280 Insert the files @var{member}@dots{} into @var{archive} (with
281 @emph{replacement}). This operation differs from @samp{q} in that any
282 previously existing members are deleted if their names match those being
285 If one of the files named in @var{member}@dots{} does not exist, @code{ar}
286 displays an error message, and leaves undisturbed any existing members
287 of the archive matching that name.
289 By default, new members are added at the end of the file; but you may
290 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
291 placement relative to some existing member.
293 The modifier @samp{v} used with this operation elicits a line of
294 output for each file inserted, along with one of the letters @samp{a} or
295 @samp{r} to indicate whether the file was appended (no old member
296 deleted) or replaced.
299 @cindex contents of archive
300 Display a @emph{table} listing the contents of @var{archive}, or those
301 of the files listed in @var{member}@dots{} that are present in the
302 archive. Normally only the member name is shown; if you also want to
303 see the modes (permissions), timestamp, owner, group, and size, you can
304 request that by also specifying the @samp{v} modifier.
306 If you do not specify a @var{member}, all files in the archive
309 @cindex repeated names in archive
310 @cindex name duplication in archive
311 If there is more than one file with the same name (say, @samp{fie}) in
312 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
313 first instance; to see them all, you must ask for a complete
314 listing---in our example, @samp{ar t b.a}.
315 @c WRS only; per Gumby, this is implementation-dependent, and in a more
316 @c recent case in fact works the other way.
319 @cindex extract from archive
320 @emph{Extract} members (named @var{member}) from the archive. You can
321 use the @samp{v} modifier with this operation, to request that
322 @code{ar} list each name as it extracts it.
324 If you do not specify a @var{member}, all files in the archive
329 A number of modifiers (@var{mod}) may immediately follow the @var{p}
330 keyletter, to specify variations on an operation's behavior:
334 @cindex relative placement in archive
335 Add new files @emph{after} an existing member of the
336 archive. If you use the modifier @samp{a}, the name of an existing archive
337 member must be present as the @var{relpos} argument, before the
338 @var{archive} specification.
341 Add new files @emph{before} an existing member of the
342 archive. If you use the modifier @samp{b}, the name of an existing archive
343 member must be present as the @var{relpos} argument, before the
344 @var{archive} specification. (same as @samp{i}).
347 @cindex creating archives
348 @emph{Create} the archive. The specified @var{archive} is always
349 created if it did not exist, when you request an update. But a warning is
350 issued unless you specify in advance that you expect to create it, by
354 Truncate names in the archive. @sc{gnu} @code{ar} will normally permit file
355 names of any length. This will cause it to create archives which are
356 not compatible with the native @code{ar} program on some systems. If
357 this is a concern, the @samp{f} modifier may be used to truncate file
358 names when putting them in the archive.
361 Insert new files @emph{before} an existing member of the
362 archive. If you use the modifier @samp{i}, the name of an existing archive
363 member must be present as the @var{relpos} argument, before the
364 @var{archive} specification. (same as @samp{b}).
367 This modifier is accepted but not used.
368 @c whaffor ar l modifier??? presumably compat; with
369 @c what???---doc@@cygnus.com, 25jan91
372 @cindex dates in archive
373 Preserve the @emph{original} dates of members when extracting them. If
374 you do not specify this modifier, files extracted from the archive
375 are stamped with the time of extraction.
378 @cindex writing archive index
379 Write an object-file index into the archive, or update an existing one,
380 even if no other change is made to the archive. You may use this modifier
381 flag either with any operation, or alone. Running @samp{ar s} on an
382 archive is equivalent to running @samp{ranlib} on it.
385 @cindex updating an archive
386 Normally, @samp{ar r}@dots{} inserts all files
387 listed into the archive. If you would like to insert @emph{only} those
388 of the files you list that are newer than existing members of the same
389 names, use this modifier. The @samp{u} modifier is allowed only for the
390 operation @samp{r} (replace). In particular, the combination @samp{qu} is
391 not allowed, since checking the timestamps would lose any speed
392 advantage from the operation @samp{q}.
395 This modifier requests the @emph{verbose} version of an operation. Many
396 operations display additional information, such as filenames processed,
397 when the modifier @samp{v} is appended.
400 This modifier shows the version number of @code{ar}.
404 @section Controlling @code{ar} with a script
407 ar -M [ <@var{script} ]
410 @cindex MRI compatibility, @code{ar}
411 @cindex scripts, @code{ar}
412 If you use the single command-line option @samp{-M} with @code{ar}, you
413 can control its operation with a rudimentary command language. This
414 form of @code{ar} operates interactively if standard input is coming
415 directly from a terminal. During interactive use, @code{ar} prompts for
416 input (the prompt is @samp{AR >}), and continues executing even after
417 errors. If you redirect standard input to a script file, no prompts are
418 issued, and @code{ar} abandons execution (with a nonzero exit code)
421 The @code{ar} command language is @emph{not} designed to be equivalent
422 to the command-line options; in fact, it provides somewhat less control
423 over archives. The only purpose of the command language is to ease the
424 transition to @sc{gnu} @code{ar} for developers who already have scripts
425 written for the MRI ``librarian'' program.
427 The syntax for the @code{ar} command language is straightforward:
430 commands are recognized in upper or lower case; for example, @code{LIST}
431 is the same as @code{list}. In the following descriptions, commands are
432 shown in upper case for clarity.
435 a single command may appear on each line; it is the first word on the
439 empty lines are allowed, and have no effect.
442 comments are allowed; text after either of the characters @samp{*}
443 or @samp{;} is ignored.
446 Whenever you use a list of names as part of the argument to an @code{ar}
447 command, you can separate the individual names with either commas or
448 blanks. Commas are shown in the explanations below, for clarity.
451 @samp{+} is used as a line continuation character; if @samp{+} appears
452 at the end of a line, the text on the following line is considered part
453 of the current command.
456 Here are the commands you can use in @code{ar} scripts, or when using
457 @code{ar} interactively. Three of them have special significance:
459 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
460 a temporary file required for most of the other commands.
462 @code{SAVE} commits the changes so far specified by the script. Prior
463 to @code{SAVE}, commands affect only the temporary copy of the current
467 @item ADDLIB @var{archive}
468 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
469 Add all the contents of @var{archive} (or, if specified, each named
470 @var{module} from @var{archive}) to the current archive.
472 Requires prior use of @code{OPEN} or @code{CREATE}.
474 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
475 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
476 @c else like "ar q..."
477 Add each named @var{member} as a module in the current archive.
479 Requires prior use of @code{OPEN} or @code{CREATE}.
482 Discard the contents of the current archive, cancelling the effect of
483 any operations since the last @code{SAVE}. May be executed (with no
484 effect) even if no current archive is specified.
486 @item CREATE @var{archive}
487 Creates an archive, and makes it the current archive (required for many
488 other commands). The new archive is created with a temporary name; it
489 is not actually saved as @var{archive} until you use @code{SAVE}.
490 You can overwrite existing archives; similarly, the contents of any
491 existing file named @var{archive} will not be destroyed until @code{SAVE}.
493 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
494 Delete each listed @var{module} from the current archive; equivalent to
495 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
497 Requires prior use of @code{OPEN} or @code{CREATE}.
499 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
500 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
501 List each named @var{module} present in @var{archive}. The separate
502 command @code{VERBOSE} specifies the form of the output: when verbose
503 output is off, output is like that of @samp{ar -t @var{archive}
504 @var{module}@dots{}}. When verbose output is on, the listing is like
505 @samp{ar -tv @var{archive} @var{module}@dots{}}.
507 Output normally goes to the standard output stream; however, if you
508 specify @var{outputfile} as a final argument, @code{ar} directs the
512 Exit from @code{ar}, with a @code{0} exit code to indicate successful
513 completion. This command does not save the output file; if you have
514 changed the current archive since the last @code{SAVE} command, those
517 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
518 Extract each named @var{module} from the current archive, writing them
519 into the current directory as separate files. Equivalent to @samp{ar -x
520 @var{archive} @var{module}@dots{}}.
522 Requires prior use of @code{OPEN} or @code{CREATE}.
525 @c FIXME Tokens but no commands???
532 Display full contents of the current archive, in ``verbose'' style
533 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
534 tv @var{archive}}). (This single command is a @sc{gnu} @code{ld}
535 enhancement, rather than present for MRI compatibility.)
537 Requires prior use of @code{OPEN} or @code{CREATE}.
539 @item OPEN @var{archive}
540 Opens an existing archive for use as the current archive (required for
541 many other commands). Any changes as the result of subsequent commands
542 will not actually affect @var{archive} until you next use @code{SAVE}.
544 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
545 In the current archive, replace each existing @var{module} (named in
546 the @code{REPLACE} arguments) from files in the current working directory.
547 To execute this command without errors, both the file, and the module in
548 the current archive, must exist.
550 Requires prior use of @code{OPEN} or @code{CREATE}.
553 Toggle an internal flag governing the output from @code{DIRECTORY}.
554 When the flag is on, @code{DIRECTORY} output matches output from
555 @samp{ar -tv }@dots{}.
558 Commit your changes to the current archive, and actually save it as a
559 file with the name specified in the last @code{CREATE} or @code{OPEN}
562 Requires prior use of @code{OPEN} or @code{CREATE}.
571 The @sc{gnu} linker @code{ld} is now described in a separate manual.
572 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
581 nm [ -a | --debug-syms ] [ -g | --extern-only ]
582 [ -B ] [ -C | --demangle ] [ -D | --dynamic ]
583 [ -s | --print-armap ] [ -A | -o | --print-file-name ]
584 [ -n | -v | --numeric-sort ] [ -p | --no-sort ]
585 [ -r | --reverse-sort ] [ --size-sort ] [ -u | --undefined-only ]
586 [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ]
587 [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ]
588 [ --defined-only ] [-l | --line-numbers ]
589 [ --no-demangle ] [ -V | --version ] [ --help ] [ @var{objfile}@dots{} ]
592 @sc{gnu} @code{nm} lists the symbols from object files @var{objfile}@dots{}.
593 If no object files are listed as arguments, @code{nm} assumes
596 For each symbol, @code{nm} shows:
600 The symbol value, in the radix selected by options (see below), or
601 hexadecimal by default.
604 The symbol type. At least the following types are used; others are, as
605 well, depending on the object file format. If lowercase, the symbol is
606 local; if uppercase, the symbol is global (external).
608 @c Some more detail on exactly what these symbol types are used for
612 The symbol's value is absolute, and will not be changed by further
616 The symbol is in the uninitialized data section (known as BSS).
619 The symbol is common. Common symbols are uninitialized data. When
620 linking, multiple common symbols may appear with the same name. If the
621 symbol is defined anywhere, the common symbols are treated as undefined
622 references. For more details on common symbols, see the discussion of
623 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
626 The symbol is in the initialized data section.
629 The symbol is in an initialized data section for small objects. Some
630 object file formats permit more efficient access to small data objects,
631 such as a global int variable as opposed to a large global array.
634 The symbol is an indirect reference to another symbol. This is a GNU
635 extension to the a.out object file format which is rarely used.
638 The symbol is a debugging symbol.
641 The symbol is in a read only data section.
644 The symbol is in an uninitialized data section for small objects.
647 The symbol is in the text (code) section.
650 The symbol is undefined.
653 The symbol is weak. When a weak defined symbol is linked with a normal
654 defined symbol, the normal defined symbol is used with no error. When a
655 weak undefined symbol is linked and the symbol is not defined, the value
656 of the weak symbol becomes zero with no error.
659 The symbol is a stabs symbol in an a.out object file. In this case, the
660 next values printed are the stabs other field, the stabs desc field, and
661 the stab type. Stabs symbols are used to hold debugging information;
662 for more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
663 ``stabs'' debug format}.
666 The symbol type is unknown, or object file format specific.
673 The long and short forms of options, shown here as alternatives, are
679 @itemx --print-file-name
680 @cindex input file name
682 @cindex source file name
683 Precede each symbol by the name of the input file (or archive element)
684 in which it was found, rather than identifying the input file once only,
685 before all of its symbols.
689 @cindex debugging symbols
690 Display all symbols, even debugger-only symbols; normally these are not
694 @cindex @code{nm} format
695 @cindex @code{nm} compatibility
696 The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}).
700 @cindex demangling in nm
701 Decode (@dfn{demangle}) low-level symbol names into user-level names.
702 Besides removing any initial underscore prepended by the system, this
703 makes C++ function names readable. @xref{c++filt}, for more information
707 Do not demangle low-level symbol names. This is the default.
711 @cindex dynamic symbols
712 Display the dynamic symbols rather than the normal symbols. This is
713 only meaningful for dynamic objects, such as certain types of shared
716 @item -f @var{format}
717 @itemx --format=@var{format}
718 @cindex @code{nm} format
719 @cindex @code{nm} compatibility
720 Use the output format @var{format}, which can be @code{bsd},
721 @code{sysv}, or @code{posix}. The default is @code{bsd}.
722 Only the first character of @var{format} is significant; it can be
723 either upper or lower case.
727 @cindex external symbols
728 Display only external symbols.
731 @itemx --line-numbers
732 @cindex symbol line numbers
733 For each symbol, use debugging information to try to find a filename and
734 line number. For a defined symbol, look for the line number of the
735 address of the symbol. For an undefined symbol, look for the line
736 number of a relocation entry which refers to the symbol. If line number
737 information can be found, print it after the other symbol information.
741 @itemx --numeric-sort
742 Sort symbols numerically by their addresses, rather than alphabetically
747 @cindex sorting symbols
748 Do not bother to sort the symbols in any order; print them in the order
753 Use the POSIX.2 standard output format instead of the default format.
754 Equivalent to @samp{-f posix}.
758 @cindex symbol index, listing
759 When listing symbols from archive members, include the index: a mapping
760 (stored in the archive by @code{ar} or @code{ranlib}) of which modules
761 contain definitions for which names.
764 @itemx --reverse-sort
765 Reverse the order of the sort (whether numeric or alphabetic); let the
769 Sort symbols by size. The size is computed as the difference between
770 the value of the symbol and the value of the symbol with the next higher
771 value. The size of the symbol is printed, rather than the value.
774 @itemx --radix=@var{radix}
775 Use @var{radix} as the radix for printing the symbol values. It must be
776 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
778 @item --target=@var{bfdname}
779 @cindex object code format
780 Specify an object code format other than your system's default format.
781 @xref{Target Selection}, for more information.
784 @itemx --undefined-only
785 @cindex external symbols
786 @cindex undefined symbols
787 Display only undefined symbols (those external to each object file).
790 @cindex external symbols
791 @cindex undefined symbols
792 Display only defined symbols for each object file.
796 Show the version number of @code{nm} and exit.
799 Show a summary of the options to @code{nm} and exit.
806 objcopy [ -F @var{bfdname} | --target=@var{bfdname} ]
807 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
808 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
809 [ -S | --strip-all ] [ -g | --strip-debug ]
810 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
811 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
812 [ -x | --discard-all ] [ -X | --discard-locals ]
813 [ -b @var{byte} | --byte=@var{byte} ]
814 [ -i @var{interleave} | --interleave=@var{interleave} ]
815 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
817 [ --gap-fill=@var{val} ] [ --pad-to=@var{address} ]
818 [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ]
819 [ --adjust-vma=@var{incr} ]
820 [ --adjust-section-vma=@var{section}@{=,+,-@}@var{val} ]
821 [ --adjust-warnings ] [ --no-adjust-warnings ]
822 [ --set-section-flags=@var{section}=@var{flags} ]
823 [ --add-section=@var{sectionname}=@var{filename} ]
824 [ --change-leading-char ] [ --remove-leading-char ]
826 [ -v | --verbose ] [ -V | --version ] [ --help ]
827 @var{infile} [@var{outfile}]
830 The @sc{gnu} @code{objcopy} utility copies the contents of an object
831 file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to
832 read and write the object files. It can write the destination object
833 file in a format different from that of the source object file. The
834 exact behavior of @code{objcopy} is controlled by command-line options.
836 @code{objcopy} creates temporary files to do its translations and
837 deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its
838 translation work; it has access to all the formats described in @sc{bfd}
839 and thus is able to recognize most formats without being told
840 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
842 @code{objcopy} can be used to generate S-records by using an output
843 target of @samp{srec} (e.g., use @samp{-O srec}).
845 @code{objcopy} can be used to generate a raw binary file by using an
846 output target of @samp{binary} (e.g., use @samp{-O binary}). When
847 @code{objcopy} generates a raw binary file, it will essentially produce
848 a memory dump of the contents of the input object file. All symbols and
849 relocation information will be discarded. The memory dump will start at
850 the load address of the lowest section copied into the output file.
852 When generating an S-record or a raw binary file, it may be helpful to
853 use @samp{-S} to remove sections containing debugging information. In
854 some cases @samp{-R} will be useful to remove sections which contain
855 information which is not needed by the binary file.
860 The source and output files, respectively.
861 If you do not specify @var{outfile}, @code{objcopy} creates a
862 temporary file and destructively renames the result with
863 the name of @var{infile}.
865 @item -I @var{bfdname}
866 @itemx --input-target=@var{bfdname}
867 Consider the source file's object format to be @var{bfdname}, rather than
868 attempting to deduce it. @xref{Target Selection}, for more information.
870 @item -O @var{bfdname}
871 @itemx --output-target=@var{bfdname}
872 Write the output file using the object format @var{bfdname}.
873 @xref{Target Selection}, for more information.
875 @item -F @var{bfdname}
876 @itemx --target=@var{bfdname}
877 Use @var{bfdname} as the object format for both the input and the output
878 file; i.e., simply transfer data from source to destination with no
879 translation. @xref{Target Selection}, for more information.
881 @item -R @var{sectionname}
882 @itemx --remove-section=@var{sectionname}
883 Remove any section named @var{sectionname} from the output file. This
884 option may be given more than once. Note that using this option
885 inappropriately may make the output file unusable.
889 Do not copy relocation and symbol information from the source file.
893 Do not copy debugging symbols from the source file.
895 @item --strip-unneeded
896 Strip all symbols that are not needed for relocation processing.
898 @item -K @var{symbolname}
899 @itemx --keep-symbol=@var{symbolname}
900 Copy only symbol @var{symbolname} from the source file. This option may
901 be given more than once.
903 @item -N @var{symbolname}
904 @itemx --strip-symbol=@var{symbolname}
905 Do not copy symbol @var{symbolname} from the source file. This option
906 may be given more than once, and may be combined with strip options
907 other than @code{-K}.
911 Do not copy non-global symbols from the source file.
912 @c FIXME any reason to prefer "non-global" to "local" here?
915 @itemx --discard-locals
916 Do not copy compiler-generated local symbols.
917 (These usually start with @samp{L} or @samp{.}.)
920 @itemx --byte=@var{byte}
921 Keep only every @var{byte}th byte of the input file (header data is not
922 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
923 where @var{interleave} is given by the @samp{-i} or @samp{--interleave}
924 option, or the default of 4. This option is useful for creating files
925 to program @sc{rom}. It is typically used with an @code{srec} output
928 @item -i @var{interleave}
929 @itemx --interleave=@var{interleave}
930 Only copy one out of every @var{interleave} bytes. Select which byte to
931 copy with the @var{-b} or @samp{--byte} option. The default is 4.
932 @code{objcopy} ignores this option if you do not specify either @samp{-b} or
936 Convert debugging information, if possible. This is not the default
937 because only certain debugging formats are supported, and the
938 conversion process can be time consuming.
940 @item --gap-fill @var{val}
941 Fill gaps between sections with @var{val}. This is done by increasing
942 the size of the section with the lower address, and filling in the extra
943 space created with @var{val}.
945 @item --pad-to @var{address}
946 Pad the output file up to the virtual address @var{address}. This is
947 done by increasing the size of the last section. The extra space is
948 filled in with the value specified by @samp{--gap-fill} (default zero).
950 @item --set-start @var{val}
951 Set the address of the new file to @var{val}. Not all object file
952 formats support setting the start address.
954 @item --adjust-start @var{incr}
955 Adjust the start address by adding @var{incr}. Not all object file
956 formats support setting the start address.
958 @item --adjust-vma @var{incr}
959 Adjust the address of all sections, as well as the start address, by
960 adding @var{incr}. Some object file formats do not permit section
961 addresses to be changed arbitrarily. Note that this does not relocate
962 the sections; if the program expects sections to be loaded at a certain
963 address, and this option is used to change the sections such that they
964 are loaded at a different address, the program may fail.
966 @item --adjust-section-vma @var{section}@{=,+,-@}@var{val}
967 Set or adjust the address of the named @var{section}. If @samp{=} is
968 used, the section address is set to @var{val}. Otherwise, @var{val} is
969 added to or subtracted from the section address. See the comments under
970 @samp{--adjust-vma}, above. If @var{section} does not exist in the
971 input file, a warning will be issued, unless @samp{--no-adjust-warnings}
974 @item --adjust-warnings
975 If @samp{--adjust-section-vma} is used, and the named section does not
976 exist, issue a warning. This is the default.
978 @item --no-adjust-warnings
979 Do not issue a warning if @samp{--adjust-section-vma} is used, even if
980 the named section does not exist.
982 @item --set-section-flags @var{section}=@var{flags}
983 Set the flags for the named section. The @var{flags} argument is a
984 comma separated string of flag names. The recognized names are
985 @samp{alloc}, @samp{load}, @samp{readonly}, @samp{code}, @samp{data},
986 and @samp{rom}. Not all flags are meaningful for all object file
989 @item --add-section @var{sectionname}=@var{filename}
990 Add a new section named @var{sectionname} while copying the file. The
991 contents of the new section are taken from the file @var{filename}. The
992 size of the section will be the size of the file. This option only
993 works on file formats which can support sections with arbitrary names.
995 @item --change-leading-char
996 Some object file formats use special characters at the start of
997 symbols. The most common such character is underscore, which compilers
998 often add before every symbol. This option tells @code{objcopy} to
999 change the leading character of every symbol when it converts between
1000 object file formats. If the object file formats use the same leading
1001 character, this option has no effect. Otherwise, it will add a
1002 character, or remove a character, or change a character, as
1005 @item --remove-leading-char
1006 If the first character of a global symbol is a special symbol leading
1007 character used by the object file format, remove the character. The
1008 most common symbol leading character is underscore. This option will
1009 remove a leading underscore from all global symbols. This can be useful
1010 if you want to link together objects of different file formats with
1011 different conventions for symbol names. This is different from
1012 @code{--change-leading-char} because it always changes the symbol name
1013 when appropriate, regardless of the object file format of the output
1017 Change all global symbols in the file to be weak. This can be useful
1018 when building an object which will be linked against other objects using
1019 the @code{-R} option to the linker. This option is only effective when
1020 using an object file format which supports weak symbols.
1024 Show the version number of @code{objcopy}.
1028 Verbose output: list all object files modified. In the case of
1029 archives, @samp{objcopy -V} lists all members of the archive.
1032 Show a summary of the options to @code{objcopy}.
1038 @cindex object file information
1042 objdump [ -a | --archive-headers ]
1043 [ -b @var{bfdname} | --target=@var{bfdname} ] [ --debugging ]
1044 [ -C | --demangle ] [ -d | --disassemble ]
1045 [ -D | --disassemble-all ] [ --disassemble-zeroes ]
1046 [ -EB | -EL | --endian=@{big | little @} ]
1047 [ -f | --file-headers ]
1048 [ -h | --section-headers | --headers ] [ -i | --info ]
1049 [ -j @var{section} | --section=@var{section} ]
1050 [ -l | --line-numbers ] [ -S | --source ]
1051 [ -m @var{machine} | --architecture=@var{machine} ]
1052 [ -r | --reloc ] [ -R | --dynamic-reloc ]
1053 [ -s | --full-contents ] [ --stabs ]
1054 [ -t | --syms ] [ -T | --dynamic-syms ] [ -x | --all-headers ]
1055 [ -w | --wide ] [ --start-address=@var{address} ]
1056 [ --stop-address=@var{address} ]
1057 [ --prefix-addresses] [ --[no-]show-raw-insn ]
1058 [ --adjust-vma=@var{offset} ]
1059 [ --version ] [ --help ]
1060 @var{objfile}@dots{}
1063 @code{objdump} displays information about one or more object files.
1064 The options control what particular information to display. This
1065 information is mostly useful to programmers who are working on the
1066 compilation tools, as opposed to programmers who just want their
1067 program to compile and work.
1069 @var{objfile}@dots{} are the object files to be examined. When you
1070 specify archives, @code{objdump} shows information on each of the member
1073 The long and short forms of options, shown here as alternatives, are
1074 equivalent. At least one option besides @samp{-l} must be given.
1078 @itemx --archive-header
1079 @cindex archive headers
1080 If any of the @var{objfile} files are archives, display the archive
1081 header information (in a format similar to @samp{ls -l}). Besides the
1082 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1083 the object file format of each archive member.
1085 @item --adjust-vma=@var{offset}
1086 @cindex section addresses in objdump
1087 @cindex VMA in objdump
1088 When dumping information, first add @var{offset} to all the section
1089 addresses. This is useful if the section addresses do not correspond to
1090 the symbol table, which can happen when putting sections at particular
1091 addresses when using a format which can not represent section addresses,
1094 @item -b @var{bfdname}
1095 @itemx --target=@var{bfdname}
1096 @cindex object code format
1097 Specify that the object-code format for the object files is
1098 @var{bfdname}. This option may not be necessary; @var{objdump} can
1099 automatically recognize many formats.
1103 objdump -b oasys -m vax -h fu.o
1106 displays summary information from the section headers (@samp{-h}) of
1107 @file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
1108 file in the format produced by Oasys compilers. You can list the
1109 formats available with the @samp{-i} option.
1110 @xref{Target Selection}, for more information.
1114 @cindex demangling in objdump
1115 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1116 Besides removing any initial underscore prepended by the system, this
1117 makes C++ function names readable. @xref{c++filt}, for more information
1121 Display debugging information. This attempts to parse debugging
1122 information stored in the file and print it out using a C like syntax.
1123 Only certain types of debugging information have been implemented.
1126 @itemx --disassemble
1127 @cindex disassembling object code
1128 @cindex machine instructions
1129 Display the assembler mnemonics for the machine instructions from
1130 @var{objfile}. This option only disassembles those sections which are
1131 expected to contain instructions.
1134 @itemx --disassemble-all
1135 Like @samp{-d}, but disassemble the contents of all sections, not just
1136 those expected to contain instructions.
1138 @item --prefix-addresses
1139 When disassembling, print the complete address on each line. This is
1140 the older disassembly format.
1142 @item --disassemble-zeroes
1143 Normally the disassembly output will skip blocks of zeroes. This
1144 option directs the disassembler to disassemble those blocks, just like
1149 @itemx --endian=@{big|little@}
1151 @cindex disassembly endianness
1152 Specify the endianness of the object files. This only affects
1153 disassembly. This can be useful when disassembling a file format which
1154 does not describe endianness information, such as S-records.
1157 @itemx --file-header
1158 @cindex object file header
1159 Display summary information from the overall header of
1160 each of the @var{objfile} files.
1163 @itemx --section-header
1165 @cindex section headers
1166 Display summary information from the section headers of the
1169 File segments may be relocated to nonstandard addresses, for example by
1170 using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
1171 @code{ld}. However, some object file formats, such as a.out, do not
1172 store the starting address of the file segments. In those situations,
1173 although @code{ld} relocates the sections correctly, using @samp{objdump
1174 -h} to list the file section headers cannot show the correct addresses.
1175 Instead, it shows the usual addresses, which are implicit for the
1179 Print a summary of the options to @code{objdump} and exit.
1183 @cindex architectures available
1184 @cindex object formats available
1185 Display a list showing all architectures and object formats available
1186 for specification with @samp{-b} or @samp{-m}.
1189 @itemx --section=@var{name}
1190 @cindex section information
1191 Display information only for section @var{name}.
1194 @itemx --line-numbers
1195 @cindex source filenames for object files
1196 Label the display (using debugging information) with the filename and
1197 source line numbers corresponding to the object code or relocs shown.
1198 Only useful with @samp{-d}, @samp{-D}, or @samp{-r}.
1200 @item -m @var{machine}
1201 @itemx --architecture=@var{machine}
1202 @cindex architecture
1203 @cindex disassembly architecture
1204 Specify the architecture to use when disassembling object files. This
1205 can be useful when disasembling object files which do not describe
1206 architecture information, such as S-records. You can list the available
1207 architectures with the @samp{-i} option.
1211 @cindex relocation entries, in object file
1212 Print the relocation entries of the file. If used with @samp{-d} or
1213 @samp{-D}, the relocations are printed interspersed with the
1217 @itemx --dynamic-reloc
1218 @cindex dynamic relocation entries, in object file
1219 Print the dynamic relocation entries of the file. This is only
1220 meaningful for dynamic objects, such as certain types of shared
1224 @itemx --full-contents
1225 @cindex sections, full contents
1226 @cindex object file sections
1227 Display the full contents of any sections requested.
1231 @cindex source disassembly
1232 @cindex disassembly, with source
1233 Display source code intermixed with disassembly, if possible. Implies
1236 @item --show-raw-insn
1237 When disassembling instructions, print the instruction in hex as well as
1238 in symbolic form. This is the default except when
1239 @code{--prefix-addresses} is used.
1241 @item --no-show-raw-insn
1242 When disassembling instructions, do not print the instruction bytes.
1243 This is the default when @code{--prefix-addresses} is used.
1248 @cindex debug symbols
1249 @cindex ELF object file format
1250 Display the full contents of any sections requested. Display the
1251 contents of the .stab and .stab.index and .stab.excl sections from an
1252 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1253 @code{.stab} debugging symbol-table entries are carried in an ELF
1254 section. In most other file formats, debugging symbol-table entries are
1255 interleaved with linkage symbols, and are visible in the @samp{--syms}
1256 output. For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1257 Overview,stabs.info, The ``stabs'' debug format}.
1259 @item --start-address=@var{address}
1260 @cindex start-address
1261 Start displaying data at the specified address. This affects the output
1262 of the @code{-d}, @code{-r} and @code{-s} options.
1264 @item --stop-address=@var{address}
1265 @cindex stop-address
1266 Stop displaying data at the specified address. This affects the output
1267 of the @code{-d}, @code{-r} and @code{-s} options.
1271 @cindex symbol table entries, printing
1272 Print the symbol table entries of the file.
1273 This is similar to the information provided by the @samp{nm} program.
1276 @itemx --dynamic-syms
1277 @cindex dynamic symbol table entries, printing
1278 Print the dynamic symbol table entries of the file. This is only
1279 meaningful for dynamic objects, such as certain types of shared
1280 libraries. This is similar to the information provided by the @samp{nm}
1281 program when given the @samp{-D} (@samp{--dynamic}) option.
1284 Print the version number of @code{objdump} and exit.
1288 @cindex all header information, object file
1289 @cindex header information, all
1290 Display all available header information, including the symbol table and
1291 relocation entries. Using @samp{-x} is equivalent to specifying all of
1292 @samp{-a -f -h -r -t}.
1296 @cindex wide output, printing
1297 Format some lines for output devices that have more than 80 columns.
1304 @cindex archive contents
1305 @cindex symbol index
1308 ranlib [-vV] @var{archive}
1311 @code{ranlib} generates an index to the contents of an archive and
1312 stores it in the archive. The index lists each symbol defined by a
1313 member of an archive that is a relocatable object file.
1315 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
1317 An archive with such an index speeds up linking to the library and
1318 allows routines in the library to call each other without regard to
1319 their placement in the archive.
1321 The @sc{gnu} @code{ranlib} program is another form of @sc{gnu} @code{ar}; running
1322 @code{ranlib} is completely equivalent to executing @samp{ar -s}.
1328 Show the version number of @code{ranlib}.
1335 @cindex section sizes
1338 size [ -A | -B | --format=@var{compatibility} ]
1339 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
1340 [ --target=@var{bfdname} ] [ -V | --version ]
1341 @var{objfile}@dots{}
1344 The @sc{gnu} @code{size} utility lists the section sizes---and the total
1345 size---for each of the object or archive files @var{objfile} in its
1346 argument list. By default, one line of output is generated for each
1347 object file or each module in an archive.
1349 @var{objfile}@dots{} are the object files to be examined.
1351 The command line options have the following meanings:
1356 @itemx --format=@var{compatibility}
1357 @cindex @code{size} display format
1358 Using one of these options, you can choose whether the output from @sc{gnu}
1359 @code{size} resembles output from System V @code{size} (using @samp{-A},
1360 or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
1361 @samp{--format=berkeley}). The default is the one-line format similar to
1363 @c Bonus for doc-source readers: you can also say --format=strange (or
1364 @c anything else that starts with 's') for sysv, and --format=boring (or
1365 @c anything else that starts with 'b') for Berkeley.
1367 Here is an example of the Berkeley (default) format of output from
1370 size --format=Berkeley ranlib size
1371 text data bss dec hex filename
1372 294880 81920 11592 388392 5ed28 ranlib
1373 294880 81920 11888 388688 5ee50 size
1377 This is the same data, but displayed closer to System V conventions:
1380 size --format=SysV ranlib size
1398 Show a summary of acceptable arguments and options.
1403 @itemx --radix=@var{number}
1404 @cindex @code{size} number format
1405 @cindex radix for section sizes
1406 Using one of these options, you can control whether the size of each
1407 section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1408 (@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1409 @samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
1410 values (8, 10, 16) are supported. The total size is always given in two
1411 radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1412 octal and hexadecimal if you're using @samp{-o}.
1414 @item --target=@var{bfdname}
1415 @cindex object code format
1416 Specify that the object-code format for @var{objfile} is
1417 @var{bfdname}. This option may not be necessary; @code{size} can
1418 automatically recognize many formats.
1419 @xref{Target Selection}, for more information.
1423 Display the version number of @code{size}.
1429 @cindex listings strings
1430 @cindex printing strings
1431 @cindex strings, printing
1434 strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
1435 [--all] [--print-file-name] [--bytes=@var{min-len}]
1436 [--radix=@var{radix}] [--target=@var{bfdname}]
1437 [--help] [--version] @var{file}@dots{}
1440 For each @var{file} given, @sc{gnu} @code{strings} prints the printable
1441 character sequences that are at least 4 characters long (or the number
1442 given with the options below) and are followed by an unprintable
1443 character. By default, it only prints the strings from the initialized
1444 and loaded sections of object files; for other types of files, it prints
1445 the strings from the whole file.
1447 @code{strings} is mainly useful for determining the contents of non-text
1454 Do not scan only the initialized and loaded sections of object files;
1455 scan the whole files.
1458 @itemx --print-file-name
1459 Print the name of the file before each string.
1462 Print a summary of the program usage on the standard output and exit.
1464 @itemx -@var{min-len}
1465 @item -n @var{min-len}
1466 @itemx --bytes=@var{min-len}
1467 Print sequences of characters that are at least @var{min-len} characters
1468 long, instead of the default 4.
1471 Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1472 act like @samp{-t d} instead. Since we can not be compatible with both
1473 ways, we simply chose one.
1475 @item -t @var{radix}
1476 @itemx --radix=@var{radix}
1477 Print the offset within the file before each string. The single
1478 character argument specifies the radix of the offset---@samp{o} for
1479 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1481 @item --target=@var{bfdname}
1482 @cindex object code format
1483 Specify an object code format other than your system's default format.
1484 @xref{Target Selection}, for more information.
1488 Print the program version number on the standard output and exit.
1495 @cindex removing symbols
1496 @cindex discarding symbols
1497 @cindex symbols, discarding
1500 strip [ -F @var{bfdname} | --target=@var{bfdname} | --target=@var{bfdname} ]
1501 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1502 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
1503 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
1504 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
1505 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
1506 [ -x | --discard-all ] [ -X | --discard-locals ]
1507 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
1509 [ -v | --verbose ] [ -V | --version ] [ --help ]
1510 @var{objfile}@dots{}
1513 @sc{gnu} @code{strip} discards all symbols from object files
1514 @var{objfile}. The list of object files may include archives.
1515 At least one object file must be given.
1517 @code{strip} modifies the files named in its argument,
1518 rather than writing modified copies under different names.
1521 @item -F @var{bfdname}
1522 @itemx --target=@var{bfdname}
1523 Treat the original @var{objfile} as a file with the object
1524 code format @var{bfdname}, and rewrite it in the same format.
1525 @xref{Target Selection}, for more information.
1528 Show a summary of the options to @code{strip} and exit.
1530 @item -I @var{bfdname}
1531 @itemx --input-target=@var{bfdname}
1532 Treat the original @var{objfile} as a file with the object
1533 code format @var{bfdname}.
1534 @xref{Target Selection}, for more information.
1536 @item -O @var{bfdname}
1537 @itemx --output-target=@var{bfdname}
1538 Replace @var{objfile} with a file in the output format @var{bfdname}.
1539 @xref{Target Selection}, for more information.
1541 @item -R @var{sectionname}
1542 @itemx --remove-section=@var{sectionname}
1543 Remove any section named @var{sectionname} from the output file. This
1544 option may be given more than once. Note that using this option
1545 inappropriately may make the output file unusable.
1553 @itemx --strip-debug
1554 Remove debugging symbols only.
1556 @item --strip-unneeded
1557 Remove all symbols that are not needed for relocation processing.
1559 @item -K @var{symbolname}
1560 @itemx --keep-symbol=@var{symbolname}
1561 Keep only symbol @var{symbolname} from the source file. This option may
1562 be given more than once.
1564 @item -N @var{symbolname}
1565 @itemx --strip-symbol=@var{symbolname}
1566 Remove symbol @var{symbolname} from the source file. This option may be
1567 given more than once, and may be combined with strip options other than
1571 Put the stripped output in @var{file}, rather than replacing the
1572 existing file. When this argument is used, only one @var{objfile}
1573 argument may be specified.
1576 @itemx --discard-all
1577 Remove non-global symbols.
1580 @itemx --discard-locals
1581 Remove compiler-generated local symbols.
1582 (These usually start with @samp{L} or @samp{.}.)
1586 Show the version number for @code{strip}.
1590 Verbose output: list all object files modified. In the case of
1591 archives, @samp{strip -v} lists all members of the archive.
1598 @cindex demangling C++ symbols
1601 c++filt [ -_ | --strip-underscores ]
1602 [ -n | --no-strip-underscores ]
1603 [ -s @var{format} | --format=@var{format} ]
1604 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
1607 The C++ language provides function overloading, which means that you can
1608 write many functions with the same name (providing each takes parameters
1609 of different types). All C++ function names are encoded into a
1610 low-level assembly label (this process is known as
1611 @dfn{mangling}). The @code{c++filt} program does the inverse mapping: it
1612 decodes (@dfn{demangles}) low-level names into user-level names so that
1613 the linker can keep these overloaded functions from clashing.
1615 Every alphanumeric word (consisting of letters, digits, underscores,
1616 dollars, or periods) seen in the input is a potential label. If the
1617 label decodes into a C++ name, the C++ name replaces the low-level
1620 You can use @code{c++filt} to decipher individual symbols:
1623 c++filt @var{symbol}
1626 If no @var{symbol} arguments are given, @code{c++filt} reads symbol
1627 names from the standard input and writes the demangled names to the
1628 standard output. All results are printed on the standard output.
1632 @itemx --strip-underscores
1633 On some systems, both the C and C++ compilers put an underscore in front
1634 of every name. For example, the C name @code{foo} gets the low-level
1635 name @code{_foo}. This option removes the initial underscore. Whether
1636 @code{c++filt} removes the underscore by default is target dependent.
1639 @itemx --no-strip-underscores
1640 Do not remove the initial underscore.
1642 @item -s @var{format}
1643 @itemx --format=@var{format}
1644 @sc{gnu} @code{nm} can decode three different methods of mangling, used by
1645 different C++ compilers. The argument to this option selects which
1650 the one used by the @sc{gnu} compiler (the default method)
1652 the one used by the Lucid compiler
1654 the one specified by the C++ Annotated Reference Manual
1658 Print a summary of the options to @code{c++filt} and exit.
1661 Print the version number of @code{c++filt} and exit.
1665 @emph{Warning:} @code{c++filt} is a new utility, and the details of its
1666 user interface are subject to change in future releases. In particular,
1667 a command-line option may be required in the the future to decode a name
1668 passed as an argument on the command line; in other words,
1671 c++filt @var{symbol}
1675 may in a future release become
1678 c++filt @var{option} @var{symbol}
1686 @cindex address to file name and line number
1689 addr2line [ -b @var{bfdname} | --target=@var{bfdname} ]
1691 [ -e @var{filename} | --exe=@var{filename} ]
1692 [ -f | --functions ] [ -s | --basename ]
1693 [ -H | --help ] [ -V | --version ]
1697 @code{addr2line} translates program addresses into file names and line
1698 numbers. Given an address and an executable, it uses the debugging
1699 information in the executable to figure out which file name and line
1700 number are associated with a given address.
1702 The executable to use is specified with the @code{-e} option. The
1703 default is @file{a.out}.
1705 @code{addr2line} has two modes of operation.
1707 In the first, hexadecimal addresses are specified on the command line,
1708 and @code{addr2line} displays the file name and line number for each
1711 In the second, @code{addr2line} reads hexadecimal addresses from
1712 standard input, and prints the file name and line number for each
1713 address on standard output. In this mode, @code{addr2line} may be used
1714 in a pipe to convert dynamically chosen addresses.
1716 The format of the output is @samp{FILENAME:LINENO}. The file name and
1717 line number for each address is printed on a separate line. If the
1718 @code{-f} option is used, then each @samp{FILENAME:LINENO} line is
1719 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
1720 containing the address.
1722 If the file name or function name can not be determined,
1723 @code{addr2line} will print two question marks in their place. If the
1724 line number can not be determined, @code{addr2line} will print 0.
1726 The long and short forms of options, shown here as alternatives, are
1730 @item -b @var{bfdname}
1731 @itemx --target=@var{bfdname}
1732 @cindex object code format
1733 Specify that the object-code format for the object files is
1738 @cindex demangling in objdump
1739 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1740 Besides removing any initial underscore prepended by the system, this
1741 makes C++ function names readable. @xref{c++filt}, for more information
1744 @item -e @var{filename}
1745 @itemx --exe=@var{filename}
1746 Specify the name of the executable for which addresses should be
1747 translated. The default file is @file{a.out}.
1751 Display function names as well as file and line number information.
1755 Display only the base of each file name.
1761 @code{nlmconv} converts a relocatable object file into a NetWare
1765 @code{nlmconv} currently works with @samp{i386} object
1766 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
1767 object files in @sc{elf}, or @code{a.out} format@footnote{
1768 @code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
1769 format in the Binary File Descriptor library. It has only been tested
1770 with the above formats.}.
1774 @emph{Warning:} @code{nlmconv} is not always built as part of the binary
1775 utilities, since it is only useful for NLM targets.
1779 nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1780 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
1781 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
1782 [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
1783 [ -h | --help ] [ -V | --version ]
1784 @var{infile} @var{outfile}
1787 @code{nlmconv} converts the relocatable @samp{i386} object file
1788 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
1789 reading @var{headerfile} for NLM header information. For instructions
1790 on writing the NLM command file language used in header files, see the
1791 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
1792 Development and Tools Overview}, which is part of the NLM Software
1793 Developer's Kit (``NLM SDK''), available from Novell, Inc.
1794 @code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
1795 @var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for
1798 @code{nlmconv} can perform a link step. In other words, you can list
1799 more than one object file for input if you list them in the definitions
1800 file (rather than simply specifying one input file on the command line).
1801 In this case, @code{nlmconv} calls the linker for you.
1804 @item -I @var{bfdname}
1805 @itemx --input-target=@var{bfdname}
1806 Object format of the input file. @code{nlmconv} can usually determine
1807 the format of a given file (so no default is necessary).
1808 @xref{Target Selection}, for more information.
1810 @item -O @var{bfdname}
1811 @itemx --output-target=@var{bfdname}
1812 Object format of the output file. @code{nlmconv} infers the output
1813 format based on the input format, e.g. for a @samp{i386} input file the
1814 output format is @samp{nlm32-i386}.
1815 @xref{Target Selection}, for more information.
1817 @item -T @var{headerfile}
1818 @itemx --header-file=@var{headerfile}
1819 Reads @var{headerfile} for NLM header information. For instructions on
1820 writing the NLM command file language used in header files, see@ see the
1821 @samp{linkers} section, of the @cite{NLM Development and Tools
1822 Overview}, which is part of the NLM Software Developer's Kit, available
1827 Displays (on standard error) the linker command line used by @code{nlmconv}.
1829 @item -l @var{linker}
1830 @itemx --linker=@var{linker}
1831 Use @var{linker} for any linking. @var{linker} can be an abosolute or a
1836 Prints a usage summary.
1840 Prints the version number for @code{nlmconv}.
1843 @node Selecting The Target System
1844 @chapter Selecting the target system
1846 You can specify three aspects of the target system to the @sc{gnu}
1847 binary file utilities, each in several ways:
1857 the linker emulation (which applies to the linker only)
1860 In the following summaries, the lists of ways to specify values are in
1861 order of decreasing precedence. The ways listed first override those
1864 The commands to list valid values only list the values for which the
1865 programs you are running were configured. If they were configured with
1866 @samp{--enable-targets=all}, the commands list most of the available
1867 values, but a few are left out; not all targets can be configured in at
1868 once because some of them can only be configured @dfn{native} (on hosts
1869 with the same type as the target system).
1872 * Target Selection::
1873 * Architecture Selection::
1874 * Linker Emulation Selection::
1877 @node Target Selection
1878 @section Target Selection
1880 A @dfn{target} is an object file format. A given target may be
1881 supported for multiple architectures (@pxref{Architecture Selection}).
1882 A target selection may also have variations for different operating
1883 systems or architectures.
1885 The command to list valid target values is @samp{objdump -i}
1886 (the first column of output contains the relevant information).
1888 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
1889 @samp{a.out-sunos-big}.
1891 You can also specify a target using a configuration triplet. This is
1892 the same sort of name that is passed to configure to specify a target.
1893 When you use a configuration triplet as an argument, it must be fully
1894 canonicalized. You can see the canonical version of a triplet by
1895 running the shell script @file{config.sub} which is included with the
1898 Some sample configuration triplets are: @samp{m68k-hp-bsd},
1899 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
1901 @subheading @code{objdump} Target
1907 command line option: @samp{-b} or @samp{--target}
1910 environment variable @code{GNUTARGET}
1913 deduced from the input file
1916 @subheading @code{objcopy} and @code{strip} Input Target
1922 command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
1925 environment variable @code{GNUTARGET}
1928 deduced from the input file
1931 @subheading @code{objcopy} and @code{strip} Output Target
1937 command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
1940 the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
1943 environment variable @code{GNUTARGET}
1946 deduced from the input file
1949 @subheading @code{nm}, @code{size}, and @code{strings} Target
1955 command line option: @samp{--target}
1958 environment variable @code{GNUTARGET}
1961 deduced from the input file
1964 @subheading Linker Input Target
1970 command line option: @samp{-b} or @samp{--format}
1971 (@pxref{Options,,Options,ld.info,Using LD})
1974 script command @code{TARGET}
1975 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1978 environment variable @code{GNUTARGET}
1979 (@pxref{Environment,,Environment,ld.info,Using LD})
1982 the default target of the selected linker emulation
1983 (@pxref{Linker Emulation Selection})
1986 @subheading Linker Output Target
1992 command line option: @samp{-oformat}
1993 (@pxref{Options,,Options,ld.info,Using LD})
1996 script command @code{OUTPUT_FORMAT}
1997 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2000 the linker input target (see ``Linker Input Target'' above)
2003 @node Architecture Selection
2004 @section Architecture selection
2006 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
2007 to run. Its name may contain a colon, separating the name of the
2008 processor family from the name of the particular @sc{cpu}.
2010 The command to list valid architecture values is @samp{objdump -i} (the
2011 second column contains the relevant information).
2013 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
2015 @subheading @code{objdump} Architecture
2021 command line option: @samp{-m} or @samp{--architecture}
2024 deduced from the input file
2027 @subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
2033 deduced from the input file
2036 @subheading Linker Input Architecture
2042 deduced from the input file
2045 @subheading Linker Output Architecture
2051 script command @code{OUTPUT_ARCH}
2052 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2055 the default architecture from the linker output target
2056 (@pxref{Target Selection})
2059 @node Linker Emulation Selection
2060 @section Linker emulation selection
2062 A linker @dfn{emulation} is a ``personality'' of the linker, which gives
2063 the linker default values for the other aspects of the target system.
2064 In particular, it consists of
2074 several ``hook'' functions that are run at certain stages of the linking
2075 process to do special things that some targets require
2078 The command to list valid linker emulation values is @samp{ld -V}.
2080 Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
2086 command line option: @samp{-m}
2087 (@pxref{Options,,Options,ld.info,Using LD})
2090 environment variable @code{LDEMULATION}
2093 compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
2094 which comes from @code{EMUL} in @file{config/@var{target}.mt}
2097 @node Reporting Bugs
2098 @chapter Reporting Bugs
2100 @cindex reporting bugs
2102 Your bug reports play an essential role in making the binary utilities
2105 Reporting a bug may help you by bringing a solution to your problem, or
2106 it may not. But in any case the principal function of a bug report is
2107 to help the entire community by making the next version of the binary
2108 utilities work better. Bug reports are your contribution to their
2111 In order for a bug report to serve its purpose, you must include the
2112 information that enables us to fix the bug.
2115 * Bug Criteria:: Have you found a bug?
2116 * Bug Reporting:: How to report bugs
2120 @section Have you found a bug?
2121 @cindex bug criteria
2123 If you are not sure whether you have found a bug, here are some guidelines:
2126 @cindex fatal signal
2129 If a binary utility gets a fatal signal, for any input whatever, that is
2130 a bug. Reliable utilities never crash.
2132 @cindex error on valid input
2134 If a binary utility produces an error message for valid input, that is a
2138 If you are an experienced user of binary utilities, your suggestions for
2139 improvement are welcome in any case.
2143 @section How to report bugs
2145 @cindex bugs, reporting
2147 A number of companies and individuals offer support for @sc{gnu}
2148 products. If you obtained the binary utilities from a support
2149 organization, we recommend you contact that organization first.
2151 You can find contact information for many support companies and
2152 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
2155 In any event, we also recommend that you send bug reports for the binary
2156 utilities to @samp{bug-gnu-utils@@prep.ai.mit.edu}.
2158 The fundamental principle of reporting bugs usefully is this:
2159 @strong{report all the facts}. If you are not sure whether to state a
2160 fact or leave it out, state it!
2162 Often people omit facts because they think they know what causes the
2163 problem and assume that some details do not matter. Thus, you might
2164 assume that the name of a file you use in an example does not matter.
2165 Well, probably it does not, but one cannot be sure. Perhaps the bug is
2166 a stray memory reference which happens to fetch from the location where
2167 that pathname is stored in memory; perhaps, if the pathname were
2168 different, the contents of that location would fool the utility into
2169 doing the right thing despite the bug. Play it safe and give a
2170 specific, complete example. That is the easiest thing for you to do,
2171 and the most helpful.
2173 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
2174 it is new to us. Therefore, always write your bug reports on the assumption
2175 that the bug has not been reported previously.
2177 Sometimes people give a few sketchy facts and ask, ``Does this ring a
2178 bell?'' Those bug reports are useless, and we urge everyone to
2179 @emph{refuse to respond to them} except to chide the sender to report
2182 To enable us to fix the bug, you should include all these things:
2186 The version of the utility. Each utility announces it if you start it
2187 with the @samp{--version} argument.
2189 Without this, we will not know whether there is any point in looking for
2190 the bug in the current version of the binary utilities.
2193 Any patches you may have applied to the source, including any patches
2194 made to the @code{BFD} library.
2197 The type of machine you are using, and the operating system name and
2201 What compiler (and its version) was used to compile the utilities---e.g.
2205 The command arguments you gave the utility to observe the bug. To
2206 guarantee you will not omit something important, list them all. A copy
2207 of the Makefile (or the output from make) is sufficient.
2209 If we were to try to guess the arguments, we would probably guess wrong
2210 and then we might not encounter the bug.
2213 A complete input file, or set of input files, that will reproduce the
2214 bug. If the utility is reading an object file or files, then it is
2215 generally most helpful to send the actual object files, uuencoded if
2216 necessary to get them through the mail system. Making them available
2217 for anonymous FTP is not as good, but may be the only reasonable choice
2218 for large object files.
2220 If the source files were produced exclusively using @sc{gnu} programs
2221 (e.g., @code{gcc}, @code{gas}, and/or the @sc{gnu} @code{ld}), then it
2222 may be OK to send the source files rather than the object files. In
2223 this case, be sure to say exactly what version of @code{gcc}, or
2224 whatever, was used to produce the object files. Also say how
2225 @code{gcc}, or whatever, was configured.
2228 A description of what behavior you observe that you believe is
2229 incorrect. For example, ``It gets a fatal signal.''
2231 Of course, if the bug is that the utility gets a fatal signal, then we
2232 will certainly notice it. But if the bug is incorrect output, we might
2233 not notice unless it is glaringly wrong. You might as well not give us
2234 a chance to make a mistake.
2236 Even if the problem you experience is a fatal signal, you should still
2237 say so explicitly. Suppose something strange is going on, such as, your
2238 copy of the utility is out of synch, or you have encountered a bug in
2239 the C library on your system. (This has happened!) Your copy might
2240 crash and ours would not. If you told us to expect a crash, then when
2241 ours fails to crash, we would know that the bug was not happening for
2242 us. If you had not told us to expect a crash, then we would not be able
2243 to draw any conclusion from our observations.
2246 If you wish to suggest changes to the source, send us context diffs, as
2247 generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
2248 option. Always send diffs from the old file to the new file. If you
2249 even discuss something in the @code{ld} source, refer to it by context,
2252 The line numbers in our development sources will not match those in your
2253 sources. Your line numbers would convey no useful information to us.
2256 Here are some things that are not necessary:
2260 A description of the envelope of the bug.
2262 Often people who encounter a bug spend a lot of time investigating
2263 which changes to the input file will make the bug go away and which
2264 changes will not affect it.
2266 This is often time consuming and not very useful, because the way we
2267 will find the bug is by running a single example under the debugger
2268 with breakpoints, not by pure deduction from a series of examples.
2269 We recommend that you save your time for something else.
2271 Of course, if you can find a simpler example to report @emph{instead}
2272 of the original one, that is a convenience for us. Errors in the
2273 output will be easier to spot, running under the debugger will take
2274 less time, and so on.
2276 However, simplification is not vital; if you do not want to do this,
2277 report the bug anyway and send us the entire test case you used.
2280 A patch for the bug.
2282 A patch for the bug does help us if it is a good one. But do not omit
2283 the necessary information, such as the test case, on the assumption that
2284 a patch is all we need. We might see problems with your patch and decide
2285 to fix the problem another way, or we might not understand it at all.
2287 Sometimes with programs as complicated as the binary utilities it is
2288 very hard to construct an example that will make the program follow a
2289 certain path through the code. If you do not send us the example, we
2290 will not be able to construct one, so we will not be able to verify that
2293 And if we cannot understand what bug you are trying to fix, or why your
2294 patch should be an improvement, we will not install it. A test case will
2295 help us to understand.
2298 A guess about what the bug is or what it depends on.
2300 Such guesses are usually wrong. Even we cannot guess right about such
2301 things without first using the debugger to find the facts.