1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @c Copyright 2001 Free Software Foundation, Inc.
10 * Binutils: (binutils). The GNU binary utilities.
11 * ar: (binutils)ar. Create, modify, and extract from archives
12 * nm: (binutils)nm. List symbols from object files
13 * objcopy: (binutils)objcopy. Copy and translate object files
14 * objdump: (binutils)objdump. Display information from object files
15 * ranlib: (binutils)ranlib. Generate index to archive contents
16 * readelf: (binutils)readelf. Display the contents of ELF format files.
17 * size: (binutils)size. List section sizes and total size
18 * strings: (binutils)strings. List printable strings from files
19 * strip: (binutils)strip. Discard symbols
20 * c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols
21 * cxxfilt: (binutils)c++filt. MS-DOS name for c++filt
22 * addr2line: (binutils)addr2line. Convert addresses to file and line
23 * nlmconv: (binutils)nlmconv. Converts object code into an NLM
24 * windres: (binutils)windres. Manipulate Windows resources
25 * dlltool: (binutils)dlltool. Create files needed to build and use DLLs
31 @c man begin COPYRIGHT
32 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc.
34 Permission is granted to copy, distribute and/or modify this document
35 under the terms of the GNU Free Documentation License, Version 1.1
36 or any later version published by the Free Software Foundation;
37 with no Invariant Sections, with no Front-Cover Texts, and with no
38 Back-Cover Texts. A copy of the license is included in the
39 section entitled "GNU Free Documentation License".
43 Permission is granted to process this file through TeX and print the
44 results, provided the printed document carries a copying permission
45 notice identical to this one except for the removal of this paragraph
46 (this paragraph not being relevant to the printed manual).
53 @c This file documents the GNU binary utilities "ar", "ld", "objcopy",
54 @c "objdump", "nm", "size", "strings", "strip", "readelf" and "ranlib".
56 @c Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc.
58 @c This text may be freely distributed under the terms of the GNU
59 @c Free Documentation License.
62 @setchapternewpage odd
63 @settitle @sc{gnu} Binary Utilities
66 @title The @sc{gnu} Binary Utilities
67 @subtitle Version @value{VERSION}
70 @author Roland H. Pesch
71 @author Jeffrey M. Osier
72 @author Cygnus Support
76 {\parskip=0pt \hfill Cygnus Support\par \hfill
77 \TeX{}info \texinfoversion\par }
80 @vskip 0pt plus 1filll
81 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 1998, 2000, 2001 Free Software Foundation, Inc.
83 Permission is granted to copy, distribute and/or modify this document
84 under the terms of the GNU Free Documentation License, Version 1.1
85 or any later version published by the Free Software Foundation;
86 with no Invariant Sections, with no Front-Cover Texts, and with no
87 Back-Cover Texts. A copy of the license is included in the
88 section entitled "GNU Free Documentation License".
96 This brief manual contains preliminary documentation for the @sc{gnu} binary
97 utilities (collectively version @value{VERSION}):
102 Create, modify, and extract from archives
105 List symbols from object files
108 Copy and translate object files
111 Display information from object files
114 Generate index to archive contents
117 Display the contents of ELF format files.
120 List file section sizes and total size
123 List printable strings from files
129 Demangle encoded C++ symbols (on MS-DOS, this program is named
133 Convert addresses into file names and line numbers
136 Convert object code into a Netware Loadable Module
139 Manipulate Windows resources
142 Create the files needed to build and use Dynamic Link Libraries
146 This document is distributed under the terms of the GNU Free
147 Documentation License. A copy of the license is included in the
148 section entitled "GNU Free Documentation License".
151 * ar:: Create, modify, and extract from archives
152 * nm:: List symbols from object files
153 * objcopy:: Copy and translate object files
154 * objdump:: Display information from object files
155 * ranlib:: Generate index to archive contents
156 * readelf:: Display the contents of ELF format files.
157 * size:: List section sizes and total size
158 * strings:: List printable strings from files
159 * strip:: Discard symbols
160 * c++filt:: Filter to demangle encoded C++ symbols
161 * cxxfilt: c++filt. MS-DOS name for c++filt
162 * addr2line:: Convert addresses to file and line
163 * nlmconv:: Converts object code into an NLM
164 * windres:: Manipulate Windows resources
165 * dlltool:: Create files needed to build and use DLLs
166 * Selecting The Target System:: How these utilities determine the target.
167 * Reporting Bugs:: Reporting Bugs
168 * GNU Free Documentation License:: GNU Free Documentation License
177 @cindex collections of files
179 @c man title ar create, modify, and extract from archives
182 ar [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
183 ar -M [ <mri-script ]
186 @c man begin DESCRIPTION ar
188 The @sc{gnu} @code{ar} program creates, modifies, and extracts from
189 archives. An @dfn{archive} is a single file holding a collection of
190 other files in a structure that makes it possible to retrieve
191 the original individual files (called @dfn{members} of the archive).
193 The original files' contents, mode (permissions), timestamp, owner, and
194 group are preserved in the archive, and can be restored on
198 @sc{gnu} @code{ar} can maintain archives whose members have names of any
199 length; however, depending on how @code{ar} is configured on your
200 system, a limit on member-name length may be imposed for compatibility
201 with archive formats maintained with other tools. If it exists, the
202 limit is often 15 characters (typical of formats related to a.out) or 16
203 characters (typical of formats related to coff).
206 @code{ar} is considered a binary utility because archives of this sort
207 are most often used as @dfn{libraries} holding commonly needed
211 @code{ar} creates an index to the symbols defined in relocatable
212 object modules in the archive when you specify the modifier @samp{s}.
213 Once created, this index is updated in the archive whenever @code{ar}
214 makes a change to its contents (save for the @samp{q} update operation).
215 An archive with such an index speeds up linking to the library, and
216 allows routines in the library to call each other without regard to
217 their placement in the archive.
219 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
220 table. If an archive lacks the table, another form of @code{ar} called
221 @code{ranlib} can be used to add just the table.
223 @cindex compatibility, @code{ar}
224 @cindex @code{ar} compatibility
225 @sc{gnu} @code{ar} is designed to be compatible with two different
226 facilities. You can control its activity using command-line options,
227 like the different varieties of @code{ar} on Unix systems; or, if you
228 specify the single command-line option @samp{-M}, you can control it
229 with a script supplied via standard input, like the MRI ``librarian''
235 * ar cmdline:: Controlling @code{ar} on the command line
236 * ar scripts:: Controlling @code{ar} with a script
241 @section Controlling @code{ar} on the command line
244 @c man begin SYNOPSIS ar
245 ar [-X32_64] [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
249 @cindex Unix compatibility, @code{ar}
250 When you use @code{ar} in the Unix style, @code{ar} insists on at least two
251 arguments to execute: one keyletter specifying the @emph{operation}
252 (optionally accompanied by other keyletters specifying
253 @emph{modifiers}), and the archive name to act on.
255 Most operations can also accept further @var{member} arguments,
256 specifying particular files to operate on.
258 @c man begin OPTIONS ar
260 @sc{gnu} @code{ar} allows you to mix the operation code @var{p} and modifier
261 flags @var{mod} in any order, within the first command-line argument.
263 If you wish, you may begin the first command-line argument with a
266 @cindex operations on archive
267 The @var{p} keyletter specifies what operation to execute; it may be
268 any of the following, but you must specify only one of them:
272 @cindex deleting from archive
273 @emph{Delete} modules from the archive. Specify the names of modules to
274 be deleted as @var{member}@dots{}; the archive is untouched if you
275 specify no files to delete.
277 If you specify the @samp{v} modifier, @code{ar} lists each module
281 @cindex moving in archive
282 Use this operation to @emph{move} members in an archive.
284 The ordering of members in an archive can make a difference in how
285 programs are linked using the library, if a symbol is defined in more
288 If no modifiers are used with @code{m}, any members you name in the
289 @var{member} arguments are moved to the @emph{end} of the archive;
290 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
291 specified place instead.
294 @cindex printing from archive
295 @emph{Print} the specified members of the archive, to the standard
296 output file. If the @samp{v} modifier is specified, show the member
297 name before copying its contents to standard output.
299 If you specify no @var{member} arguments, all the files in the archive are
303 @cindex quick append to archive
304 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
305 @var{archive}, without checking for replacement.
307 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
308 operation; new members are always placed at the end of the archive.
310 The modifier @samp{v} makes @code{ar} list each file as it is appended.
312 Since the point of this operation is speed, the archive's symbol table
313 index is not updated, even if it already existed; you can use @samp{ar s} or
314 @code{ranlib} explicitly to update the symbol table index.
316 However, too many different systems assume quick append rebuilds the
317 index, so GNU ar implements @code{q} as a synonym for @code{r}.
320 @cindex replacement in archive
321 Insert the files @var{member}@dots{} into @var{archive} (with
322 @emph{replacement}). This operation differs from @samp{q} in that any
323 previously existing members are deleted if their names match those being
326 If one of the files named in @var{member}@dots{} does not exist, @code{ar}
327 displays an error message, and leaves undisturbed any existing members
328 of the archive matching that name.
330 By default, new members are added at the end of the file; but you may
331 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
332 placement relative to some existing member.
334 The modifier @samp{v} used with this operation elicits a line of
335 output for each file inserted, along with one of the letters @samp{a} or
336 @samp{r} to indicate whether the file was appended (no old member
337 deleted) or replaced.
340 @cindex contents of archive
341 Display a @emph{table} listing the contents of @var{archive}, or those
342 of the files listed in @var{member}@dots{} that are present in the
343 archive. Normally only the member name is shown; if you also want to
344 see the modes (permissions), timestamp, owner, group, and size, you can
345 request that by also specifying the @samp{v} modifier.
347 If you do not specify a @var{member}, all files in the archive
350 @cindex repeated names in archive
351 @cindex name duplication in archive
352 If there is more than one file with the same name (say, @samp{fie}) in
353 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
354 first instance; to see them all, you must ask for a complete
355 listing---in our example, @samp{ar t b.a}.
356 @c WRS only; per Gumby, this is implementation-dependent, and in a more
357 @c recent case in fact works the other way.
360 @cindex extract from archive
361 @emph{Extract} members (named @var{member}) from the archive. You can
362 use the @samp{v} modifier with this operation, to request that
363 @code{ar} list each name as it extracts it.
365 If you do not specify a @var{member}, all files in the archive
370 A number of modifiers (@var{mod}) may immediately follow the @var{p}
371 keyletter, to specify variations on an operation's behavior:
375 @cindex relative placement in archive
376 Add new files @emph{after} an existing member of the
377 archive. If you use the modifier @samp{a}, the name of an existing archive
378 member must be present as the @var{relpos} argument, before the
379 @var{archive} specification.
382 Add new files @emph{before} an existing member of the
383 archive. If you use the modifier @samp{b}, the name of an existing archive
384 member must be present as the @var{relpos} argument, before the
385 @var{archive} specification. (same as @samp{i}).
388 @cindex creating archives
389 @emph{Create} the archive. The specified @var{archive} is always
390 created if it did not exist, when you request an update. But a warning is
391 issued unless you specify in advance that you expect to create it, by
395 Truncate names in the archive. @sc{gnu} @code{ar} will normally permit file
396 names of any length. This will cause it to create archives which are
397 not compatible with the native @code{ar} program on some systems. If
398 this is a concern, the @samp{f} modifier may be used to truncate file
399 names when putting them in the archive.
402 Insert new files @emph{before} an existing member of the
403 archive. If you use the modifier @samp{i}, the name of an existing archive
404 member must be present as the @var{relpos} argument, before the
405 @var{archive} specification. (same as @samp{b}).
408 This modifier is accepted but not used.
409 @c whaffor ar l modifier??? presumably compat; with
410 @c what???---doc@@cygnus.com, 25jan91
413 Uses the @var{count} parameter. This is used if there are multiple
414 entries in the archive with the same name. Extract or delete instance
415 @var{count} of the given name from the archive.
418 @cindex dates in archive
419 Preserve the @emph{original} dates of members when extracting them. If
420 you do not specify this modifier, files extracted from the archive
421 are stamped with the time of extraction.
424 Use the full path name when matching names in the archive. @sc{gnu}
425 @code{ar} can not create an archive with a full path name (such archives
426 are not POSIX complaint), but other archive creators can. This option
427 will cause @sc{gnu} @code{ar} to match file names using a complete path
428 name, which can be convenient when extracting a single file from an
429 archive created by another tool.
432 @cindex writing archive index
433 Write an object-file index into the archive, or update an existing one,
434 even if no other change is made to the archive. You may use this modifier
435 flag either with any operation, or alone. Running @samp{ar s} on an
436 archive is equivalent to running @samp{ranlib} on it.
439 @cindex not writing archive index
440 Do not generate an archive symbol table. This can speed up building a
441 large library in several steps. The resulting archive can not be used
442 with the linker. In order to build a symbol table, you must omit the
443 @samp{S} modifier on the last execution of @samp{ar}, or you must run
444 @samp{ranlib} on the archive.
447 @cindex updating an archive
448 Normally, @samp{ar r}@dots{} inserts all files
449 listed into the archive. If you would like to insert @emph{only} those
450 of the files you list that are newer than existing members of the same
451 names, use this modifier. The @samp{u} modifier is allowed only for the
452 operation @samp{r} (replace). In particular, the combination @samp{qu} is
453 not allowed, since checking the timestamps would lose any speed
454 advantage from the operation @samp{q}.
457 This modifier requests the @emph{verbose} version of an operation. Many
458 operations display additional information, such as filenames processed,
459 when the modifier @samp{v} is appended.
462 This modifier shows the version number of @code{ar}.
465 @code{ar} ignores an initial option spelt @code{-X32_64}, for
466 compatibility with AIX. The behaviour produced by this option is the
467 default for GNU @code{ar}. @code{ar} does not support any of the other
468 @code{-X} options; in particular, it does not support @code{-X32}
469 which is the default for AIX @code{ar}.
474 @c man begin SEEALSO ar
475 nm(1), ranlib(1), and the Info entries for @file{binutils}.
480 @section Controlling @code{ar} with a script
483 ar -M [ <@var{script} ]
486 @cindex MRI compatibility, @code{ar}
487 @cindex scripts, @code{ar}
488 If you use the single command-line option @samp{-M} with @code{ar}, you
489 can control its operation with a rudimentary command language. This
490 form of @code{ar} operates interactively if standard input is coming
491 directly from a terminal. During interactive use, @code{ar} prompts for
492 input (the prompt is @samp{AR >}), and continues executing even after
493 errors. If you redirect standard input to a script file, no prompts are
494 issued, and @code{ar} abandons execution (with a nonzero exit code)
497 The @code{ar} command language is @emph{not} designed to be equivalent
498 to the command-line options; in fact, it provides somewhat less control
499 over archives. The only purpose of the command language is to ease the
500 transition to @sc{gnu} @code{ar} for developers who already have scripts
501 written for the MRI ``librarian'' program.
503 The syntax for the @code{ar} command language is straightforward:
506 commands are recognized in upper or lower case; for example, @code{LIST}
507 is the same as @code{list}. In the following descriptions, commands are
508 shown in upper case for clarity.
511 a single command may appear on each line; it is the first word on the
515 empty lines are allowed, and have no effect.
518 comments are allowed; text after either of the characters @samp{*}
519 or @samp{;} is ignored.
522 Whenever you use a list of names as part of the argument to an @code{ar}
523 command, you can separate the individual names with either commas or
524 blanks. Commas are shown in the explanations below, for clarity.
527 @samp{+} is used as a line continuation character; if @samp{+} appears
528 at the end of a line, the text on the following line is considered part
529 of the current command.
532 Here are the commands you can use in @code{ar} scripts, or when using
533 @code{ar} interactively. Three of them have special significance:
535 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
536 a temporary file required for most of the other commands.
538 @code{SAVE} commits the changes so far specified by the script. Prior
539 to @code{SAVE}, commands affect only the temporary copy of the current
543 @item ADDLIB @var{archive}
544 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
545 Add all the contents of @var{archive} (or, if specified, each named
546 @var{module} from @var{archive}) to the current archive.
548 Requires prior use of @code{OPEN} or @code{CREATE}.
550 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
551 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
552 @c else like "ar q..."
553 Add each named @var{member} as a module in the current archive.
555 Requires prior use of @code{OPEN} or @code{CREATE}.
558 Discard the contents of the current archive, canceling the effect of
559 any operations since the last @code{SAVE}. May be executed (with no
560 effect) even if no current archive is specified.
562 @item CREATE @var{archive}
563 Creates an archive, and makes it the current archive (required for many
564 other commands). The new archive is created with a temporary name; it
565 is not actually saved as @var{archive} until you use @code{SAVE}.
566 You can overwrite existing archives; similarly, the contents of any
567 existing file named @var{archive} will not be destroyed until @code{SAVE}.
569 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
570 Delete each listed @var{module} from the current archive; equivalent to
571 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
573 Requires prior use of @code{OPEN} or @code{CREATE}.
575 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
576 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
577 List each named @var{module} present in @var{archive}. The separate
578 command @code{VERBOSE} specifies the form of the output: when verbose
579 output is off, output is like that of @samp{ar -t @var{archive}
580 @var{module}@dots{}}. When verbose output is on, the listing is like
581 @samp{ar -tv @var{archive} @var{module}@dots{}}.
583 Output normally goes to the standard output stream; however, if you
584 specify @var{outputfile} as a final argument, @code{ar} directs the
588 Exit from @code{ar}, with a @code{0} exit code to indicate successful
589 completion. This command does not save the output file; if you have
590 changed the current archive since the last @code{SAVE} command, those
593 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
594 Extract each named @var{module} from the current archive, writing them
595 into the current directory as separate files. Equivalent to @samp{ar -x
596 @var{archive} @var{module}@dots{}}.
598 Requires prior use of @code{OPEN} or @code{CREATE}.
601 @c FIXME Tokens but no commands???
608 Display full contents of the current archive, in ``verbose'' style
609 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
610 tv @var{archive}}. (This single command is a @sc{gnu} @code{ar}
611 enhancement, rather than present for MRI compatibility.)
613 Requires prior use of @code{OPEN} or @code{CREATE}.
615 @item OPEN @var{archive}
616 Opens an existing archive for use as the current archive (required for
617 many other commands). Any changes as the result of subsequent commands
618 will not actually affect @var{archive} until you next use @code{SAVE}.
620 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
621 In the current archive, replace each existing @var{module} (named in
622 the @code{REPLACE} arguments) from files in the current working directory.
623 To execute this command without errors, both the file, and the module in
624 the current archive, must exist.
626 Requires prior use of @code{OPEN} or @code{CREATE}.
629 Toggle an internal flag governing the output from @code{DIRECTORY}.
630 When the flag is on, @code{DIRECTORY} output matches output from
631 @samp{ar -tv }@dots{}.
634 Commit your changes to the current archive, and actually save it as a
635 file with the name specified in the last @code{CREATE} or @code{OPEN}
638 Requires prior use of @code{OPEN} or @code{CREATE}.
647 The @sc{gnu} linker @code{ld} is now described in a separate manual.
648 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
656 @c man title nm list symbols from object files
659 @c man begin SYNOPSIS nm
660 nm [ -a | --debug-syms ] [ -g | --extern-only ]
661 [ -B ] [ -C | --demangle[=@var{style}] ] [ -D | --dynamic ]
662 [ -s | --print-armap ] [ -A | -o | --print-file-name ]
663 [ -n | -v | --numeric-sort ] [ -p | --no-sort ]
664 [ -r | --reverse-sort ] [ --size-sort ] [ -u | --undefined-only ]
665 [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ]
666 [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ]
667 [ --defined-only ] [-l | --line-numbers ] [ --no-demangle ]
668 [ -V | --version ] [ -X 32_64 ] [ --help ] [ @var{objfile}@dots{} ]
672 @c man begin DESCRIPTION nm
673 @sc{gnu} @code{nm} lists the symbols from object files @var{objfile}@dots{}.
674 If no object files are listed as arguments, @code{nm} assumes the file
677 For each symbol, @code{nm} shows:
681 The symbol value, in the radix selected by options (see below), or
682 hexadecimal by default.
685 The symbol type. At least the following types are used; others are, as
686 well, depending on the object file format. If lowercase, the symbol is
687 local; if uppercase, the symbol is global (external).
689 @c Some more detail on exactly what these symbol types are used for
693 The symbol's value is absolute, and will not be changed by further
697 The symbol is in the uninitialized data section (known as BSS).
700 The symbol is common. Common symbols are uninitialized data. When
701 linking, multiple common symbols may appear with the same name. If the
702 symbol is defined anywhere, the common symbols are treated as undefined
705 For more details on common symbols, see the discussion of
706 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
710 The symbol is in the initialized data section.
713 The symbol is in an initialized data section for small objects. Some
714 object file formats permit more efficient access to small data objects,
715 such as a global int variable as opposed to a large global array.
718 The symbol is an indirect reference to another symbol. This is a GNU
719 extension to the a.out object file format which is rarely used.
722 The symbol is a debugging symbol.
725 The symbol is in a read only data section.
728 The symbol is in an uninitialized data section for small objects.
731 The symbol is in the text (code) section.
734 The symbol is undefined.
737 The symbol is a weak object. When a weak defined symbol is linked with
738 a normal defined symbol, the normal defined symbol is used with no error.
739 When a weak undefined symbol is linked and the symbol is not defined,
740 the value of the weak symbol becomes zero with no error.
743 The symbol is a weak symbol that has not been specifically tagged as a
744 weak object symbol. When a weak defined symbol is linked with a normal
745 defined symbol, the normal defined symbol is used with no error.
746 When a weak undefined symbol is linked and the symbol is not defined,
747 the value of the weak symbol becomes zero with no error.
750 The symbol is a stabs symbol in an a.out object file. In this case, the
751 next values printed are the stabs other field, the stabs desc field, and
752 the stab type. Stabs symbols are used to hold debugging information;
753 for more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
754 ``stabs'' debug format}.
757 The symbol type is unknown, or object file format specific.
766 @c man begin OPTIONS nm
767 The long and short forms of options, shown here as alternatives, are
773 @itemx --print-file-name
774 @cindex input file name
776 @cindex source file name
777 Precede each symbol by the name of the input file (or archive member)
778 in which it was found, rather than identifying the input file once only,
779 before all of its symbols.
783 @cindex debugging symbols
784 Display all symbols, even debugger-only symbols; normally these are not
788 @cindex @code{nm} format
789 @cindex @code{nm} compatibility
790 The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}).
793 @itemx --demangle[=@var{style}]
794 @cindex demangling in nm
795 Decode (@dfn{demangle}) low-level symbol names into user-level names.
796 Besides removing any initial underscore prepended by the system, this
797 makes C++ function names readable. Different compilers have different
798 mangling styles. The optional demangling style argument can be used to
799 choose an appropriate demangling style for your compiler. @xref{c++filt},
800 for more information on demangling.
803 Do not demangle low-level symbol names. This is the default.
807 @cindex dynamic symbols
808 Display the dynamic symbols rather than the normal symbols. This is
809 only meaningful for dynamic objects, such as certain types of shared
812 @item -f @var{format}
813 @itemx --format=@var{format}
814 @cindex @code{nm} format
815 @cindex @code{nm} compatibility
816 Use the output format @var{format}, which can be @code{bsd},
817 @code{sysv}, or @code{posix}. The default is @code{bsd}.
818 Only the first character of @var{format} is significant; it can be
819 either upper or lower case.
823 @cindex external symbols
824 Display only external symbols.
827 @itemx --line-numbers
828 @cindex symbol line numbers
829 For each symbol, use debugging information to try to find a filename and
830 line number. For a defined symbol, look for the line number of the
831 address of the symbol. For an undefined symbol, look for the line
832 number of a relocation entry which refers to the symbol. If line number
833 information can be found, print it after the other symbol information.
837 @itemx --numeric-sort
838 Sort symbols numerically by their addresses, rather than alphabetically
843 @cindex sorting symbols
844 Do not bother to sort the symbols in any order; print them in the order
849 Use the POSIX.2 standard output format instead of the default format.
850 Equivalent to @samp{-f posix}.
854 @cindex symbol index, listing
855 When listing symbols from archive members, include the index: a mapping
856 (stored in the archive by @code{ar} or @code{ranlib}) of which modules
857 contain definitions for which names.
860 @itemx --reverse-sort
861 Reverse the order of the sort (whether numeric or alphabetic); let the
865 Sort symbols by size. The size is computed as the difference between
866 the value of the symbol and the value of the symbol with the next higher
867 value. The size of the symbol is printed, rather than the value.
870 @itemx --radix=@var{radix}
871 Use @var{radix} as the radix for printing the symbol values. It must be
872 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
874 @item --target=@var{bfdname}
875 @cindex object code format
876 Specify an object code format other than your system's default format.
877 @xref{Target Selection}, for more information.
880 @itemx --undefined-only
881 @cindex external symbols
882 @cindex undefined symbols
883 Display only undefined symbols (those external to each object file).
886 @cindex external symbols
887 @cindex undefined symbols
888 Display only defined symbols for each object file.
892 Show the version number of @code{nm} and exit.
895 This option is ignored for compatibility with the AIX version of
896 @code{nm}. It takes one parameter which must be the string
897 @code{32_64}. The default mode of AIX @code{nm} corresponds
898 to @code{-X 32}, which is not supported by @sc{gnu} @code{nm}.
901 Show a summary of the options to @code{nm} and exit.
907 @c man begin SEEALSO nm
908 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
915 @c man title objcopy copy and translate object files
918 @c man begin SYNOPSIS objcopy
919 objcopy [ -F @var{bfdname} | --target=@var{bfdname} ]
920 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
921 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
922 [ -B @var{bfdarch} | --binary-architecture=@var{bfdarch} ]
923 [ -S | --strip-all ] [ -g | --strip-debug ]
924 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
925 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
926 [ -G @var{symbolname} | --keep-global-symbol=@var{symbolname}]
927 [ -L @var{symbolname} | --localize-symbol=@var{symbolname} ]
928 [ -W @var{symbolname} | --weaken-symbol=@var{symbolname} ]
929 [ -x | --discard-all ] [ -X | --discard-locals ]
930 [ -b @var{byte} | --byte=@var{byte} ]
931 [ -i @var{interleave} | --interleave=@var{interleave} ]
932 [ -j @var{sectionname} | --only-section=@var{sectionname} ]
933 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
934 [ -p | --preserve-dates ] [ --debugging ]
935 [ --gap-fill=@var{val} ] [ --pad-to=@var{address} ]
936 [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ]
937 [ --change-addresses=@var{incr} ]
938 [ --change-section-address @var{section}@{=,+,-@}@var{val} ]
939 [ --change-section-lma @var{section}@{=,+,-@}@var{val} ]
940 [ --change-section-vma @var{section}@{=,+,-@}@var{val} ]
941 [ --change-warnings ] [ --no-change-warnings ]
942 [ --set-section-flags @var{section}=@var{flags} ]
943 [ --add-section @var{sectionname}=@var{filename} ]
944 [ --rename-section @var{oldname}=@var{newname}[,@var{flags}] ]
945 [ --change-leading-char ] [ --remove-leading-char ]
946 [ --srec-len=@var{ival} ] [ --srec-forceS3 ]
947 [ --redefine-sym @var{old}=@var{new} ] [ --weaken ]
948 [ --keep-symbols=@var{filename} ]
949 [ --strip-symbols=@var{filename} ]
950 [ --keep-global-symbols=@var{filename} ]
951 [ --localize-symbols=@var{filename} ]
952 [ --weaken-symbols=@var{filename} ]
953 [ -v | --verbose ] [ -V | --version ] [ --help ]
954 @var{infile} [@var{outfile}]
958 @c man begin DESCRIPTION objcopy
959 The @sc{gnu} @code{objcopy} utility copies the contents of an object
960 file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to
961 read and write the object files. It can write the destination object
962 file in a format different from that of the source object file. The
963 exact behavior of @code{objcopy} is controlled by command-line options.
964 Note that @code{objcopy} should be able to copy a fully linked file
965 between any two formats. However, copying a relocatable object file
966 between any two formats may not work as expected.
968 @code{objcopy} creates temporary files to do its translations and
969 deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its
970 translation work; it has access to all the formats described in @sc{bfd}
971 and thus is able to recognize most formats without being told
972 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
974 @code{objcopy} can be used to generate S-records by using an output
975 target of @samp{srec} (e.g., use @samp{-O srec}).
977 @code{objcopy} can be used to generate a raw binary file by using an
978 output target of @samp{binary} (e.g., use @samp{-O binary}). When
979 @code{objcopy} generates a raw binary file, it will essentially produce
980 a memory dump of the contents of the input object file. All symbols and
981 relocation information will be discarded. The memory dump will start at
982 the load address of the lowest section copied into the output file.
984 When generating an S-record or a raw binary file, it may be helpful to
985 use @samp{-S} to remove sections containing debugging information. In
986 some cases @samp{-R} will be useful to remove sections which contain
987 information that is not needed by the binary file.
989 Note - @code{objcopy} is not able to change the endianness of its input
990 files. If the input format has an endianness, (some formats do not),
991 @code{objcopy} can only copy the inputs into file formats that have the
992 same endianness or which have no endianness (eg @samp{srec}).
996 @c man begin OPTIONS objcopy
1000 @itemx @var{outfile}
1001 The input and output files, respectively.
1002 If you do not specify @var{outfile}, @code{objcopy} creates a
1003 temporary file and destructively renames the result with
1004 the name of @var{infile}.
1006 @item -I @var{bfdname}
1007 @itemx --input-target=@var{bfdname}
1008 Consider the source file's object format to be @var{bfdname}, rather than
1009 attempting to deduce it. @xref{Target Selection}, for more information.
1011 @item -O @var{bfdname}
1012 @itemx --output-target=@var{bfdname}
1013 Write the output file using the object format @var{bfdname}.
1014 @xref{Target Selection}, for more information.
1016 @item -F @var{bfdname}
1017 @itemx --target=@var{bfdname}
1018 Use @var{bfdname} as the object format for both the input and the output
1019 file; i.e., simply transfer data from source to destination with no
1020 translation. @xref{Target Selection}, for more information.
1022 @item -B @var{bfdarch}
1023 @itemx --binary-architecture=@var{bfdarch}
1024 Useful when transforming a raw binary input file into an object file.
1025 In this case the output architecture can be set to @var{bfdarch}. This
1026 option will be ignored if the input file has a known @var{bfdarch}. You
1027 can access this binary data inside a program by referencing the special
1028 symbols that are created by the conversion process. These symbols are
1029 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1030 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1031 an object file and then access it in your code using these symbols.
1033 @item -j @var{sectionname}
1034 @itemx --only-section=@var{sectionname}
1035 Copy only the named section from the input file to the output file.
1036 This option may be given more than once. Note that using this option
1037 inappropriately may make the output file unusable.
1039 @item -R @var{sectionname}
1040 @itemx --remove-section=@var{sectionname}
1041 Remove any section named @var{sectionname} from the output file. This
1042 option may be given more than once. Note that using this option
1043 inappropriately may make the output file unusable.
1047 Do not copy relocation and symbol information from the source file.
1050 @itemx --strip-debug
1051 Do not copy debugging symbols from the source file.
1053 @item --strip-unneeded
1054 Strip all symbols that are not needed for relocation processing.
1056 @item -K @var{symbolname}
1057 @itemx --keep-symbol=@var{symbolname}
1058 Copy only symbol @var{symbolname} from the source file. This option may
1059 be given more than once.
1061 @item -N @var{symbolname}
1062 @itemx --strip-symbol=@var{symbolname}
1063 Do not copy symbol @var{symbolname} from the source file. This option
1064 may be given more than once.
1066 @item -G @var{symbolname}
1067 @itemx --keep-global-symbol=@var{symbolname}
1068 Keep only symbol @var{symbolname} global. Make all other symbols local
1069 to the file, so that they are not visible externally. This option may
1070 be given more than once.
1072 @item -L @var{symbolname}
1073 @itemx --localize-symbol=@var{symbolname}
1074 Make symbol @var{symbolname} local to the file, so that it is not
1075 visible externally. This option may be given more than once.
1077 @item -W @var{symbolname}
1078 @itemx --weaken-symbol=@var{symbolname}
1079 Make symbol @var{symbolname} weak. This option may be given more than once.
1082 @itemx --discard-all
1083 Do not copy non-global symbols from the source file.
1084 @c FIXME any reason to prefer "non-global" to "local" here?
1087 @itemx --discard-locals
1088 Do not copy compiler-generated local symbols.
1089 (These usually start with @samp{L} or @samp{.}.)
1092 @itemx --byte=@var{byte}
1093 Keep only every @var{byte}th byte of the input file (header data is not
1094 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
1095 where @var{interleave} is given by the @samp{-i} or @samp{--interleave}
1096 option, or the default of 4. This option is useful for creating files
1097 to program @sc{rom}. It is typically used with an @code{srec} output
1100 @item -i @var{interleave}
1101 @itemx --interleave=@var{interleave}
1102 Only copy one out of every @var{interleave} bytes. Select which byte to
1103 copy with the @var{-b} or @samp{--byte} option. The default is 4.
1104 @code{objcopy} ignores this option if you do not specify either @samp{-b} or
1108 @itemx --preserve-dates
1109 Set the access and modification dates of the output file to be the same
1110 as those of the input file.
1113 Convert debugging information, if possible. This is not the default
1114 because only certain debugging formats are supported, and the
1115 conversion process can be time consuming.
1117 @item --gap-fill @var{val}
1118 Fill gaps between sections with @var{val}. This operation applies to
1119 the @emph{load address} (LMA) of the sections. It is done by increasing
1120 the size of the section with the lower address, and filling in the extra
1121 space created with @var{val}.
1123 @item --pad-to @var{address}
1124 Pad the output file up to the load address @var{address}. This is
1125 done by increasing the size of the last section. The extra space is
1126 filled in with the value specified by @samp{--gap-fill} (default zero).
1128 @item --set-start @var{val}
1129 Set the start address of the new file to @var{val}. Not all object file
1130 formats support setting the start address.
1132 @item --change-start @var{incr}
1133 @itemx --adjust-start @var{incr}
1134 @cindex changing start address
1135 Change the start address by adding @var{incr}. Not all object file
1136 formats support setting the start address.
1138 @item --change-addresses @var{incr}
1139 @itemx --adjust-vma @var{incr}
1140 @cindex changing object addresses
1141 Change the VMA and LMA addresses of all sections, as well as the start
1142 address, by adding @var{incr}. Some object file formats do not permit
1143 section addresses to be changed arbitrarily. Note that this does not
1144 relocate the sections; if the program expects sections to be loaded at a
1145 certain address, and this option is used to change the sections such
1146 that they are loaded at a different address, the program may fail.
1148 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1149 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1150 @cindex changing section address
1151 Set or change both the VMA address and the LMA address of the named
1152 @var{section}. If @samp{=} is used, the section address is set to
1153 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1154 section address. See the comments under @samp{--change-addresses},
1155 above. If @var{section} does not exist in the input file, a warning will
1156 be issued, unless @samp{--no-change-warnings} is used.
1158 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1159 @cindex changing section LMA
1160 Set or change the LMA address of the named @var{section}. The LMA
1161 address is the address where the section will be loaded into memory at
1162 program load time. Normally this is the same as the VMA address, which
1163 is the address of the section at program run time, but on some systems,
1164 especially those where a program is held in ROM, the two can be
1165 different. If @samp{=} is used, the section address is set to
1166 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1167 section address. See the comments under @samp{--change-addresses},
1168 above. If @var{section} does not exist in the input file, a warning
1169 will be issued, unless @samp{--no-change-warnings} is used.
1171 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1172 @cindex changing section VMA
1173 Set or change the VMA address of the named @var{section}. The VMA
1174 address is the address where the section will be located once the
1175 program has started executing. Normally this is the same as the LMA
1176 address, which is the address where the section will be loaded into
1177 memory, but on some systems, especially those where a program is held in
1178 ROM, the two can be different. If @samp{=} is used, the section address
1179 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1180 from the section address. See the comments under
1181 @samp{--change-addresses}, above. If @var{section} does not exist in
1182 the input file, a warning will be issued, unless
1183 @samp{--no-change-warnings} is used.
1185 @item --change-warnings
1186 @itemx --adjust-warnings
1187 If @samp{--change-section-address} or @samp{--change-section-lma} or
1188 @samp{--change-section-vma} is used, and the named section does not
1189 exist, issue a warning. This is the default.
1191 @item --no-change-warnings
1192 @itemx --no-adjust-warnings
1193 Do not issue a warning if @samp{--change-section-address} or
1194 @samp{--adjust-section-lma} or @samp{--adjust-section-vma} is used, even
1195 if the named section does not exist.
1197 @item --set-section-flags @var{section}=@var{flags}
1198 Set the flags for the named section. The @var{flags} argument is a
1199 comma separated string of flag names. The recognized names are
1200 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1201 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1202 @samp{debug}. You can set the @samp{contents} flag for a section which
1203 does not have contents, but it is not meaningful to clear the
1204 @samp{contents} flag of a section which does have contents--just remove
1205 the section instead. Not all flags are meaningful for all object file
1208 @item --add-section @var{sectionname}=@var{filename}
1209 Add a new section named @var{sectionname} while copying the file. The
1210 contents of the new section are taken from the file @var{filename}. The
1211 size of the section will be the size of the file. This option only
1212 works on file formats which can support sections with arbitrary names.
1214 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1215 Rename a section from @var{oldname} to @var{newname}, optionally
1216 changing the section's flags to @var{flags} in the process. This has
1217 the advantage over usng a linker script to perform the rename in that
1218 the output stays as an object file and does not become a linked
1221 This option is particularly helpful when the input format is binary,
1222 since this will always create a section called .data. If for example,
1223 you wanted instead to create a section called .rodata containing binary
1224 data you could use the following command line to achieve it:
1227 objcopy -I binary -O <output_format> -B <architecture> \
1228 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1229 <input_binary_file> <output_object_file>
1232 @item --change-leading-char
1233 Some object file formats use special characters at the start of
1234 symbols. The most common such character is underscore, which compilers
1235 often add before every symbol. This option tells @code{objcopy} to
1236 change the leading character of every symbol when it converts between
1237 object file formats. If the object file formats use the same leading
1238 character, this option has no effect. Otherwise, it will add a
1239 character, or remove a character, or change a character, as
1242 @item --remove-leading-char
1243 If the first character of a global symbol is a special symbol leading
1244 character used by the object file format, remove the character. The
1245 most common symbol leading character is underscore. This option will
1246 remove a leading underscore from all global symbols. This can be useful
1247 if you want to link together objects of different file formats with
1248 different conventions for symbol names. This is different from
1249 @code{--change-leading-char} because it always changes the symbol name
1250 when appropriate, regardless of the object file format of the output
1253 @item --srec-len=@var{ival}
1254 Meaningful only for srec output. Set the maximum length of the Srecords
1255 being produced to @var{ival}. This length covers both address, data and
1258 @item --srec-forceS3
1259 Meaningful only for srec output. Avoid generation of S1/S2 records,
1260 creating S3-only record format.
1262 @item --redefine-sym @var{old}=@var{new}
1263 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1264 when one is trying link two things together for which you have no
1265 source, and there are name collisions.
1268 Change all global symbols in the file to be weak. This can be useful
1269 when building an object which will be linked against other objects using
1270 the @code{-R} option to the linker. This option is only effective when
1271 using an object file format which supports weak symbols.
1273 @item --keep-symbols=@var{filename}
1274 Apply @samp{--keep-symbol} option to each symbol listed in the file
1275 @var{filename}. @var{filename} is simply a flat file, with one symbol
1276 name per line. Line comments may be introduced by the hash character.
1277 This option may be given more than once.
1279 @item --strip-symbols=@var{filename}
1280 Apply @samp{--strip-symbol} option to each symbol listed in the file
1281 @var{filename}. @var{filename} is simply a flat file, with one symbol
1282 name per line. Line comments may be introduced by the hash character.
1283 This option may be given more than once.
1285 @item --keep-global-symbols=@var{filename}
1286 Apply @samp{--keep-global-symbol} option to each symbol listed in the
1287 file @var{filename}. @var{filename} is simply a flat file, with one
1288 symbol name per line. Line comments may be introduced by the hash
1289 character. This option may be given more than once.
1291 @item --localize-symbols=@var{filename}
1292 Apply @samp{--localize-symbol} option to each symbol listed in the file
1293 @var{filename}. @var{filename} is simply a flat file, with one symbol
1294 name per line. Line comments may be introduced by the hash character.
1295 This option may be given more than once.
1297 @item --weaken-symbols=@var{filename}
1298 Apply @samp{--weaken-symbol} option to each symbol listed in the file
1299 @var{filename}. @var{filename} is simply a flat file, with one symbol
1300 name per line. Line comments may be introduced by the hash character.
1301 This option may be given more than once.
1305 Show the version number of @code{objcopy}.
1309 Verbose output: list all object files modified. In the case of
1310 archives, @samp{objcopy -V} lists all members of the archive.
1313 Show a summary of the options to @code{objcopy}.
1319 @c man begin SEEALSO objcopy
1320 ld(1), objdump(1), and the Info entries for @file{binutils}.
1327 @cindex object file information
1330 @c man title objdump display information from object files.
1333 @c man begin SYNOPSIS objdump
1334 objdump [ -a | --archive-headers ]
1335 [ -b @var{bfdname} | --target=@var{bfdname} ]
1336 [ -C | --demangle[=@var{style}] ]
1337 [ -d | --disassemble ]
1338 [ -D | --disassemble-all ]
1339 [ -z | --disassemble-zeroes ]
1340 [ -EB | -EL | --endian=@{big | little @} ]
1341 [ -f | --file-headers ]
1342 [ --file-start-context ]
1343 [ -g | --debugging ]
1344 [ -h | --section-headers | --headers ]
1346 [ -j @var{section} | --section=@var{section} ]
1347 [ -l | --line-numbers ]
1349 [ -m @var{machine} | --architecture=@var{machine} ]
1350 [ -M @var{options} | --disassembler-options=@var{options}]
1351 [ -p | --private-headers ]
1353 [ -R | --dynamic-reloc ]
1354 [ -s | --full-contents ]
1357 [ -T | --dynamic-syms ]
1358 [ -x | --all-headers ]
1360 [ --start-address=@var{address} ]
1361 [ --stop-address=@var{address} ]
1362 [ --prefix-addresses]
1363 [ --[no-]show-raw-insn ]
1364 [ --adjust-vma=@var{offset} ]
1367 @var{objfile}@dots{}
1371 @c man begin DESCRIPTION objdump
1373 @code{objdump} displays information about one or more object files.
1374 The options control what particular information to display. This
1375 information is mostly useful to programmers who are working on the
1376 compilation tools, as opposed to programmers who just want their
1377 program to compile and work.
1379 @var{objfile}@dots{} are the object files to be examined. When you
1380 specify archives, @code{objdump} shows information on each of the member
1385 @c man begin OPTIONS objdump
1387 The long and short forms of options, shown here as alternatives, are
1388 equivalent. At least one option from the list
1389 @samp{-a,-d,-D,-f,-g,-G,-h,-H,-p,-r,-R,-S,-t,-T,-V,-x} must be given.
1393 @itemx --archive-header
1394 @cindex archive headers
1395 If any of the @var{objfile} files are archives, display the archive
1396 header information (in a format similar to @samp{ls -l}). Besides the
1397 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1398 the object file format of each archive member.
1400 @item --adjust-vma=@var{offset}
1401 @cindex section addresses in objdump
1402 @cindex VMA in objdump
1403 When dumping information, first add @var{offset} to all the section
1404 addresses. This is useful if the section addresses do not correspond to
1405 the symbol table, which can happen when putting sections at particular
1406 addresses when using a format which can not represent section addresses,
1409 @item -b @var{bfdname}
1410 @itemx --target=@var{bfdname}
1411 @cindex object code format
1412 Specify that the object-code format for the object files is
1413 @var{bfdname}. This option may not be necessary; @var{objdump} can
1414 automatically recognize many formats.
1418 objdump -b oasys -m vax -h fu.o
1421 displays summary information from the section headers (@samp{-h}) of
1422 @file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
1423 file in the format produced by Oasys compilers. You can list the
1424 formats available with the @samp{-i} option.
1425 @xref{Target Selection}, for more information.
1428 @itemx --demangle[=@var{style}]
1429 @cindex demangling in objdump
1430 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1431 Besides removing any initial underscore prepended by the system, this
1432 makes C++ function names readable. Different compilers have different
1433 mangling styles. The optional demangling style argument can be used to
1434 choose an appropriate demangling style for your compiler. @xref{c++filt},
1435 for more information on demangling.
1439 Display debugging information. This attempts to parse debugging
1440 information stored in the file and print it out using a C like syntax.
1441 Only certain types of debugging information have been implemented.
1444 @itemx --disassemble
1445 @cindex disassembling object code
1446 @cindex machine instructions
1447 Display the assembler mnemonics for the machine instructions from
1448 @var{objfile}. This option only disassembles those sections which are
1449 expected to contain instructions.
1452 @itemx --disassemble-all
1453 Like @samp{-d}, but disassemble the contents of all sections, not just
1454 those expected to contain instructions.
1456 @item --prefix-addresses
1457 When disassembling, print the complete address on each line. This is
1458 the older disassembly format.
1460 @item --disassemble-zeroes
1461 Normally the disassembly output will skip blocks of zeroes. This
1462 option directs the disassembler to disassemble those blocks, just like
1467 @itemx --endian=@{big|little@}
1469 @cindex disassembly endianness
1470 Specify the endianness of the object files. This only affects
1471 disassembly. This can be useful when disassembling a file format which
1472 does not describe endianness information, such as S-records.
1475 @itemx --file-header
1476 @cindex object file header
1477 Display summary information from the overall header of
1478 each of the @var{objfile} files.
1480 @item --file-start-context
1481 @cindex source code context
1482 Specify that when displaying interlisted source code/disassembly
1483 (assumes '-S') from a file that has not yet been displayed, extend the
1484 context to the start of the file.
1487 @itemx --section-header
1489 @cindex section headers
1490 Display summary information from the section headers of the
1493 File segments may be relocated to nonstandard addresses, for example by
1494 using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
1495 @code{ld}. However, some object file formats, such as a.out, do not
1496 store the starting address of the file segments. In those situations,
1497 although @code{ld} relocates the sections correctly, using @samp{objdump
1498 -h} to list the file section headers cannot show the correct addresses.
1499 Instead, it shows the usual addresses, which are implicit for the
1503 Print a summary of the options to @code{objdump} and exit.
1507 @cindex architectures available
1508 @cindex object formats available
1509 Display a list showing all architectures and object formats available
1510 for specification with @samp{-b} or @samp{-m}.
1513 @itemx --section=@var{name}
1514 @cindex section information
1515 Display information only for section @var{name}.
1518 @itemx --line-numbers
1519 @cindex source filenames for object files
1520 Label the display (using debugging information) with the filename and
1521 source line numbers corresponding to the object code or relocs shown.
1522 Only useful with @samp{-d}, @samp{-D}, or @samp{-r}.
1524 @item -m @var{machine}
1525 @itemx --architecture=@var{machine}
1526 @cindex architecture
1527 @cindex disassembly architecture
1528 Specify the architecture to use when disassembling object files. This
1529 can be useful when disassembling object files which do not describe
1530 architecture information, such as S-records. You can list the available
1531 architectures with the @samp{-i} option.
1533 @item -M @var{options}
1534 @itemx --disassembler-options=@var{options}
1535 Pass target specific information to the disassembler. Only supported on
1538 If the target is an ARM architecture then this switch can be used to
1539 select which register name set is used during disassembler. Specifying
1540 @samp{-M reg-name-std} (the default) will select the register names as
1541 used in ARM's instruction set documentation, but with register 13 called
1542 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
1543 @samp{-M reg-names-apcs} will select the name set used by the ARM
1544 Procedure Call Standard, whilst specifying @samp{-M reg-names-raw} will
1545 just use @samp{r} followed by the register number.
1547 There are also two variants on the APCS register naming scheme enabled
1548 by @samp{-M reg-names-atpcs} and @samp{-M reg-names-special-atpcs} which
1549 use the ARM/Thumb Procedure Call Standard naming conventions. (Eiuther
1550 with the normal register name sor the special register names).
1552 This option can also be used for ARM architectures to force the
1553 disassembler to interpret all instructions as THUMB instructions by
1554 using the switch @samp{--disassembler-options=force-thumb}. This can be
1555 useful when attempting to disassemble thumb code produced by other
1559 @itemx --private-headers
1560 Print information that is specific to the object file format. The exact
1561 information printed depends upon the object file format. For some
1562 object file formats, no additional information is printed.
1566 @cindex relocation entries, in object file
1567 Print the relocation entries of the file. If used with @samp{-d} or
1568 @samp{-D}, the relocations are printed interspersed with the
1572 @itemx --dynamic-reloc
1573 @cindex dynamic relocation entries, in object file
1574 Print the dynamic relocation entries of the file. This is only
1575 meaningful for dynamic objects, such as certain types of shared
1579 @itemx --full-contents
1580 @cindex sections, full contents
1581 @cindex object file sections
1582 Display the full contents of any sections requested.
1586 @cindex source disassembly
1587 @cindex disassembly, with source
1588 Display source code intermixed with disassembly, if possible. Implies
1591 @item --show-raw-insn
1592 When disassembling instructions, print the instruction in hex as well as
1593 in symbolic form. This is the default except when
1594 @code{--prefix-addresses} is used.
1596 @item --no-show-raw-insn
1597 When disassembling instructions, do not print the instruction bytes.
1598 This is the default when @code{--prefix-addresses} is used.
1604 @cindex debug symbols
1605 @cindex ELF object file format
1606 Display the full contents of any sections requested. Display the
1607 contents of the .stab and .stab.index and .stab.excl sections from an
1608 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1609 @code{.stab} debugging symbol-table entries are carried in an ELF
1610 section. In most other file formats, debugging symbol-table entries are
1611 interleaved with linkage symbols, and are visible in the @samp{--syms}
1614 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1615 Overview,stabs.info, The ``stabs'' debug format}.
1618 @item --start-address=@var{address}
1619 @cindex start-address
1620 Start displaying data at the specified address. This affects the output
1621 of the @code{-d}, @code{-r} and @code{-s} options.
1623 @item --stop-address=@var{address}
1624 @cindex stop-address
1625 Stop displaying data at the specified address. This affects the output
1626 of the @code{-d}, @code{-r} and @code{-s} options.
1630 @cindex symbol table entries, printing
1631 Print the symbol table entries of the file.
1632 This is similar to the information provided by the @samp{nm} program.
1635 @itemx --dynamic-syms
1636 @cindex dynamic symbol table entries, printing
1637 Print the dynamic symbol table entries of the file. This is only
1638 meaningful for dynamic objects, such as certain types of shared
1639 libraries. This is similar to the information provided by the @samp{nm}
1640 program when given the @samp{-D} (@samp{--dynamic}) option.
1643 Print the version number of @code{objdump} and exit.
1647 @cindex all header information, object file
1648 @cindex header information, all
1649 Display all available header information, including the symbol table and
1650 relocation entries. Using @samp{-x} is equivalent to specifying all of
1651 @samp{-a -f -h -r -t}.
1655 @cindex wide output, printing
1656 Format some lines for output devices that have more than 80 columns.
1662 @c man begin SEEALSO objdump
1663 nm(1), readelf(1), and the Info entries for @file{binutils}.
1671 @cindex archive contents
1672 @cindex symbol index
1674 @c man title ranlib generate index to archive.
1677 @c man begin SYNOPSIS ranlib
1678 ranlib [-vV] @var{archive}
1682 @c man begin DESCRIPTION ranlib
1684 @code{ranlib} generates an index to the contents of an archive and
1685 stores it in the archive. The index lists each symbol defined by a
1686 member of an archive that is a relocatable object file.
1688 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
1690 An archive with such an index speeds up linking to the library and
1691 allows routines in the library to call each other without regard to
1692 their placement in the archive.
1694 The @sc{gnu} @code{ranlib} program is another form of @sc{gnu} @code{ar}; running
1695 @code{ranlib} is completely equivalent to executing @samp{ar -s}.
1700 @c man begin OPTIONS ranlib
1706 Show the version number of @code{ranlib}.
1712 @c man begin SEEALSO ranlib
1713 ar(1), nm(1), and the Info entries for @file{binutils}.
1721 @cindex section sizes
1723 @c man title size list section sizes and total size.
1726 @c man begin SYNOPSIS size
1727 size [ -A | -B | --format=@var{compatibility} ]
1728 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
1729 [ --target=@var{bfdname} ] [ -V | --version ]
1730 [ @var{objfile}@dots{} ]
1734 @c man begin DESCRIPTION size
1736 The @sc{gnu} @code{size} utility lists the section sizes---and the total
1737 size---for each of the object or archive files @var{objfile} in its
1738 argument list. By default, one line of output is generated for each
1739 object file or each module in an archive.
1741 @var{objfile}@dots{} are the object files to be examined.
1742 If none are specified, the file @code{a.out} will be used.
1746 @c man begin OPTIONS size
1748 The command line options have the following meanings:
1753 @itemx --format=@var{compatibility}
1754 @cindex @code{size} display format
1755 Using one of these options, you can choose whether the output from @sc{gnu}
1756 @code{size} resembles output from System V @code{size} (using @samp{-A},
1757 or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
1758 @samp{--format=berkeley}). The default is the one-line format similar to
1760 @c Bonus for doc-source readers: you can also say --format=strange (or
1761 @c anything else that starts with 's') for sysv, and --format=boring (or
1762 @c anything else that starts with 'b') for Berkeley.
1764 Here is an example of the Berkeley (default) format of output from
1767 $ size --format=Berkeley ranlib size
1768 text data bss dec hex filename
1769 294880 81920 11592 388392 5ed28 ranlib
1770 294880 81920 11888 388688 5ee50 size
1774 This is the same data, but displayed closer to System V conventions:
1777 $ size --format=SysV ranlib size
1795 Show a summary of acceptable arguments and options.
1800 @itemx --radix=@var{number}
1801 @cindex @code{size} number format
1802 @cindex radix for section sizes
1803 Using one of these options, you can control whether the size of each
1804 section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1805 (@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1806 @samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
1807 values (8, 10, 16) are supported. The total size is always given in two
1808 radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1809 octal and hexadecimal if you're using @samp{-o}.
1811 @item --target=@var{bfdname}
1812 @cindex object code format
1813 Specify that the object-code format for @var{objfile} is
1814 @var{bfdname}. This option may not be necessary; @code{size} can
1815 automatically recognize many formats.
1816 @xref{Target Selection}, for more information.
1820 Display the version number of @code{size}.
1826 @c man begin SEEALSO size
1827 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
1834 @cindex listings strings
1835 @cindex printing strings
1836 @cindex strings, printing
1838 @c man title strings print the strings of printable characters in files.
1841 @c man begin SYNOPSIS strings
1842 strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
1843 [--all] [--print-file-name] [--bytes=@var{min-len}]
1844 [--radix=@var{radix}] [--target=@var{bfdname}]
1845 [--help] [--version] @var{file}@dots{}
1849 @c man begin DESCRIPTION strings
1851 For each @var{file} given, @sc{gnu} @code{strings} prints the printable
1852 character sequences that are at least 4 characters long (or the number
1853 given with the options below) and are followed by an unprintable
1854 character. By default, it only prints the strings from the initialized
1855 and loaded sections of object files; for other types of files, it prints
1856 the strings from the whole file.
1858 @code{strings} is mainly useful for determining the contents of non-text
1863 @c man begin OPTIONS strings
1869 Do not scan only the initialized and loaded sections of object files;
1870 scan the whole files.
1873 @itemx --print-file-name
1874 Print the name of the file before each string.
1877 Print a summary of the program usage on the standard output and exit.
1879 @item -@var{min-len}
1880 @itemx -n @var{min-len}
1881 @itemx --bytes=@var{min-len}
1882 Print sequences of characters that are at least @var{min-len} characters
1883 long, instead of the default 4.
1886 Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1887 act like @samp{-t d} instead. Since we can not be compatible with both
1888 ways, we simply chose one.
1890 @item -t @var{radix}
1891 @itemx --radix=@var{radix}
1892 Print the offset within the file before each string. The single
1893 character argument specifies the radix of the offset---@samp{o} for
1894 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1896 @item --target=@var{bfdname}
1897 @cindex object code format
1898 Specify an object code format other than your system's default format.
1899 @xref{Target Selection}, for more information.
1903 Print the program version number on the standard output and exit.
1909 @c man begin SEEALSO strings
1910 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
1911 and the Info entries for @file{binutils}.
1919 @cindex removing symbols
1920 @cindex discarding symbols
1921 @cindex symbols, discarding
1923 @c man title strip Discard symbols from object files.
1926 @c man begin SYNOPSIS strip
1927 strip [ -F @var{bfdname} | --target=@var{bfdname} ]
1928 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1929 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
1930 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
1931 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
1932 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
1933 [ -x | --discard-all ] [ -X | --discard-locals ]
1934 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
1935 [ -o @var{file} ] [ -p | --preserve-dates ]
1936 [ -v | --verbose ] [ -V | --version ] [ --help ]
1937 @var{objfile}@dots{}
1941 @c man begin DESCRIPTION strip
1943 @sc{gnu} @code{strip} discards all symbols from object files
1944 @var{objfile}. The list of object files may include archives.
1945 At least one object file must be given.
1947 @code{strip} modifies the files named in its argument,
1948 rather than writing modified copies under different names.
1952 @c man begin OPTIONS strip
1955 @item -F @var{bfdname}
1956 @itemx --target=@var{bfdname}
1957 Treat the original @var{objfile} as a file with the object
1958 code format @var{bfdname}, and rewrite it in the same format.
1959 @xref{Target Selection}, for more information.
1962 Show a summary of the options to @code{strip} and exit.
1964 @item -I @var{bfdname}
1965 @itemx --input-target=@var{bfdname}
1966 Treat the original @var{objfile} as a file with the object
1967 code format @var{bfdname}.
1968 @xref{Target Selection}, for more information.
1970 @item -O @var{bfdname}
1971 @itemx --output-target=@var{bfdname}
1972 Replace @var{objfile} with a file in the output format @var{bfdname}.
1973 @xref{Target Selection}, for more information.
1975 @item -R @var{sectionname}
1976 @itemx --remove-section=@var{sectionname}
1977 Remove any section named @var{sectionname} from the output file. This
1978 option may be given more than once. Note that using this option
1979 inappropriately may make the output file unusable.
1987 @itemx --strip-debug
1988 Remove debugging symbols only.
1990 @item --strip-unneeded
1991 Remove all symbols that are not needed for relocation processing.
1993 @item -K @var{symbolname}
1994 @itemx --keep-symbol=@var{symbolname}
1995 Keep only symbol @var{symbolname} from the source file. This option may
1996 be given more than once.
1998 @item -N @var{symbolname}
1999 @itemx --strip-symbol=@var{symbolname}
2000 Remove symbol @var{symbolname} from the source file. This option may be
2001 given more than once, and may be combined with strip options other than
2005 Put the stripped output in @var{file}, rather than replacing the
2006 existing file. When this argument is used, only one @var{objfile}
2007 argument may be specified.
2010 @itemx --preserve-dates
2011 Preserve the access and modification dates of the file.
2014 @itemx --discard-all
2015 Remove non-global symbols.
2018 @itemx --discard-locals
2019 Remove compiler-generated local symbols.
2020 (These usually start with @samp{L} or @samp{.}.)
2024 Show the version number for @code{strip}.
2028 Verbose output: list all object files modified. In the case of
2029 archives, @samp{strip -v} lists all members of the archive.
2035 @c man begin SEEALSO strip
2036 the Info entries for @file{binutils}.
2040 @node c++filt, addr2line, strip, Top
2044 @cindex demangling C++ symbols
2046 @c man title cxxfilt Demangle C++ and Java symbols.
2049 @c man begin SYNOPSIS cxxfilt
2050 c++filt [ -_ | --strip-underscores ]
2052 [ -n | --no-strip-underscores ]
2053 [ -s @var{format} | --format=@var{format} ]
2054 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
2058 @c man begin DESCRIPTION cxxfilt
2061 The C++ and Java languages provides function overloading, which means
2062 that you can write many functions with the same name (providing each
2063 takes parameters of different types). All C++ and Java function names
2064 are encoded into a low-level assembly label (this process is known as
2065 @dfn{mangling}). The @code{c++filt}
2066 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2067 MS-DOS this program is named @code{cxxfilt}.}
2068 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2069 names into user-level names so that the linker can keep these overloaded
2070 functions from clashing.
2072 Every alphanumeric word (consisting of letters, digits, underscores,
2073 dollars, or periods) seen in the input is a potential label. If the
2074 label decodes into a C++ name, the C++ name replaces the low-level
2077 You can use @code{c++filt} to decipher individual symbols:
2080 c++filt @var{symbol}
2083 If no @var{symbol} arguments are given, @code{c++filt} reads symbol
2084 names from the standard input and writes the demangled names to the
2085 standard output. All results are printed on the standard output.
2089 @c man begin OPTIONS cxxfilt
2093 @itemx --strip-underscores
2094 On some systems, both the C and C++ compilers put an underscore in front
2095 of every name. For example, the C name @code{foo} gets the low-level
2096 name @code{_foo}. This option removes the initial underscore. Whether
2097 @code{c++filt} removes the underscore by default is target dependent.
2101 Prints demangled names using Java syntax. The default is to use C++
2105 @itemx --no-strip-underscores
2106 Do not remove the initial underscore.
2108 @item -s @var{format}
2109 @itemx --format=@var{format}
2110 @sc{gnu} @code{nm} can decode three different methods of mangling, used by
2111 different C++ compilers. The argument to this option selects which
2116 the one used by the @sc{gnu} compiler (the default method)
2118 the one used by the Lucid compiler
2120 the one specified by the C++ Annotated Reference Manual
2122 the one used by the HP compiler
2124 the one used by the EDG compiler
2126 the one used by the @sc{gnu} compiler with the new ABI.
2130 Print a summary of the options to @code{c++filt} and exit.
2133 Print the version number of @code{c++filt} and exit.
2139 @c man begin SEEALSO cxxfilt
2140 the Info entries for @file{binutils}.
2145 @emph{Warning:} @code{c++filt} is a new utility, and the details of its
2146 user interface are subject to change in future releases. In particular,
2147 a command-line option may be required in the the future to decode a name
2148 passed as an argument on the command line; in other words,
2151 c++filt @var{symbol}
2155 may in a future release become
2158 c++filt @var{option} @var{symbol}
2166 @cindex address to file name and line number
2168 @c man title addr2line convert addresses into file names and line numbers.
2171 @c man begin SYNOPSIS addr2line
2172 addr2line [ -b @var{bfdname} | --target=@var{bfdname} ]
2173 [ -C | --demangle[=@var{style} ]
2174 [ -e @var{filename} | --exe=@var{filename} ]
2175 [ -f | --functions ] [ -s | --basename ]
2176 [ -H | --help ] [ -V | --version ]
2181 @c man begin DESCRIPTION addr2line
2183 @code{addr2line} translates program addresses into file names and line
2184 numbers. Given an address and an executable, it uses the debugging
2185 information in the executable to figure out which file name and line
2186 number are associated with a given address.
2188 The executable to use is specified with the @code{-e} option. The
2189 default is the file @file{a.out}.
2191 @code{addr2line} has two modes of operation.
2193 In the first, hexadecimal addresses are specified on the command line,
2194 and @code{addr2line} displays the file name and line number for each
2197 In the second, @code{addr2line} reads hexadecimal addresses from
2198 standard input, and prints the file name and line number for each
2199 address on standard output. In this mode, @code{addr2line} may be used
2200 in a pipe to convert dynamically chosen addresses.
2202 The format of the output is @samp{FILENAME:LINENO}. The file name and
2203 line number for each address is printed on a separate line. If the
2204 @code{-f} option is used, then each @samp{FILENAME:LINENO} line is
2205 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2206 containing the address.
2208 If the file name or function name can not be determined,
2209 @code{addr2line} will print two question marks in their place. If the
2210 line number can not be determined, @code{addr2line} will print 0.
2214 @c man begin OPTIONS addr2line
2216 The long and short forms of options, shown here as alternatives, are
2220 @item -b @var{bfdname}
2221 @itemx --target=@var{bfdname}
2222 @cindex object code format
2223 Specify that the object-code format for the object files is
2227 @itemx --demangle[=@var{style}]
2228 @cindex demangling in objdump
2229 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2230 Besides removing any initial underscore prepended by the system, this
2231 makes C++ function names readable. Different compilers have different
2232 mangling styles. The optional demangling style argument can be used to
2233 choose an appropriate demangling style for your compiler. @xref{c++filt},
2234 for more information on demangling.
2236 @item -e @var{filename}
2237 @itemx --exe=@var{filename}
2238 Specify the name of the executable for which addresses should be
2239 translated. The default file is @file{a.out}.
2243 Display function names as well as file and line number information.
2247 Display only the base of each file name.
2253 @c man begin SEEALSO addr2line
2254 Info entries for @file{binutils}.
2261 @code{nlmconv} converts a relocatable object file into a NetWare
2265 @code{nlmconv} currently works with @samp{i386} object
2266 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
2267 object files in @sc{elf}, or @code{a.out} format@footnote{
2268 @code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
2269 format in the Binary File Descriptor library. It has only been tested
2270 with the above formats.}.
2274 @emph{Warning:} @code{nlmconv} is not always built as part of the binary
2275 utilities, since it is only useful for NLM targets.
2278 @c man title nlmconv converts object code into an NLM.
2281 @c man begin SYNOPSIS nlmconv
2282 nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
2283 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
2284 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
2285 [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
2286 [ -h | --help ] [ -V | --version ]
2287 @var{infile} @var{outfile}
2291 @c man begin DESCRIPTION nlmconv
2293 @code{nlmconv} converts the relocatable @samp{i386} object file
2294 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
2295 reading @var{headerfile} for NLM header information. For instructions
2296 on writing the NLM command file language used in header files, see the
2297 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
2298 Development and Tools Overview}, which is part of the NLM Software
2299 Developer's Kit (``NLM SDK''), available from Novell, Inc.
2300 @code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
2303 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
2306 @code{nlmconv} can perform a link step. In other words, you can list
2307 more than one object file for input if you list them in the definitions
2308 file (rather than simply specifying one input file on the command line).
2309 In this case, @code{nlmconv} calls the linker for you.
2313 @c man begin OPTIONS nlmconv
2316 @item -I @var{bfdname}
2317 @itemx --input-target=@var{bfdname}
2318 Object format of the input file. @code{nlmconv} can usually determine
2319 the format of a given file (so no default is necessary).
2320 @xref{Target Selection}, for more information.
2322 @item -O @var{bfdname}
2323 @itemx --output-target=@var{bfdname}
2324 Object format of the output file. @code{nlmconv} infers the output
2325 format based on the input format, e.g. for a @samp{i386} input file the
2326 output format is @samp{nlm32-i386}.
2327 @xref{Target Selection}, for more information.
2329 @item -T @var{headerfile}
2330 @itemx --header-file=@var{headerfile}
2331 Reads @var{headerfile} for NLM header information. For instructions on
2332 writing the NLM command file language used in header files, see@ see the
2333 @samp{linkers} section, of the @cite{NLM Development and Tools
2334 Overview}, which is part of the NLM Software Developer's Kit, available
2339 Displays (on standard error) the linker command line used by @code{nlmconv}.
2341 @item -l @var{linker}
2342 @itemx --linker=@var{linker}
2343 Use @var{linker} for any linking. @var{linker} can be an absolute or a
2348 Prints a usage summary.
2352 Prints the version number for @code{nlmconv}.
2358 @c man begin SEEALSO nlmconv
2359 the Info entries for @file{binutils}.
2366 @code{windres} may be used to manipulate Windows resources.
2369 @emph{Warning:} @code{windres} is not always built as part of the binary
2370 utilities, since it is only useful for Windows targets.
2373 @c man title windres manipulate Windows resources.
2376 @c man begin SYNOPSIS windres
2377 windres [options] [input-file] [output-file]
2381 @c man begin DESCRIPTION windres
2383 @code{windres} reads resources from an input file and copies them into
2384 an output file. Either file may be in one of three formats:
2388 A text format read by the Resource Compiler.
2391 A binary format generated by the Resource Compiler.
2394 A COFF object or executable.
2397 The exact description of these different formats is available in
2398 documentation from Microsoft.
2400 When @code{windres} converts from the @code{rc} format to the @code{res}
2401 format, it is acting like the Windows Resource Compiler. When
2402 @code{windres} converts from the @code{res} format to the @code{coff}
2403 format, it is acting like the Windows @code{CVTRES} program.
2405 When @code{windres} generates an @code{rc} file, the output is similar
2406 but not identical to the format expected for the input. When an input
2407 @code{rc} file refers to an external filename, an output @code{rc} file
2408 will instead include the file contents.
2410 If the input or output format is not specified, @code{windres} will
2411 guess based on the file name, or, for the input file, the file contents.
2412 A file with an extension of @file{.rc} will be treated as an @code{rc}
2413 file, a file with an extension of @file{.res} will be treated as a
2414 @code{res} file, and a file with an extension of @file{.o} or
2415 @file{.exe} will be treated as a @code{coff} file.
2417 If no output file is specified, @code{windres} will print the resources
2418 in @code{rc} format to standard output.
2420 The normal use is for you to write an @code{rc} file, use @code{windres}
2421 to convert it to a COFF object file, and then link the COFF file into
2422 your application. This will make the resources described in the
2423 @code{rc} file available to Windows.
2427 @c man begin OPTIONS windres
2430 @item -i @var{filename}
2431 @itemx --input @var{filename}
2432 The name of the input file. If this option is not used, then
2433 @code{windres} will use the first non-option argument as the input file
2434 name. If there are no non-option arguments, then @code{windres} will
2435 read from standard input. @code{windres} can not read a COFF file from
2438 @item -o @var{filename}
2439 @itemx --output @var{filename}
2440 The name of the output file. If this option is not used, then
2441 @code{windres} will use the first non-option argument, after any used
2442 for the input file name, as the output file name. If there is no
2443 non-option argument, then @code{windres} will write to standard output.
2444 @code{windres} can not write a COFF file to standard output.
2446 @item -I @var{format}
2447 @itemx --input-format @var{format}
2448 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
2449 @samp{coff}. If no input format is specified, @code{windres} will
2450 guess, as described above.
2452 @item -O @var{format}
2453 @itemx --output-format @var{format}
2454 The output format to generate. @var{format} may be @samp{res},
2455 @samp{rc}, or @samp{coff}. If no output format is specified,
2456 @code{windres} will guess, as described above.
2458 @item -F @var{target}
2459 @itemx --target @var{target}
2460 Specify the BFD format to use for a COFF file as input or output. This
2461 is a BFD target name; you can use the @code{--help} option to see a list
2462 of supported targets. Normally @code{windres} will use the default
2463 format, which is the first one listed by the @code{--help} option.
2464 @ref{Target Selection}.
2466 @item --preprocessor @var{program}
2467 When @code{windres} reads an @code{rc} file, it runs it through the C
2468 preprocessor first. This option may be used to specify the preprocessor
2469 to use, including any leading arguments. The default preprocessor
2470 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
2472 @item --include-dir @var{directory}
2473 Specify an include directory to use when reading an @code{rc} file.
2474 @code{windres} will pass this to the preprocessor as an @code{-I}
2475 option. @code{windres} will also search this directory when looking for
2476 files named in the @code{rc} file.
2478 @item -D @var{target}
2479 @itemx --define @var{sym}[=@var{val}]
2480 Specify a @code{-D} option to pass to the preprocessor when reading an
2484 Enable verbose mode. This tells you what the preprocessor is if you
2487 @item --language @var{val}
2488 Specify the default language to use when reading an @code{rc} file.
2489 @var{val} should be a hexadecimal language code. The low eight bits are
2490 the language, and the high eight bits are the sublanguage.
2492 @item --use-temp-file
2493 Use a temporary file to instead of using popen to read the output of
2494 the preprocessor. Use this option if the popen implementation is buggy
2495 on the host (eg., certain non-English language versions of Windows 95 and
2496 Windows 98 are known to have buggy popen where the output will instead
2499 @item --no-use-temp-file
2500 Use popen, not a temporary file, to read the output of the preprocessor.
2501 This is the default behaviour.
2504 Prints a usage summary.
2507 Prints the version number for @code{windres}.
2510 If @code{windres} is compiled with @code{YYDEBUG} defined as @code{1},
2511 this will turn on parser debugging.
2517 @c man begin SEEALSO windres
2518 the Info entries for @file{binutils}.
2523 @chapter Create files needed to build and use DLLs
2527 @code{dlltool} may be used to create the files needed to build and use
2528 dynamic link libraries (DLLs).
2531 @emph{Warning:} @code{dlltool} is not always built as part of the binary
2532 utilities, since it is only useful for those targets which support DLLs.
2535 @c man title dlltool Create files needed to build and use DLLs.
2538 @c man begin SYNOPSIS dlltool
2539 dlltool [-d|--input-def @var{def-file-name}]
2540 [-b|--base-file @var{base-file-name}]
2541 [-e|--output-exp @var{exports-file-name}]
2542 [-z|--output-def @var{def-file-name}]
2543 [-l|--output-lib @var{library-file-name}]
2544 [--export-all-symbols] [--no-export-all-symbols]
2545 [--exclude-symbols @var{list}]
2546 [--no-default-excludes]
2547 [-S|--as @var{path-to-assembler}] [-f|--as-flags @var{options}]
2548 [-D|--dllname @var{name}] [-m|--machine @var{machine}]
2549 [-a|--add-indirect] [-U|--add-underscore] [-k|--kill-at]
2550 [-A|--add-stdcall-alias]
2551 [-x|--no-idata4] [-c|--no-idata5] [-i|--interwork]
2552 [-n|--nodelete] [-v|--verbose] [-h|--help] [-V|--version]
2553 [object-file @dots{}]
2557 @c man begin DESCRIPTION dlltool
2559 @code{dlltool} reads its inputs, which can come from the @samp{-d} and
2560 @samp{-b} options as well as object files specified on the command
2561 line. It then processes these inputs and if the @samp{-e} option has
2562 been specified it creates a exports file. If the @samp{-l} option
2563 has been specified it creates a library file and if the @samp{-z} option
2564 has been specified it creates a def file. Any or all of the -e, -l
2565 and -z options can be present in one invocation of dlltool.
2567 When creating a DLL, along with the source for the DLL, it is necessary
2568 to have three other files. @code{dlltool} can help with the creation of
2571 The first file is a @samp{.def} file which specifies which functions are
2572 exported from the DLL, which functions the DLL imports, and so on. This
2573 is a text file and can be created by hand, or @code{dlltool} can be used
2574 to create it using the @samp{-z} option. In this case @code{dlltool}
2575 will scan the object files specified on its command line looking for
2576 those functions which have been specially marked as being exported and
2577 put entries for them in the .def file it creates.
2579 In order to mark a function as being exported from a DLL, it needs to
2580 have an @samp{-export:<name_of_function>} entry in the @samp{.drectve}
2581 section of the object file. This can be done in C by using the
2585 asm (".section .drectve");
2586 asm (".ascii \"-export:my_func\"");
2588 int my_func (void) @{ @dots{} @}
2591 The second file needed for DLL creation is an exports file. This file
2592 is linked with the object files that make up the body of the DLL and it
2593 handles the interface between the DLL and the outside world. This is a
2594 binary file and it can be created by giving the @samp{-e} option to
2595 @code{dlltool} when it is creating or reading in a .def file.
2597 The third file needed for DLL creation is the library file that programs
2598 will link with in order to access the functions in the DLL. This file
2599 can be created by giving the @samp{-l} option to dlltool when it
2600 is creating or reading in a .def file.
2602 @code{dlltool} builds the library file by hand, but it builds the
2603 exports file by creating temporary files containing assembler statements
2604 and then assembling these. The @samp{-S} command line option can be
2605 used to specify the path to the assembler that dlltool will use,
2606 and the @samp{-f} option can be used to pass specific flags to that
2607 assembler. The @samp{-n} can be used to prevent dlltool from deleting
2608 these temporary assembler files when it is done, and if @samp{-n} is
2609 specified twice then this will prevent dlltool from deleting the
2610 temporary object files it used to build the library.
2612 Here is an example of creating a DLL from a source file @samp{dll.c} and
2613 also creating a program (from an object file called @samp{program.o})
2618 dlltool -e exports.o -l dll.lib dll.o
2619 gcc dll.o exports.o -o dll.dll
2620 gcc program.o dll.lib -o program
2625 @c man begin OPTIONS dlltool
2627 The command line options have the following meanings:
2631 @item -d @var{filename}
2632 @itemx --input-def @var{filename}
2633 @cindex input .def file
2634 Specifies the name of a .def file to be read in and processed.
2636 @item -b @var{filename}
2637 @itemx --base-file @var{filename}
2639 Specifies the name of a base file to be read in and processed. The
2640 contents of this file will be added to the relocation section in the
2641 exports file generated by dlltool.
2643 @item -e @var{filename}
2644 @itemx --output-exp @var{filename}
2645 Specifies the name of the export file to be created by dlltool.
2647 @item -z @var{filename}
2648 @itemx --output-def @var{filename}
2649 Specifies the name of the .def file to be created by dlltool.
2651 @item -l @var{filename}
2652 @itemx --output-lib @var{filename}
2653 Specifies the name of the library file to be created by dlltool.
2655 @item --export-all-symbols
2656 Treat all global and weak defined symbols found in the input object
2657 files as symbols to be exported. There is a small list of symbols which
2658 are not exported by default; see the @code{--no-default-excludes}
2659 option. You may add to the list of symbols to not export by using the
2660 @code{--exclude-symbols} option.
2662 @item --no-export-all-symbols
2663 Only export symbols explicitly listed in an input .def file or in
2664 @samp{.drectve} sections in the input object files. This is the default
2665 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
2666 attributes in the source code.
2668 @item --exclude-symbols @var{list}
2669 Do not export the symbols in @var{list}. This is a list of symbol names
2670 separated by comma or colon characters. The symbol names should not
2671 contain a leading underscore. This is only meaningful when
2672 @code{--export-all-symbols} is used.
2674 @item --no-default-excludes
2675 When @code{--export-all-symbols} is used, it will by default avoid
2676 exporting certain special symbols. The current list of symbols to avoid
2677 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
2678 @samp{impure_ptr}. You may use the @code{--no-default-excludes} option
2679 to go ahead and export these special symbols. This is only meaningful
2680 when @code{--export-all-symbols} is used.
2683 @itemx --as @var{path}
2684 Specifies the path, including the filename, of the assembler to be used
2685 to create the exports file.
2687 @item -f @var{switches}
2688 @itemx --as-flags @var{switches}
2689 Specifies any specific command line switches to be passed to the
2690 assembler when building the exports file. This option will work even if
2691 the @samp{-S} option is not used. This option only takes one argument,
2692 and if it occurs more than once on the command line, then later
2693 occurrences will override earlier occurrences. So if it is necessary to
2694 pass multiple switches to the assembler they should be enclosed in
2698 @itemx --dll-name @var{name}
2699 Specifies the name to be stored in the .def file as the name of the DLL
2700 when the @samp{-e} option is used. If this option is not present, then
2701 the filename given to the @samp{-e} option will be used as the name of
2704 @item -m @var{machine}
2705 @itemx -machine @var{machine}
2706 Specifies the type of machine for which the library file should be
2707 built. @code{dlltool} has a built in default type, depending upon how
2708 it was created, but this option can be used to override that. This is
2709 normally only useful when creating DLLs for an ARM processor, when the
2710 contents of the DLL are actually encode using THUMB instructions.
2713 @itemx --add-indirect
2714 Specifies that when @code{dlltool} is creating the exports file it
2715 should add a section which allows the exported functions to be
2716 referenced without using the import library. Whatever the hell that
2720 @itemx --add-underscore
2721 Specifies that when @code{dlltool} is creating the exports file it
2722 should prepend an underscore to the names of the exported functions.
2726 Specifies that when @code{dlltool} is creating the exports file it
2727 should not append the string @samp{@@ <number>}. These numbers are
2728 called ordinal numbers and they represent another way of accessing the
2729 function in a DLL, other than by name.
2732 @itemx --add-stdcall-alias
2733 Specifies that when @code{dlltool} is creating the exports file it
2734 should add aliases for stdcall symbols without @samp{@@ <number>}
2735 in addition to the symbols with @samp{@@ <number>}.
2739 Specifies that when @code{dlltool} is creating the exports and library
2740 files it should omit the .idata4 section. This is for compatibility
2741 with certain operating systems.
2745 Specifies that when @code{dlltool} is creating the exports and library
2746 files it should omit the .idata5 section. This is for compatibility
2747 with certain operating systems.
2751 Specifies that @code{dlltool} should mark the objects in the library
2752 file and exports file that it produces as supporting interworking
2753 between ARM and THUMB code.
2757 Makes @code{dlltool} preserve the temporary assembler files it used to
2758 create the exports file. If this option is repeated then dlltool will
2759 also preserve the temporary object files it uses to create the library
2764 Make dlltool describe what it is doing.
2768 Displays a list of command line options and then exits.
2772 Displays dlltool's version number and then exits.
2779 @c man begin SEEALSO dlltool
2780 the Info entries for @file{binutils}.
2787 @cindex ELF file information
2790 @c man title readelf Displays information about ELF files.
2793 @c man begin SYNOPSIS readelf
2794 readelf [ -a | --all ]
2795 [ -h | --file-header]
2796 [ -l | --program-headers | --segments]
2797 [ -S | --section-headers | --sections]
2799 [ -s | --syms | --symbols]
2804 [ -V | --version-info]
2805 [ -D | --use-dynamic]
2806 [ -x <number> | --hex-dump=<number>]
2807 [ -w[liaprmf] | --debug-dump[=line,=info,=abbrev,=pubnames,=ranges,=macro,=frames]]
2811 @var{elffile}@dots{}
2815 @c man begin DESCRIPTION readelf
2817 @code{readelf} displays information about one or more ELF format object
2818 files. The options control what particular information to display.
2820 @var{elffile}@dots{} are the object files to be examined. At the
2821 moment, @code{readelf} does not support examining archives, nor does it
2822 support examing 64 bit ELF files.
2826 @c man begin OPTIONS readelf
2828 The long and short forms of options, shown here as alternatives, are
2829 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
2835 Equivalent to specifiying @samp{--file-header},
2836 @samp{--program-headers}, @samp{--sections}, @samp{--symbols},
2837 @samp{--relocs}, @samp{--dynamic}, @samp{--notes} and
2838 @samp{--version-info}.
2841 @itemx --file-header
2842 @cindex ELF file header information
2843 Displays the information contained in the ELF header at the start of the
2847 @itemx --program-headers
2849 @cindex ELF program header information
2850 @cindex ELF segment information
2851 Displays the information contained in the file's segment headers, if it
2856 @itemx --section-headers
2857 @cindex ELF section information
2858 Displays the information contained in the file's section headers, if it
2864 @cindex ELF symbol table information
2865 Displays the entries in symbol table section of the file, if it has one.
2869 Display all the headers in the file. Equivalent to @samp{-h -l -S}.
2873 @cindex ELF core notes
2874 Displays the contents of the NOTE segment, if it exists.
2878 @cindex ELF reloc information
2879 Displays the contents of the file's relocation section, if it has one.
2883 @cindex unwind information
2884 Displays the contents of the file's unwind section, if it has one. Only
2885 the unwind sections for IA64 ELF files are currently supported.
2889 @cindex ELF dynamic section information
2890 Displays the contents of the file's dynamic section, if it has one.
2893 @itemx --version-info
2894 @cindex ELF version sections informations
2895 Displays the contents of the version sections in the file, it they
2899 @itemx --use-dynamic
2900 When displaying symbols, this option makes @code{readelf} use the
2901 symbol table in the file's dynamic section, rather than the one in the
2905 @itemx --hex-dump=<number>
2906 Displays the contents of the indicated section as a hexadecimal dump.
2909 @itemx --debug-dump[=line,=info,=abbrev,=pubnames,=ranges,=macro,=frames]
2910 Displays the contents of the debug sections in the file, if any are
2911 present. If one of the optional letters or words follows the switch
2912 then only data found in those specific sections will be dumped.
2915 Display a histogram of bucket list lengths when displaying the contents
2916 of the symbol tables.
2920 Display the version number of readelf.
2924 Display the command line options understood by @code{readelf}.
2931 @c man begin SEEALSO readelf
2932 objdump(1), and the Info entries for @file{binutils}.
2936 @node Selecting The Target System
2937 @chapter Selecting the target system
2939 You can specify three aspects of the target system to the @sc{gnu}
2940 binary file utilities, each in several ways:
2950 the linker emulation (which applies to the linker only)
2953 In the following summaries, the lists of ways to specify values are in
2954 order of decreasing precedence. The ways listed first override those
2957 The commands to list valid values only list the values for which the
2958 programs you are running were configured. If they were configured with
2959 @samp{--enable-targets=all}, the commands list most of the available
2960 values, but a few are left out; not all targets can be configured in at
2961 once because some of them can only be configured @dfn{native} (on hosts
2962 with the same type as the target system).
2965 * Target Selection::
2966 * Architecture Selection::
2967 * Linker Emulation Selection::
2970 @node Target Selection
2971 @section Target Selection
2973 A @dfn{target} is an object file format. A given target may be
2974 supported for multiple architectures (@pxref{Architecture Selection}).
2975 A target selection may also have variations for different operating
2976 systems or architectures.
2978 The command to list valid target values is @samp{objdump -i}
2979 (the first column of output contains the relevant information).
2981 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
2982 @samp{a.out-sunos-big}.
2984 You can also specify a target using a configuration triplet. This is
2985 the same sort of name that is passed to @file{configure} to specify a
2986 target. When you use a configuration triplet as an argument, it must be
2987 fully canonicalized. You can see the canonical version of a triplet by
2988 running the shell script @file{config.sub} which is included with the
2991 Some sample configuration triplets are: @samp{m68k-hp-bsd},
2992 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
2994 @subheading @code{objdump} Target
3000 command line option: @samp{-b} or @samp{--target}
3003 environment variable @code{GNUTARGET}
3006 deduced from the input file
3009 @subheading @code{objcopy} and @code{strip} Input Target
3015 command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
3018 environment variable @code{GNUTARGET}
3021 deduced from the input file
3024 @subheading @code{objcopy} and @code{strip} Output Target
3030 command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
3033 the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
3036 environment variable @code{GNUTARGET}
3039 deduced from the input file
3042 @subheading @code{nm}, @code{size}, and @code{strings} Target
3048 command line option: @samp{--target}
3051 environment variable @code{GNUTARGET}
3054 deduced from the input file
3057 @subheading Linker Input Target
3063 command line option: @samp{-b} or @samp{--format}
3064 (@pxref{Options,,Options,ld.info,Using LD})
3067 script command @code{TARGET}
3068 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
3071 environment variable @code{GNUTARGET}
3072 (@pxref{Environment,,Environment,ld.info,Using LD})
3075 the default target of the selected linker emulation
3076 (@pxref{Linker Emulation Selection})
3079 @subheading Linker Output Target
3085 command line option: @samp{-oformat}
3086 (@pxref{Options,,Options,ld.info,Using LD})
3089 script command @code{OUTPUT_FORMAT}
3090 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
3093 the linker input target (see ``Linker Input Target'' above)
3096 @node Architecture Selection
3097 @section Architecture selection
3099 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
3100 to run. Its name may contain a colon, separating the name of the
3101 processor family from the name of the particular @sc{cpu}.
3103 The command to list valid architecture values is @samp{objdump -i} (the
3104 second column contains the relevant information).
3106 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
3108 @subheading @code{objdump} Architecture
3114 command line option: @samp{-m} or @samp{--architecture}
3117 deduced from the input file
3120 @subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
3126 deduced from the input file
3129 @subheading Linker Input Architecture
3135 deduced from the input file
3138 @subheading Linker Output Architecture
3144 script command @code{OUTPUT_ARCH}
3145 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
3148 the default architecture from the linker output target
3149 (@pxref{Target Selection})
3152 @node Linker Emulation Selection
3153 @section Linker emulation selection
3155 A linker @dfn{emulation} is a ``personality'' of the linker, which gives
3156 the linker default values for the other aspects of the target system.
3157 In particular, it consists of
3167 several ``hook'' functions that are run at certain stages of the linking
3168 process to do special things that some targets require
3171 The command to list valid linker emulation values is @samp{ld -V}.
3173 Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
3179 command line option: @samp{-m}
3180 (@pxref{Options,,Options,ld.info,Using LD})
3183 environment variable @code{LDEMULATION}
3186 compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
3187 which comes from @code{EMUL} in @file{config/@var{target}.mt}
3190 @node Reporting Bugs
3191 @chapter Reporting Bugs
3193 @cindex reporting bugs
3195 Your bug reports play an essential role in making the binary utilities
3198 Reporting a bug may help you by bringing a solution to your problem, or
3199 it may not. But in any case the principal function of a bug report is
3200 to help the entire community by making the next version of the binary
3201 utilities work better. Bug reports are your contribution to their
3204 In order for a bug report to serve its purpose, you must include the
3205 information that enables us to fix the bug.
3208 * Bug Criteria:: Have you found a bug?
3209 * Bug Reporting:: How to report bugs
3213 @section Have you found a bug?
3214 @cindex bug criteria
3216 If you are not sure whether you have found a bug, here are some guidelines:
3219 @cindex fatal signal
3222 If a binary utility gets a fatal signal, for any input whatever, that is
3223 a bug. Reliable utilities never crash.
3225 @cindex error on valid input
3227 If a binary utility produces an error message for valid input, that is a
3231 If you are an experienced user of binary utilities, your suggestions for
3232 improvement are welcome in any case.
3236 @section How to report bugs
3238 @cindex bugs, reporting
3240 A number of companies and individuals offer support for @sc{gnu}
3241 products. If you obtained the binary utilities from a support
3242 organization, we recommend you contact that organization first.
3244 You can find contact information for many support companies and
3245 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
3248 In any event, we also recommend that you send bug reports for the binary
3249 utilities to @samp{bug-binutils@@gnu.org}.
3251 The fundamental principle of reporting bugs usefully is this:
3252 @strong{report all the facts}. If you are not sure whether to state a
3253 fact or leave it out, state it!
3255 Often people omit facts because they think they know what causes the
3256 problem and assume that some details do not matter. Thus, you might
3257 assume that the name of a file you use in an example does not matter.
3258 Well, probably it does not, but one cannot be sure. Perhaps the bug is
3259 a stray memory reference which happens to fetch from the location where
3260 that pathname is stored in memory; perhaps, if the pathname were
3261 different, the contents of that location would fool the utility into
3262 doing the right thing despite the bug. Play it safe and give a
3263 specific, complete example. That is the easiest thing for you to do,
3264 and the most helpful.
3266 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
3267 it is new to us. Therefore, always write your bug reports on the assumption
3268 that the bug has not been reported previously.
3270 Sometimes people give a few sketchy facts and ask, ``Does this ring a
3271 bell?'' Those bug reports are useless, and we urge everyone to
3272 @emph{refuse to respond to them} except to chide the sender to report
3275 To enable us to fix the bug, you should include all these things:
3279 The version of the utility. Each utility announces it if you start it
3280 with the @samp{--version} argument.
3282 Without this, we will not know whether there is any point in looking for
3283 the bug in the current version of the binary utilities.
3286 Any patches you may have applied to the source, including any patches
3287 made to the @code{BFD} library.
3290 The type of machine you are using, and the operating system name and
3294 What compiler (and its version) was used to compile the utilities---e.g.
3298 The command arguments you gave the utility to observe the bug. To
3299 guarantee you will not omit something important, list them all. A copy
3300 of the Makefile (or the output from make) is sufficient.
3302 If we were to try to guess the arguments, we would probably guess wrong
3303 and then we might not encounter the bug.
3306 A complete input file, or set of input files, that will reproduce the
3307 bug. If the utility is reading an object file or files, then it is
3308 generally most helpful to send the actual object files, uuencoded if
3309 necessary to get them through the mail system. Note that
3310 @samp{bug-binutils@@gnu.org} is a mailing list, so you should avoid
3311 sending very large files to it. Making the files available for
3312 anonymous FTP is OK.
3314 If the source files were produced exclusively using @sc{gnu} programs
3315 (e.g., @code{gcc}, @code{gas}, and/or the @sc{gnu} @code{ld}), then it
3316 may be OK to send the source files rather than the object files. In
3317 this case, be sure to say exactly what version of @code{gcc}, or
3318 whatever, was used to produce the object files. Also say how
3319 @code{gcc}, or whatever, was configured.
3322 A description of what behavior you observe that you believe is
3323 incorrect. For example, ``It gets a fatal signal.''
3325 Of course, if the bug is that the utility gets a fatal signal, then we
3326 will certainly notice it. But if the bug is incorrect output, we might
3327 not notice unless it is glaringly wrong. You might as well not give us
3328 a chance to make a mistake.
3330 Even if the problem you experience is a fatal signal, you should still
3331 say so explicitly. Suppose something strange is going on, such as your
3332 copy of the utility is out of synch, or you have encountered a bug in
3333 the C library on your system. (This has happened!) Your copy might
3334 crash and ours would not. If you told us to expect a crash, then when
3335 ours fails to crash, we would know that the bug was not happening for
3336 us. If you had not told us to expect a crash, then we would not be able
3337 to draw any conclusion from our observations.
3340 If you wish to suggest changes to the source, send us context diffs, as
3341 generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
3342 option. Always send diffs from the old file to the new file. If you
3343 wish to discuss something in the @code{ld} source, refer to it by
3344 context, not by line number.
3346 The line numbers in our development sources will not match those in your
3347 sources. Your line numbers would convey no useful information to us.
3350 Here are some things that are not necessary:
3354 A description of the envelope of the bug.
3356 Often people who encounter a bug spend a lot of time investigating
3357 which changes to the input file will make the bug go away and which
3358 changes will not affect it.
3360 This is often time consuming and not very useful, because the way we
3361 will find the bug is by running a single example under the debugger
3362 with breakpoints, not by pure deduction from a series of examples.
3363 We recommend that you save your time for something else.
3365 Of course, if you can find a simpler example to report @emph{instead}
3366 of the original one, that is a convenience for us. Errors in the
3367 output will be easier to spot, running under the debugger will take
3368 less time, and so on.
3370 However, simplification is not vital; if you do not want to do this,
3371 report the bug anyway and send us the entire test case you used.
3374 A patch for the bug.
3376 A patch for the bug does help us if it is a good one. But do not omit
3377 the necessary information, such as the test case, on the assumption that
3378 a patch is all we need. We might see problems with your patch and decide
3379 to fix the problem another way, or we might not understand it at all.
3381 Sometimes with programs as complicated as the binary utilities it is
3382 very hard to construct an example that will make the program follow a
3383 certain path through the code. If you do not send us the example, we
3384 will not be able to construct one, so we will not be able to verify that
3387 And if we cannot understand what bug you are trying to fix, or why your
3388 patch should be an improvement, we will not install it. A test case will
3389 help us to understand.
3392 A guess about what the bug is or what it depends on.
3394 Such guesses are usually wrong. Even we cannot guess right about such
3395 things without first using the debugger to find the facts.
3398 @node GNU Free Documentation License
3399 @chapter GNU Free Documentation License
3400 @cindex GNU Free Documentation License
3402 GNU Free Documentation License
3404 Version 1.1, March 2000
3406 Copyright (C) 2000 Free Software Foundation, Inc.
3407 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3409 Everyone is permitted to copy and distribute verbatim copies
3410 of this license document, but changing it is not allowed.
3415 The purpose of this License is to make a manual, textbook, or other
3416 written document "free" in the sense of freedom: to assure everyone
3417 the effective freedom to copy and redistribute it, with or without
3418 modifying it, either commercially or noncommercially. Secondarily,
3419 this License preserves for the author and publisher a way to get
3420 credit for their work, while not being considered responsible for
3421 modifications made by others.
3423 This License is a kind of "copyleft", which means that derivative
3424 works of the document must themselves be free in the same sense. It
3425 complements the GNU General Public License, which is a copyleft
3426 license designed for free software.
3428 We have designed this License in order to use it for manuals for free
3429 software, because free software needs free documentation: a free
3430 program should come with manuals providing the same freedoms that the
3431 software does. But this License is not limited to software manuals;
3432 it can be used for any textual work, regardless of subject matter or
3433 whether it is published as a printed book. We recommend this License
3434 principally for works whose purpose is instruction or reference.
3437 1. APPLICABILITY AND DEFINITIONS
3439 This License applies to any manual or other work that contains a
3440 notice placed by the copyright holder saying it can be distributed
3441 under the terms of this License. The "Document", below, refers to any
3442 such manual or work. Any member of the public is a licensee, and is
3445 A "Modified Version" of the Document means any work containing the
3446 Document or a portion of it, either copied verbatim, or with
3447 modifications and/or translated into another language.
3449 A "Secondary Section" is a named appendix or a front-matter section of
3450 the Document that deals exclusively with the relationship of the
3451 publishers or authors of the Document to the Document's overall subject
3452 (or to related matters) and contains nothing that could fall directly
3453 within that overall subject. (For example, if the Document is in part a
3454 textbook of mathematics, a Secondary Section may not explain any
3455 mathematics.) The relationship could be a matter of historical
3456 connection with the subject or with related matters, or of legal,
3457 commercial, philosophical, ethical or political position regarding
3460 The "Invariant Sections" are certain Secondary Sections whose titles
3461 are designated, as being those of Invariant Sections, in the notice
3462 that says that the Document is released under this License.
3464 The "Cover Texts" are certain short passages of text that are listed,
3465 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3466 the Document is released under this License.
3468 A "Transparent" copy of the Document means a machine-readable copy,
3469 represented in a format whose specification is available to the
3470 general public, whose contents can be viewed and edited directly and
3471 straightforwardly with generic text editors or (for images composed of
3472 pixels) generic paint programs or (for drawings) some widely available
3473 drawing editor, and that is suitable for input to text formatters or
3474 for automatic translation to a variety of formats suitable for input
3475 to text formatters. A copy made in an otherwise Transparent file
3476 format whose markup has been designed to thwart or discourage
3477 subsequent modification by readers is not Transparent. A copy that is
3478 not "Transparent" is called "Opaque".
3480 Examples of suitable formats for Transparent copies include plain
3481 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3482 or XML using a publicly available DTD, and standard-conforming simple
3483 HTML designed for human modification. Opaque formats include
3484 PostScript, PDF, proprietary formats that can be read and edited only
3485 by proprietary word processors, SGML or XML for which the DTD and/or
3486 processing tools are not generally available, and the
3487 machine-generated HTML produced by some word processors for output
3490 The "Title Page" means, for a printed book, the title page itself,
3491 plus such following pages as are needed to hold, legibly, the material
3492 this License requires to appear in the title page. For works in
3493 formats which do not have any title page as such, "Title Page" means
3494 the text near the most prominent appearance of the work's title,
3495 preceding the beginning of the body of the text.
3500 You may copy and distribute the Document in any medium, either
3501 commercially or noncommercially, provided that this License, the
3502 copyright notices, and the license notice saying this License applies
3503 to the Document are reproduced in all copies, and that you add no other
3504 conditions whatsoever to those of this License. You may not use
3505 technical measures to obstruct or control the reading or further
3506 copying of the copies you make or distribute. However, you may accept
3507 compensation in exchange for copies. If you distribute a large enough
3508 number of copies you must also follow the conditions in section 3.
3510 You may also lend copies, under the same conditions stated above, and
3511 you may publicly display copies.
3514 3. COPYING IN QUANTITY
3516 If you publish printed copies of the Document numbering more than 100,
3517 and the Document's license notice requires Cover Texts, you must enclose
3518 the copies in covers that carry, clearly and legibly, all these Cover
3519 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3520 the back cover. Both covers must also clearly and legibly identify
3521 you as the publisher of these copies. The front cover must present
3522 the full title with all words of the title equally prominent and
3523 visible. You may add other material on the covers in addition.
3524 Copying with changes limited to the covers, as long as they preserve
3525 the title of the Document and satisfy these conditions, can be treated
3526 as verbatim copying in other respects.
3528 If the required texts for either cover are too voluminous to fit
3529 legibly, you should put the first ones listed (as many as fit
3530 reasonably) on the actual cover, and continue the rest onto adjacent
3533 If you publish or distribute Opaque copies of the Document numbering
3534 more than 100, you must either include a machine-readable Transparent
3535 copy along with each Opaque copy, or state in or with each Opaque copy
3536 a publicly-accessible computer-network location containing a complete
3537 Transparent copy of the Document, free of added material, which the
3538 general network-using public has access to download anonymously at no
3539 charge using public-standard network protocols. If you use the latter
3540 option, you must take reasonably prudent steps, when you begin
3541 distribution of Opaque copies in quantity, to ensure that this
3542 Transparent copy will remain thus accessible at the stated location
3543 until at least one year after the last time you distribute an Opaque
3544 copy (directly or through your agents or retailers) of that edition to
3547 It is requested, but not required, that you contact the authors of the
3548 Document well before redistributing any large number of copies, to give
3549 them a chance to provide you with an updated version of the Document.
3554 You may copy and distribute a Modified Version of the Document under
3555 the conditions of sections 2 and 3 above, provided that you release
3556 the Modified Version under precisely this License, with the Modified
3557 Version filling the role of the Document, thus licensing distribution
3558 and modification of the Modified Version to whoever possesses a copy
3559 of it. In addition, you must do these things in the Modified Version:
3561 A. Use in the Title Page (and on the covers, if any) a title distinct
3562 from that of the Document, and from those of previous versions
3563 (which should, if there were any, be listed in the History section
3564 of the Document). You may use the same title as a previous version
3565 if the original publisher of that version gives permission.
3566 B. List on the Title Page, as authors, one or more persons or entities
3567 responsible for authorship of the modifications in the Modified
3568 Version, together with at least five of the principal authors of the
3569 Document (all of its principal authors, if it has less than five).
3570 C. State on the Title page the name of the publisher of the
3571 Modified Version, as the publisher.
3572 D. Preserve all the copyright notices of the Document.
3573 E. Add an appropriate copyright notice for your modifications
3574 adjacent to the other copyright notices.
3575 F. Include, immediately after the copyright notices, a license notice
3576 giving the public permission to use the Modified Version under the
3577 terms of this License, in the form shown in the Addendum below.
3578 G. Preserve in that license notice the full lists of Invariant Sections
3579 and required Cover Texts given in the Document's license notice.
3580 H. Include an unaltered copy of this License.
3581 I. Preserve the section entitled "History", and its title, and add to
3582 it an item stating at least the title, year, new authors, and
3583 publisher of the Modified Version as given on the Title Page. If
3584 there is no section entitled "History" in the Document, create one
3585 stating the title, year, authors, and publisher of the Document as
3586 given on its Title Page, then add an item describing the Modified
3587 Version as stated in the previous sentence.
3588 J. Preserve the network location, if any, given in the Document for
3589 public access to a Transparent copy of the Document, and likewise
3590 the network locations given in the Document for previous versions
3591 it was based on. These may be placed in the "History" section.
3592 You may omit a network location for a work that was published at
3593 least four years before the Document itself, or if the original
3594 publisher of the version it refers to gives permission.
3595 K. In any section entitled "Acknowledgements" or "Dedications",
3596 preserve the section's title, and preserve in the section all the
3597 substance and tone of each of the contributor acknowledgements
3598 and/or dedications given therein.
3599 L. Preserve all the Invariant Sections of the Document,
3600 unaltered in their text and in their titles. Section numbers
3601 or the equivalent are not considered part of the section titles.
3602 M. Delete any section entitled "Endorsements". Such a section
3603 may not be included in the Modified Version.
3604 N. Do not retitle any existing section as "Endorsements"
3605 or to conflict in title with any Invariant Section.
3607 If the Modified Version includes new front-matter sections or
3608 appendices that qualify as Secondary Sections and contain no material
3609 copied from the Document, you may at your option designate some or all
3610 of these sections as invariant. To do this, add their titles to the
3611 list of Invariant Sections in the Modified Version's license notice.
3612 These titles must be distinct from any other section titles.
3614 You may add a section entitled "Endorsements", provided it contains
3615 nothing but endorsements of your Modified Version by various
3616 parties--for example, statements of peer review or that the text has
3617 been approved by an organization as the authoritative definition of a
3620 You may add a passage of up to five words as a Front-Cover Text, and a
3621 passage of up to 25 words as a Back-Cover Text, to the end of the list
3622 of Cover Texts in the Modified Version. Only one passage of
3623 Front-Cover Text and one of Back-Cover Text may be added by (or
3624 through arrangements made by) any one entity. If the Document already
3625 includes a cover text for the same cover, previously added by you or
3626 by arrangement made by the same entity you are acting on behalf of,
3627 you may not add another; but you may replace the old one, on explicit
3628 permission from the previous publisher that added the old one.
3630 The author(s) and publisher(s) of the Document do not by this License
3631 give permission to use their names for publicity for or to assert or
3632 imply endorsement of any Modified Version.
3635 5. COMBINING DOCUMENTS
3637 You may combine the Document with other documents released under this
3638 License, under the terms defined in section 4 above for modified
3639 versions, provided that you include in the combination all of the
3640 Invariant Sections of all of the original documents, unmodified, and
3641 list them all as Invariant Sections of your combined work in its
3644 The combined work need only contain one copy of this License, and
3645 multiple identical Invariant Sections may be replaced with a single
3646 copy. If there are multiple Invariant Sections with the same name but
3647 different contents, make the title of each such section unique by
3648 adding at the end of it, in parentheses, the name of the original
3649 author or publisher of that section if known, or else a unique number.
3650 Make the same adjustment to the section titles in the list of
3651 Invariant Sections in the license notice of the combined work.
3653 In the combination, you must combine any sections entitled "History"
3654 in the various original documents, forming one section entitled
3655 "History"; likewise combine any sections entitled "Acknowledgements",
3656 and any sections entitled "Dedications". You must delete all sections
3657 entitled "Endorsements."
3660 6. COLLECTIONS OF DOCUMENTS
3662 You may make a collection consisting of the Document and other documents
3663 released under this License, and replace the individual copies of this
3664 License in the various documents with a single copy that is included in
3665 the collection, provided that you follow the rules of this License for
3666 verbatim copying of each of the documents in all other respects.
3668 You may extract a single document from such a collection, and distribute
3669 it individually under this License, provided you insert a copy of this
3670 License into the extracted document, and follow this License in all
3671 other respects regarding verbatim copying of that document.
3674 7. AGGREGATION WITH INDEPENDENT WORKS
3676 A compilation of the Document or its derivatives with other separate
3677 and independent documents or works, in or on a volume of a storage or
3678 distribution medium, does not as a whole count as a Modified Version
3679 of the Document, provided no compilation copyright is claimed for the
3680 compilation. Such a compilation is called an "aggregate", and this
3681 License does not apply to the other self-contained works thus compiled
3682 with the Document, on account of their being thus compiled, if they
3683 are not themselves derivative works of the Document.
3685 If the Cover Text requirement of section 3 is applicable to these
3686 copies of the Document, then if the Document is less than one quarter
3687 of the entire aggregate, the Document's Cover Texts may be placed on
3688 covers that surround only the Document within the aggregate.
3689 Otherwise they must appear on covers around the whole aggregate.
3694 Translation is considered a kind of modification, so you may
3695 distribute translations of the Document under the terms of section 4.
3696 Replacing Invariant Sections with translations requires special
3697 permission from their copyright holders, but you may include
3698 translations of some or all Invariant Sections in addition to the
3699 original versions of these Invariant Sections. You may include a
3700 translation of this License provided that you also include the
3701 original English version of this License. In case of a disagreement
3702 between the translation and the original English version of this
3703 License, the original English version will prevail.
3708 You may not copy, modify, sublicense, or distribute the Document except
3709 as expressly provided for under this License. Any other attempt to
3710 copy, modify, sublicense or distribute the Document is void, and will
3711 automatically terminate your rights under this License. However,
3712 parties who have received copies, or rights, from you under this
3713 License will not have their licenses terminated so long as such
3714 parties remain in full compliance.
3717 10. FUTURE REVISIONS OF THIS LICENSE
3719 The Free Software Foundation may publish new, revised versions
3720 of the GNU Free Documentation License from time to time. Such new
3721 versions will be similar in spirit to the present version, but may
3722 differ in detail to address new problems or concerns. See
3723 http://www.gnu.org/copyleft/.
3725 Each version of the License is given a distinguishing version number.
3726 If the Document specifies that a particular numbered version of this
3727 License "or any later version" applies to it, you have the option of
3728 following the terms and conditions either of that specified version or
3729 of any later version that has been published (not as a draft) by the
3730 Free Software Foundation. If the Document does not specify a version
3731 number of this License, you may choose any version ever published (not
3732 as a draft) by the Free Software Foundation.
3735 ADDENDUM: How to use this License for your documents
3737 To use this License in a document you have written, include a copy of
3738 the License in the document and put the following copyright and
3739 license notices just after the title page:
3742 Copyright (c) YEAR YOUR NAME.
3743 Permission is granted to copy, distribute and/or modify this document
3744 under the terms of the GNU Free Documentation License, Version 1.1
3745 or any later version published by the Free Software Foundation;
3746 with the Invariant Sections being LIST THEIR TITLES, with the
3747 Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
3748 A copy of the license is included in the section entitled "GNU
3749 Free Documentation License".
3752 If you have no Invariant Sections, write "with no Invariant Sections"
3753 instead of saying which ones are invariant. If you have no
3754 Front-Cover Texts, write "no Front-Cover Texts" instead of
3755 "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
3757 If your document contains nontrivial examples of program code, we
3758 recommend releasing these examples in parallel under your choice of
3759 free software license, such as the GNU General Public License,
3760 to permit their use in free software.