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 [ -L @var{symbolname} | --localize-symbol=@var{symbolname} ]
927 [ -W @var{symbolname} | --weaken-symbol=@var{symbolname} ]
928 [ -x | --discard-all ] [ -X | --discard-locals ]
929 [ -b @var{byte} | --byte=@var{byte} ]
930 [ -i @var{interleave} | --interleave=@var{interleave} ]
931 [ -j @var{sectionname} | --only-section=@var{sectionname} ]
932 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
933 [ -p | --preserve-dates ] [ --debugging ]
934 [ --gap-fill=@var{val} ] [ --pad-to=@var{address} ]
935 [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ]
936 [ --change-addresses=@var{incr} ]
937 [ --change-section-address @var{section}@{=,+,-@}@var{val} ]
938 [ --change-section-lma @var{section}@{=,+,-@}@var{val} ]
939 [ --change-section-vma @var{section}@{=,+,-@}@var{val} ]
940 [ --change-warnings ] [ --no-change-warnings ]
941 [ --set-section-flags @var{section}=@var{flags} ]
942 [ --add-section @var{sectionname}=@var{filename} ]
943 [ --change-leading-char ] [ --remove-leading-char ]
944 [ --srec-len=@var{ival} ] [ --srec-forceS3 ]
945 [ --redefine-sym @var{old}=@var{new} ] [ --weaken ]
946 [ -v | --verbose ] [ -V | --version ] [ --help ]
947 @var{infile} [@var{outfile}]
951 @c man begin DESCRIPTION objcopy
952 The @sc{gnu} @code{objcopy} utility copies the contents of an object
953 file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to
954 read and write the object files. It can write the destination object
955 file in a format different from that of the source object file. The
956 exact behavior of @code{objcopy} is controlled by command-line options.
957 Note that @code{objcopy} should be able to copy a fully linked file
958 between any two formats. However, copying a relocatable object file
959 between any two formats may not work as expected.
961 @code{objcopy} creates temporary files to do its translations and
962 deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its
963 translation work; it has access to all the formats described in @sc{bfd}
964 and thus is able to recognize most formats without being told
965 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
967 @code{objcopy} can be used to generate S-records by using an output
968 target of @samp{srec} (e.g., use @samp{-O srec}).
970 @code{objcopy} can be used to generate a raw binary file by using an
971 output target of @samp{binary} (e.g., use @samp{-O binary}). When
972 @code{objcopy} generates a raw binary file, it will essentially produce
973 a memory dump of the contents of the input object file. All symbols and
974 relocation information will be discarded. The memory dump will start at
975 the load address of the lowest section copied into the output file.
977 When generating an S-record or a raw binary file, it may be helpful to
978 use @samp{-S} to remove sections containing debugging information. In
979 some cases @samp{-R} will be useful to remove sections which contain
980 information that is not needed by the binary file.
982 Note - @code{objcopy} is not able to change the endianness of its input
983 files. If the input format has an endianness, (some formats do not),
984 @code{objcopy} can only copy the inputs into file formats that have the
985 same endianness or which have no endianness (eg @samp{srec}).
989 @c man begin OPTIONS objcopy
994 The input and output files, respectively.
995 If you do not specify @var{outfile}, @code{objcopy} creates a
996 temporary file and destructively renames the result with
997 the name of @var{infile}.
999 @item -I @var{bfdname}
1000 @itemx --input-target=@var{bfdname}
1001 Consider the source file's object format to be @var{bfdname}, rather than
1002 attempting to deduce it. @xref{Target Selection}, for more information.
1004 @item -O @var{bfdname}
1005 @itemx --output-target=@var{bfdname}
1006 Write the output file using the object format @var{bfdname}.
1007 @xref{Target Selection}, for more information.
1009 @item -F @var{bfdname}
1010 @itemx --target=@var{bfdname}
1011 Use @var{bfdname} as the object format for both the input and the output
1012 file; i.e., simply transfer data from source to destination with no
1013 translation. @xref{Target Selection}, for more information.
1015 @item -B @var{bfdarch}
1016 @itemx --binary-architecture=@var{bfdarch}
1017 Useful when transforming a raw binary input file into an object file.
1018 In this case the output architecture can be set to @var{bfdarch}. This
1019 option will be ignored if the input file has a known @var{bfdarch}. You
1020 can access this binary data inside a program by referencing the special
1021 symbols that are created by the conversion process. These symbols are
1022 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1023 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1024 an object file and then access it in your code using these symbols.
1026 @item -j @var{sectionname}
1027 @itemx --only-section=@var{sectionname}
1028 Copy only the named section from the input file to the output file.
1029 This option may be given more than once. Note that using this option
1030 inappropriately may make the output file unusable.
1032 @item -R @var{sectionname}
1033 @itemx --remove-section=@var{sectionname}
1034 Remove any section named @var{sectionname} from the output file. This
1035 option may be given more than once. Note that using this option
1036 inappropriately may make the output file unusable.
1040 Do not copy relocation and symbol information from the source file.
1043 @itemx --strip-debug
1044 Do not copy debugging symbols from the source file.
1046 @item --strip-unneeded
1047 Strip all symbols that are not needed for relocation processing.
1049 @item -K @var{symbolname}
1050 @itemx --keep-symbol=@var{symbolname}
1051 Copy only symbol @var{symbolname} from the source file. This option may
1052 be given more than once.
1054 @item -N @var{symbolname}
1055 @itemx --strip-symbol=@var{symbolname}
1056 Do not copy symbol @var{symbolname} from the source file. This option
1057 may be given more than once.
1059 @item -L @var{symbolname}
1060 @itemx --localize-symbol=@var{symbolname}
1061 Make symbol @var{symbolname} local to the file, so that it is not
1062 visible externally. This option may be given more than once.
1064 @item -W @var{symbolname}
1065 @itemx --weaken-symbol=@var{symbolname}
1066 Make symbol @var{symbolname} weak. This option may be given more than once.
1069 @itemx --discard-all
1070 Do not copy non-global symbols from the source file.
1071 @c FIXME any reason to prefer "non-global" to "local" here?
1074 @itemx --discard-locals
1075 Do not copy compiler-generated local symbols.
1076 (These usually start with @samp{L} or @samp{.}.)
1079 @itemx --byte=@var{byte}
1080 Keep only every @var{byte}th byte of the input file (header data is not
1081 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
1082 where @var{interleave} is given by the @samp{-i} or @samp{--interleave}
1083 option, or the default of 4. This option is useful for creating files
1084 to program @sc{rom}. It is typically used with an @code{srec} output
1087 @item -i @var{interleave}
1088 @itemx --interleave=@var{interleave}
1089 Only copy one out of every @var{interleave} bytes. Select which byte to
1090 copy with the @var{-b} or @samp{--byte} option. The default is 4.
1091 @code{objcopy} ignores this option if you do not specify either @samp{-b} or
1095 @itemx --preserve-dates
1096 Set the access and modification dates of the output file to be the same
1097 as those of the input file.
1100 Convert debugging information, if possible. This is not the default
1101 because only certain debugging formats are supported, and the
1102 conversion process can be time consuming.
1104 @item --gap-fill @var{val}
1105 Fill gaps between sections with @var{val}. This operation applies to
1106 the @emph{load address} (LMA) of the sections. It is done by increasing
1107 the size of the section with the lower address, and filling in the extra
1108 space created with @var{val}.
1110 @item --pad-to @var{address}
1111 Pad the output file up to the load address @var{address}. This is
1112 done by increasing the size of the last section. The extra space is
1113 filled in with the value specified by @samp{--gap-fill} (default zero).
1115 @item --set-start @var{val}
1116 Set the start address of the new file to @var{val}. Not all object file
1117 formats support setting the start address.
1119 @item --change-start @var{incr}
1120 @itemx --adjust-start @var{incr}
1121 @cindex changing start address
1122 Change the start address by adding @var{incr}. Not all object file
1123 formats support setting the start address.
1125 @item --change-addresses @var{incr}
1126 @itemx --adjust-vma @var{incr}
1127 @cindex changing object addresses
1128 Change the VMA and LMA addresses of all sections, as well as the start
1129 address, by adding @var{incr}. Some object file formats do not permit
1130 section addresses to be changed arbitrarily. Note that this does not
1131 relocate the sections; if the program expects sections to be loaded at a
1132 certain address, and this option is used to change the sections such
1133 that they are loaded at a different address, the program may fail.
1135 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1136 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1137 @cindex changing section address
1138 Set or change both the VMA address and the LMA address of the named
1139 @var{section}. If @samp{=} is used, the section address is set to
1140 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1141 section address. See the comments under @samp{--change-addresses},
1142 above. If @var{section} does not exist in the input file, a warning will
1143 be issued, unless @samp{--no-change-warnings} is used.
1145 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1146 @cindex changing section LMA
1147 Set or change the LMA address of the named @var{section}. The LMA
1148 address is the address where the section will be loaded into memory at
1149 program load time. Normally this is the same as the VMA address, which
1150 is the address of the section at program run time, but on some systems,
1151 especially those where a program is held in ROM, the two can be
1152 different. 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
1156 will be issued, unless @samp{--no-change-warnings} is used.
1158 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1159 @cindex changing section VMA
1160 Set or change the VMA address of the named @var{section}. The VMA
1161 address is the address where the section will be located once the
1162 program has started executing. Normally this is the same as the LMA
1163 address, which is the address where the section will be loaded into
1164 memory, but on some systems, especially those where a program is held in
1165 ROM, the two can be different. If @samp{=} is used, the section address
1166 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1167 from the section address. See the comments under
1168 @samp{--change-addresses}, above. If @var{section} does not exist in
1169 the input file, a warning will be issued, unless
1170 @samp{--no-change-warnings} is used.
1172 @item --change-warnings
1173 @itemx --adjust-warnings
1174 If @samp{--change-section-address} or @samp{--change-section-lma} or
1175 @samp{--change-section-vma} is used, and the named section does not
1176 exist, issue a warning. This is the default.
1178 @item --no-change-warnings
1179 @itemx --no-adjust-warnings
1180 Do not issue a warning if @samp{--change-section-address} or
1181 @samp{--adjust-section-lma} or @samp{--adjust-section-vma} is used, even
1182 if the named section does not exist.
1184 @item --set-section-flags @var{section}=@var{flags}
1185 Set the flags for the named section. The @var{flags} argument is a
1186 comma separated string of flag names. The recognized names are
1187 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1188 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1189 @samp{debug}. You can set the @samp{contents} flag for a section which
1190 does not have contents, but it is not meaningful to clear the
1191 @samp{contents} flag of a section which does have contents--just remove
1192 the section instead. Not all flags are meaningful for all object file
1195 @item --add-section @var{sectionname}=@var{filename}
1196 Add a new section named @var{sectionname} while copying the file. The
1197 contents of the new section are taken from the file @var{filename}. The
1198 size of the section will be the size of the file. This option only
1199 works on file formats which can support sections with arbitrary names.
1201 @item --change-leading-char
1202 Some object file formats use special characters at the start of
1203 symbols. The most common such character is underscore, which compilers
1204 often add before every symbol. This option tells @code{objcopy} to
1205 change the leading character of every symbol when it converts between
1206 object file formats. If the object file formats use the same leading
1207 character, this option has no effect. Otherwise, it will add a
1208 character, or remove a character, or change a character, as
1211 @item --remove-leading-char
1212 If the first character of a global symbol is a special symbol leading
1213 character used by the object file format, remove the character. The
1214 most common symbol leading character is underscore. This option will
1215 remove a leading underscore from all global symbols. This can be useful
1216 if you want to link together objects of different file formats with
1217 different conventions for symbol names. This is different from
1218 @code{--change-leading-char} because it always changes the symbol name
1219 when appropriate, regardless of the object file format of the output
1222 @item --srec-len=@var{ival}
1223 Meaningful only for srec output. Set the maximum length of the Srecords
1224 being produced to @var{ival}. This length covers both address, data and
1227 @item --srec-forceS3
1228 Meaningful only for srec output. Avoid generation of S1/S2 records,
1229 creating S3-only record format.
1231 @item --redefine-sym @var{old}=@var{new}
1232 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1233 when one is trying link two things together for which you have no
1234 source, and there are name collisions.
1237 Change all global symbols in the file to be weak. This can be useful
1238 when building an object which will be linked against other objects using
1239 the @code{-R} option to the linker. This option is only effective when
1240 using an object file format which supports weak symbols.
1244 Show the version number of @code{objcopy}.
1248 Verbose output: list all object files modified. In the case of
1249 archives, @samp{objcopy -V} lists all members of the archive.
1252 Show a summary of the options to @code{objcopy}.
1258 @c man begin SEEALSO objcopy
1259 ld(1), objdump(1), and the Info entries for @file{binutils}.
1266 @cindex object file information
1269 @c man title objdump display information from object files.
1272 @c man begin SYNOPSIS objdump
1273 objdump [ -a | --archive-headers ]
1274 [ -b @var{bfdname} | --target=@var{bfdname} ]
1275 [ -C | --demangle[=@var{style}] ]
1276 [ -d | --disassemble ]
1277 [ -D | --disassemble-all ]
1278 [ -z | --disassemble-zeroes ]
1279 [ -EB | -EL | --endian=@{big | little @} ]
1280 [ -f | --file-headers ]
1281 [ --file-start-context ]
1282 [ -g | --debugging ]
1283 [ -h | --section-headers | --headers ]
1285 [ -j @var{section} | --section=@var{section} ]
1286 [ -l | --line-numbers ]
1288 [ -m @var{machine} | --architecture=@var{machine} ]
1289 [ -M @var{options} | --disassembler-options=@var{options}]
1290 [ -p | --private-headers ]
1292 [ -R | --dynamic-reloc ]
1293 [ -s | --full-contents ]
1296 [ -T | --dynamic-syms ]
1297 [ -x | --all-headers ]
1299 [ --start-address=@var{address} ]
1300 [ --stop-address=@var{address} ]
1301 [ --prefix-addresses]
1302 [ --[no-]show-raw-insn ]
1303 [ --adjust-vma=@var{offset} ]
1306 @var{objfile}@dots{}
1310 @c man begin DESCRIPTION objdump
1312 @code{objdump} displays information about one or more object files.
1313 The options control what particular information to display. This
1314 information is mostly useful to programmers who are working on the
1315 compilation tools, as opposed to programmers who just want their
1316 program to compile and work.
1318 @var{objfile}@dots{} are the object files to be examined. When you
1319 specify archives, @code{objdump} shows information on each of the member
1324 @c man begin OPTIONS objdump
1326 The long and short forms of options, shown here as alternatives, are
1327 equivalent. At least one option from the list
1328 @samp{-a,-d,-D,-f,-g,-G,-h,-H,-p,-r,-R,-S,-t,-T,-V,-x} must be given.
1332 @itemx --archive-header
1333 @cindex archive headers
1334 If any of the @var{objfile} files are archives, display the archive
1335 header information (in a format similar to @samp{ls -l}). Besides the
1336 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1337 the object file format of each archive member.
1339 @item --adjust-vma=@var{offset}
1340 @cindex section addresses in objdump
1341 @cindex VMA in objdump
1342 When dumping information, first add @var{offset} to all the section
1343 addresses. This is useful if the section addresses do not correspond to
1344 the symbol table, which can happen when putting sections at particular
1345 addresses when using a format which can not represent section addresses,
1348 @item -b @var{bfdname}
1349 @itemx --target=@var{bfdname}
1350 @cindex object code format
1351 Specify that the object-code format for the object files is
1352 @var{bfdname}. This option may not be necessary; @var{objdump} can
1353 automatically recognize many formats.
1357 objdump -b oasys -m vax -h fu.o
1360 displays summary information from the section headers (@samp{-h}) of
1361 @file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
1362 file in the format produced by Oasys compilers. You can list the
1363 formats available with the @samp{-i} option.
1364 @xref{Target Selection}, for more information.
1367 @itemx --demangle[=@var{style}]
1368 @cindex demangling in objdump
1369 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1370 Besides removing any initial underscore prepended by the system, this
1371 makes C++ function names readable. Different compilers have different
1372 mangling styles. The optional demangling style argument can be used to
1373 choose an appropriate demangling style for your compiler. @xref{c++filt},
1374 for more information on demangling.
1378 Display debugging information. This attempts to parse debugging
1379 information stored in the file and print it out using a C like syntax.
1380 Only certain types of debugging information have been implemented.
1383 @itemx --disassemble
1384 @cindex disassembling object code
1385 @cindex machine instructions
1386 Display the assembler mnemonics for the machine instructions from
1387 @var{objfile}. This option only disassembles those sections which are
1388 expected to contain instructions.
1391 @itemx --disassemble-all
1392 Like @samp{-d}, but disassemble the contents of all sections, not just
1393 those expected to contain instructions.
1395 @item --prefix-addresses
1396 When disassembling, print the complete address on each line. This is
1397 the older disassembly format.
1399 @item --disassemble-zeroes
1400 Normally the disassembly output will skip blocks of zeroes. This
1401 option directs the disassembler to disassemble those blocks, just like
1406 @itemx --endian=@{big|little@}
1408 @cindex disassembly endianness
1409 Specify the endianness of the object files. This only affects
1410 disassembly. This can be useful when disassembling a file format which
1411 does not describe endianness information, such as S-records.
1414 @itemx --file-header
1415 @cindex object file header
1416 Display summary information from the overall header of
1417 each of the @var{objfile} files.
1419 @item --file-start-context
1420 @cindex source code context
1421 Specify that when displaying interlisted source code/disassembly
1422 (assumes '-S') from a file that has not yet been displayed, extend the
1423 context to the start of the file.
1426 @itemx --section-header
1428 @cindex section headers
1429 Display summary information from the section headers of the
1432 File segments may be relocated to nonstandard addresses, for example by
1433 using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
1434 @code{ld}. However, some object file formats, such as a.out, do not
1435 store the starting address of the file segments. In those situations,
1436 although @code{ld} relocates the sections correctly, using @samp{objdump
1437 -h} to list the file section headers cannot show the correct addresses.
1438 Instead, it shows the usual addresses, which are implicit for the
1442 Print a summary of the options to @code{objdump} and exit.
1446 @cindex architectures available
1447 @cindex object formats available
1448 Display a list showing all architectures and object formats available
1449 for specification with @samp{-b} or @samp{-m}.
1452 @itemx --section=@var{name}
1453 @cindex section information
1454 Display information only for section @var{name}.
1457 @itemx --line-numbers
1458 @cindex source filenames for object files
1459 Label the display (using debugging information) with the filename and
1460 source line numbers corresponding to the object code or relocs shown.
1461 Only useful with @samp{-d}, @samp{-D}, or @samp{-r}.
1463 @item -m @var{machine}
1464 @itemx --architecture=@var{machine}
1465 @cindex architecture
1466 @cindex disassembly architecture
1467 Specify the architecture to use when disassembling object files. This
1468 can be useful when disassembling object files which do not describe
1469 architecture information, such as S-records. You can list the available
1470 architectures with the @samp{-i} option.
1472 @item -M @var{options}
1473 @itemx --disassembler-options=@var{options}
1474 Pass target specific information to the disassembler. Only supported on
1477 If the target is an ARM architecture then this switch can be used to
1478 select which register name set is used during disassembler. Specifying
1479 @samp{-M reg-name-std} (the default) will select the register names as
1480 used in ARM's instruction set documentation, but with register 13 called
1481 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
1482 @samp{-M reg-names-apcs} will select the name set used by the ARM
1483 Procedure Call Standard, whilst specifying @samp{-M reg-names-raw} will
1484 just use @samp{r} followed by the register number.
1486 There are also two variants on the APCS register naming scheme enabled
1487 by @samp{-M reg-names-atpcs} and @samp{-M reg-names-special-atpcs} which
1488 use the ARM/Thumb Procedure Call Standard naming conventions. (Eiuther
1489 with the normal register name sor the special register names).
1491 This option can also be used for ARM architectures to force the
1492 disassembler to interpret all instructions as THUMB instructions by
1493 using the switch @samp{--disassembler-options=force-thumb}. This can be
1494 useful when attempting to disassemble thumb code produced by other
1498 @itemx --private-headers
1499 Print information that is specific to the object file format. The exact
1500 information printed depends upon the object file format. For some
1501 object file formats, no additional information is printed.
1505 @cindex relocation entries, in object file
1506 Print the relocation entries of the file. If used with @samp{-d} or
1507 @samp{-D}, the relocations are printed interspersed with the
1511 @itemx --dynamic-reloc
1512 @cindex dynamic relocation entries, in object file
1513 Print the dynamic relocation entries of the file. This is only
1514 meaningful for dynamic objects, such as certain types of shared
1518 @itemx --full-contents
1519 @cindex sections, full contents
1520 @cindex object file sections
1521 Display the full contents of any sections requested.
1525 @cindex source disassembly
1526 @cindex disassembly, with source
1527 Display source code intermixed with disassembly, if possible. Implies
1530 @item --show-raw-insn
1531 When disassembling instructions, print the instruction in hex as well as
1532 in symbolic form. This is the default except when
1533 @code{--prefix-addresses} is used.
1535 @item --no-show-raw-insn
1536 When disassembling instructions, do not print the instruction bytes.
1537 This is the default when @code{--prefix-addresses} is used.
1543 @cindex debug symbols
1544 @cindex ELF object file format
1545 Display the full contents of any sections requested. Display the
1546 contents of the .stab and .stab.index and .stab.excl sections from an
1547 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1548 @code{.stab} debugging symbol-table entries are carried in an ELF
1549 section. In most other file formats, debugging symbol-table entries are
1550 interleaved with linkage symbols, and are visible in the @samp{--syms}
1553 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1554 Overview,stabs.info, The ``stabs'' debug format}.
1557 @item --start-address=@var{address}
1558 @cindex start-address
1559 Start displaying data at the specified address. This affects the output
1560 of the @code{-d}, @code{-r} and @code{-s} options.
1562 @item --stop-address=@var{address}
1563 @cindex stop-address
1564 Stop displaying data at the specified address. This affects the output
1565 of the @code{-d}, @code{-r} and @code{-s} options.
1569 @cindex symbol table entries, printing
1570 Print the symbol table entries of the file.
1571 This is similar to the information provided by the @samp{nm} program.
1574 @itemx --dynamic-syms
1575 @cindex dynamic symbol table entries, printing
1576 Print the dynamic symbol table entries of the file. This is only
1577 meaningful for dynamic objects, such as certain types of shared
1578 libraries. This is similar to the information provided by the @samp{nm}
1579 program when given the @samp{-D} (@samp{--dynamic}) option.
1582 Print the version number of @code{objdump} and exit.
1586 @cindex all header information, object file
1587 @cindex header information, all
1588 Display all available header information, including the symbol table and
1589 relocation entries. Using @samp{-x} is equivalent to specifying all of
1590 @samp{-a -f -h -r -t}.
1594 @cindex wide output, printing
1595 Format some lines for output devices that have more than 80 columns.
1601 @c man begin SEEALSO objdump
1602 nm(1), readelf(1), and the Info entries for @file{binutils}.
1610 @cindex archive contents
1611 @cindex symbol index
1613 @c man title ranlib generate index to archive.
1616 @c man begin SYNOPSIS ranlib
1617 ranlib [-vV] @var{archive}
1621 @c man begin DESCRIPTION ranlib
1623 @code{ranlib} generates an index to the contents of an archive and
1624 stores it in the archive. The index lists each symbol defined by a
1625 member of an archive that is a relocatable object file.
1627 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
1629 An archive with such an index speeds up linking to the library and
1630 allows routines in the library to call each other without regard to
1631 their placement in the archive.
1633 The @sc{gnu} @code{ranlib} program is another form of @sc{gnu} @code{ar}; running
1634 @code{ranlib} is completely equivalent to executing @samp{ar -s}.
1639 @c man begin OPTIONS ranlib
1645 Show the version number of @code{ranlib}.
1651 @c man begin SEEALSO ranlib
1652 ar(1), nm(1), and the Info entries for @file{binutils}.
1660 @cindex section sizes
1662 @c man title size list section sizes and total size.
1665 @c man begin SYNOPSIS size
1666 size [ -A | -B | --format=@var{compatibility} ]
1667 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
1668 [ --target=@var{bfdname} ] [ -V | --version ]
1669 [ @var{objfile}@dots{} ]
1673 @c man begin DESCRIPTION size
1675 The @sc{gnu} @code{size} utility lists the section sizes---and the total
1676 size---for each of the object or archive files @var{objfile} in its
1677 argument list. By default, one line of output is generated for each
1678 object file or each module in an archive.
1680 @var{objfile}@dots{} are the object files to be examined.
1681 If none are specified, the file @code{a.out} will be used.
1685 @c man begin OPTIONS size
1687 The command line options have the following meanings:
1692 @itemx --format=@var{compatibility}
1693 @cindex @code{size} display format
1694 Using one of these options, you can choose whether the output from @sc{gnu}
1695 @code{size} resembles output from System V @code{size} (using @samp{-A},
1696 or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
1697 @samp{--format=berkeley}). The default is the one-line format similar to
1699 @c Bonus for doc-source readers: you can also say --format=strange (or
1700 @c anything else that starts with 's') for sysv, and --format=boring (or
1701 @c anything else that starts with 'b') for Berkeley.
1703 Here is an example of the Berkeley (default) format of output from
1706 $ size --format=Berkeley ranlib size
1707 text data bss dec hex filename
1708 294880 81920 11592 388392 5ed28 ranlib
1709 294880 81920 11888 388688 5ee50 size
1713 This is the same data, but displayed closer to System V conventions:
1716 $ size --format=SysV ranlib size
1734 Show a summary of acceptable arguments and options.
1739 @itemx --radix=@var{number}
1740 @cindex @code{size} number format
1741 @cindex radix for section sizes
1742 Using one of these options, you can control whether the size of each
1743 section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1744 (@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1745 @samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
1746 values (8, 10, 16) are supported. The total size is always given in two
1747 radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1748 octal and hexadecimal if you're using @samp{-o}.
1750 @item --target=@var{bfdname}
1751 @cindex object code format
1752 Specify that the object-code format for @var{objfile} is
1753 @var{bfdname}. This option may not be necessary; @code{size} can
1754 automatically recognize many formats.
1755 @xref{Target Selection}, for more information.
1759 Display the version number of @code{size}.
1765 @c man begin SEEALSO size
1766 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
1773 @cindex listings strings
1774 @cindex printing strings
1775 @cindex strings, printing
1777 @c man title strings print the strings of printable characters in files.
1780 @c man begin SYNOPSIS strings
1781 strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
1782 [--all] [--print-file-name] [--bytes=@var{min-len}]
1783 [--radix=@var{radix}] [--target=@var{bfdname}]
1784 [--help] [--version] @var{file}@dots{}
1788 @c man begin DESCRIPTION strings
1790 For each @var{file} given, @sc{gnu} @code{strings} prints the printable
1791 character sequences that are at least 4 characters long (or the number
1792 given with the options below) and are followed by an unprintable
1793 character. By default, it only prints the strings from the initialized
1794 and loaded sections of object files; for other types of files, it prints
1795 the strings from the whole file.
1797 @code{strings} is mainly useful for determining the contents of non-text
1802 @c man begin OPTIONS strings
1808 Do not scan only the initialized and loaded sections of object files;
1809 scan the whole files.
1812 @itemx --print-file-name
1813 Print the name of the file before each string.
1816 Print a summary of the program usage on the standard output and exit.
1818 @item -@var{min-len}
1819 @itemx -n @var{min-len}
1820 @itemx --bytes=@var{min-len}
1821 Print sequences of characters that are at least @var{min-len} characters
1822 long, instead of the default 4.
1825 Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1826 act like @samp{-t d} instead. Since we can not be compatible with both
1827 ways, we simply chose one.
1829 @item -t @var{radix}
1830 @itemx --radix=@var{radix}
1831 Print the offset within the file before each string. The single
1832 character argument specifies the radix of the offset---@samp{o} for
1833 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1835 @item --target=@var{bfdname}
1836 @cindex object code format
1837 Specify an object code format other than your system's default format.
1838 @xref{Target Selection}, for more information.
1842 Print the program version number on the standard output and exit.
1848 @c man begin SEEALSO strings
1849 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
1850 and the Info entries for @file{binutils}.
1858 @cindex removing symbols
1859 @cindex discarding symbols
1860 @cindex symbols, discarding
1862 @c man title strip Discard symbols from object files.
1865 @c man begin SYNOPSIS strip
1866 strip [ -F @var{bfdname} | --target=@var{bfdname} ]
1867 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1868 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
1869 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
1870 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
1871 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
1872 [ -x | --discard-all ] [ -X | --discard-locals ]
1873 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
1874 [ -o @var{file} ] [ -p | --preserve-dates ]
1875 [ -v | --verbose ] [ -V | --version ] [ --help ]
1876 @var{objfile}@dots{}
1880 @c man begin DESCRIPTION strip
1882 @sc{gnu} @code{strip} discards all symbols from object files
1883 @var{objfile}. The list of object files may include archives.
1884 At least one object file must be given.
1886 @code{strip} modifies the files named in its argument,
1887 rather than writing modified copies under different names.
1891 @c man begin OPTIONS strip
1894 @item -F @var{bfdname}
1895 @itemx --target=@var{bfdname}
1896 Treat the original @var{objfile} as a file with the object
1897 code format @var{bfdname}, and rewrite it in the same format.
1898 @xref{Target Selection}, for more information.
1901 Show a summary of the options to @code{strip} and exit.
1903 @item -I @var{bfdname}
1904 @itemx --input-target=@var{bfdname}
1905 Treat the original @var{objfile} as a file with the object
1906 code format @var{bfdname}.
1907 @xref{Target Selection}, for more information.
1909 @item -O @var{bfdname}
1910 @itemx --output-target=@var{bfdname}
1911 Replace @var{objfile} with a file in the output format @var{bfdname}.
1912 @xref{Target Selection}, for more information.
1914 @item -R @var{sectionname}
1915 @itemx --remove-section=@var{sectionname}
1916 Remove any section named @var{sectionname} from the output file. This
1917 option may be given more than once. Note that using this option
1918 inappropriately may make the output file unusable.
1926 @itemx --strip-debug
1927 Remove debugging symbols only.
1929 @item --strip-unneeded
1930 Remove all symbols that are not needed for relocation processing.
1932 @item -K @var{symbolname}
1933 @itemx --keep-symbol=@var{symbolname}
1934 Keep only symbol @var{symbolname} from the source file. This option may
1935 be given more than once.
1937 @item -N @var{symbolname}
1938 @itemx --strip-symbol=@var{symbolname}
1939 Remove symbol @var{symbolname} from the source file. This option may be
1940 given more than once, and may be combined with strip options other than
1944 Put the stripped output in @var{file}, rather than replacing the
1945 existing file. When this argument is used, only one @var{objfile}
1946 argument may be specified.
1949 @itemx --preserve-dates
1950 Preserve the access and modification dates of the file.
1953 @itemx --discard-all
1954 Remove non-global symbols.
1957 @itemx --discard-locals
1958 Remove compiler-generated local symbols.
1959 (These usually start with @samp{L} or @samp{.}.)
1963 Show the version number for @code{strip}.
1967 Verbose output: list all object files modified. In the case of
1968 archives, @samp{strip -v} lists all members of the archive.
1974 @c man begin SEEALSO strip
1975 the Info entries for @file{binutils}.
1979 @node c++filt, addr2line, strip, Top
1983 @cindex demangling C++ symbols
1985 @c man title cxxfilt Demangle C++ and Java symbols.
1988 @c man begin SYNOPSIS cxxfilt
1989 c++filt [ -_ | --strip-underscores ]
1991 [ -n | --no-strip-underscores ]
1992 [ -s @var{format} | --format=@var{format} ]
1993 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
1997 @c man begin DESCRIPTION cxxfilt
2000 The C++ and Java languages provides function overloading, which means
2001 that you can write many functions with the same name (providing each
2002 takes parameters of different types). All C++ and Java function names
2003 are encoded into a low-level assembly label (this process is known as
2004 @dfn{mangling}). The @code{c++filt}
2005 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2006 MS-DOS this program is named @code{cxxfilt}.}
2007 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2008 names into user-level names so that the linker can keep these overloaded
2009 functions from clashing.
2011 Every alphanumeric word (consisting of letters, digits, underscores,
2012 dollars, or periods) seen in the input is a potential label. If the
2013 label decodes into a C++ name, the C++ name replaces the low-level
2016 You can use @code{c++filt} to decipher individual symbols:
2019 c++filt @var{symbol}
2022 If no @var{symbol} arguments are given, @code{c++filt} reads symbol
2023 names from the standard input and writes the demangled names to the
2024 standard output. All results are printed on the standard output.
2028 @c man begin OPTIONS cxxfilt
2032 @itemx --strip-underscores
2033 On some systems, both the C and C++ compilers put an underscore in front
2034 of every name. For example, the C name @code{foo} gets the low-level
2035 name @code{_foo}. This option removes the initial underscore. Whether
2036 @code{c++filt} removes the underscore by default is target dependent.
2040 Prints demangled names using Java syntax. The default is to use C++
2044 @itemx --no-strip-underscores
2045 Do not remove the initial underscore.
2047 @item -s @var{format}
2048 @itemx --format=@var{format}
2049 @sc{gnu} @code{nm} can decode three different methods of mangling, used by
2050 different C++ compilers. The argument to this option selects which
2055 the one used by the @sc{gnu} compiler (the default method)
2057 the one used by the Lucid compiler
2059 the one specified by the C++ Annotated Reference Manual
2061 the one used by the HP compiler
2063 the one used by the EDG compiler
2065 the one used by the @sc{gnu} compiler with the new ABI.
2069 Print a summary of the options to @code{c++filt} and exit.
2072 Print the version number of @code{c++filt} and exit.
2078 @c man begin SEEALSO cxxfilt
2079 the Info entries for @file{binutils}.
2084 @emph{Warning:} @code{c++filt} is a new utility, and the details of its
2085 user interface are subject to change in future releases. In particular,
2086 a command-line option may be required in the the future to decode a name
2087 passed as an argument on the command line; in other words,
2090 c++filt @var{symbol}
2094 may in a future release become
2097 c++filt @var{option} @var{symbol}
2105 @cindex address to file name and line number
2107 @c man title addr2line convert addresses into file names and line numbers.
2110 @c man begin SYNOPSIS addr2line
2111 addr2line [ -b @var{bfdname} | --target=@var{bfdname} ]
2112 [ -C | --demangle[=@var{style} ]
2113 [ -e @var{filename} | --exe=@var{filename} ]
2114 [ -f | --functions ] [ -s | --basename ]
2115 [ -H | --help ] [ -V | --version ]
2120 @c man begin DESCRIPTION addr2line
2122 @code{addr2line} translates program addresses into file names and line
2123 numbers. Given an address and an executable, it uses the debugging
2124 information in the executable to figure out which file name and line
2125 number are associated with a given address.
2127 The executable to use is specified with the @code{-e} option. The
2128 default is the file @file{a.out}.
2130 @code{addr2line} has two modes of operation.
2132 In the first, hexadecimal addresses are specified on the command line,
2133 and @code{addr2line} displays the file name and line number for each
2136 In the second, @code{addr2line} reads hexadecimal addresses from
2137 standard input, and prints the file name and line number for each
2138 address on standard output. In this mode, @code{addr2line} may be used
2139 in a pipe to convert dynamically chosen addresses.
2141 The format of the output is @samp{FILENAME:LINENO}. The file name and
2142 line number for each address is printed on a separate line. If the
2143 @code{-f} option is used, then each @samp{FILENAME:LINENO} line is
2144 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2145 containing the address.
2147 If the file name or function name can not be determined,
2148 @code{addr2line} will print two question marks in their place. If the
2149 line number can not be determined, @code{addr2line} will print 0.
2153 @c man begin OPTIONS addr2line
2155 The long and short forms of options, shown here as alternatives, are
2159 @item -b @var{bfdname}
2160 @itemx --target=@var{bfdname}
2161 @cindex object code format
2162 Specify that the object-code format for the object files is
2166 @itemx --demangle[=@var{style}]
2167 @cindex demangling in objdump
2168 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2169 Besides removing any initial underscore prepended by the system, this
2170 makes C++ function names readable. Different compilers have different
2171 mangling styles. The optional demangling style argument can be used to
2172 choose an appropriate demangling style for your compiler. @xref{c++filt},
2173 for more information on demangling.
2175 @item -e @var{filename}
2176 @itemx --exe=@var{filename}
2177 Specify the name of the executable for which addresses should be
2178 translated. The default file is @file{a.out}.
2182 Display function names as well as file and line number information.
2186 Display only the base of each file name.
2192 @c man begin SEEALSO addr2line
2193 Info entries for @file{binutils}.
2200 @code{nlmconv} converts a relocatable object file into a NetWare
2204 @code{nlmconv} currently works with @samp{i386} object
2205 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
2206 object files in @sc{elf}, or @code{a.out} format@footnote{
2207 @code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
2208 format in the Binary File Descriptor library. It has only been tested
2209 with the above formats.}.
2213 @emph{Warning:} @code{nlmconv} is not always built as part of the binary
2214 utilities, since it is only useful for NLM targets.
2217 @c man title nlmconv converts object code into an NLM.
2220 @c man begin SYNOPSIS nlmconv
2221 nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
2222 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
2223 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
2224 [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
2225 [ -h | --help ] [ -V | --version ]
2226 @var{infile} @var{outfile}
2230 @c man begin DESCRIPTION nlmconv
2232 @code{nlmconv} converts the relocatable @samp{i386} object file
2233 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
2234 reading @var{headerfile} for NLM header information. For instructions
2235 on writing the NLM command file language used in header files, see the
2236 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
2237 Development and Tools Overview}, which is part of the NLM Software
2238 Developer's Kit (``NLM SDK''), available from Novell, Inc.
2239 @code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
2242 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
2245 @code{nlmconv} can perform a link step. In other words, you can list
2246 more than one object file for input if you list them in the definitions
2247 file (rather than simply specifying one input file on the command line).
2248 In this case, @code{nlmconv} calls the linker for you.
2252 @c man begin OPTIONS nlmconv
2255 @item -I @var{bfdname}
2256 @itemx --input-target=@var{bfdname}
2257 Object format of the input file. @code{nlmconv} can usually determine
2258 the format of a given file (so no default is necessary).
2259 @xref{Target Selection}, for more information.
2261 @item -O @var{bfdname}
2262 @itemx --output-target=@var{bfdname}
2263 Object format of the output file. @code{nlmconv} infers the output
2264 format based on the input format, e.g. for a @samp{i386} input file the
2265 output format is @samp{nlm32-i386}.
2266 @xref{Target Selection}, for more information.
2268 @item -T @var{headerfile}
2269 @itemx --header-file=@var{headerfile}
2270 Reads @var{headerfile} for NLM header information. For instructions on
2271 writing the NLM command file language used in header files, see@ see the
2272 @samp{linkers} section, of the @cite{NLM Development and Tools
2273 Overview}, which is part of the NLM Software Developer's Kit, available
2278 Displays (on standard error) the linker command line used by @code{nlmconv}.
2280 @item -l @var{linker}
2281 @itemx --linker=@var{linker}
2282 Use @var{linker} for any linking. @var{linker} can be an absolute or a
2287 Prints a usage summary.
2291 Prints the version number for @code{nlmconv}.
2297 @c man begin SEEALSO nlmconv
2298 the Info entries for @file{binutils}.
2305 @code{windres} may be used to manipulate Windows resources.
2308 @emph{Warning:} @code{windres} is not always built as part of the binary
2309 utilities, since it is only useful for Windows targets.
2312 @c man title windres manipulate Windows resources.
2315 @c man begin SYNOPSIS windres
2316 windres [options] [input-file] [output-file]
2320 @c man begin DESCRIPTION windres
2322 @code{windres} reads resources from an input file and copies them into
2323 an output file. Either file may be in one of three formats:
2327 A text format read by the Resource Compiler.
2330 A binary format generated by the Resource Compiler.
2333 A COFF object or executable.
2336 The exact description of these different formats is available in
2337 documentation from Microsoft.
2339 When @code{windres} converts from the @code{rc} format to the @code{res}
2340 format, it is acting like the Windows Resource Compiler. When
2341 @code{windres} converts from the @code{res} format to the @code{coff}
2342 format, it is acting like the Windows @code{CVTRES} program.
2344 When @code{windres} generates an @code{rc} file, the output is similar
2345 but not identical to the format expected for the input. When an input
2346 @code{rc} file refers to an external filename, an output @code{rc} file
2347 will instead include the file contents.
2349 If the input or output format is not specified, @code{windres} will
2350 guess based on the file name, or, for the input file, the file contents.
2351 A file with an extension of @file{.rc} will be treated as an @code{rc}
2352 file, a file with an extension of @file{.res} will be treated as a
2353 @code{res} file, and a file with an extension of @file{.o} or
2354 @file{.exe} will be treated as a @code{coff} file.
2356 If no output file is specified, @code{windres} will print the resources
2357 in @code{rc} format to standard output.
2359 The normal use is for you to write an @code{rc} file, use @code{windres}
2360 to convert it to a COFF object file, and then link the COFF file into
2361 your application. This will make the resources described in the
2362 @code{rc} file available to Windows.
2366 @c man begin OPTIONS windres
2369 @item -i @var{filename}
2370 @itemx --input @var{filename}
2371 The name of the input file. If this option is not used, then
2372 @code{windres} will use the first non-option argument as the input file
2373 name. If there are no non-option arguments, then @code{windres} will
2374 read from standard input. @code{windres} can not read a COFF file from
2377 @item -o @var{filename}
2378 @itemx --output @var{filename}
2379 The name of the output file. If this option is not used, then
2380 @code{windres} will use the first non-option argument, after any used
2381 for the input file name, as the output file name. If there is no
2382 non-option argument, then @code{windres} will write to standard output.
2383 @code{windres} can not write a COFF file to standard output.
2385 @item -I @var{format}
2386 @itemx --input-format @var{format}
2387 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
2388 @samp{coff}. If no input format is specified, @code{windres} will
2389 guess, as described above.
2391 @item -O @var{format}
2392 @itemx --output-format @var{format}
2393 The output format to generate. @var{format} may be @samp{res},
2394 @samp{rc}, or @samp{coff}. If no output format is specified,
2395 @code{windres} will guess, as described above.
2397 @item -F @var{target}
2398 @itemx --target @var{target}
2399 Specify the BFD format to use for a COFF file as input or output. This
2400 is a BFD target name; you can use the @code{--help} option to see a list
2401 of supported targets. Normally @code{windres} will use the default
2402 format, which is the first one listed by the @code{--help} option.
2403 @ref{Target Selection}.
2405 @item --preprocessor @var{program}
2406 When @code{windres} reads an @code{rc} file, it runs it through the C
2407 preprocessor first. This option may be used to specify the preprocessor
2408 to use, including any leading arguments. The default preprocessor
2409 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
2411 @item --include-dir @var{directory}
2412 Specify an include directory to use when reading an @code{rc} file.
2413 @code{windres} will pass this to the preprocessor as an @code{-I}
2414 option. @code{windres} will also search this directory when looking for
2415 files named in the @code{rc} file.
2417 @item -D @var{target}
2418 @itemx --define @var{sym}[=@var{val}]
2419 Specify a @code{-D} option to pass to the preprocessor when reading an
2423 Enable verbose mode. This tells you what the preprocessor is if you
2426 @item --language @var{val}
2427 Specify the default language to use when reading an @code{rc} file.
2428 @var{val} should be a hexadecimal language code. The low eight bits are
2429 the language, and the high eight bits are the sublanguage.
2431 @item --use-temp-file
2432 Use a temporary file to instead of using popen to read the output of
2433 the preprocessor. Use this option if the popen implementation is buggy
2434 on the host (eg., certain non-English language versions of Windows 95 and
2435 Windows 98 are known to have buggy popen where the output will instead
2438 @item --no-use-temp-file
2439 Use popen, not a temporary file, to read the output of the preprocessor.
2440 This is the default behaviour.
2443 Prints a usage summary.
2446 Prints the version number for @code{windres}.
2449 If @code{windres} is compiled with @code{YYDEBUG} defined as @code{1},
2450 this will turn on parser debugging.
2456 @c man begin SEEALSO windres
2457 the Info entries for @file{binutils}.
2462 @chapter Create files needed to build and use DLLs
2466 @code{dlltool} may be used to create the files needed to build and use
2467 dynamic link libraries (DLLs).
2470 @emph{Warning:} @code{dlltool} is not always built as part of the binary
2471 utilities, since it is only useful for those targets which support DLLs.
2474 @c man title dlltool Create files needed to build and use DLLs.
2477 @c man begin SYNOPSIS dlltool
2478 dlltool [-d|--input-def @var{def-file-name}]
2479 [-b|--base-file @var{base-file-name}]
2480 [-e|--output-exp @var{exports-file-name}]
2481 [-z|--output-def @var{def-file-name}]
2482 [-l|--output-lib @var{library-file-name}]
2483 [--export-all-symbols] [--no-export-all-symbols]
2484 [--exclude-symbols @var{list}]
2485 [--no-default-excludes]
2486 [-S|--as @var{path-to-assembler}] [-f|--as-flags @var{options}]
2487 [-D|--dllname @var{name}] [-m|--machine @var{machine}]
2488 [-a|--add-indirect] [-U|--add-underscore] [-k|--kill-at]
2489 [-A|--add-stdcall-alias]
2490 [-x|--no-idata4] [-c|--no-idata5] [-i|--interwork]
2491 [-n|--nodelete] [-v|--verbose] [-h|--help] [-V|--version]
2492 [object-file @dots{}]
2496 @c man begin DESCRIPTION dlltool
2498 @code{dlltool} reads its inputs, which can come from the @samp{-d} and
2499 @samp{-b} options as well as object files specified on the command
2500 line. It then processes these inputs and if the @samp{-e} option has
2501 been specified it creates a exports file. If the @samp{-l} option
2502 has been specified it creates a library file and if the @samp{-z} option
2503 has been specified it creates a def file. Any or all of the -e, -l
2504 and -z options can be present in one invocation of dlltool.
2506 When creating a DLL, along with the source for the DLL, it is necessary
2507 to have three other files. @code{dlltool} can help with the creation of
2510 The first file is a @samp{.def} file which specifies which functions are
2511 exported from the DLL, which functions the DLL imports, and so on. This
2512 is a text file and can be created by hand, or @code{dlltool} can be used
2513 to create it using the @samp{-z} option. In this case @code{dlltool}
2514 will scan the object files specified on its command line looking for
2515 those functions which have been specially marked as being exported and
2516 put entries for them in the .def file it creates.
2518 In order to mark a function as being exported from a DLL, it needs to
2519 have an @samp{-export:<name_of_function>} entry in the @samp{.drectve}
2520 section of the object file. This can be done in C by using the
2524 asm (".section .drectve");
2525 asm (".ascii \"-export:my_func\"");
2527 int my_func (void) @{ @dots{} @}
2530 The second file needed for DLL creation is an exports file. This file
2531 is linked with the object files that make up the body of the DLL and it
2532 handles the interface between the DLL and the outside world. This is a
2533 binary file and it can be created by giving the @samp{-e} option to
2534 @code{dlltool} when it is creating or reading in a .def file.
2536 The third file needed for DLL creation is the library file that programs
2537 will link with in order to access the functions in the DLL. This file
2538 can be created by giving the @samp{-l} option to dlltool when it
2539 is creating or reading in a .def file.
2541 @code{dlltool} builds the library file by hand, but it builds the
2542 exports file by creating temporary files containing assembler statements
2543 and then assembling these. The @samp{-S} command line option can be
2544 used to specify the path to the assembler that dlltool will use,
2545 and the @samp{-f} option can be used to pass specific flags to that
2546 assembler. The @samp{-n} can be used to prevent dlltool from deleting
2547 these temporary assembler files when it is done, and if @samp{-n} is
2548 specified twice then this will prevent dlltool from deleting the
2549 temporary object files it used to build the library.
2551 Here is an example of creating a DLL from a source file @samp{dll.c} and
2552 also creating a program (from an object file called @samp{program.o})
2557 dlltool -e exports.o -l dll.lib dll.o
2558 gcc dll.o exports.o -o dll.dll
2559 gcc program.o dll.lib -o program
2564 @c man begin OPTIONS dlltool
2566 The command line options have the following meanings:
2570 @item -d @var{filename}
2571 @itemx --input-def @var{filename}
2572 @cindex input .def file
2573 Specifies the name of a .def file to be read in and processed.
2575 @item -b @var{filename}
2576 @itemx --base-file @var{filename}
2578 Specifies the name of a base file to be read in and processed. The
2579 contents of this file will be added to the relocation section in the
2580 exports file generated by dlltool.
2582 @item -e @var{filename}
2583 @itemx --output-exp @var{filename}
2584 Specifies the name of the export file to be created by dlltool.
2586 @item -z @var{filename}
2587 @itemx --output-def @var{filename}
2588 Specifies the name of the .def file to be created by dlltool.
2590 @item -l @var{filename}
2591 @itemx --output-lib @var{filename}
2592 Specifies the name of the library file to be created by dlltool.
2594 @item --export-all-symbols
2595 Treat all global and weak defined symbols found in the input object
2596 files as symbols to be exported. There is a small list of symbols which
2597 are not exported by default; see the @code{--no-default-excludes}
2598 option. You may add to the list of symbols to not export by using the
2599 @code{--exclude-symbols} option.
2601 @item --no-export-all-symbols
2602 Only export symbols explicitly listed in an input .def file or in
2603 @samp{.drectve} sections in the input object files. This is the default
2604 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
2605 attributes in the source code.
2607 @item --exclude-symbols @var{list}
2608 Do not export the symbols in @var{list}. This is a list of symbol names
2609 separated by comma or colon characters. The symbol names should not
2610 contain a leading underscore. This is only meaningful when
2611 @code{--export-all-symbols} is used.
2613 @item --no-default-excludes
2614 When @code{--export-all-symbols} is used, it will by default avoid
2615 exporting certain special symbols. The current list of symbols to avoid
2616 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
2617 @samp{impure_ptr}. You may use the @code{--no-default-excludes} option
2618 to go ahead and export these special symbols. This is only meaningful
2619 when @code{--export-all-symbols} is used.
2622 @itemx --as @var{path}
2623 Specifies the path, including the filename, of the assembler to be used
2624 to create the exports file.
2626 @item -f @var{switches}
2627 @itemx --as-flags @var{switches}
2628 Specifies any specific command line switches to be passed to the
2629 assembler when building the exports file. This option will work even if
2630 the @samp{-S} option is not used. This option only takes one argument,
2631 and if it occurs more than once on the command line, then later
2632 occurrences will override earlier occurrences. So if it is necessary to
2633 pass multiple switches to the assembler they should be enclosed in
2637 @itemx --dll-name @var{name}
2638 Specifies the name to be stored in the .def file as the name of the DLL
2639 when the @samp{-e} option is used. If this option is not present, then
2640 the filename given to the @samp{-e} option will be used as the name of
2643 @item -m @var{machine}
2644 @itemx -machine @var{machine}
2645 Specifies the type of machine for which the library file should be
2646 built. @code{dlltool} has a built in default type, depending upon how
2647 it was created, but this option can be used to override that. This is
2648 normally only useful when creating DLLs for an ARM processor, when the
2649 contents of the DLL are actually encode using THUMB instructions.
2652 @itemx --add-indirect
2653 Specifies that when @code{dlltool} is creating the exports file it
2654 should add a section which allows the exported functions to be
2655 referenced without using the import library. Whatever the hell that
2659 @itemx --add-underscore
2660 Specifies that when @code{dlltool} is creating the exports file it
2661 should prepend an underscore to the names of the exported functions.
2665 Specifies that when @code{dlltool} is creating the exports file it
2666 should not append the string @samp{@@ <number>}. These numbers are
2667 called ordinal numbers and they represent another way of accessing the
2668 function in a DLL, other than by name.
2671 @itemx --add-stdcall-alias
2672 Specifies that when @code{dlltool} is creating the exports file it
2673 should add aliases for stdcall symbols without @samp{@@ <number>}
2674 in addition to the symbols with @samp{@@ <number>}.
2678 Specifies that when @code{dlltool} is creating the exports and library
2679 files it should omit the .idata4 section. This is for compatibility
2680 with certain operating systems.
2684 Specifies that when @code{dlltool} is creating the exports and library
2685 files it should omit the .idata5 section. This is for compatibility
2686 with certain operating systems.
2690 Specifies that @code{dlltool} should mark the objects in the library
2691 file and exports file that it produces as supporting interworking
2692 between ARM and THUMB code.
2696 Makes @code{dlltool} preserve the temporary assembler files it used to
2697 create the exports file. If this option is repeated then dlltool will
2698 also preserve the temporary object files it uses to create the library
2703 Make dlltool describe what it is doing.
2707 Displays a list of command line options and then exits.
2711 Displays dlltool's version number and then exits.
2718 @c man begin SEEALSO dlltool
2719 the Info entries for @file{binutils}.
2726 @cindex ELF file information
2729 @c man title readelf Displays information about ELF files.
2732 @c man begin SYNOPSIS readelf
2733 readelf [ -a | --all ]
2734 [ -h | --file-header]
2735 [ -l | --program-headers | --segments]
2736 [ -S | --section-headers | --sections]
2738 [ -s | --syms | --symbols]
2743 [ -V | --version-info]
2744 [ -D | --use-dynamic]
2745 [ -x <number> | --hex-dump=<number>]
2746 [ -w[liaprf] | --debug-dump[=info,=line,=abbrev,=pubnames,=ranges,=frames]]
2750 @var{elffile}@dots{}
2754 @c man begin DESCRIPTION readelf
2756 @code{readelf} displays information about one or more ELF format object
2757 files. The options control what particular information to display.
2759 @var{elffile}@dots{} are the object files to be examined. At the
2760 moment, @code{readelf} does not support examining archives, nor does it
2761 support examing 64 bit ELF files.
2765 @c man begin OPTIONS readelf
2767 The long and short forms of options, shown here as alternatives, are
2768 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
2774 Equivalent to specifiying @samp{--file-header},
2775 @samp{--program-headers}, @samp{--sections}, @samp{--symbols},
2776 @samp{--relocs}, @samp{--dynamic}, @samp{--notes} and
2777 @samp{--version-info}.
2780 @itemx --file-header
2781 @cindex ELF file header information
2782 Displays the information contained in the ELF header at the start of the
2786 @itemx --program-headers
2788 @cindex ELF program header information
2789 @cindex ELF segment information
2790 Displays the information contained in the file's segment headers, if it
2795 @itemx --section-headers
2796 @cindex ELF section information
2797 Displays the information contained in the file's section headers, if it
2803 @cindex ELF symbol table information
2804 Displays the entries in symbol table section of the file, if it has one.
2808 Display all the headers in the file. Equivalent to @samp{-h -l -S}.
2812 @cindex ELF core notes
2813 Displays the contents of the NOTE segment, if it exists.
2817 @cindex ELF reloc information
2818 Displays the contents of the file's relocation section, if it has one.
2822 @cindex unwind information
2823 Displays the contents of the file's unwind section, if it has one. Only
2824 the unwind sections for IA64 ELF files are currently supported.
2828 @cindex ELF dynamic section information
2829 Displays the contents of the file's dynamic section, if it has one.
2832 @itemx --version-info
2833 @cindex ELF version sections informations
2834 Displays the contents of the version sections in the file, it they
2838 @itemx --use-dynamic
2839 When displaying symbols, this option makes @code{readelf} use the
2840 symbol table in the file's dynamic section, rather than the one in the
2844 @itemx --hex-dump=<number>
2845 Displays the contents of the indicated section as a hexadecimal dump.
2848 @itemx --debug-dump[=line,=info,=abbrev,=pubnames,=ranges,=frames]
2849 Displays the contents of the debug sections in the file, if any are
2850 present. If one of the optional letters or words follows the switch
2851 then only data found in those specific sections will be dumped.
2854 Display a histogram of bucket list lengths when displaying the contents
2855 of the symbol tables.
2859 Display the version number of readelf.
2863 Display the command line options understood by @code{readelf}.
2870 @c man begin SEEALSO readelf
2871 objdump(1), and the Info entries for @file{binutils}.
2875 @node Selecting The Target System
2876 @chapter Selecting the target system
2878 You can specify three aspects of the target system to the @sc{gnu}
2879 binary file utilities, each in several ways:
2889 the linker emulation (which applies to the linker only)
2892 In the following summaries, the lists of ways to specify values are in
2893 order of decreasing precedence. The ways listed first override those
2896 The commands to list valid values only list the values for which the
2897 programs you are running were configured. If they were configured with
2898 @samp{--enable-targets=all}, the commands list most of the available
2899 values, but a few are left out; not all targets can be configured in at
2900 once because some of them can only be configured @dfn{native} (on hosts
2901 with the same type as the target system).
2904 * Target Selection::
2905 * Architecture Selection::
2906 * Linker Emulation Selection::
2909 @node Target Selection
2910 @section Target Selection
2912 A @dfn{target} is an object file format. A given target may be
2913 supported for multiple architectures (@pxref{Architecture Selection}).
2914 A target selection may also have variations for different operating
2915 systems or architectures.
2917 The command to list valid target values is @samp{objdump -i}
2918 (the first column of output contains the relevant information).
2920 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
2921 @samp{a.out-sunos-big}.
2923 You can also specify a target using a configuration triplet. This is
2924 the same sort of name that is passed to @file{configure} to specify a
2925 target. When you use a configuration triplet as an argument, it must be
2926 fully canonicalized. You can see the canonical version of a triplet by
2927 running the shell script @file{config.sub} which is included with the
2930 Some sample configuration triplets are: @samp{m68k-hp-bsd},
2931 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
2933 @subheading @code{objdump} Target
2939 command line option: @samp{-b} or @samp{--target}
2942 environment variable @code{GNUTARGET}
2945 deduced from the input file
2948 @subheading @code{objcopy} and @code{strip} Input Target
2954 command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
2957 environment variable @code{GNUTARGET}
2960 deduced from the input file
2963 @subheading @code{objcopy} and @code{strip} Output Target
2969 command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
2972 the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
2975 environment variable @code{GNUTARGET}
2978 deduced from the input file
2981 @subheading @code{nm}, @code{size}, and @code{strings} Target
2987 command line option: @samp{--target}
2990 environment variable @code{GNUTARGET}
2993 deduced from the input file
2996 @subheading Linker Input Target
3002 command line option: @samp{-b} or @samp{--format}
3003 (@pxref{Options,,Options,ld.info,Using LD})
3006 script command @code{TARGET}
3007 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
3010 environment variable @code{GNUTARGET}
3011 (@pxref{Environment,,Environment,ld.info,Using LD})
3014 the default target of the selected linker emulation
3015 (@pxref{Linker Emulation Selection})
3018 @subheading Linker Output Target
3024 command line option: @samp{-oformat}
3025 (@pxref{Options,,Options,ld.info,Using LD})
3028 script command @code{OUTPUT_FORMAT}
3029 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
3032 the linker input target (see ``Linker Input Target'' above)
3035 @node Architecture Selection
3036 @section Architecture selection
3038 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
3039 to run. Its name may contain a colon, separating the name of the
3040 processor family from the name of the particular @sc{cpu}.
3042 The command to list valid architecture values is @samp{objdump -i} (the
3043 second column contains the relevant information).
3045 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
3047 @subheading @code{objdump} Architecture
3053 command line option: @samp{-m} or @samp{--architecture}
3056 deduced from the input file
3059 @subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
3065 deduced from the input file
3068 @subheading Linker Input Architecture
3074 deduced from the input file
3077 @subheading Linker Output Architecture
3083 script command @code{OUTPUT_ARCH}
3084 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
3087 the default architecture from the linker output target
3088 (@pxref{Target Selection})
3091 @node Linker Emulation Selection
3092 @section Linker emulation selection
3094 A linker @dfn{emulation} is a ``personality'' of the linker, which gives
3095 the linker default values for the other aspects of the target system.
3096 In particular, it consists of
3106 several ``hook'' functions that are run at certain stages of the linking
3107 process to do special things that some targets require
3110 The command to list valid linker emulation values is @samp{ld -V}.
3112 Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
3118 command line option: @samp{-m}
3119 (@pxref{Options,,Options,ld.info,Using LD})
3122 environment variable @code{LDEMULATION}
3125 compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
3126 which comes from @code{EMUL} in @file{config/@var{target}.mt}
3129 @node Reporting Bugs
3130 @chapter Reporting Bugs
3132 @cindex reporting bugs
3134 Your bug reports play an essential role in making the binary utilities
3137 Reporting a bug may help you by bringing a solution to your problem, or
3138 it may not. But in any case the principal function of a bug report is
3139 to help the entire community by making the next version of the binary
3140 utilities work better. Bug reports are your contribution to their
3143 In order for a bug report to serve its purpose, you must include the
3144 information that enables us to fix the bug.
3147 * Bug Criteria:: Have you found a bug?
3148 * Bug Reporting:: How to report bugs
3152 @section Have you found a bug?
3153 @cindex bug criteria
3155 If you are not sure whether you have found a bug, here are some guidelines:
3158 @cindex fatal signal
3161 If a binary utility gets a fatal signal, for any input whatever, that is
3162 a bug. Reliable utilities never crash.
3164 @cindex error on valid input
3166 If a binary utility produces an error message for valid input, that is a
3170 If you are an experienced user of binary utilities, your suggestions for
3171 improvement are welcome in any case.
3175 @section How to report bugs
3177 @cindex bugs, reporting
3179 A number of companies and individuals offer support for @sc{gnu}
3180 products. If you obtained the binary utilities from a support
3181 organization, we recommend you contact that organization first.
3183 You can find contact information for many support companies and
3184 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
3187 In any event, we also recommend that you send bug reports for the binary
3188 utilities to @samp{bug-binutils@@gnu.org}.
3190 The fundamental principle of reporting bugs usefully is this:
3191 @strong{report all the facts}. If you are not sure whether to state a
3192 fact or leave it out, state it!
3194 Often people omit facts because they think they know what causes the
3195 problem and assume that some details do not matter. Thus, you might
3196 assume that the name of a file you use in an example does not matter.
3197 Well, probably it does not, but one cannot be sure. Perhaps the bug is
3198 a stray memory reference which happens to fetch from the location where
3199 that pathname is stored in memory; perhaps, if the pathname were
3200 different, the contents of that location would fool the utility into
3201 doing the right thing despite the bug. Play it safe and give a
3202 specific, complete example. That is the easiest thing for you to do,
3203 and the most helpful.
3205 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
3206 it is new to us. Therefore, always write your bug reports on the assumption
3207 that the bug has not been reported previously.
3209 Sometimes people give a few sketchy facts and ask, ``Does this ring a
3210 bell?'' Those bug reports are useless, and we urge everyone to
3211 @emph{refuse to respond to them} except to chide the sender to report
3214 To enable us to fix the bug, you should include all these things:
3218 The version of the utility. Each utility announces it if you start it
3219 with the @samp{--version} argument.
3221 Without this, we will not know whether there is any point in looking for
3222 the bug in the current version of the binary utilities.
3225 Any patches you may have applied to the source, including any patches
3226 made to the @code{BFD} library.
3229 The type of machine you are using, and the operating system name and
3233 What compiler (and its version) was used to compile the utilities---e.g.
3237 The command arguments you gave the utility to observe the bug. To
3238 guarantee you will not omit something important, list them all. A copy
3239 of the Makefile (or the output from make) is sufficient.
3241 If we were to try to guess the arguments, we would probably guess wrong
3242 and then we might not encounter the bug.
3245 A complete input file, or set of input files, that will reproduce the
3246 bug. If the utility is reading an object file or files, then it is
3247 generally most helpful to send the actual object files, uuencoded if
3248 necessary to get them through the mail system. Note that
3249 @samp{bug-binutils@@gnu.org} is a mailing list, so you should avoid
3250 sending very large files to it. Making the files available for
3251 anonymous FTP is OK.
3253 If the source files were produced exclusively using @sc{gnu} programs
3254 (e.g., @code{gcc}, @code{gas}, and/or the @sc{gnu} @code{ld}), then it
3255 may be OK to send the source files rather than the object files. In
3256 this case, be sure to say exactly what version of @code{gcc}, or
3257 whatever, was used to produce the object files. Also say how
3258 @code{gcc}, or whatever, was configured.
3261 A description of what behavior you observe that you believe is
3262 incorrect. For example, ``It gets a fatal signal.''
3264 Of course, if the bug is that the utility gets a fatal signal, then we
3265 will certainly notice it. But if the bug is incorrect output, we might
3266 not notice unless it is glaringly wrong. You might as well not give us
3267 a chance to make a mistake.
3269 Even if the problem you experience is a fatal signal, you should still
3270 say so explicitly. Suppose something strange is going on, such as your
3271 copy of the utility is out of synch, or you have encountered a bug in
3272 the C library on your system. (This has happened!) Your copy might
3273 crash and ours would not. If you told us to expect a crash, then when
3274 ours fails to crash, we would know that the bug was not happening for
3275 us. If you had not told us to expect a crash, then we would not be able
3276 to draw any conclusion from our observations.
3279 If you wish to suggest changes to the source, send us context diffs, as
3280 generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
3281 option. Always send diffs from the old file to the new file. If you
3282 wish to discuss something in the @code{ld} source, refer to it by
3283 context, not by line number.
3285 The line numbers in our development sources will not match those in your
3286 sources. Your line numbers would convey no useful information to us.
3289 Here are some things that are not necessary:
3293 A description of the envelope of the bug.
3295 Often people who encounter a bug spend a lot of time investigating
3296 which changes to the input file will make the bug go away and which
3297 changes will not affect it.
3299 This is often time consuming and not very useful, because the way we
3300 will find the bug is by running a single example under the debugger
3301 with breakpoints, not by pure deduction from a series of examples.
3302 We recommend that you save your time for something else.
3304 Of course, if you can find a simpler example to report @emph{instead}
3305 of the original one, that is a convenience for us. Errors in the
3306 output will be easier to spot, running under the debugger will take
3307 less time, and so on.
3309 However, simplification is not vital; if you do not want to do this,
3310 report the bug anyway and send us the entire test case you used.
3313 A patch for the bug.
3315 A patch for the bug does help us if it is a good one. But do not omit
3316 the necessary information, such as the test case, on the assumption that
3317 a patch is all we need. We might see problems with your patch and decide
3318 to fix the problem another way, or we might not understand it at all.
3320 Sometimes with programs as complicated as the binary utilities it is
3321 very hard to construct an example that will make the program follow a
3322 certain path through the code. If you do not send us the example, we
3323 will not be able to construct one, so we will not be able to verify that
3326 And if we cannot understand what bug you are trying to fix, or why your
3327 patch should be an improvement, we will not install it. A test case will
3328 help us to understand.
3331 A guess about what the bug is or what it depends on.
3333 Such guesses are usually wrong. Even we cannot guess right about such
3334 things without first using the debugger to find the facts.
3337 @node GNU Free Documentation License
3338 @chapter GNU Free Documentation License
3339 @cindex GNU Free Documentation License
3341 GNU Free Documentation License
3343 Version 1.1, March 2000
3345 Copyright (C) 2000 Free Software Foundation, Inc.
3346 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3348 Everyone is permitted to copy and distribute verbatim copies
3349 of this license document, but changing it is not allowed.
3354 The purpose of this License is to make a manual, textbook, or other
3355 written document "free" in the sense of freedom: to assure everyone
3356 the effective freedom to copy and redistribute it, with or without
3357 modifying it, either commercially or noncommercially. Secondarily,
3358 this License preserves for the author and publisher a way to get
3359 credit for their work, while not being considered responsible for
3360 modifications made by others.
3362 This License is a kind of "copyleft", which means that derivative
3363 works of the document must themselves be free in the same sense. It
3364 complements the GNU General Public License, which is a copyleft
3365 license designed for free software.
3367 We have designed this License in order to use it for manuals for free
3368 software, because free software needs free documentation: a free
3369 program should come with manuals providing the same freedoms that the
3370 software does. But this License is not limited to software manuals;
3371 it can be used for any textual work, regardless of subject matter or
3372 whether it is published as a printed book. We recommend this License
3373 principally for works whose purpose is instruction or reference.
3376 1. APPLICABILITY AND DEFINITIONS
3378 This License applies to any manual or other work that contains a
3379 notice placed by the copyright holder saying it can be distributed
3380 under the terms of this License. The "Document", below, refers to any
3381 such manual or work. Any member of the public is a licensee, and is
3384 A "Modified Version" of the Document means any work containing the
3385 Document or a portion of it, either copied verbatim, or with
3386 modifications and/or translated into another language.
3388 A "Secondary Section" is a named appendix or a front-matter section of
3389 the Document that deals exclusively with the relationship of the
3390 publishers or authors of the Document to the Document's overall subject
3391 (or to related matters) and contains nothing that could fall directly
3392 within that overall subject. (For example, if the Document is in part a
3393 textbook of mathematics, a Secondary Section may not explain any
3394 mathematics.) The relationship could be a matter of historical
3395 connection with the subject or with related matters, or of legal,
3396 commercial, philosophical, ethical or political position regarding
3399 The "Invariant Sections" are certain Secondary Sections whose titles
3400 are designated, as being those of Invariant Sections, in the notice
3401 that says that the Document is released under this License.
3403 The "Cover Texts" are certain short passages of text that are listed,
3404 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3405 the Document is released under this License.
3407 A "Transparent" copy of the Document means a machine-readable copy,
3408 represented in a format whose specification is available to the
3409 general public, whose contents can be viewed and edited directly and
3410 straightforwardly with generic text editors or (for images composed of
3411 pixels) generic paint programs or (for drawings) some widely available
3412 drawing editor, and that is suitable for input to text formatters or
3413 for automatic translation to a variety of formats suitable for input
3414 to text formatters. A copy made in an otherwise Transparent file
3415 format whose markup has been designed to thwart or discourage
3416 subsequent modification by readers is not Transparent. A copy that is
3417 not "Transparent" is called "Opaque".
3419 Examples of suitable formats for Transparent copies include plain
3420 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3421 or XML using a publicly available DTD, and standard-conforming simple
3422 HTML designed for human modification. Opaque formats include
3423 PostScript, PDF, proprietary formats that can be read and edited only
3424 by proprietary word processors, SGML or XML for which the DTD and/or
3425 processing tools are not generally available, and the
3426 machine-generated HTML produced by some word processors for output
3429 The "Title Page" means, for a printed book, the title page itself,
3430 plus such following pages as are needed to hold, legibly, the material
3431 this License requires to appear in the title page. For works in
3432 formats which do not have any title page as such, "Title Page" means
3433 the text near the most prominent appearance of the work's title,
3434 preceding the beginning of the body of the text.
3439 You may copy and distribute the Document in any medium, either
3440 commercially or noncommercially, provided that this License, the
3441 copyright notices, and the license notice saying this License applies
3442 to the Document are reproduced in all copies, and that you add no other
3443 conditions whatsoever to those of this License. You may not use
3444 technical measures to obstruct or control the reading or further
3445 copying of the copies you make or distribute. However, you may accept
3446 compensation in exchange for copies. If you distribute a large enough
3447 number of copies you must also follow the conditions in section 3.
3449 You may also lend copies, under the same conditions stated above, and
3450 you may publicly display copies.
3453 3. COPYING IN QUANTITY
3455 If you publish printed copies of the Document numbering more than 100,
3456 and the Document's license notice requires Cover Texts, you must enclose
3457 the copies in covers that carry, clearly and legibly, all these Cover
3458 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3459 the back cover. Both covers must also clearly and legibly identify
3460 you as the publisher of these copies. The front cover must present
3461 the full title with all words of the title equally prominent and
3462 visible. You may add other material on the covers in addition.
3463 Copying with changes limited to the covers, as long as they preserve
3464 the title of the Document and satisfy these conditions, can be treated
3465 as verbatim copying in other respects.
3467 If the required texts for either cover are too voluminous to fit
3468 legibly, you should put the first ones listed (as many as fit
3469 reasonably) on the actual cover, and continue the rest onto adjacent
3472 If you publish or distribute Opaque copies of the Document numbering
3473 more than 100, you must either include a machine-readable Transparent
3474 copy along with each Opaque copy, or state in or with each Opaque copy
3475 a publicly-accessible computer-network location containing a complete
3476 Transparent copy of the Document, free of added material, which the
3477 general network-using public has access to download anonymously at no
3478 charge using public-standard network protocols. If you use the latter
3479 option, you must take reasonably prudent steps, when you begin
3480 distribution of Opaque copies in quantity, to ensure that this
3481 Transparent copy will remain thus accessible at the stated location
3482 until at least one year after the last time you distribute an Opaque
3483 copy (directly or through your agents or retailers) of that edition to
3486 It is requested, but not required, that you contact the authors of the
3487 Document well before redistributing any large number of copies, to give
3488 them a chance to provide you with an updated version of the Document.
3493 You may copy and distribute a Modified Version of the Document under
3494 the conditions of sections 2 and 3 above, provided that you release
3495 the Modified Version under precisely this License, with the Modified
3496 Version filling the role of the Document, thus licensing distribution
3497 and modification of the Modified Version to whoever possesses a copy
3498 of it. In addition, you must do these things in the Modified Version:
3500 A. Use in the Title Page (and on the covers, if any) a title distinct
3501 from that of the Document, and from those of previous versions
3502 (which should, if there were any, be listed in the History section
3503 of the Document). You may use the same title as a previous version
3504 if the original publisher of that version gives permission.
3505 B. List on the Title Page, as authors, one or more persons or entities
3506 responsible for authorship of the modifications in the Modified
3507 Version, together with at least five of the principal authors of the
3508 Document (all of its principal authors, if it has less than five).
3509 C. State on the Title page the name of the publisher of the
3510 Modified Version, as the publisher.
3511 D. Preserve all the copyright notices of the Document.
3512 E. Add an appropriate copyright notice for your modifications
3513 adjacent to the other copyright notices.
3514 F. Include, immediately after the copyright notices, a license notice
3515 giving the public permission to use the Modified Version under the
3516 terms of this License, in the form shown in the Addendum below.
3517 G. Preserve in that license notice the full lists of Invariant Sections
3518 and required Cover Texts given in the Document's license notice.
3519 H. Include an unaltered copy of this License.
3520 I. Preserve the section entitled "History", and its title, and add to
3521 it an item stating at least the title, year, new authors, and
3522 publisher of the Modified Version as given on the Title Page. If
3523 there is no section entitled "History" in the Document, create one
3524 stating the title, year, authors, and publisher of the Document as
3525 given on its Title Page, then add an item describing the Modified
3526 Version as stated in the previous sentence.
3527 J. Preserve the network location, if any, given in the Document for
3528 public access to a Transparent copy of the Document, and likewise
3529 the network locations given in the Document for previous versions
3530 it was based on. These may be placed in the "History" section.
3531 You may omit a network location for a work that was published at
3532 least four years before the Document itself, or if the original
3533 publisher of the version it refers to gives permission.
3534 K. In any section entitled "Acknowledgements" or "Dedications",
3535 preserve the section's title, and preserve in the section all the
3536 substance and tone of each of the contributor acknowledgements
3537 and/or dedications given therein.
3538 L. Preserve all the Invariant Sections of the Document,
3539 unaltered in their text and in their titles. Section numbers
3540 or the equivalent are not considered part of the section titles.
3541 M. Delete any section entitled "Endorsements". Such a section
3542 may not be included in the Modified Version.
3543 N. Do not retitle any existing section as "Endorsements"
3544 or to conflict in title with any Invariant Section.
3546 If the Modified Version includes new front-matter sections or
3547 appendices that qualify as Secondary Sections and contain no material
3548 copied from the Document, you may at your option designate some or all
3549 of these sections as invariant. To do this, add their titles to the
3550 list of Invariant Sections in the Modified Version's license notice.
3551 These titles must be distinct from any other section titles.
3553 You may add a section entitled "Endorsements", provided it contains
3554 nothing but endorsements of your Modified Version by various
3555 parties--for example, statements of peer review or that the text has
3556 been approved by an organization as the authoritative definition of a
3559 You may add a passage of up to five words as a Front-Cover Text, and a
3560 passage of up to 25 words as a Back-Cover Text, to the end of the list
3561 of Cover Texts in the Modified Version. Only one passage of
3562 Front-Cover Text and one of Back-Cover Text may be added by (or
3563 through arrangements made by) any one entity. If the Document already
3564 includes a cover text for the same cover, previously added by you or
3565 by arrangement made by the same entity you are acting on behalf of,
3566 you may not add another; but you may replace the old one, on explicit
3567 permission from the previous publisher that added the old one.
3569 The author(s) and publisher(s) of the Document do not by this License
3570 give permission to use their names for publicity for or to assert or
3571 imply endorsement of any Modified Version.
3574 5. COMBINING DOCUMENTS
3576 You may combine the Document with other documents released under this
3577 License, under the terms defined in section 4 above for modified
3578 versions, provided that you include in the combination all of the
3579 Invariant Sections of all of the original documents, unmodified, and
3580 list them all as Invariant Sections of your combined work in its
3583 The combined work need only contain one copy of this License, and
3584 multiple identical Invariant Sections may be replaced with a single
3585 copy. If there are multiple Invariant Sections with the same name but
3586 different contents, make the title of each such section unique by
3587 adding at the end of it, in parentheses, the name of the original
3588 author or publisher of that section if known, or else a unique number.
3589 Make the same adjustment to the section titles in the list of
3590 Invariant Sections in the license notice of the combined work.
3592 In the combination, you must combine any sections entitled "History"
3593 in the various original documents, forming one section entitled
3594 "History"; likewise combine any sections entitled "Acknowledgements",
3595 and any sections entitled "Dedications". You must delete all sections
3596 entitled "Endorsements."
3599 6. COLLECTIONS OF DOCUMENTS
3601 You may make a collection consisting of the Document and other documents
3602 released under this License, and replace the individual copies of this
3603 License in the various documents with a single copy that is included in
3604 the collection, provided that you follow the rules of this License for
3605 verbatim copying of each of the documents in all other respects.
3607 You may extract a single document from such a collection, and distribute
3608 it individually under this License, provided you insert a copy of this
3609 License into the extracted document, and follow this License in all
3610 other respects regarding verbatim copying of that document.
3613 7. AGGREGATION WITH INDEPENDENT WORKS
3615 A compilation of the Document or its derivatives with other separate
3616 and independent documents or works, in or on a volume of a storage or
3617 distribution medium, does not as a whole count as a Modified Version
3618 of the Document, provided no compilation copyright is claimed for the
3619 compilation. Such a compilation is called an "aggregate", and this
3620 License does not apply to the other self-contained works thus compiled
3621 with the Document, on account of their being thus compiled, if they
3622 are not themselves derivative works of the Document.
3624 If the Cover Text requirement of section 3 is applicable to these
3625 copies of the Document, then if the Document is less than one quarter
3626 of the entire aggregate, the Document's Cover Texts may be placed on
3627 covers that surround only the Document within the aggregate.
3628 Otherwise they must appear on covers around the whole aggregate.
3633 Translation is considered a kind of modification, so you may
3634 distribute translations of the Document under the terms of section 4.
3635 Replacing Invariant Sections with translations requires special
3636 permission from their copyright holders, but you may include
3637 translations of some or all Invariant Sections in addition to the
3638 original versions of these Invariant Sections. You may include a
3639 translation of this License provided that you also include the
3640 original English version of this License. In case of a disagreement
3641 between the translation and the original English version of this
3642 License, the original English version will prevail.
3647 You may not copy, modify, sublicense, or distribute the Document except
3648 as expressly provided for under this License. Any other attempt to
3649 copy, modify, sublicense or distribute the Document is void, and will
3650 automatically terminate your rights under this License. However,
3651 parties who have received copies, or rights, from you under this
3652 License will not have their licenses terminated so long as such
3653 parties remain in full compliance.
3656 10. FUTURE REVISIONS OF THIS LICENSE
3658 The Free Software Foundation may publish new, revised versions
3659 of the GNU Free Documentation License from time to time. Such new
3660 versions will be similar in spirit to the present version, but may
3661 differ in detail to address new problems or concerns. See
3662 http://www.gnu.org/copyleft/.
3664 Each version of the License is given a distinguishing version number.
3665 If the Document specifies that a particular numbered version of this
3666 License "or any later version" applies to it, you have the option of
3667 following the terms and conditions either of that specified version or
3668 of any later version that has been published (not as a draft) by the
3669 Free Software Foundation. If the Document does not specify a version
3670 number of this License, you may choose any version ever published (not
3671 as a draft) by the Free Software Foundation.
3674 ADDENDUM: How to use this License for your documents
3676 To use this License in a document you have written, include a copy of
3677 the License in the document and put the following copyright and
3678 license notices just after the title page:
3681 Copyright (c) YEAR YOUR NAME.
3682 Permission is granted to copy, distribute and/or modify this document
3683 under the terms of the GNU Free Documentation License, Version 1.1
3684 or any later version published by the Free Software Foundation;
3685 with the Invariant Sections being LIST THEIR TITLES, with the
3686 Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
3687 A copy of the license is included in the section entitled "GNU
3688 Free Documentation License".
3691 If you have no Invariant Sections, write "with no Invariant Sections"
3692 instead of saying which ones are invariant. If you have no
3693 Front-Cover Texts, write "no Front-Cover Texts" instead of
3694 "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
3696 If your document contains nontrivial examples of program code, we
3697 recommend releasing these examples in parallel under your choice of
3698 free software license, such as the GNU General Public License,
3699 to permit their use in free software.