1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @c Copyright 2001, 2002, 2003, 2004, 2005 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, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
33 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
35 Permission is granted to copy, distribute and/or modify this document
36 under the terms of the GNU Free Documentation License, Version 1.1
37 or any later version published by the Free Software Foundation;
38 with no Invariant Sections, with no Front-Cover Texts, and with no
39 Back-Cover Texts. A copy of the license is included in the
40 section entitled ``GNU Free Documentation License''.
44 Permission is granted to process this file through TeX and print the
45 results, provided the printed document carries a copying permission
46 notice identical to this one except for the removal of this paragraph
47 (this paragraph not being relevant to the printed manual).
54 @c This file documents the GNU binary utilities "ar", "ld", "objcopy",
55 @c "objdump", "nm", "size", "strings", "strip", "readelf" and "ranlib".
57 @c Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
58 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
60 @c This text may be freely distributed under the terms of the GNU
61 @c Free Documentation License.
64 @setchapternewpage odd
65 @settitle @sc{gnu} Binary Utilities
68 @title The @sc{gnu} Binary Utilities
69 @subtitle Version @value{VERSION}
71 @subtitle @value{UPDATED}
72 @author Roland H. Pesch
73 @author Jeffrey M. Osier
74 @author Cygnus Support
78 {\parskip=0pt \hfill Cygnus Support\par \hfill
79 \TeX{}info \texinfoversion\par }
82 @vskip 0pt plus 1filll
83 Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
84 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
86 Permission is granted to copy, distribute and/or modify this document
87 under the terms of the GNU Free Documentation License, Version 1.1
88 or any later version published by the Free Software Foundation;
89 with no Invariant Sections, with no Front-Cover Texts, and with no
90 Back-Cover Texts. A copy of the license is included in the
91 section entitled ``GNU Free Documentation License''.
99 This brief manual contains documentation for the @sc{gnu} binary
100 utilities (collectively version @value{VERSION}):
105 Create, modify, and extract from archives
108 List symbols from object files
111 Copy and translate object files
114 Display information from object files
117 Generate index to archive contents
120 Display the contents of ELF format files.
123 List file section sizes and total size
126 List printable strings from files
132 Demangle encoded C++ symbols (on MS-DOS, this program is named
136 Convert addresses into file names and line numbers
139 Convert object code into a Netware Loadable Module
142 Manipulate Windows resources
145 Create the files needed to build and use Dynamic Link Libraries
149 This document is distributed under the terms of the GNU Free
150 Documentation License. A copy of the license is included in the
151 section entitled "GNU Free Documentation License".
154 * ar:: Create, modify, and extract from archives
155 * nm:: List symbols from object files
156 * objcopy:: Copy and translate object files
157 * objdump:: Display information from object files
158 * ranlib:: Generate index to archive contents
159 * readelf:: Display the contents of ELF format files.
160 * size:: List section sizes and total size
161 * strings:: List printable strings from files
162 * strip:: Discard symbols
163 * c++filt:: Filter to demangle encoded C++ symbols
164 * cxxfilt: c++filt. MS-DOS name for c++filt
165 * addr2line:: Convert addresses to file and line
166 * nlmconv:: Converts object code into an NLM
167 * windres:: Manipulate Windows resources
168 * dlltool:: Create files needed to build and use DLLs
169 * Common Options:: Command-line options for all utilities
170 * Selecting The Target System:: How these utilities determine the target.
171 * Reporting Bugs:: Reporting Bugs
172 * GNU Free Documentation License:: GNU Free Documentation License
181 @cindex collections of files
183 @c man title ar create, modify, and extract from archives
186 ar [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
187 ar -M [ <mri-script ]
190 @c man begin DESCRIPTION ar
192 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
193 archives. An @dfn{archive} is a single file holding a collection of
194 other files in a structure that makes it possible to retrieve
195 the original individual files (called @dfn{members} of the archive).
197 The original files' contents, mode (permissions), timestamp, owner, and
198 group are preserved in the archive, and can be restored on
202 @sc{gnu} @command{ar} can maintain archives whose members have names of any
203 length; however, depending on how @command{ar} is configured on your
204 system, a limit on member-name length may be imposed for compatibility
205 with archive formats maintained with other tools. If it exists, the
206 limit is often 15 characters (typical of formats related to a.out) or 16
207 characters (typical of formats related to coff).
210 @command{ar} is considered a binary utility because archives of this sort
211 are most often used as @dfn{libraries} holding commonly needed
215 @command{ar} creates an index to the symbols defined in relocatable
216 object modules in the archive when you specify the modifier @samp{s}.
217 Once created, this index is updated in the archive whenever @command{ar}
218 makes a change to its contents (save for the @samp{q} update operation).
219 An archive with such an index speeds up linking to the library, and
220 allows routines in the library to call each other without regard to
221 their placement in the archive.
223 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
224 table. If an archive lacks the table, another form of @command{ar} called
225 @command{ranlib} can be used to add just the table.
227 @cindex compatibility, @command{ar}
228 @cindex @command{ar} compatibility
229 @sc{gnu} @command{ar} is designed to be compatible with two different
230 facilities. You can control its activity using command-line options,
231 like the different varieties of @command{ar} on Unix systems; or, if you
232 specify the single command-line option @option{-M}, you can control it
233 with a script supplied via standard input, like the MRI ``librarian''
239 * ar cmdline:: Controlling @command{ar} on the command line
240 * ar scripts:: Controlling @command{ar} with a script
245 @section Controlling @command{ar} on the Command Line
248 @c man begin SYNOPSIS ar
249 ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
253 @cindex Unix compatibility, @command{ar}
254 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
255 arguments to execute: one keyletter specifying the @emph{operation}
256 (optionally accompanied by other keyletters specifying
257 @emph{modifiers}), and the archive name to act on.
259 Most operations can also accept further @var{member} arguments,
260 specifying particular files to operate on.
262 @c man begin OPTIONS ar
264 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
265 flags @var{mod} in any order, within the first command-line argument.
267 If you wish, you may begin the first command-line argument with a
270 @cindex operations on archive
271 The @var{p} keyletter specifies what operation to execute; it may be
272 any of the following, but you must specify only one of them:
276 @cindex deleting from archive
277 @emph{Delete} modules from the archive. Specify the names of modules to
278 be deleted as @var{member}@dots{}; the archive is untouched if you
279 specify no files to delete.
281 If you specify the @samp{v} modifier, @command{ar} lists each module
285 @cindex moving in archive
286 Use this operation to @emph{move} members in an archive.
288 The ordering of members in an archive can make a difference in how
289 programs are linked using the library, if a symbol is defined in more
292 If no modifiers are used with @code{m}, any members you name in the
293 @var{member} arguments are moved to the @emph{end} of the archive;
294 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
295 specified place instead.
298 @cindex printing from archive
299 @emph{Print} the specified members of the archive, to the standard
300 output file. If the @samp{v} modifier is specified, show the member
301 name before copying its contents to standard output.
303 If you specify no @var{member} arguments, all the files in the archive are
307 @cindex quick append to archive
308 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
309 @var{archive}, without checking for replacement.
311 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
312 operation; new members are always placed at the end of the archive.
314 The modifier @samp{v} makes @command{ar} list each file as it is appended.
316 Since the point of this operation is speed, the archive's symbol table
317 index is not updated, even if it already existed; you can use @samp{ar s} or
318 @command{ranlib} explicitly to update the symbol table index.
320 However, too many different systems assume quick append rebuilds the
321 index, so @sc{gnu} @command{ar} implements @samp{q} as a synonym for @samp{r}.
324 @cindex replacement in archive
325 Insert the files @var{member}@dots{} into @var{archive} (with
326 @emph{replacement}). This operation differs from @samp{q} in that any
327 previously existing members are deleted if their names match those being
330 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
331 displays an error message, and leaves undisturbed any existing members
332 of the archive matching that name.
334 By default, new members are added at the end of the file; but you may
335 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
336 placement relative to some existing member.
338 The modifier @samp{v} used with this operation elicits a line of
339 output for each file inserted, along with one of the letters @samp{a} or
340 @samp{r} to indicate whether the file was appended (no old member
341 deleted) or replaced.
344 @cindex contents of archive
345 Display a @emph{table} listing the contents of @var{archive}, or those
346 of the files listed in @var{member}@dots{} that are present in the
347 archive. Normally only the member name is shown; if you also want to
348 see the modes (permissions), timestamp, owner, group, and size, you can
349 request that by also specifying the @samp{v} modifier.
351 If you do not specify a @var{member}, all files in the archive
354 @cindex repeated names in archive
355 @cindex name duplication in archive
356 If there is more than one file with the same name (say, @samp{fie}) in
357 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
358 first instance; to see them all, you must ask for a complete
359 listing---in our example, @samp{ar t b.a}.
360 @c WRS only; per Gumby, this is implementation-dependent, and in a more
361 @c recent case in fact works the other way.
364 @cindex extract from archive
365 @emph{Extract} members (named @var{member}) from the archive. You can
366 use the @samp{v} modifier with this operation, to request that
367 @command{ar} list each name as it extracts it.
369 If you do not specify a @var{member}, all files in the archive
374 A number of modifiers (@var{mod}) may immediately follow the @var{p}
375 keyletter, to specify variations on an operation's behavior:
379 @cindex relative placement in archive
380 Add new files @emph{after} an existing member of the
381 archive. If you use the modifier @samp{a}, the name of an existing archive
382 member must be present as the @var{relpos} argument, before the
383 @var{archive} specification.
386 Add new files @emph{before} an existing member of the
387 archive. If you use the modifier @samp{b}, the name of an existing archive
388 member must be present as the @var{relpos} argument, before the
389 @var{archive} specification. (same as @samp{i}).
392 @cindex creating archives
393 @emph{Create} the archive. The specified @var{archive} is always
394 created if it did not exist, when you request an update. But a warning is
395 issued unless you specify in advance that you expect to create it, by
399 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
400 names of any length. This will cause it to create archives which are
401 not compatible with the native @command{ar} program on some systems. If
402 this is a concern, the @samp{f} modifier may be used to truncate file
403 names when putting them in the archive.
406 Insert new files @emph{before} an existing member of the
407 archive. If you use the modifier @samp{i}, the name of an existing archive
408 member must be present as the @var{relpos} argument, before the
409 @var{archive} specification. (same as @samp{b}).
412 This modifier is accepted but not used.
413 @c whaffor ar l modifier??? presumably compat; with
414 @c what???---doc@@cygnus.com, 25jan91
417 Uses the @var{count} parameter. This is used if there are multiple
418 entries in the archive with the same name. Extract or delete instance
419 @var{count} of the given name from the archive.
422 @cindex dates in archive
423 Preserve the @emph{original} dates of members when extracting them. If
424 you do not specify this modifier, files extracted from the archive
425 are stamped with the time of extraction.
428 Use the full path name when matching names in the archive. @sc{gnu}
429 @command{ar} can not create an archive with a full path name (such archives
430 are not POSIX complaint), but other archive creators can. This option
431 will cause @sc{gnu} @command{ar} to match file names using a complete path
432 name, which can be convenient when extracting a single file from an
433 archive created by another tool.
436 @cindex writing archive index
437 Write an object-file index into the archive, or update an existing one,
438 even if no other change is made to the archive. You may use this modifier
439 flag either with any operation, or alone. Running @samp{ar s} on an
440 archive is equivalent to running @samp{ranlib} on it.
443 @cindex not writing archive index
444 Do not generate an archive symbol table. This can speed up building a
445 large library in several steps. The resulting archive can not be used
446 with the linker. In order to build a symbol table, you must omit the
447 @samp{S} modifier on the last execution of @samp{ar}, or you must run
448 @samp{ranlib} on the archive.
451 @cindex updating an archive
452 Normally, @samp{ar r}@dots{} inserts all files
453 listed into the archive. If you would like to insert @emph{only} those
454 of the files you list that are newer than existing members of the same
455 names, use this modifier. The @samp{u} modifier is allowed only for the
456 operation @samp{r} (replace). In particular, the combination @samp{qu} is
457 not allowed, since checking the timestamps would lose any speed
458 advantage from the operation @samp{q}.
461 This modifier requests the @emph{verbose} version of an operation. Many
462 operations display additional information, such as filenames processed,
463 when the modifier @samp{v} is appended.
466 This modifier shows the version number of @command{ar}.
469 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
470 compatibility with AIX. The behaviour produced by this option is the
471 default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other
472 @samp{-X} options; in particular, it does not support @option{-X32}
473 which is the default for AIX @command{ar}.
478 @c man begin SEEALSO ar
479 nm(1), ranlib(1), and the Info entries for @file{binutils}.
484 @section Controlling @command{ar} with a Script
487 ar -M [ <@var{script} ]
490 @cindex MRI compatibility, @command{ar}
491 @cindex scripts, @command{ar}
492 If you use the single command-line option @samp{-M} with @command{ar}, you
493 can control its operation with a rudimentary command language. This
494 form of @command{ar} operates interactively if standard input is coming
495 directly from a terminal. During interactive use, @command{ar} prompts for
496 input (the prompt is @samp{AR >}), and continues executing even after
497 errors. If you redirect standard input to a script file, no prompts are
498 issued, and @command{ar} abandons execution (with a nonzero exit code)
501 The @command{ar} command language is @emph{not} designed to be equivalent
502 to the command-line options; in fact, it provides somewhat less control
503 over archives. The only purpose of the command language is to ease the
504 transition to @sc{gnu} @command{ar} for developers who already have scripts
505 written for the MRI ``librarian'' program.
507 The syntax for the @command{ar} command language is straightforward:
510 commands are recognized in upper or lower case; for example, @code{LIST}
511 is the same as @code{list}. In the following descriptions, commands are
512 shown in upper case for clarity.
515 a single command may appear on each line; it is the first word on the
519 empty lines are allowed, and have no effect.
522 comments are allowed; text after either of the characters @samp{*}
523 or @samp{;} is ignored.
526 Whenever you use a list of names as part of the argument to an @command{ar}
527 command, you can separate the individual names with either commas or
528 blanks. Commas are shown in the explanations below, for clarity.
531 @samp{+} is used as a line continuation character; if @samp{+} appears
532 at the end of a line, the text on the following line is considered part
533 of the current command.
536 Here are the commands you can use in @command{ar} scripts, or when using
537 @command{ar} interactively. Three of them have special significance:
539 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
540 a temporary file required for most of the other commands.
542 @code{SAVE} commits the changes so far specified by the script. Prior
543 to @code{SAVE}, commands affect only the temporary copy of the current
547 @item ADDLIB @var{archive}
548 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
549 Add all the contents of @var{archive} (or, if specified, each named
550 @var{module} from @var{archive}) to the current archive.
552 Requires prior use of @code{OPEN} or @code{CREATE}.
554 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
555 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
556 @c else like "ar q..."
557 Add each named @var{member} as a module in the current archive.
559 Requires prior use of @code{OPEN} or @code{CREATE}.
562 Discard the contents of the current archive, canceling the effect of
563 any operations since the last @code{SAVE}. May be executed (with no
564 effect) even if no current archive is specified.
566 @item CREATE @var{archive}
567 Creates an archive, and makes it the current archive (required for many
568 other commands). The new archive is created with a temporary name; it
569 is not actually saved as @var{archive} until you use @code{SAVE}.
570 You can overwrite existing archives; similarly, the contents of any
571 existing file named @var{archive} will not be destroyed until @code{SAVE}.
573 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
574 Delete each listed @var{module} from the current archive; equivalent to
575 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
577 Requires prior use of @code{OPEN} or @code{CREATE}.
579 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
580 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
581 List each named @var{module} present in @var{archive}. The separate
582 command @code{VERBOSE} specifies the form of the output: when verbose
583 output is off, output is like that of @samp{ar -t @var{archive}
584 @var{module}@dots{}}. When verbose output is on, the listing is like
585 @samp{ar -tv @var{archive} @var{module}@dots{}}.
587 Output normally goes to the standard output stream; however, if you
588 specify @var{outputfile} as a final argument, @command{ar} directs the
592 Exit from @command{ar}, with a @code{0} exit code to indicate successful
593 completion. This command does not save the output file; if you have
594 changed the current archive since the last @code{SAVE} command, those
597 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
598 Extract each named @var{module} from the current archive, writing them
599 into the current directory as separate files. Equivalent to @samp{ar -x
600 @var{archive} @var{module}@dots{}}.
602 Requires prior use of @code{OPEN} or @code{CREATE}.
605 @c FIXME Tokens but no commands???
612 Display full contents of the current archive, in ``verbose'' style
613 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
614 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
615 enhancement, rather than present for MRI compatibility.)
617 Requires prior use of @code{OPEN} or @code{CREATE}.
619 @item OPEN @var{archive}
620 Opens an existing archive for use as the current archive (required for
621 many other commands). Any changes as the result of subsequent commands
622 will not actually affect @var{archive} until you next use @code{SAVE}.
624 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
625 In the current archive, replace each existing @var{module} (named in
626 the @code{REPLACE} arguments) from files in the current working directory.
627 To execute this command without errors, both the file, and the module in
628 the current archive, must exist.
630 Requires prior use of @code{OPEN} or @code{CREATE}.
633 Toggle an internal flag governing the output from @code{DIRECTORY}.
634 When the flag is on, @code{DIRECTORY} output matches output from
635 @samp{ar -tv }@dots{}.
638 Commit your changes to the current archive, and actually save it as a
639 file with the name specified in the last @code{CREATE} or @code{OPEN}
642 Requires prior use of @code{OPEN} or @code{CREATE}.
651 The @sc{gnu} linker @command{ld} is now described in a separate manual.
652 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
660 @c man title nm list symbols from object files
663 @c man begin SYNOPSIS nm
664 nm [@option{-a}|@option{--debug-syms}] [@option{-g}|@option{--extern-only}]
665 [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]
666 [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}]
667 [@option{-A}|@option{-o}|@option{--print-file-name}][@option{--special-syms}]
668 [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}]
669 [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}]
670 [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}]
671 [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]
672 [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]
673 [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}]
677 @c man begin DESCRIPTION nm
678 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
679 If no object files are listed as arguments, @command{nm} assumes the file
682 For each symbol, @command{nm} shows:
686 The symbol value, in the radix selected by options (see below), or
687 hexadecimal by default.
690 The symbol type. At least the following types are used; others are, as
691 well, depending on the object file format. If lowercase, the symbol is
692 local; if uppercase, the symbol is global (external).
694 @c Some more detail on exactly what these symbol types are used for
698 The symbol's value is absolute, and will not be changed by further
702 The symbol is in the uninitialized data section (known as BSS).
705 The symbol is common. Common symbols are uninitialized data. When
706 linking, multiple common symbols may appear with the same name. If the
707 symbol is defined anywhere, the common symbols are treated as undefined
710 For more details on common symbols, see the discussion of
711 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
715 The symbol is in the initialized data section.
718 The symbol is in an initialized data section for small objects. Some
719 object file formats permit more efficient access to small data objects,
720 such as a global int variable as opposed to a large global array.
723 The symbol is an indirect reference to another symbol. This is a @sc{gnu}
724 extension to the a.out object file format which is rarely used.
727 The symbol is a debugging symbol.
730 The symbol is in a read only data section.
733 The symbol is in an uninitialized data section for small objects.
736 The symbol is in the text (code) section.
739 The symbol is undefined.
742 The symbol is a weak object. When a weak defined symbol is linked with
743 a normal defined symbol, the normal defined symbol is used with no error.
744 When a weak undefined symbol is linked and the symbol is not defined,
745 the value of the weak symbol becomes zero with no error.
748 The symbol is a weak symbol that has not been specifically tagged as a
749 weak object symbol. When a weak defined symbol is linked with a normal
750 defined symbol, the normal defined symbol is used with no error.
751 When a weak undefined symbol is linked and the symbol is not defined,
752 the value of the symbol is determined in a system-specific manner without
753 error. On some systems, uppercase indicates that a default value has been
758 The symbol is a stabs symbol in an a.out object file. In this case, the
759 next values printed are the stabs other field, the stabs desc field, and
760 the stab type. Stabs symbols are used to hold debugging information.
762 For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
763 ``stabs'' debug format}.
767 The symbol type is unknown, or object file format specific.
776 @c man begin OPTIONS nm
777 The long and short forms of options, shown here as alternatives, are
783 @itemx --print-file-name
784 @cindex input file name
786 @cindex source file name
787 Precede each symbol by the name of the input file (or archive member)
788 in which it was found, rather than identifying the input file once only,
789 before all of its symbols.
793 @cindex debugging symbols
794 Display all symbols, even debugger-only symbols; normally these are not
798 @cindex @command{nm} format
799 @cindex @command{nm} compatibility
800 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
803 @itemx --demangle[=@var{style}]
804 @cindex demangling in nm
805 Decode (@dfn{demangle}) low-level symbol names into user-level names.
806 Besides removing any initial underscore prepended by the system, this
807 makes C++ function names readable. Different compilers have different
808 mangling styles. The optional demangling style argument can be used to
809 choose an appropriate demangling style for your compiler. @xref{c++filt},
810 for more information on demangling.
813 Do not demangle low-level symbol names. This is the default.
817 @cindex dynamic symbols
818 Display the dynamic symbols rather than the normal symbols. This is
819 only meaningful for dynamic objects, such as certain types of shared
822 @item -f @var{format}
823 @itemx --format=@var{format}
824 @cindex @command{nm} format
825 @cindex @command{nm} compatibility
826 Use the output format @var{format}, which can be @code{bsd},
827 @code{sysv}, or @code{posix}. The default is @code{bsd}.
828 Only the first character of @var{format} is significant; it can be
829 either upper or lower case.
833 @cindex external symbols
834 Display only external symbols.
837 @itemx --line-numbers
838 @cindex symbol line numbers
839 For each symbol, use debugging information to try to find a filename and
840 line number. For a defined symbol, look for the line number of the
841 address of the symbol. For an undefined symbol, look for the line
842 number of a relocation entry which refers to the symbol. If line number
843 information can be found, print it after the other symbol information.
847 @itemx --numeric-sort
848 Sort symbols numerically by their addresses, rather than alphabetically
853 @cindex sorting symbols
854 Do not bother to sort the symbols in any order; print them in the order
859 Use the POSIX.2 standard output format instead of the default format.
860 Equivalent to @samp{-f posix}.
864 Print size, not the value, of defined symbols for the @code{bsd} output format.
868 @cindex symbol index, listing
869 When listing symbols from archive members, include the index: a mapping
870 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
871 contain definitions for which names.
874 @itemx --reverse-sort
875 Reverse the order of the sort (whether numeric or alphabetic); let the
879 Sort symbols by size. The size is computed as the difference between
880 the value of the symbol and the value of the symbol with the next higher
881 value. If the @code{bsd} output format is used the size of the symbol
882 is printed, rather than the value, and @samp{-S} must be used in order
883 both size and value to be printed.
886 Display symbols which have a target-specific special meaning. These
887 symbols are usually used by the target for some special processing and
888 are not normally helpful when included included in the normal symbol
889 lists. For example for ARM targets this option would skip the mapping
890 symbols used to mark transistions between ARM code, THUMB code and
894 @itemx --radix=@var{radix}
895 Use @var{radix} as the radix for printing the symbol values. It must be
896 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
898 @item --target=@var{bfdname}
899 @cindex object code format
900 Specify an object code format other than your system's default format.
901 @xref{Target Selection}, for more information.
904 @itemx --undefined-only
905 @cindex external symbols
906 @cindex undefined symbols
907 Display only undefined symbols (those external to each object file).
910 @cindex external symbols
911 @cindex undefined symbols
912 Display only defined symbols for each object file.
916 Show the version number of @command{nm} and exit.
919 This option is ignored for compatibility with the AIX version of
920 @command{nm}. It takes one parameter which must be the string
921 @option{32_64}. The default mode of AIX @command{nm} corresponds
922 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
925 Show a summary of the options to @command{nm} and exit.
931 @c man begin SEEALSO nm
932 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
939 @c man title objcopy copy and translate object files
942 @c man begin SYNOPSIS objcopy
943 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
944 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
945 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
946 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
947 [@option{-S}|@option{--strip-all}]
948 [@option{-g}|@option{--strip-debug}]
949 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
950 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
951 [@option{--strip-unneeded-symbol=}@var{symbolname}]
952 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
953 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
954 [@option{--globalize-symbol=}@var{symbolname}]
955 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
956 [@option{-w}|@option{--wildcard}]
957 [@option{-x}|@option{--discard-all}]
958 [@option{-X}|@option{--discard-locals}]
959 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
960 [@option{-i} @var{interleave}|@option{--interleave=}@var{interleave}]
961 [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
962 [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
963 [@option{-p}|@option{--preserve-dates}]
964 [@option{--debugging}]
965 [@option{--gap-fill=}@var{val}]
966 [@option{--pad-to=}@var{address}]
967 [@option{--set-start=}@var{val}]
968 [@option{--adjust-start=}@var{incr}]
969 [@option{--change-addresses=}@var{incr}]
970 [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
971 [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
972 [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
973 [@option{--change-warnings}] [@option{--no-change-warnings}]
974 [@option{--set-section-flags} @var{section}=@var{flags}]
975 [@option{--add-section} @var{sectionname}=@var{filename}]
976 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
977 [@option{--change-leading-char}] [@option{--remove-leading-char}]
978 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
979 [@option{--redefine-sym} @var{old}=@var{new}]
980 [@option{--redefine-syms=}@var{filename}]
982 [@option{--keep-symbols=}@var{filename}]
983 [@option{--strip-symbols=}@var{filename}]
984 [@option{--strip-unneeded-symbols=}@var{filename}]
985 [@option{--keep-global-symbols=}@var{filename}]
986 [@option{--localize-symbols=}@var{filename}]
987 [@option{--globalize-symbols=}@var{filename}]
988 [@option{--weaken-symbols=}@var{filename}]
989 [@option{--alt-machine-code=}@var{index}]
990 [@option{--prefix-symbols=}@var{string}]
991 [@option{--prefix-sections=}@var{string}]
992 [@option{--prefix-alloc-sections=}@var{string}]
993 [@option{--add-gnu-debuglink=}@var{path-to-file}]
994 [@option{--only-keep-debug}]
995 [@option{--writable-text}]
996 [@option{--readonly-text}]
999 [@option{-v}|@option{--verbose}]
1000 [@option{-V}|@option{--version}]
1001 [@option{--help}] [@option{--info}]
1002 @var{infile} [@var{outfile}]
1006 @c man begin DESCRIPTION objcopy
1007 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1008 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1009 read and write the object files. It can write the destination object
1010 file in a format different from that of the source object file. The
1011 exact behavior of @command{objcopy} is controlled by command-line options.
1012 Note that @command{objcopy} should be able to copy a fully linked file
1013 between any two formats. However, copying a relocatable object file
1014 between any two formats may not work as expected.
1016 @command{objcopy} creates temporary files to do its translations and
1017 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1018 translation work; it has access to all the formats described in @sc{bfd}
1019 and thus is able to recognize most formats without being told
1020 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1022 @command{objcopy} can be used to generate S-records by using an output
1023 target of @samp{srec} (e.g., use @samp{-O srec}).
1025 @command{objcopy} can be used to generate a raw binary file by using an
1026 output target of @samp{binary} (e.g., use @option{-O binary}). When
1027 @command{objcopy} generates a raw binary file, it will essentially produce
1028 a memory dump of the contents of the input object file. All symbols and
1029 relocation information will be discarded. The memory dump will start at
1030 the load address of the lowest section copied into the output file.
1032 When generating an S-record or a raw binary file, it may be helpful to
1033 use @option{-S} to remove sections containing debugging information. In
1034 some cases @option{-R} will be useful to remove sections which contain
1035 information that is not needed by the binary file.
1037 Note---@command{objcopy} is not able to change the endianness of its input
1038 files. If the input format has an endianness (some formats do not),
1039 @command{objcopy} can only copy the inputs into file formats that have the
1040 same endianness or which have no endianness (e.g., @samp{srec}).
1044 @c man begin OPTIONS objcopy
1048 @itemx @var{outfile}
1049 The input and output files, respectively.
1050 If you do not specify @var{outfile}, @command{objcopy} creates a
1051 temporary file and destructively renames the result with
1052 the name of @var{infile}.
1054 @item -I @var{bfdname}
1055 @itemx --input-target=@var{bfdname}
1056 Consider the source file's object format to be @var{bfdname}, rather than
1057 attempting to deduce it. @xref{Target Selection}, for more information.
1059 @item -O @var{bfdname}
1060 @itemx --output-target=@var{bfdname}
1061 Write the output file using the object format @var{bfdname}.
1062 @xref{Target Selection}, for more information.
1064 @item -F @var{bfdname}
1065 @itemx --target=@var{bfdname}
1066 Use @var{bfdname} as the object format for both the input and the output
1067 file; i.e., simply transfer data from source to destination with no
1068 translation. @xref{Target Selection}, for more information.
1070 @item -B @var{bfdarch}
1071 @itemx --binary-architecture=@var{bfdarch}
1072 Useful when transforming a raw binary input file into an object file.
1073 In this case the output architecture can be set to @var{bfdarch}. This
1074 option will be ignored if the input file has a known @var{bfdarch}. You
1075 can access this binary data inside a program by referencing the special
1076 symbols that are created by the conversion process. These symbols are
1077 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1078 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1079 an object file and then access it in your code using these symbols.
1081 @item -j @var{sectionname}
1082 @itemx --only-section=@var{sectionname}
1083 Copy only the named section from the input file to the output file.
1084 This option may be given more than once. Note that using this option
1085 inappropriately may make the output file unusable.
1087 @item -R @var{sectionname}
1088 @itemx --remove-section=@var{sectionname}
1089 Remove any section named @var{sectionname} from the output file. This
1090 option may be given more than once. Note that using this option
1091 inappropriately may make the output file unusable.
1095 Do not copy relocation and symbol information from the source file.
1098 @itemx --strip-debug
1099 Do not copy debugging symbols or sections from the source file.
1101 @item --strip-unneeded
1102 Strip all symbols that are not needed for relocation processing.
1104 @item -K @var{symbolname}
1105 @itemx --keep-symbol=@var{symbolname}
1106 When stripping symbols, keep symbol @var{symbolname} even if it would
1107 normally be stripped. This option may be given more than once.
1109 @item -N @var{symbolname}
1110 @itemx --strip-symbol=@var{symbolname}
1111 Do not copy symbol @var{symbolname} from the source file. This option
1112 may be given more than once.
1114 @item --strip-unneeded-symbol=@var{symbolname}
1115 Do not copy symbol @var{symbolname} from the source file unless it is needed
1116 by a relocation. This option may be given more than once.
1118 @item -G @var{symbolname}
1119 @itemx --keep-global-symbol=@var{symbolname}
1120 Keep only symbol @var{symbolname} global. Make all other symbols local
1121 to the file, so that they are not visible externally. This option may
1122 be given more than once.
1124 @item -L @var{symbolname}
1125 @itemx --localize-symbol=@var{symbolname}
1126 Make symbol @var{symbolname} local to the file, so that it is not
1127 visible externally. This option may be given more than once.
1129 @item -W @var{symbolname}
1130 @itemx --weaken-symbol=@var{symbolname}
1131 Make symbol @var{symbolname} weak. This option may be given more than once.
1133 @item --globalize-symbol=@var{symbolname}
1134 Give symbol @var{symbolname} global scoping so that it is visible
1135 outside of the file in which it is defined. This option may be given
1140 Permit regular expressions in @var{symbolname}s used in other command
1141 line options. The question mark (?), asterisk (*), backslash (\) and
1142 square brackets ([]) operators can be used anywhere in the symbol
1143 name. If the first character of the symbol name is the exclamation
1144 point (!) then the sense of the switch is reversed for that symbol.
1151 would cause objcopy to weaken all symbols that start with ``fo''
1152 except for the symbol ``foo''.
1155 @itemx --discard-all
1156 Do not copy non-global symbols from the source file.
1157 @c FIXME any reason to prefer "non-global" to "local" here?
1160 @itemx --discard-locals
1161 Do not copy compiler-generated local symbols.
1162 (These usually start with @samp{L} or @samp{.}.)
1165 @itemx --byte=@var{byte}
1166 Keep only every @var{byte}th byte of the input file (header data is not
1167 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
1168 where @var{interleave} is given by the @option{-i} or @option{--interleave}
1169 option, or the default of 4. This option is useful for creating files
1170 to program @sc{rom}. It is typically used with an @code{srec} output
1173 @item -i @var{interleave}
1174 @itemx --interleave=@var{interleave}
1175 Only copy one out of every @var{interleave} bytes. Select which byte to
1176 copy with the @option{-b} or @option{--byte} option. The default is 4.
1177 @command{objcopy} ignores this option if you do not specify either @option{-b} or
1181 @itemx --preserve-dates
1182 Set the access and modification dates of the output file to be the same
1183 as those of the input file.
1186 Convert debugging information, if possible. This is not the default
1187 because only certain debugging formats are supported, and the
1188 conversion process can be time consuming.
1190 @item --gap-fill @var{val}
1191 Fill gaps between sections with @var{val}. This operation applies to
1192 the @emph{load address} (LMA) of the sections. It is done by increasing
1193 the size of the section with the lower address, and filling in the extra
1194 space created with @var{val}.
1196 @item --pad-to @var{address}
1197 Pad the output file up to the load address @var{address}. This is
1198 done by increasing the size of the last section. The extra space is
1199 filled in with the value specified by @option{--gap-fill} (default zero).
1201 @item --set-start @var{val}
1202 Set the start address of the new file to @var{val}. Not all object file
1203 formats support setting the start address.
1205 @item --change-start @var{incr}
1206 @itemx --adjust-start @var{incr}
1207 @cindex changing start address
1208 Change the start address by adding @var{incr}. Not all object file
1209 formats support setting the start address.
1211 @item --change-addresses @var{incr}
1212 @itemx --adjust-vma @var{incr}
1213 @cindex changing object addresses
1214 Change the VMA and LMA addresses of all sections, as well as the start
1215 address, by adding @var{incr}. Some object file formats do not permit
1216 section addresses to be changed arbitrarily. Note that this does not
1217 relocate the sections; if the program expects sections to be loaded at a
1218 certain address, and this option is used to change the sections such
1219 that they are loaded at a different address, the program may fail.
1221 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1222 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1223 @cindex changing section address
1224 Set or change both the VMA address and the LMA address of the named
1225 @var{section}. If @samp{=} is used, the section address is set to
1226 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1227 section address. See the comments under @option{--change-addresses},
1228 above. If @var{section} does not exist in the input file, a warning will
1229 be issued, unless @option{--no-change-warnings} is used.
1231 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1232 @cindex changing section LMA
1233 Set or change the LMA address of the named @var{section}. The LMA
1234 address is the address where the section will be loaded into memory at
1235 program load time. Normally this is the same as the VMA address, which
1236 is the address of the section at program run time, but on some systems,
1237 especially those where a program is held in ROM, the two can be
1238 different. If @samp{=} is used, the section address is set to
1239 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1240 section address. See the comments under @option{--change-addresses},
1241 above. If @var{section} does not exist in the input file, a warning
1242 will be issued, unless @option{--no-change-warnings} is used.
1244 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1245 @cindex changing section VMA
1246 Set or change the VMA address of the named @var{section}. The VMA
1247 address is the address where the section will be located once the
1248 program has started executing. Normally this is the same as the LMA
1249 address, which is the address where the section will be loaded into
1250 memory, but on some systems, especially those where a program is held in
1251 ROM, the two can be different. If @samp{=} is used, the section address
1252 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1253 from the section address. See the comments under
1254 @option{--change-addresses}, above. If @var{section} does not exist in
1255 the input file, a warning will be issued, unless
1256 @option{--no-change-warnings} is used.
1258 @item --change-warnings
1259 @itemx --adjust-warnings
1260 If @option{--change-section-address} or @option{--change-section-lma} or
1261 @option{--change-section-vma} is used, and the named section does not
1262 exist, issue a warning. This is the default.
1264 @item --no-change-warnings
1265 @itemx --no-adjust-warnings
1266 Do not issue a warning if @option{--change-section-address} or
1267 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1268 if the named section does not exist.
1270 @item --set-section-flags @var{section}=@var{flags}
1271 Set the flags for the named section. The @var{flags} argument is a
1272 comma separated string of flag names. The recognized names are
1273 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1274 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1275 @samp{debug}. You can set the @samp{contents} flag for a section which
1276 does not have contents, but it is not meaningful to clear the
1277 @samp{contents} flag of a section which does have contents--just remove
1278 the section instead. Not all flags are meaningful for all object file
1281 @item --add-section @var{sectionname}=@var{filename}
1282 Add a new section named @var{sectionname} while copying the file. The
1283 contents of the new section are taken from the file @var{filename}. The
1284 size of the section will be the size of the file. This option only
1285 works on file formats which can support sections with arbitrary names.
1287 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1288 Rename a section from @var{oldname} to @var{newname}, optionally
1289 changing the section's flags to @var{flags} in the process. This has
1290 the advantage over usng a linker script to perform the rename in that
1291 the output stays as an object file and does not become a linked
1294 This option is particularly helpful when the input format is binary,
1295 since this will always create a section called .data. If for example,
1296 you wanted instead to create a section called .rodata containing binary
1297 data you could use the following command line to achieve it:
1300 objcopy -I binary -O <output_format> -B <architecture> \
1301 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1302 <input_binary_file> <output_object_file>
1305 @item --change-leading-char
1306 Some object file formats use special characters at the start of
1307 symbols. The most common such character is underscore, which compilers
1308 often add before every symbol. This option tells @command{objcopy} to
1309 change the leading character of every symbol when it converts between
1310 object file formats. If the object file formats use the same leading
1311 character, this option has no effect. Otherwise, it will add a
1312 character, or remove a character, or change a character, as
1315 @item --remove-leading-char
1316 If the first character of a global symbol is a special symbol leading
1317 character used by the object file format, remove the character. The
1318 most common symbol leading character is underscore. This option will
1319 remove a leading underscore from all global symbols. This can be useful
1320 if you want to link together objects of different file formats with
1321 different conventions for symbol names. This is different from
1322 @option{--change-leading-char} because it always changes the symbol name
1323 when appropriate, regardless of the object file format of the output
1326 @item --srec-len=@var{ival}
1327 Meaningful only for srec output. Set the maximum length of the Srecords
1328 being produced to @var{ival}. This length covers both address, data and
1331 @item --srec-forceS3
1332 Meaningful only for srec output. Avoid generation of S1/S2 records,
1333 creating S3-only record format.
1335 @item --redefine-sym @var{old}=@var{new}
1336 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1337 when one is trying link two things together for which you have no
1338 source, and there are name collisions.
1340 @item --redefine-syms=@var{filename}
1341 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1342 listed in the file @var{filename}. @var{filename} is simply a flat file,
1343 with one symbol pair per line. Line comments may be introduced by the hash
1344 character. This option may be given more than once.
1347 Change all global symbols in the file to be weak. This can be useful
1348 when building an object which will be linked against other objects using
1349 the @option{-R} option to the linker. This option is only effective when
1350 using an object file format which supports weak symbols.
1352 @item --keep-symbols=@var{filename}
1353 Apply @option{--keep-symbol} option to each symbol listed in the file
1354 @var{filename}. @var{filename} is simply a flat file, with one symbol
1355 name per line. Line comments may be introduced by the hash character.
1356 This option may be given more than once.
1358 @item --strip-symbols=@var{filename}
1359 Apply @option{--strip-symbol} option to each symbol listed in the file
1360 @var{filename}. @var{filename} is simply a flat file, with one symbol
1361 name per line. Line comments may be introduced by the hash character.
1362 This option may be given more than once.
1364 @item --strip-unneeded-symbols=@var{filename}
1365 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1366 the file @var{filename}. @var{filename} is simply a flat file, with one
1367 symbol name per line. Line comments may be introduced by the hash
1368 character. This option may be given more than once.
1370 @item --keep-global-symbols=@var{filename}
1371 Apply @option{--keep-global-symbol} option to each symbol listed in the
1372 file @var{filename}. @var{filename} is simply a flat file, with one
1373 symbol name per line. Line comments may be introduced by the hash
1374 character. This option may be given more than once.
1376 @item --localize-symbols=@var{filename}
1377 Apply @option{--localize-symbol} option to each symbol listed in the file
1378 @var{filename}. @var{filename} is simply a flat file, with one symbol
1379 name per line. Line comments may be introduced by the hash character.
1380 This option may be given more than once.
1382 @item --globalize-symbols=@var{filename}
1383 Apply @option{--globalize-symbol} option to each symbol listed in the file
1384 @var{filename}. @var{filename} is simply a flat file, with one symbol
1385 name per line. Line comments may be introduced by the hash character.
1386 This option may be given more than once.
1388 @item --weaken-symbols=@var{filename}
1389 Apply @option{--weaken-symbol} option to each symbol listed in the file
1390 @var{filename}. @var{filename} is simply a flat file, with one symbol
1391 name per line. Line comments may be introduced by the hash character.
1392 This option may be given more than once.
1394 @item --alt-machine-code=@var{index}
1395 If the output architecture has alternate machine codes, use the
1396 @var{index}th code instead of the default one. This is useful in case
1397 a machine is assigned an official code and the tool-chain adopts the
1398 new code, but other applications still depend on the original code
1401 @item --writable-text
1402 Mark the output text as writable. This option isn't meaningful for all
1403 object file formats.
1405 @item --readonly-text
1406 Make the output text write protected. This option isn't meaningful for all
1407 object file formats.
1410 Mark the output file as demand paged. This option isn't meaningful for all
1411 object file formats.
1414 Mark the output file as impure. This option isn't meaningful for all
1415 object file formats.
1417 @item --prefix-symbols=@var{string}
1418 Prefix all symbols in the output file with @var{string}.
1420 @item --prefix-sections=@var{string}
1421 Prefix all section names in the output file with @var{string}.
1423 @item --prefix-alloc-sections=@var{string}
1424 Prefix all the names of all allocated sections in the output file with
1427 @item --add-gnu-debuglink=@var{path-to-file}
1428 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1429 and adds it to the output file.
1431 @item --only-keep-debug
1432 Strip a file, removing contents of any sections that would not be
1433 stripped by @option{--strip-debug} and leaving the debugging sections
1436 The intention is that this option will be used in conjunction with
1437 @option{--add-gnu-debuglink} to create a two part executable. One a
1438 stripped binary which will occupy less space in RAM and in a
1439 distribution and the second a debugging information file which is only
1440 needed if debugging abilities are required. The suggested procedure
1441 to create these files is as follows:
1444 @item Link the executable as normal. Assuming that is is called
1446 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1447 create a file containing the debugging info.
1448 @item Run @code{objcopy --strip-debug foo} to create a
1449 stripped executable.
1450 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1451 to add a link to the debugging info into the stripped executable.
1454 Note - the choice of @code{.dbg} as an extension for the debug info
1455 file is arbitrary. Also the @code{--only-keep-debug} step is
1456 optional. You could instead do this:
1459 @item Link the executable as normal.
1460 @item Copy @code{foo} to @code{foo.full}
1461 @item Run @code{objcopy --strip-debug foo}
1462 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1465 i.e. the file pointed to by the @option{--add-gnu-debuglink} can be the
1466 full executable. It does not have to be a file created by the
1467 @option{--only-keep-debug} switch.
1471 Show the version number of @command{objcopy}.
1475 Verbose output: list all object files modified. In the case of
1476 archives, @samp{objcopy -V} lists all members of the archive.
1479 Show a summary of the options to @command{objcopy}.
1482 Display a list showing all architectures and object formats available.
1488 @c man begin SEEALSO objcopy
1489 ld(1), objdump(1), and the Info entries for @file{binutils}.
1496 @cindex object file information
1499 @c man title objdump display information from object files.
1502 @c man begin SYNOPSIS objdump
1503 objdump [@option{-a}|@option{--archive-headers}]
1504 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1505 [@option{-C}|@option{--demangle}[=@var{style}] ]
1506 [@option{-d}|@option{--disassemble}]
1507 [@option{-D}|@option{--disassemble-all}]
1508 [@option{-z}|@option{--disassemble-zeroes}]
1509 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1510 [@option{-f}|@option{--file-headers}]
1511 [@option{--file-start-context}]
1512 [@option{-g}|@option{--debugging}]
1513 [@option{-e}|@option{--debugging-tags}]
1514 [@option{-h}|@option{--section-headers}|@option{--headers}]
1515 [@option{-i}|@option{--info}]
1516 [@option{-j} @var{section}|@option{--section=}@var{section}]
1517 [@option{-l}|@option{--line-numbers}]
1518 [@option{-S}|@option{--source}]
1519 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1520 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1521 [@option{-p}|@option{--private-headers}]
1522 [@option{-r}|@option{--reloc}]
1523 [@option{-R}|@option{--dynamic-reloc}]
1524 [@option{-s}|@option{--full-contents}]
1525 [@option{-W}|@option{--dwarf}]
1526 [@option{-G}|@option{--stabs}]
1527 [@option{-t}|@option{--syms}]
1528 [@option{-T}|@option{--dynamic-syms}]
1529 [@option{-x}|@option{--all-headers}]
1530 [@option{-w}|@option{--wide}]
1531 [@option{--start-address=}@var{address}]
1532 [@option{--stop-address=}@var{address}]
1533 [@option{--prefix-addresses}]
1534 [@option{--[no-]show-raw-insn}]
1535 [@option{--adjust-vma=}@var{offset}]
1536 [@option{--special-syms}]
1537 [@option{-V}|@option{--version}]
1538 [@option{-H}|@option{--help}]
1539 @var{objfile}@dots{}
1543 @c man begin DESCRIPTION objdump
1545 @command{objdump} displays information about one or more object files.
1546 The options control what particular information to display. This
1547 information is mostly useful to programmers who are working on the
1548 compilation tools, as opposed to programmers who just want their
1549 program to compile and work.
1551 @var{objfile}@dots{} are the object files to be examined. When you
1552 specify archives, @command{objdump} shows information on each of the member
1557 @c man begin OPTIONS objdump
1559 The long and short forms of options, shown here as alternatives, are
1560 equivalent. At least one option from the list
1561 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1565 @itemx --archive-header
1566 @cindex archive headers
1567 If any of the @var{objfile} files are archives, display the archive
1568 header information (in a format similar to @samp{ls -l}). Besides the
1569 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1570 the object file format of each archive member.
1572 @item --adjust-vma=@var{offset}
1573 @cindex section addresses in objdump
1574 @cindex VMA in objdump
1575 When dumping information, first add @var{offset} to all the section
1576 addresses. This is useful if the section addresses do not correspond to
1577 the symbol table, which can happen when putting sections at particular
1578 addresses when using a format which can not represent section addresses,
1581 @item -b @var{bfdname}
1582 @itemx --target=@var{bfdname}
1583 @cindex object code format
1584 Specify that the object-code format for the object files is
1585 @var{bfdname}. This option may not be necessary; @var{objdump} can
1586 automatically recognize many formats.
1590 objdump -b oasys -m vax -h fu.o
1593 displays summary information from the section headers (@option{-h}) of
1594 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1595 file in the format produced by Oasys compilers. You can list the
1596 formats available with the @option{-i} option.
1597 @xref{Target Selection}, for more information.
1600 @itemx --demangle[=@var{style}]
1601 @cindex demangling in objdump
1602 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1603 Besides removing any initial underscore prepended by the system, this
1604 makes C++ function names readable. Different compilers have different
1605 mangling styles. The optional demangling style argument can be used to
1606 choose an appropriate demangling style for your compiler. @xref{c++filt},
1607 for more information on demangling.
1611 Display debugging information. This attempts to parse debugging
1612 information stored in the file and print it out using a C like syntax.
1613 Only certain types of debugging information have been implemented.
1614 Some other types are supported by @command{readelf -w}.
1618 @itemx --debugging-tags
1619 Like @option{-g}, but the information is generated in a format compatible
1623 @itemx --disassemble
1624 @cindex disassembling object code
1625 @cindex machine instructions
1626 Display the assembler mnemonics for the machine instructions from
1627 @var{objfile}. This option only disassembles those sections which are
1628 expected to contain instructions.
1631 @itemx --disassemble-all
1632 Like @option{-d}, but disassemble the contents of all sections, not just
1633 those expected to contain instructions.
1635 @item --prefix-addresses
1636 When disassembling, print the complete address on each line. This is
1637 the older disassembly format.
1641 @itemx --endian=@{big|little@}
1643 @cindex disassembly endianness
1644 Specify the endianness of the object files. This only affects
1645 disassembly. This can be useful when disassembling a file format which
1646 does not describe endianness information, such as S-records.
1649 @itemx --file-headers
1650 @cindex object file header
1651 Display summary information from the overall header of
1652 each of the @var{objfile} files.
1654 @item --file-start-context
1655 @cindex source code context
1656 Specify that when displaying interlisted source code/disassembly
1657 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1658 context to the start of the file.
1661 @itemx --section-headers
1663 @cindex section headers
1664 Display summary information from the section headers of the
1667 File segments may be relocated to nonstandard addresses, for example by
1668 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1669 @command{ld}. However, some object file formats, such as a.out, do not
1670 store the starting address of the file segments. In those situations,
1671 although @command{ld} relocates the sections correctly, using @samp{objdump
1672 -h} to list the file section headers cannot show the correct addresses.
1673 Instead, it shows the usual addresses, which are implicit for the
1678 Print a summary of the options to @command{objdump} and exit.
1682 @cindex architectures available
1683 @cindex object formats available
1684 Display a list showing all architectures and object formats available
1685 for specification with @option{-b} or @option{-m}.
1688 @itemx --section=@var{name}
1689 @cindex section information
1690 Display information only for section @var{name}.
1693 @itemx --line-numbers
1694 @cindex source filenames for object files
1695 Label the display (using debugging information) with the filename and
1696 source line numbers corresponding to the object code or relocs shown.
1697 Only useful with @option{-d}, @option{-D}, or @option{-r}.
1699 @item -m @var{machine}
1700 @itemx --architecture=@var{machine}
1701 @cindex architecture
1702 @cindex disassembly architecture
1703 Specify the architecture to use when disassembling object files. This
1704 can be useful when disassembling object files which do not describe
1705 architecture information, such as S-records. You can list the available
1706 architectures with the @option{-i} option.
1708 @item -M @var{options}
1709 @itemx --disassembler-options=@var{options}
1710 Pass target specific information to the disassembler. Only supported on
1711 some targets. If it is necessary to specify more than one
1712 disassembler option then multiple @option{-M} options can be used or
1713 can be placed together into a comma separated list.
1715 If the target is an ARM architecture then this switch can be used to
1716 select which register name set is used during disassembler. Specifying
1717 @option{-M reg-name-std} (the default) will select the register names as
1718 used in ARM's instruction set documentation, but with register 13 called
1719 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
1720 @option{-M reg-names-apcs} will select the name set used by the ARM
1721 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
1722 just use @samp{r} followed by the register number.
1724 There are also two variants on the APCS register naming scheme enabled
1725 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
1726 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
1727 with the normal register names or the special register names).
1729 This option can also be used for ARM architectures to force the
1730 disassembler to interpret all instructions as Thumb instructions by
1731 using the switch @option{--disassembler-options=force-thumb}. This can be
1732 useful when attempting to disassemble thumb code produced by other
1735 For the x86, some of the options duplicate functions of the @option{-m}
1736 switch, but allow finer grained control. Multiple selections from the
1737 following may be specified as a comma separated string.
1738 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
1739 the given architecture. @option{intel} and @option{att} select between
1740 intel syntax mode and AT&T syntax mode. @option{addr32},
1741 @option{addr16}, @option{data32} and @option{data16} specify the default
1742 address size and operand size. These four options will be overridden if
1743 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
1744 option string. Lastly, @option{suffix}, when in AT&T mode,
1745 instructs the disassembler to print a mnemonic suffix even when the
1746 suffix could be inferred by the operands.
1748 For PPC, @option{booke}, @option{booke32} and @option{booke64} select
1749 disassembly of BookE instructions. @option{32} and @option{64} select
1750 PowerPC and PowerPC64 disassembly, respectively. @option{e300} selects
1751 disassembly for the e300 family.
1753 For MIPS, this option controls the printing of instruction mneumonic
1754 names and register names in disassembled instructions. Multiple
1755 selections from the following may be specified as a comma separated
1756 string, and invalid options are ignored:
1760 Print the 'raw' instruction mneumonic instead of some pseudo
1761 instruction mneumonic. I.E. print 'daddu' or 'or' instead of 'move',
1762 'sll' instead of 'nop', etc.
1764 @item gpr-names=@var{ABI}
1765 Print GPR (general-purpose register) names as appropriate
1766 for the specified ABI. By default, GPR names are selected according to
1767 the ABI of the binary being disassembled.
1769 @item fpr-names=@var{ABI}
1770 Print FPR (floating-point register) names as
1771 appropriate for the specified ABI. By default, FPR numbers are printed
1774 @item cp0-names=@var{ARCH}
1775 Print CP0 (system control coprocessor; coprocessor 0) register names
1776 as appropriate for the CPU or architecture specified by
1777 @var{ARCH}. By default, CP0 register names are selected according to
1778 the architecture and CPU of the binary being disassembled.
1780 @item hwr-names=@var{ARCH}
1781 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
1782 as appropriate for the CPU or architecture specified by
1783 @var{ARCH}. By default, HWR names are selected according to
1784 the architecture and CPU of the binary being disassembled.
1786 @item reg-names=@var{ABI}
1787 Print GPR and FPR names as appropriate for the selected ABI.
1789 @item reg-names=@var{ARCH}
1790 Print CPU-specific register names (CP0 register and HWR names)
1791 as appropriate for the selected CPU or architecture.
1794 For any of the options listed above, @var{ABI} or
1795 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
1796 rather than names, for the selected types of registers.
1797 You can list the available values of @var{ABI} and @var{ARCH} using
1798 the @option{--help} option.
1800 For VAX, you can specify function entry addresses with @option{-M
1801 entry:0xf00ba}. You can use this multiple times to properly
1802 disassemble VAX binary files that don't contain symbol tables (like
1803 ROM dumps). In these cases, the function entry mask would otherwise
1804 be decoded as VAX instructions, which would probably lead the the rest
1805 of the function being wrongly disassembled.
1808 @itemx --private-headers
1809 Print information that is specific to the object file format. The exact
1810 information printed depends upon the object file format. For some
1811 object file formats, no additional information is printed.
1815 @cindex relocation entries, in object file
1816 Print the relocation entries of the file. If used with @option{-d} or
1817 @option{-D}, the relocations are printed interspersed with the
1821 @itemx --dynamic-reloc
1822 @cindex dynamic relocation entries, in object file
1823 Print the dynamic relocation entries of the file. This is only
1824 meaningful for dynamic objects, such as certain types of shared
1828 @itemx --full-contents
1829 @cindex sections, full contents
1830 @cindex object file sections
1831 Display the full contents of any sections requested. By default all
1832 non-empty sections are displayed.
1836 @cindex source disassembly
1837 @cindex disassembly, with source
1838 Display source code intermixed with disassembly, if possible. Implies
1841 @item --show-raw-insn
1842 When disassembling instructions, print the instruction in hex as well as
1843 in symbolic form. This is the default except when
1844 @option{--prefix-addresses} is used.
1846 @item --no-show-raw-insn
1847 When disassembling instructions, do not print the instruction bytes.
1848 This is the default when @option{--prefix-addresses} is used.
1853 @cindex debug symbols
1854 Displays the contents of the DWARF debug sections in the file, if any
1861 @cindex debug symbols
1862 @cindex ELF object file format
1863 Display the full contents of any sections requested. Display the
1864 contents of the .stab and .stab.index and .stab.excl sections from an
1865 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1866 @code{.stab} debugging symbol-table entries are carried in an ELF
1867 section. In most other file formats, debugging symbol-table entries are
1868 interleaved with linkage symbols, and are visible in the @option{--syms}
1871 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1872 Overview,stabs.info, The ``stabs'' debug format}.
1875 @item --start-address=@var{address}
1876 @cindex start-address
1877 Start displaying data at the specified address. This affects the output
1878 of the @option{-d}, @option{-r} and @option{-s} options.
1880 @item --stop-address=@var{address}
1881 @cindex stop-address
1882 Stop displaying data at the specified address. This affects the output
1883 of the @option{-d}, @option{-r} and @option{-s} options.
1887 @cindex symbol table entries, printing
1888 Print the symbol table entries of the file.
1889 This is similar to the information provided by the @samp{nm} program.
1892 @itemx --dynamic-syms
1893 @cindex dynamic symbol table entries, printing
1894 Print the dynamic symbol table entries of the file. This is only
1895 meaningful for dynamic objects, such as certain types of shared
1896 libraries. This is similar to the information provided by the @samp{nm}
1897 program when given the @option{-D} (@option{--dynamic}) option.
1899 @item --special-syms
1900 When displaying symbols include those which the target considers to be
1901 special in some way and which would not normally be of interest to the
1906 Print the version number of @command{objdump} and exit.
1909 @itemx --all-headers
1910 @cindex all header information, object file
1911 @cindex header information, all
1912 Display all available header information, including the symbol table and
1913 relocation entries. Using @option{-x} is equivalent to specifying all of
1914 @option{-a -f -h -p -r -t}.
1918 @cindex wide output, printing
1919 Format some lines for output devices that have more than 80 columns.
1920 Also do not truncate symbol names when they are displayed.
1923 @itemx --disassemble-zeroes
1924 Normally the disassembly output will skip blocks of zeroes. This
1925 option directs the disassembler to disassemble those blocks, just like
1932 @c man begin SEEALSO objdump
1933 nm(1), readelf(1), and the Info entries for @file{binutils}.
1941 @cindex archive contents
1942 @cindex symbol index
1944 @c man title ranlib generate index to archive.
1947 @c man begin SYNOPSIS ranlib
1948 ranlib [@option{-vV}] @var{archive}
1952 @c man begin DESCRIPTION ranlib
1954 @command{ranlib} generates an index to the contents of an archive and
1955 stores it in the archive. The index lists each symbol defined by a
1956 member of an archive that is a relocatable object file.
1958 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
1960 An archive with such an index speeds up linking to the library and
1961 allows routines in the library to call each other without regard to
1962 their placement in the archive.
1964 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
1965 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
1970 @c man begin OPTIONS ranlib
1976 Show the version number of @command{ranlib}.
1982 @c man begin SEEALSO ranlib
1983 ar(1), nm(1), and the Info entries for @file{binutils}.
1991 @cindex section sizes
1993 @c man title size list section sizes and total size.
1996 @c man begin SYNOPSIS size
1997 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
1999 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2000 [@option{-t}|@option{--totals}]
2001 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2002 [@var{objfile}@dots{}]
2006 @c man begin DESCRIPTION size
2008 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2009 size---for each of the object or archive files @var{objfile} in its
2010 argument list. By default, one line of output is generated for each
2011 object file or each module in an archive.
2013 @var{objfile}@dots{} are the object files to be examined.
2014 If none are specified, the file @code{a.out} will be used.
2018 @c man begin OPTIONS size
2020 The command line options have the following meanings:
2025 @itemx --format=@var{compatibility}
2026 @cindex @command{size} display format
2027 Using one of these options, you can choose whether the output from @sc{gnu}
2028 @command{size} resembles output from System V @command{size} (using @option{-A},
2029 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2030 @option{--format=berkeley}). The default is the one-line format similar to
2032 @c Bonus for doc-source readers: you can also say --format=strange (or
2033 @c anything else that starts with 's') for sysv, and --format=boring (or
2034 @c anything else that starts with 'b') for Berkeley.
2036 Here is an example of the Berkeley (default) format of output from
2039 $ size --format=Berkeley ranlib size
2040 text data bss dec hex filename
2041 294880 81920 11592 388392 5ed28 ranlib
2042 294880 81920 11888 388688 5ee50 size
2046 This is the same data, but displayed closer to System V conventions:
2049 $ size --format=SysV ranlib size
2067 Show a summary of acceptable arguments and options.
2072 @itemx --radix=@var{number}
2073 @cindex @command{size} number format
2074 @cindex radix for section sizes
2075 Using one of these options, you can control whether the size of each
2076 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2077 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2078 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2079 values (8, 10, 16) are supported. The total size is always given in two
2080 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2081 octal and hexadecimal if you're using @option{-o}.
2085 Show totals of all objects listed (Berkeley format listing mode only).
2087 @item --target=@var{bfdname}
2088 @cindex object code format
2089 Specify that the object-code format for @var{objfile} is
2090 @var{bfdname}. This option may not be necessary; @command{size} can
2091 automatically recognize many formats.
2092 @xref{Target Selection}, for more information.
2096 Display the version number of @command{size}.
2102 @c man begin SEEALSO size
2103 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2110 @cindex listings strings
2111 @cindex printing strings
2112 @cindex strings, printing
2114 @c man title strings print the strings of printable characters in files.
2117 @c man begin SYNOPSIS strings
2118 strings [@option{-afov}] [@option{-}@var{min-len}]
2119 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2120 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2121 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2122 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2123 [@option{--target=}@var{bfdname}]
2124 [@option{--help}] [@option{--version}] @var{file}@dots{}
2128 @c man begin DESCRIPTION strings
2130 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
2131 character sequences that are at least 4 characters long (or the number
2132 given with the options below) and are followed by an unprintable
2133 character. By default, it only prints the strings from the initialized
2134 and loaded sections of object files; for other types of files, it prints
2135 the strings from the whole file.
2137 @command{strings} is mainly useful for determining the contents of non-text
2142 @c man begin OPTIONS strings
2148 Do not scan only the initialized and loaded sections of object files;
2149 scan the whole files.
2152 @itemx --print-file-name
2153 Print the name of the file before each string.
2156 Print a summary of the program usage on the standard output and exit.
2158 @item -@var{min-len}
2159 @itemx -n @var{min-len}
2160 @itemx --bytes=@var{min-len}
2161 Print sequences of characters that are at least @var{min-len} characters
2162 long, instead of the default 4.
2165 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2166 act like @samp{-t d} instead. Since we can not be compatible with both
2167 ways, we simply chose one.
2169 @item -t @var{radix}
2170 @itemx --radix=@var{radix}
2171 Print the offset within the file before each string. The single
2172 character argument specifies the radix of the offset---@samp{o} for
2173 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2175 @item -e @var{encoding}
2176 @itemx --encoding=@var{encoding}
2177 Select the character encoding of the strings that are to be found.
2178 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2179 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2180 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2181 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2182 littleendian. Useful for finding wide character strings.
2184 @item --target=@var{bfdname}
2185 @cindex object code format
2186 Specify an object code format other than your system's default format.
2187 @xref{Target Selection}, for more information.
2191 Print the program version number on the standard output and exit.
2197 @c man begin SEEALSO strings
2198 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2199 and the Info entries for @file{binutils}.
2207 @cindex removing symbols
2208 @cindex discarding symbols
2209 @cindex symbols, discarding
2211 @c man title strip Discard symbols from object files.
2214 @c man begin SYNOPSIS strip
2215 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2216 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2217 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2218 [@option{-s}|@option{--strip-all}]
2219 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2220 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2221 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2222 [@option{-w}|@option{--wildcard}]
2223 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2224 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2225 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2226 [@option{--only-keep-debug}]
2227 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2228 [@option{--help}] [@option{--info}]
2229 @var{objfile}@dots{}
2233 @c man begin DESCRIPTION strip
2235 @sc{gnu} @command{strip} discards all symbols from object files
2236 @var{objfile}. The list of object files may include archives.
2237 At least one object file must be given.
2239 @command{strip} modifies the files named in its argument,
2240 rather than writing modified copies under different names.
2244 @c man begin OPTIONS strip
2247 @item -F @var{bfdname}
2248 @itemx --target=@var{bfdname}
2249 Treat the original @var{objfile} as a file with the object
2250 code format @var{bfdname}, and rewrite it in the same format.
2251 @xref{Target Selection}, for more information.
2254 Show a summary of the options to @command{strip} and exit.
2257 Display a list showing all architectures and object formats available.
2259 @item -I @var{bfdname}
2260 @itemx --input-target=@var{bfdname}
2261 Treat the original @var{objfile} as a file with the object
2262 code format @var{bfdname}.
2263 @xref{Target Selection}, for more information.
2265 @item -O @var{bfdname}
2266 @itemx --output-target=@var{bfdname}
2267 Replace @var{objfile} with a file in the output format @var{bfdname}.
2268 @xref{Target Selection}, for more information.
2270 @item -R @var{sectionname}
2271 @itemx --remove-section=@var{sectionname}
2272 Remove any section named @var{sectionname} from the output file. This
2273 option may be given more than once. Note that using this option
2274 inappropriately may make the output file unusable.
2283 @itemx --strip-debug
2284 Remove debugging symbols only.
2286 @item --strip-unneeded
2287 Remove all symbols that are not needed for relocation processing.
2289 @item -K @var{symbolname}
2290 @itemx --keep-symbol=@var{symbolname}
2291 When stripping symbols, keep symbol @var{symbolname} even if it would
2292 normally be stripped. This option may be given more than once.
2294 @item -N @var{symbolname}
2295 @itemx --strip-symbol=@var{symbolname}
2296 Remove symbol @var{symbolname} from the source file. This option may be
2297 given more than once, and may be combined with strip options other than
2301 Put the stripped output in @var{file}, rather than replacing the
2302 existing file. When this argument is used, only one @var{objfile}
2303 argument may be specified.
2306 @itemx --preserve-dates
2307 Preserve the access and modification dates of the file.
2311 Permit regular expressions in @var{symbolname}s used in other command
2312 line options. The question mark (?), asterisk (*), backslash (\) and
2313 square brackets ([]) operators can be used anywhere in the symbol
2314 name. If the first character of the symbol name is the exclamation
2315 point (!) then the sense of the switch is reversed for that symbol.
2322 would cause strip to only keep symbols that start with the letters
2323 ``fo'', but to discard the symbol ``foo''.
2326 @itemx --discard-all
2327 Remove non-global symbols.
2330 @itemx --discard-locals
2331 Remove compiler-generated local symbols.
2332 (These usually start with @samp{L} or @samp{.}.)
2334 @item --only-keep-debug
2335 Strip a file, removing any sections that would be stripped by
2336 @option{--strip-debug} and leaving the debugging sections.
2338 The intention is that this option will be used in conjunction with
2339 @option{--add-gnu-debuglink} to create a two part executable. One a
2340 stripped binary which will occupy less space in RAM and in a
2341 distribution and the second a debugging information file which is only
2342 needed if debugging abilities are required. The suggested procedure
2343 to create these files is as follows:
2346 @item Link the executable as normal. Assuming that is is called
2348 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2349 create a file containing the debugging info.
2350 @item Run @code{objcopy --strip-debug foo} to create a
2351 stripped executable.
2352 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2353 to add a link to the debugging info into the stripped executable.
2356 Note - the choice of @code{.dbg} as an extension for the debug info
2357 file is arbitrary. Also the @code{--only-keep-debug} step is
2358 optional. You could instead do this:
2361 @item Link the executable as normal.
2362 @item Copy @code{foo} to @code{foo.full}
2363 @item Run @code{strip --strip-debug foo}
2364 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2367 ie the file pointed to by the @option{--add-gnu-debuglink} can be the
2368 full executable. It does not have to be a file created by the
2369 @option{--only-keep-debug} switch.
2373 Show the version number for @command{strip}.
2377 Verbose output: list all object files modified. In the case of
2378 archives, @samp{strip -v} lists all members of the archive.
2384 @c man begin SEEALSO strip
2385 the Info entries for @file{binutils}.
2389 @node c++filt, addr2line, strip, Top
2393 @cindex demangling C++ symbols
2395 @c man title cxxfilt Demangle C++ and Java symbols.
2398 @c man begin SYNOPSIS cxxfilt
2399 c++filt [@option{-_}|@option{--strip-underscores}]
2400 [@option{-j}|@option{--java}]
2401 [@option{-n}|@option{--no-strip-underscores}]
2402 [@option{-p}|@option{--no-params}]
2403 [@option{-s} @var{format}|@option{--format=}@var{format}]
2404 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2408 @c man begin DESCRIPTION cxxfilt
2411 The C++ and Java languages provides function overloading, which means
2412 that you can write many functions with the same name (providing each
2413 takes parameters of different types). All C++ and Java function names
2414 are encoded into a low-level assembly label (this process is known as
2415 @dfn{mangling}). The @command{c++filt}
2416 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2417 MS-DOS this program is named @command{CXXFILT}.}
2418 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2419 names into user-level names so that the linker can keep these overloaded
2420 functions from clashing.
2422 Every alphanumeric word (consisting of letters, digits, underscores,
2423 dollars, or periods) seen in the input is a potential label. If the
2424 label decodes into a C++ name, the C++ name replaces the low-level
2427 You can use @command{c++filt} to decipher individual symbols:
2430 c++filt @var{symbol}
2433 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
2434 names from the standard input and writes the demangled names to the
2435 standard output. All results are printed on the standard output.
2439 @c man begin OPTIONS cxxfilt
2443 @itemx --strip-underscores
2444 On some systems, both the C and C++ compilers put an underscore in front
2445 of every name. For example, the C name @code{foo} gets the low-level
2446 name @code{_foo}. This option removes the initial underscore. Whether
2447 @command{c++filt} removes the underscore by default is target dependent.
2451 Prints demangled names using Java syntax. The default is to use C++
2455 @itemx --no-strip-underscores
2456 Do not remove the initial underscore.
2460 When demangling the name of a function, do not display the types of
2461 the function's parameters.
2463 @item -s @var{format}
2464 @itemx --format=@var{format}
2465 @command{c++filt} can decode various methods of mangling, used by
2466 different compilers. The argument to this option selects which
2471 Automatic selection based on executable (the default method)
2473 the one used by the @sc{gnu} C++ compiler (g++)
2475 the one used by the Lucid compiler (lcc)
2477 the one specified by the C++ Annotated Reference Manual
2479 the one used by the HP compiler (aCC)
2481 the one used by the EDG compiler
2483 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
2485 the one used by the @sc{gnu} Java compiler (gcj)
2487 the one used by the @sc{gnu} Ada compiler (GNAT).
2491 Print a summary of the options to @command{c++filt} and exit.
2494 Print the version number of @command{c++filt} and exit.
2500 @c man begin SEEALSO cxxfilt
2501 the Info entries for @file{binutils}.
2506 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
2507 user interface are subject to change in future releases. In particular,
2508 a command-line option may be required in the the future to decode a name
2509 passed as an argument on the command line; in other words,
2512 c++filt @var{symbol}
2516 may in a future release become
2519 c++filt @var{option} @var{symbol}
2527 @cindex address to file name and line number
2529 @c man title addr2line convert addresses into file names and line numbers.
2532 @c man begin SYNOPSIS addr2line
2533 addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
2534 [@option{-C}|@option{--demangle}[=@var{style}]]
2535 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
2536 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
2537 [@option{-i}|@option{--inlines}]
2538 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
2543 @c man begin DESCRIPTION addr2line
2545 @command{addr2line} translates program addresses into file names and line
2546 numbers. Given an address and an executable, it uses the debugging
2547 information in the executable to figure out which file name and line
2548 number are associated with a given address.
2550 The executable to use is specified with the @option{-e} option. The
2551 default is the file @file{a.out}.
2553 @command{addr2line} has two modes of operation.
2555 In the first, hexadecimal addresses are specified on the command line,
2556 and @command{addr2line} displays the file name and line number for each
2559 In the second, @command{addr2line} reads hexadecimal addresses from
2560 standard input, and prints the file name and line number for each
2561 address on standard output. In this mode, @command{addr2line} may be used
2562 in a pipe to convert dynamically chosen addresses.
2564 The format of the output is @samp{FILENAME:LINENO}. The file name and
2565 line number for each address is printed on a separate line. If the
2566 @command{-f} option is used, then each @samp{FILENAME:LINENO} line is
2567 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2568 containing the address.
2570 If the file name or function name can not be determined,
2571 @command{addr2line} will print two question marks in their place. If the
2572 line number can not be determined, @command{addr2line} will print 0.
2576 @c man begin OPTIONS addr2line
2578 The long and short forms of options, shown here as alternatives, are
2582 @item -b @var{bfdname}
2583 @itemx --target=@var{bfdname}
2584 @cindex object code format
2585 Specify that the object-code format for the object files is
2589 @itemx --demangle[=@var{style}]
2590 @cindex demangling in objdump
2591 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2592 Besides removing any initial underscore prepended by the system, this
2593 makes C++ function names readable. Different compilers have different
2594 mangling styles. The optional demangling style argument can be used to
2595 choose an appropriate demangling style for your compiler. @xref{c++filt},
2596 for more information on demangling.
2598 @item -e @var{filename}
2599 @itemx --exe=@var{filename}
2600 Specify the name of the executable for which addresses should be
2601 translated. The default file is @file{a.out}.
2605 Display function names as well as file and line number information.
2609 Display only the base of each file name.
2613 If the address belongs to a function that was inlined, the source
2614 information for all enclosing scopes back to the first non-inlined
2615 function will also be printed. For example, if @code{main} inlines
2616 @code{callee1} which inlines @code{callee2}, and address is from
2617 @code{callee2}, the source information for @code{callee1} and @code{main}
2618 will also be printed.
2624 @c man begin SEEALSO addr2line
2625 Info entries for @file{binutils}.
2632 @command{nlmconv} converts a relocatable object file into a NetWare
2636 @command{nlmconv} currently works with @samp{i386} object
2637 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
2638 object files in @sc{elf}, or @code{a.out} format@footnote{
2639 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
2640 format in the Binary File Descriptor library. It has only been tested
2641 with the above formats.}.
2645 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
2646 utilities, since it is only useful for NLM targets.
2649 @c man title nlmconv converts object code into an NLM.
2652 @c man begin SYNOPSIS nlmconv
2653 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
2654 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
2655 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
2656 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
2657 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
2658 @var{infile} @var{outfile}
2662 @c man begin DESCRIPTION nlmconv
2664 @command{nlmconv} converts the relocatable @samp{i386} object file
2665 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
2666 reading @var{headerfile} for NLM header information. For instructions
2667 on writing the NLM command file language used in header files, see the
2668 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
2669 Development and Tools Overview}, which is part of the NLM Software
2670 Developer's Kit (``NLM SDK''), available from Novell, Inc.
2671 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
2674 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
2677 @command{nlmconv} can perform a link step. In other words, you can list
2678 more than one object file for input if you list them in the definitions
2679 file (rather than simply specifying one input file on the command line).
2680 In this case, @command{nlmconv} calls the linker for you.
2684 @c man begin OPTIONS nlmconv
2687 @item -I @var{bfdname}
2688 @itemx --input-target=@var{bfdname}
2689 Object format of the input file. @command{nlmconv} can usually determine
2690 the format of a given file (so no default is necessary).
2691 @xref{Target Selection}, for more information.
2693 @item -O @var{bfdname}
2694 @itemx --output-target=@var{bfdname}
2695 Object format of the output file. @command{nlmconv} infers the output
2696 format based on the input format, e.g. for a @samp{i386} input file the
2697 output format is @samp{nlm32-i386}.
2698 @xref{Target Selection}, for more information.
2700 @item -T @var{headerfile}
2701 @itemx --header-file=@var{headerfile}
2702 Reads @var{headerfile} for NLM header information. For instructions on
2703 writing the NLM command file language used in header files, see@ see the
2704 @samp{linkers} section, of the @cite{NLM Development and Tools
2705 Overview}, which is part of the NLM Software Developer's Kit, available
2710 Displays (on standard error) the linker command line used by @command{nlmconv}.
2712 @item -l @var{linker}
2713 @itemx --linker=@var{linker}
2714 Use @var{linker} for any linking. @var{linker} can be an absolute or a
2719 Prints a usage summary.
2723 Prints the version number for @command{nlmconv}.
2729 @c man begin SEEALSO nlmconv
2730 the Info entries for @file{binutils}.
2737 @command{windres} may be used to manipulate Windows resources.
2740 @emph{Warning:} @command{windres} is not always built as part of the binary
2741 utilities, since it is only useful for Windows targets.
2744 @c man title windres manipulate Windows resources.
2747 @c man begin SYNOPSIS windres
2748 windres [options] [input-file] [output-file]
2752 @c man begin DESCRIPTION windres
2754 @command{windres} reads resources from an input file and copies them into
2755 an output file. Either file may be in one of three formats:
2759 A text format read by the Resource Compiler.
2762 A binary format generated by the Resource Compiler.
2765 A COFF object or executable.
2768 The exact description of these different formats is available in
2769 documentation from Microsoft.
2771 When @command{windres} converts from the @code{rc} format to the @code{res}
2772 format, it is acting like the Windows Resource Compiler. When
2773 @command{windres} converts from the @code{res} format to the @code{coff}
2774 format, it is acting like the Windows @code{CVTRES} program.
2776 When @command{windres} generates an @code{rc} file, the output is similar
2777 but not identical to the format expected for the input. When an input
2778 @code{rc} file refers to an external filename, an output @code{rc} file
2779 will instead include the file contents.
2781 If the input or output format is not specified, @command{windres} will
2782 guess based on the file name, or, for the input file, the file contents.
2783 A file with an extension of @file{.rc} will be treated as an @code{rc}
2784 file, a file with an extension of @file{.res} will be treated as a
2785 @code{res} file, and a file with an extension of @file{.o} or
2786 @file{.exe} will be treated as a @code{coff} file.
2788 If no output file is specified, @command{windres} will print the resources
2789 in @code{rc} format to standard output.
2791 The normal use is for you to write an @code{rc} file, use @command{windres}
2792 to convert it to a COFF object file, and then link the COFF file into
2793 your application. This will make the resources described in the
2794 @code{rc} file available to Windows.
2798 @c man begin OPTIONS windres
2801 @item -i @var{filename}
2802 @itemx --input @var{filename}
2803 The name of the input file. If this option is not used, then
2804 @command{windres} will use the first non-option argument as the input file
2805 name. If there are no non-option arguments, then @command{windres} will
2806 read from standard input. @command{windres} can not read a COFF file from
2809 @item -o @var{filename}
2810 @itemx --output @var{filename}
2811 The name of the output file. If this option is not used, then
2812 @command{windres} will use the first non-option argument, after any used
2813 for the input file name, as the output file name. If there is no
2814 non-option argument, then @command{windres} will write to standard output.
2815 @command{windres} can not write a COFF file to standard output. Note,
2816 for compatability with @command{rc} the option @option{-fo} is also
2817 accepted, but its use is not recommended.
2819 @item -J @var{format}
2820 @itemx --input-format @var{format}
2821 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
2822 @samp{coff}. If no input format is specified, @command{windres} will
2823 guess, as described above.
2825 @item -O @var{format}
2826 @itemx --output-format @var{format}
2827 The output format to generate. @var{format} may be @samp{res},
2828 @samp{rc}, or @samp{coff}. If no output format is specified,
2829 @command{windres} will guess, as described above.
2831 @item -F @var{target}
2832 @itemx --target @var{target}
2833 Specify the BFD format to use for a COFF file as input or output. This
2834 is a BFD target name; you can use the @option{--help} option to see a list
2835 of supported targets. Normally @command{windres} will use the default
2836 format, which is the first one listed by the @option{--help} option.
2838 @ref{Target Selection}.
2841 @item --preprocessor @var{program}
2842 When @command{windres} reads an @code{rc} file, it runs it through the C
2843 preprocessor first. This option may be used to specify the preprocessor
2844 to use, including any leading arguments. The default preprocessor
2845 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
2847 @item -I @var{directory}
2848 @itemx --include-dir @var{directory}
2849 Specify an include directory to use when reading an @code{rc} file.
2850 @command{windres} will pass this to the preprocessor as an @option{-I}
2851 option. @command{windres} will also search this directory when looking for
2852 files named in the @code{rc} file. If the argument passed to this command
2853 matches any of the supported @var{formats} (as descrived in the @option{-J}
2854 option), it will issue a deprecation warning, and behave just like the
2855 @option{-J} option. New programs should not use this behaviour. If a
2856 directory happens to match a @var{format}, simple prefix it with @samp{./}
2857 to disable the backward compatibility.
2859 @item -D @var{target}
2860 @itemx --define @var{sym}[=@var{val}]
2861 Specify a @option{-D} option to pass to the preprocessor when reading an
2864 @item -U @var{target}
2865 @itemx --undefine @var{sym}
2866 Specify a @option{-U} option to pass to the preprocessor when reading an
2870 Ignored for compatibility with rc.
2873 Enable verbose mode. This tells you what the preprocessor is if you
2877 @item --language @var{val}
2878 Specify the default language to use when reading an @code{rc} file.
2879 @var{val} should be a hexadecimal language code. The low eight bits are
2880 the language, and the high eight bits are the sublanguage.
2882 @item --use-temp-file
2883 Use a temporary file to instead of using popen to read the output of
2884 the preprocessor. Use this option if the popen implementation is buggy
2885 on the host (eg., certain non-English language versions of Windows 95 and
2886 Windows 98 are known to have buggy popen where the output will instead
2889 @item --no-use-temp-file
2890 Use popen, not a temporary file, to read the output of the preprocessor.
2891 This is the default behaviour.
2895 Prints a usage summary.
2899 Prints the version number for @command{windres}.
2902 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
2903 this will turn on parser debugging.
2909 @c man begin SEEALSO windres
2910 the Info entries for @file{binutils}.
2919 @command{dlltool} is used to create the files needed to create dynamic
2920 link libraries (DLLs) on systems which understand PE format image
2921 files such as Windows. A DLL contains an export table which contains
2922 information that the runtime loader needs to resolve references from a
2923 referencing program.
2925 The export table is generated by this program by reading in a
2926 @file{.def} file or scanning the @file{.a} and @file{.o} files which
2927 will be in the DLL. A @file{.o} file can contain information in
2928 special @samp{.drectve} sections with export information.
2931 @emph{Note:} @command{dlltool} is not always built as part of the
2932 binary utilities, since it is only useful for those targets which
2936 @c man title dlltool Create files needed to build and use DLLs.
2939 @c man begin SYNOPSIS dlltool
2940 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
2941 [@option{-b}|@option{--base-file} @var{base-file-name}]
2942 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
2943 [@option{-z}|@option{--output-def} @var{def-file-name}]
2944 [@option{-l}|@option{--output-lib} @var{library-file-name}]
2945 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
2946 [@option{--exclude-symbols} @var{list}]
2947 [@option{--no-default-excludes}]
2948 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
2949 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
2950 [@option{-a}|@option{--add-indirect}] [@option{-U}|@option{--add-underscore}] [@option{-k}|@option{--kill-at}]
2951 [@option{-A}|@option{--add-stdcall-alias}]
2952 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
2953 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}] [@option{-i}|@option{--interwork}]
2954 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
2955 [@option{-v}|@option{--verbose}]
2956 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
2957 [object-file @dots{}]
2961 @c man begin DESCRIPTION dlltool
2963 @command{dlltool} reads its inputs, which can come from the @option{-d} and
2964 @option{-b} options as well as object files specified on the command
2965 line. It then processes these inputs and if the @option{-e} option has
2966 been specified it creates a exports file. If the @option{-l} option
2967 has been specified it creates a library file and if the @option{-z} option
2968 has been specified it creates a def file. Any or all of the @option{-e},
2969 @option{-l} and @option{-z} options can be present in one invocation of
2972 When creating a DLL, along with the source for the DLL, it is necessary
2973 to have three other files. @command{dlltool} can help with the creation of
2976 The first file is a @file{.def} file which specifies which functions are
2977 exported from the DLL, which functions the DLL imports, and so on. This
2978 is a text file and can be created by hand, or @command{dlltool} can be used
2979 to create it using the @option{-z} option. In this case @command{dlltool}
2980 will scan the object files specified on its command line looking for
2981 those functions which have been specially marked as being exported and
2982 put entries for them in the @file{.def} file it creates.
2984 In order to mark a function as being exported from a DLL, it needs to
2985 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
2986 section of the object file. This can be done in C by using the
2990 asm (".section .drectve");
2991 asm (".ascii \"-export:my_func\"");
2993 int my_func (void) @{ @dots{} @}
2996 The second file needed for DLL creation is an exports file. This file
2997 is linked with the object files that make up the body of the DLL and it
2998 handles the interface between the DLL and the outside world. This is a
2999 binary file and it can be created by giving the @option{-e} option to
3000 @command{dlltool} when it is creating or reading in a @file{.def} file.
3002 The third file needed for DLL creation is the library file that programs
3003 will link with in order to access the functions in the DLL. This file
3004 can be created by giving the @option{-l} option to dlltool when it
3005 is creating or reading in a @file{.def} file.
3007 @command{dlltool} builds the library file by hand, but it builds the
3008 exports file by creating temporary files containing assembler statements
3009 and then assembling these. The @option{-S} command line option can be
3010 used to specify the path to the assembler that dlltool will use,
3011 and the @option{-f} option can be used to pass specific flags to that
3012 assembler. The @option{-n} can be used to prevent dlltool from deleting
3013 these temporary assembler files when it is done, and if @option{-n} is
3014 specified twice then this will prevent dlltool from deleting the
3015 temporary object files it used to build the library.
3017 Here is an example of creating a DLL from a source file @samp{dll.c} and
3018 also creating a program (from an object file called @samp{program.o})
3023 dlltool -e exports.o -l dll.lib dll.o
3024 gcc dll.o exports.o -o dll.dll
3025 gcc program.o dll.lib -o program
3030 @c man begin OPTIONS dlltool
3032 The command line options have the following meanings:
3036 @item -d @var{filename}
3037 @itemx --input-def @var{filename}
3038 @cindex input .def file
3039 Specifies the name of a @file{.def} file to be read in and processed.
3041 @item -b @var{filename}
3042 @itemx --base-file @var{filename}
3044 Specifies the name of a base file to be read in and processed. The
3045 contents of this file will be added to the relocation section in the
3046 exports file generated by dlltool.
3048 @item -e @var{filename}
3049 @itemx --output-exp @var{filename}
3050 Specifies the name of the export file to be created by dlltool.
3052 @item -z @var{filename}
3053 @itemx --output-def @var{filename}
3054 Specifies the name of the @file{.def} file to be created by dlltool.
3056 @item -l @var{filename}
3057 @itemx --output-lib @var{filename}
3058 Specifies the name of the library file to be created by dlltool.
3060 @item --export-all-symbols
3061 Treat all global and weak defined symbols found in the input object
3062 files as symbols to be exported. There is a small list of symbols which
3063 are not exported by default; see the @option{--no-default-excludes}
3064 option. You may add to the list of symbols to not export by using the
3065 @option{--exclude-symbols} option.
3067 @item --no-export-all-symbols
3068 Only export symbols explicitly listed in an input @file{.def} file or in
3069 @samp{.drectve} sections in the input object files. This is the default
3070 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3071 attributes in the source code.
3073 @item --exclude-symbols @var{list}
3074 Do not export the symbols in @var{list}. This is a list of symbol names
3075 separated by comma or colon characters. The symbol names should not
3076 contain a leading underscore. This is only meaningful when
3077 @option{--export-all-symbols} is used.
3079 @item --no-default-excludes
3080 When @option{--export-all-symbols} is used, it will by default avoid
3081 exporting certain special symbols. The current list of symbols to avoid
3082 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3083 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3084 to go ahead and export these special symbols. This is only meaningful
3085 when @option{--export-all-symbols} is used.
3088 @itemx --as @var{path}
3089 Specifies the path, including the filename, of the assembler to be used
3090 to create the exports file.
3092 @item -f @var{options}
3093 @itemx --as-flags @var{options}
3094 Specifies any specific command line options to be passed to the
3095 assembler when building the exports file. This option will work even if
3096 the @option{-S} option is not used. This option only takes one argument,
3097 and if it occurs more than once on the command line, then later
3098 occurrences will override earlier occurrences. So if it is necessary to
3099 pass multiple options to the assembler they should be enclosed in
3103 @itemx --dll-name @var{name}
3104 Specifies the name to be stored in the @file{.def} file as the name of
3105 the DLL when the @option{-e} option is used. If this option is not
3106 present, then the filename given to the @option{-e} option will be
3107 used as the name of the DLL.
3109 @item -m @var{machine}
3110 @itemx -machine @var{machine}
3111 Specifies the type of machine for which the library file should be
3112 built. @command{dlltool} has a built in default type, depending upon how
3113 it was created, but this option can be used to override that. This is
3114 normally only useful when creating DLLs for an ARM processor, when the
3115 contents of the DLL are actually encode using Thumb instructions.
3118 @itemx --add-indirect
3119 Specifies that when @command{dlltool} is creating the exports file it
3120 should add a section which allows the exported functions to be
3121 referenced without using the import library. Whatever the hell that
3125 @itemx --add-underscore
3126 Specifies that when @command{dlltool} is creating the exports file it
3127 should prepend an underscore to the names of the exported functions.
3131 Specifies that when @command{dlltool} is creating the exports file it
3132 should not append the string @samp{@@ <number>}. These numbers are
3133 called ordinal numbers and they represent another way of accessing the
3134 function in a DLL, other than by name.
3137 @itemx --add-stdcall-alias
3138 Specifies that when @command{dlltool} is creating the exports file it
3139 should add aliases for stdcall symbols without @samp{@@ <number>}
3140 in addition to the symbols with @samp{@@ <number>}.
3143 @itemx --ext-prefix-alias @var{prefix}
3144 Causes @command{dlltool} to create external aliases for all DLL
3145 imports with the specified prefix. The aliases are created for both
3146 external and import symbols with no leading underscore.
3150 Specifies that when @command{dlltool} is creating the exports and library
3151 files it should omit the @code{.idata4} section. This is for compatibility
3152 with certain operating systems.
3156 Specifies that when @command{dlltool} is creating the exports and library
3157 files it should omit the @code{.idata5} section. This is for compatibility
3158 with certain operating systems.
3162 Specifies that @command{dlltool} should mark the objects in the library
3163 file and exports file that it produces as supporting interworking
3164 between ARM and Thumb code.
3168 Makes @command{dlltool} preserve the temporary assembler files it used to
3169 create the exports file. If this option is repeated then dlltool will
3170 also preserve the temporary object files it uses to create the library
3173 @item -t @var{prefix}
3174 @itemx --temp-prefix @var{prefix}
3175 Makes @command{dlltool} use @var{prefix} when constructing the names of
3176 temporary assembler and object files. By default, the temp file prefix
3177 is generated from the pid.
3181 Make dlltool describe what it is doing.
3185 Displays a list of command line options and then exits.
3189 Displays dlltool's version number and then exits.
3196 * def file format:: The format of the dlltool @file{.def} file
3199 @node def file format
3200 @section The format of the @command{dlltool} @file{.def} file
3202 A @file{.def} file contains any number of the following commands:
3206 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
3207 The result is going to be named @var{name}@code{.exe}.
3209 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
3210 The result is going to be named @var{name}@code{.dll}.
3212 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) )}
3213 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
3214 Declares @var{name1} as an exported symbol from the DLL, with optional
3215 ordinal number @var{integer}, or declares @var{name1} as an alias
3216 (forward) of the function @var{external-name} in the DLL
3219 @item @code{IMPORTS ( (} @var{internal-name} @code{=} @var{module-name} @code{.} @var{integer} @code{) | [} @var{internal-name} @code{= ]} @var{module-name} @code{.} @var{external-name} @code{) ) *}
3220 Declares that @var{external-name} or the exported function whose
3221 ordinal number is @var{integer} is to be imported from the file
3222 @var{module-name}. If @var{internal-name} is specified then this is
3223 the name that the imported function will be referred to in the body of
3226 @item @code{DESCRIPTION} @var{string}
3227 Puts @var{string} into the output @file{.exp} file in the
3228 @code{.rdata} section.
3230 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3231 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3232 Generates @code{--stack} or @code{--heap}
3233 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
3234 section. The linker will see this and act upon it.
3236 @item @code{CODE} @var{attr} @code{+}
3237 @item @code{DATA} @var{attr} @code{+}
3238 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
3239 Generates @code{--attr} @var{section-name} @var{attr} in the output
3240 @code{.drectve} section, where @var{attr} is one of @code{READ},
3241 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
3242 this and act upon it.
3247 @c man begin SEEALSO dlltool
3248 The Info pages for @file{binutils}.
3255 @cindex ELF file information
3258 @c man title readelf Displays information about ELF files.
3261 @c man begin SYNOPSIS readelf
3262 readelf [@option{-a}|@option{--all}]
3263 [@option{-h}|@option{--file-header}]
3264 [@option{-l}|@option{--program-headers}|@option{--segments}]
3265 [@option{-S}|@option{--section-headers}|@option{--sections}]
3266 [@option{-g}|@option{--section-groups}]
3267 [@option{-t}|@option{--section-details}]
3268 [@option{-e}|@option{--headers}]
3269 [@option{-s}|@option{--syms}|@option{--symbols}]
3270 [@option{-n}|@option{--notes}]
3271 [@option{-r}|@option{--relocs}]
3272 [@option{-u}|@option{--unwind}]
3273 [@option{-d}|@option{--dynamic}]
3274 [@option{-V}|@option{--version-info}]
3275 [@option{-A}|@option{--arch-specific}]
3276 [@option{-D}|@option{--use-dynamic}]
3277 [@option{-x} <number>|@option{--hex-dump=}<number>]
3278 [@option{-w[liaprmfFsoR]}|
3279 @option{--debug-dump}[=line,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
3280 [@option{-I}|@option{-histogram}]
3281 [@option{-v}|@option{--version}]
3282 [@option{-W}|@option{--wide}]
3283 [@option{-H}|@option{--help}]
3284 @var{elffile}@dots{}
3288 @c man begin DESCRIPTION readelf
3290 @command{readelf} displays information about one or more ELF format object
3291 files. The options control what particular information to display.
3293 @var{elffile}@dots{} are the object files to be examined. 32-bit and
3294 64-bit ELF files are supported, as are archives containing ELF files.
3296 This program performs a similar function to @command{objdump} but it
3297 goes into more detail and it exists independently of the @sc{bfd}
3298 library, so if there is a bug in @sc{bfd} then readelf will not be
3303 @c man begin OPTIONS readelf
3305 The long and short forms of options, shown here as alternatives, are
3306 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
3312 Equivalent to specifiying @option{--file-header},
3313 @option{--program-headers}, @option{--sections}, @option{--symbols},
3314 @option{--relocs}, @option{--dynamic}, @option{--notes} and
3315 @option{--version-info}.
3318 @itemx --file-header
3319 @cindex ELF file header information
3320 Displays the information contained in the ELF header at the start of the
3324 @itemx --program-headers
3326 @cindex ELF program header information
3327 @cindex ELF segment information
3328 Displays the information contained in the file's segment headers, if it
3333 @itemx --section-headers
3334 @cindex ELF section information
3335 Displays the information contained in the file's section headers, if it
3339 @itemx --section-groups
3340 @cindex ELF section group information
3341 Displays the information contained in the file's section groups, if it
3345 @itemx --section-details
3346 @cindex ELF section information
3347 Displays the detailed section information. Implies @option{-S}.
3352 @cindex ELF symbol table information
3353 Displays the entries in symbol table section of the file, if it has one.
3357 Display all the headers in the file. Equivalent to @option{-h -l -S}.
3362 Displays the contents of the NOTE segments and/or sections, if any.
3366 @cindex ELF reloc information
3367 Displays the contents of the file's relocation section, if it has one.
3371 @cindex unwind information
3372 Displays the contents of the file's unwind section, if it has one. Only
3373 the unwind sections for IA64 ELF files are currently supported.
3377 @cindex ELF dynamic section information
3378 Displays the contents of the file's dynamic section, if it has one.
3381 @itemx --version-info
3382 @cindex ELF version sections informations
3383 Displays the contents of the version sections in the file, it they
3387 @itemx --arch-specific
3388 Displays architecture-specific information in the file, if there
3392 @itemx --use-dynamic
3393 When displaying symbols, this option makes @command{readelf} use the
3394 symbol table in the file's dynamic section, rather than the one in the
3398 @itemx --hex-dump=<number>
3399 Displays the contents of the indicated section as a hexadecimal dump.
3401 @item -w[liaprmfFsoR]
3402 @itemx --debug-dump[=line,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]
3403 Displays the contents of the debug sections in the file, if any are
3404 present. If one of the optional letters or words follows the switch
3405 then only data found in those specific sections will be dumped.
3409 Display a histogram of bucket list lengths when displaying the contents
3410 of the symbol tables.
3414 Display the version number of readelf.
3418 Don't break output lines to fit into 80 columns. By default
3419 @command{readelf} breaks section header and segment listing lines for
3420 64-bit ELF files, so that they fit into 80 columns. This option causes
3421 @command{readelf} to print each section header resp. each segment one a
3422 single line, which is far more readable on terminals wider than 80 columns.
3426 Display the command line options understood by @command{readelf}.
3433 @c man begin SEEALSO readelf
3434 objdump(1), and the Info entries for @file{binutils}.
3438 @node Common Options
3439 @chapter Common Options
3441 The following command-line options are supported by all of the
3442 programs described in this manual.
3446 Read command-line options from @var{file}. The options read are
3447 inserted in place of the original @@@var{file} option. If @var{file}
3448 does not exist, or cannot be read, then the option will be treated
3449 literally, and not removed.
3451 Options in @var{file} are separated by whitespace. A whitespace
3452 character may be included in an option by surrounding the entire
3453 option in either single or double quotes. Any character (including a
3454 backslash) may be included by prefixing the character to be included
3455 character with a backslash. The @var{file} may itself contain
3456 additional @@@var{file} options; any such options will be processed
3460 Display the command-line options supported by the program.
3463 Display the version number of the program.
3467 @node Selecting The Target System
3468 @chapter Selecting the Target System
3470 You can specify two aspects of the target system to the @sc{gnu}
3471 binary file utilities, each in several ways:
3481 In the following summaries, the lists of ways to specify values are in
3482 order of decreasing precedence. The ways listed first override those
3485 The commands to list valid values only list the values for which the
3486 programs you are running were configured. If they were configured with
3487 @option{--enable-targets=all}, the commands list most of the available
3488 values, but a few are left out; not all targets can be configured in at
3489 once because some of them can only be configured @dfn{native} (on hosts
3490 with the same type as the target system).
3493 * Target Selection::
3494 * Architecture Selection::
3497 @node Target Selection
3498 @section Target Selection
3500 A @dfn{target} is an object file format. A given target may be
3501 supported for multiple architectures (@pxref{Architecture Selection}).
3502 A target selection may also have variations for different operating
3503 systems or architectures.
3505 The command to list valid target values is @samp{objdump -i}
3506 (the first column of output contains the relevant information).
3508 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
3509 @samp{a.out-sunos-big}.
3511 You can also specify a target using a configuration triplet. This is
3512 the same sort of name that is passed to @file{configure} to specify a
3513 target. When you use a configuration triplet as an argument, it must be
3514 fully canonicalized. You can see the canonical version of a triplet by
3515 running the shell script @file{config.sub} which is included with the
3518 Some sample configuration triplets are: @samp{m68k-hp-bsd},
3519 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
3521 @subheading @command{objdump} Target
3527 command line option: @option{-b} or @option{--target}
3530 environment variable @code{GNUTARGET}
3533 deduced from the input file
3536 @subheading @command{objcopy} and @command{strip} Input Target
3542 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
3545 environment variable @code{GNUTARGET}
3548 deduced from the input file
3551 @subheading @command{objcopy} and @command{strip} Output Target
3557 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
3560 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
3563 environment variable @code{GNUTARGET}
3566 deduced from the input file
3569 @subheading @command{nm}, @command{size}, and @command{strings} Target
3575 command line option: @option{--target}
3578 environment variable @code{GNUTARGET}
3581 deduced from the input file
3584 @node Architecture Selection
3585 @section Architecture Selection
3587 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
3588 to run. Its name may contain a colon, separating the name of the
3589 processor family from the name of the particular @sc{cpu}.
3591 The command to list valid architecture values is @samp{objdump -i} (the
3592 second column contains the relevant information).
3594 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
3596 @subheading @command{objdump} Architecture
3602 command line option: @option{-m} or @option{--architecture}
3605 deduced from the input file
3608 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
3614 deduced from the input file
3617 @node Reporting Bugs
3618 @chapter Reporting Bugs
3620 @cindex reporting bugs
3622 Your bug reports play an essential role in making the binary utilities
3625 Reporting a bug may help you by bringing a solution to your problem, or
3626 it may not. But in any case the principal function of a bug report is
3627 to help the entire community by making the next version of the binary
3628 utilities work better. Bug reports are your contribution to their
3631 In order for a bug report to serve its purpose, you must include the
3632 information that enables us to fix the bug.
3635 * Bug Criteria:: Have you found a bug?
3636 * Bug Reporting:: How to report bugs
3640 @section Have You Found a Bug?
3641 @cindex bug criteria
3643 If you are not sure whether you have found a bug, here are some guidelines:
3646 @cindex fatal signal
3649 If a binary utility gets a fatal signal, for any input whatever, that is
3650 a bug. Reliable utilities never crash.
3652 @cindex error on valid input
3654 If a binary utility produces an error message for valid input, that is a
3658 If you are an experienced user of binary utilities, your suggestions for
3659 improvement are welcome in any case.
3663 @section How to Report Bugs
3665 @cindex bugs, reporting
3667 A number of companies and individuals offer support for @sc{gnu}
3668 products. If you obtained the binary utilities from a support
3669 organization, we recommend you contact that organization first.
3671 You can find contact information for many support companies and
3672 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
3675 In any event, we also recommend that you send bug reports for the binary
3676 utilities to @samp{bug-binutils@@gnu.org}.
3678 The fundamental principle of reporting bugs usefully is this:
3679 @strong{report all the facts}. If you are not sure whether to state a
3680 fact or leave it out, state it!
3682 Often people omit facts because they think they know what causes the
3683 problem and assume that some details do not matter. Thus, you might
3684 assume that the name of a file you use in an example does not matter.
3685 Well, probably it does not, but one cannot be sure. Perhaps the bug is
3686 a stray memory reference which happens to fetch from the location where
3687 that pathname is stored in memory; perhaps, if the pathname were
3688 different, the contents of that location would fool the utility into
3689 doing the right thing despite the bug. Play it safe and give a
3690 specific, complete example. That is the easiest thing for you to do,
3691 and the most helpful.
3693 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
3694 it is new to us. Therefore, always write your bug reports on the assumption
3695 that the bug has not been reported previously.
3697 Sometimes people give a few sketchy facts and ask, ``Does this ring a
3698 bell?'' This cannot help us fix a bug, so it is basically useless. We
3699 respond by asking for enough details to enable us to investigate.
3700 You might as well expedite matters by sending them to begin with.
3702 To enable us to fix the bug, you should include all these things:
3706 The version of the utility. Each utility announces it if you start it
3707 with the @option{--version} argument.
3709 Without this, we will not know whether there is any point in looking for
3710 the bug in the current version of the binary utilities.
3713 Any patches you may have applied to the source, including any patches
3714 made to the @code{BFD} library.
3717 The type of machine you are using, and the operating system name and
3721 What compiler (and its version) was used to compile the utilities---e.g.
3725 The command arguments you gave the utility to observe the bug. To
3726 guarantee you will not omit something important, list them all. A copy
3727 of the Makefile (or the output from make) is sufficient.
3729 If we were to try to guess the arguments, we would probably guess wrong
3730 and then we might not encounter the bug.
3733 A complete input file, or set of input files, that will reproduce the
3734 bug. If the utility is reading an object file or files, then it is
3735 generally most helpful to send the actual object files, uuencoded if
3736 necessary to get them through the mail system. Note that
3737 @samp{bug-binutils@@gnu.org} is a mailing list, so you should avoid
3738 sending very large files to it. Making the files available for
3739 anonymous FTP is OK.
3741 If the source files were produced exclusively using @sc{gnu} programs
3742 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
3743 may be OK to send the source files rather than the object files. In
3744 this case, be sure to say exactly what version of @command{gcc}, or
3745 whatever, was used to produce the object files. Also say how
3746 @command{gcc}, or whatever, was configured.
3749 A description of what behavior you observe that you believe is
3750 incorrect. For example, ``It gets a fatal signal.''
3752 Of course, if the bug is that the utility gets a fatal signal, then we
3753 will certainly notice it. But if the bug is incorrect output, we might
3754 not notice unless it is glaringly wrong. You might as well not give us
3755 a chance to make a mistake.
3757 Even if the problem you experience is a fatal signal, you should still
3758 say so explicitly. Suppose something strange is going on, such as your
3759 copy of the utility is out of synch, or you have encountered a bug in
3760 the C library on your system. (This has happened!) Your copy might
3761 crash and ours would not. If you told us to expect a crash, then when
3762 ours fails to crash, we would know that the bug was not happening for
3763 us. If you had not told us to expect a crash, then we would not be able
3764 to draw any conclusion from our observations.
3767 If you wish to suggest changes to the source, send us context diffs, as
3768 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
3769 option. Always send diffs from the old file to the new file. If you
3770 wish to discuss something in the @command{ld} source, refer to it by
3771 context, not by line number.
3773 The line numbers in our development sources will not match those in your
3774 sources. Your line numbers would convey no useful information to us.
3777 Here are some things that are not necessary:
3781 A description of the envelope of the bug.
3783 Often people who encounter a bug spend a lot of time investigating
3784 which changes to the input file will make the bug go away and which
3785 changes will not affect it.
3787 This is often time consuming and not very useful, because the way we
3788 will find the bug is by running a single example under the debugger
3789 with breakpoints, not by pure deduction from a series of examples.
3790 We recommend that you save your time for something else.
3792 Of course, if you can find a simpler example to report @emph{instead}
3793 of the original one, that is a convenience for us. Errors in the
3794 output will be easier to spot, running under the debugger will take
3795 less time, and so on.
3797 However, simplification is not vital; if you do not want to do this,
3798 report the bug anyway and send us the entire test case you used.
3801 A patch for the bug.
3803 A patch for the bug does help us if it is a good one. But do not omit
3804 the necessary information, such as the test case, on the assumption that
3805 a patch is all we need. We might see problems with your patch and decide
3806 to fix the problem another way, or we might not understand it at all.
3808 Sometimes with programs as complicated as the binary utilities it is
3809 very hard to construct an example that will make the program follow a
3810 certain path through the code. If you do not send us the example, we
3811 will not be able to construct one, so we will not be able to verify that
3814 And if we cannot understand what bug you are trying to fix, or why your
3815 patch should be an improvement, we will not install it. A test case will
3816 help us to understand.
3819 A guess about what the bug is or what it depends on.
3821 Such guesses are usually wrong. Even we cannot guess right about such
3822 things without first using the debugger to find the facts.