1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @c Copyright 2001 Free Software Foundation, Inc.
10 * Binutils: (binutils). The GNU binary utilities.
11 * ar: (binutils)ar. Create, modify, and extract from archives
12 * nm: (binutils)nm. List symbols from object files
13 * objcopy: (binutils)objcopy. Copy and translate object files
14 * objdump: (binutils)objdump. Display information from object files
15 * ranlib: (binutils)ranlib. Generate index to archive contents
16 * readelf: (binutils)readelf. Display the contents of ELF format files.
17 * size: (binutils)size. List section sizes and total size
18 * strings: (binutils)strings. List printable strings from files
19 * strip: (binutils)strip. Discard symbols
20 * c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols
21 * cxxfilt: (binutils)c++filt. MS-DOS name for c++filt
22 * addr2line: (binutils)addr2line. Convert addresses to file and line
23 * nlmconv: (binutils)nlmconv. Converts object code into an NLM
24 * windres: (binutils)windres. Manipulate Windows resources
25 * dlltool: (binutils)dlltool. Create files needed to build and use DLLs
31 @c man begin COPYRIGHT
32 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc.
34 Permission is granted to copy, distribute and/or modify this document
35 under the terms of the GNU Free Documentation License, Version 1.1
36 or any later version published by the Free Software Foundation;
37 with no Invariant Sections, with no Front-Cover Texts, and with no
38 Back-Cover Texts. A copy of the license is included in the
39 section entitled "GNU Free Documentation License".
43 Permission is granted to process this file through TeX and print the
44 results, provided the printed document carries a copying permission
45 notice identical to this one except for the removal of this paragraph
46 (this paragraph not being relevant to the printed manual).
53 @c This file documents the GNU binary utilities "ar", "ld", "objcopy",
54 @c "objdump", "nm", "size", "strings", "strip", "readelf" and "ranlib".
56 @c Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc.
58 @c This text may be freely distributed under the terms of the GNU
59 @c Free Documentation License.
62 @setchapternewpage odd
63 @settitle @sc{gnu} Binary Utilities
66 @title The @sc{gnu} Binary Utilities
67 @subtitle Version @value{VERSION}
70 @author Roland H. Pesch
71 @author Jeffrey M. Osier
72 @author Cygnus Support
76 {\parskip=0pt \hfill Cygnus Support\par \hfill
77 \TeX{}info \texinfoversion\par }
80 @vskip 0pt plus 1filll
81 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 1998, 2000, 2001 Free Software Foundation, Inc.
83 Permission is granted to copy, distribute and/or modify this document
84 under the terms of the GNU Free Documentation License, Version 1.1
85 or any later version published by the Free Software Foundation;
86 with no Invariant Sections, with no Front-Cover Texts, and with no
87 Back-Cover Texts. A copy of the license is included in the
88 section entitled "GNU Free Documentation License".
96 This brief manual contains preliminary documentation for the @sc{gnu} binary
97 utilities (collectively version @value{VERSION}):
102 Create, modify, and extract from archives
105 List symbols from object files
108 Copy and translate object files
111 Display information from object files
114 Generate index to archive contents
117 Display the contents of ELF format files.
120 List file section sizes and total size
123 List printable strings from files
129 Demangle encoded C++ symbols (on MS-DOS, this program is named
133 Convert addresses into file names and line numbers
136 Convert object code into a Netware Loadable Module
139 Manipulate Windows resources
142 Create the files needed to build and use Dynamic Link Libraries
146 This document is distributed under the terms of the GNU Free
147 Documentation License. A copy of the license is included in the
148 section entitled "GNU Free Documentation License".
151 * ar:: Create, modify, and extract from archives
152 * nm:: List symbols from object files
153 * objcopy:: Copy and translate object files
154 * objdump:: Display information from object files
155 * ranlib:: Generate index to archive contents
156 * readelf:: Display the contents of ELF format files.
157 * size:: List section sizes and total size
158 * strings:: List printable strings from files
159 * strip:: Discard symbols
160 * c++filt:: Filter to demangle encoded C++ symbols
161 * cxxfilt: c++filt. MS-DOS name for c++filt
162 * addr2line:: Convert addresses to file and line
163 * nlmconv:: Converts object code into an NLM
164 * windres:: Manipulate Windows resources
165 * dlltool:: Create files needed to build and use DLLs
166 * Selecting The Target System:: How these utilities determine the target.
167 * Reporting Bugs:: Reporting Bugs
168 * GNU Free Documentation License:: GNU Free Documentation License
177 @cindex collections of files
179 @c man title ar create, modify, and extract from archives
182 ar [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
183 ar -M [ <mri-script ]
186 @c man begin DESCRIPTION ar
188 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
189 archives. An @dfn{archive} is a single file holding a collection of
190 other files in a structure that makes it possible to retrieve
191 the original individual files (called @dfn{members} of the archive).
193 The original files' contents, mode (permissions), timestamp, owner, and
194 group are preserved in the archive, and can be restored on
198 @sc{gnu} @command{ar} can maintain archives whose members have names of any
199 length; however, depending on how @command{ar} is configured on your
200 system, a limit on member-name length may be imposed for compatibility
201 with archive formats maintained with other tools. If it exists, the
202 limit is often 15 characters (typical of formats related to a.out) or 16
203 characters (typical of formats related to coff).
206 @command{ar} is considered a binary utility because archives of this sort
207 are most often used as @dfn{libraries} holding commonly needed
211 @command{ar} creates an index to the symbols defined in relocatable
212 object modules in the archive when you specify the modifier @samp{s}.
213 Once created, this index is updated in the archive whenever @command{ar}
214 makes a change to its contents (save for the @samp{q} update operation).
215 An archive with such an index speeds up linking to the library, and
216 allows routines in the library to call each other without regard to
217 their placement in the archive.
219 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
220 table. If an archive lacks the table, another form of @command{ar} called
221 @command{ranlib} can be used to add just the table.
223 @cindex compatibility, @command{ar}
224 @cindex @command{ar} compatibility
225 @sc{gnu} @command{ar} is designed to be compatible with two different
226 facilities. You can control its activity using command-line options,
227 like the different varieties of @command{ar} on Unix systems; or, if you
228 specify the single command-line option @option{-M}, you can control it
229 with a script supplied via standard input, like the MRI ``librarian''
235 * ar cmdline:: Controlling @command{ar} on the command line
236 * ar scripts:: Controlling @command{ar} with a script
241 @section Controlling @command{ar} on the command line
244 @c man begin SYNOPSIS ar
245 ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
249 @cindex Unix compatibility, @command{ar}
250 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
251 arguments to execute: one keyletter specifying the @emph{operation}
252 (optionally accompanied by other keyletters specifying
253 @emph{modifiers}), and the archive name to act on.
255 Most operations can also accept further @var{member} arguments,
256 specifying particular files to operate on.
258 @c man begin OPTIONS ar
260 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
261 flags @var{mod} in any order, within the first command-line argument.
263 If you wish, you may begin the first command-line argument with a
266 @cindex operations on archive
267 The @var{p} keyletter specifies what operation to execute; it may be
268 any of the following, but you must specify only one of them:
272 @cindex deleting from archive
273 @emph{Delete} modules from the archive. Specify the names of modules to
274 be deleted as @var{member}@dots{}; the archive is untouched if you
275 specify no files to delete.
277 If you specify the @samp{v} modifier, @command{ar} lists each module
281 @cindex moving in archive
282 Use this operation to @emph{move} members in an archive.
284 The ordering of members in an archive can make a difference in how
285 programs are linked using the library, if a symbol is defined in more
288 If no modifiers are used with @code{m}, any members you name in the
289 @var{member} arguments are moved to the @emph{end} of the archive;
290 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
291 specified place instead.
294 @cindex printing from archive
295 @emph{Print} the specified members of the archive, to the standard
296 output file. If the @samp{v} modifier is specified, show the member
297 name before copying its contents to standard output.
299 If you specify no @var{member} arguments, all the files in the archive are
303 @cindex quick append to archive
304 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
305 @var{archive}, without checking for replacement.
307 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
308 operation; new members are always placed at the end of the archive.
310 The modifier @samp{v} makes @command{ar} list each file as it is appended.
312 Since the point of this operation is speed, the archive's symbol table
313 index is not updated, even if it already existed; you can use @samp{ar s} or
314 @command{ranlib} explicitly to update the symbol table index.
316 However, too many different systems assume quick append rebuilds the
317 index, so GNU ar implements @code{q} as a synonym for @code{r}.
320 @cindex replacement in archive
321 Insert the files @var{member}@dots{} into @var{archive} (with
322 @emph{replacement}). This operation differs from @samp{q} in that any
323 previously existing members are deleted if their names match those being
326 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
327 displays an error message, and leaves undisturbed any existing members
328 of the archive matching that name.
330 By default, new members are added at the end of the file; but you may
331 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
332 placement relative to some existing member.
334 The modifier @samp{v} used with this operation elicits a line of
335 output for each file inserted, along with one of the letters @samp{a} or
336 @samp{r} to indicate whether the file was appended (no old member
337 deleted) or replaced.
340 @cindex contents of archive
341 Display a @emph{table} listing the contents of @var{archive}, or those
342 of the files listed in @var{member}@dots{} that are present in the
343 archive. Normally only the member name is shown; if you also want to
344 see the modes (permissions), timestamp, owner, group, and size, you can
345 request that by also specifying the @samp{v} modifier.
347 If you do not specify a @var{member}, all files in the archive
350 @cindex repeated names in archive
351 @cindex name duplication in archive
352 If there is more than one file with the same name (say, @samp{fie}) in
353 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
354 first instance; to see them all, you must ask for a complete
355 listing---in our example, @samp{ar t b.a}.
356 @c WRS only; per Gumby, this is implementation-dependent, and in a more
357 @c recent case in fact works the other way.
360 @cindex extract from archive
361 @emph{Extract} members (named @var{member}) from the archive. You can
362 use the @samp{v} modifier with this operation, to request that
363 @command{ar} list each name as it extracts it.
365 If you do not specify a @var{member}, all files in the archive
370 A number of modifiers (@var{mod}) may immediately follow the @var{p}
371 keyletter, to specify variations on an operation's behavior:
375 @cindex relative placement in archive
376 Add new files @emph{after} an existing member of the
377 archive. If you use the modifier @samp{a}, the name of an existing archive
378 member must be present as the @var{relpos} argument, before the
379 @var{archive} specification.
382 Add new files @emph{before} an existing member of the
383 archive. If you use the modifier @samp{b}, the name of an existing archive
384 member must be present as the @var{relpos} argument, before the
385 @var{archive} specification. (same as @samp{i}).
388 @cindex creating archives
389 @emph{Create} the archive. The specified @var{archive} is always
390 created if it did not exist, when you request an update. But a warning is
391 issued unless you specify in advance that you expect to create it, by
395 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
396 names of any length. This will cause it to create archives which are
397 not compatible with the native @command{ar} program on some systems. If
398 this is a concern, the @samp{f} modifier may be used to truncate file
399 names when putting them in the archive.
402 Insert new files @emph{before} an existing member of the
403 archive. If you use the modifier @samp{i}, the name of an existing archive
404 member must be present as the @var{relpos} argument, before the
405 @var{archive} specification. (same as @samp{b}).
408 This modifier is accepted but not used.
409 @c whaffor ar l modifier??? presumably compat; with
410 @c what???---doc@@cygnus.com, 25jan91
413 Uses the @var{count} parameter. This is used if there are multiple
414 entries in the archive with the same name. Extract or delete instance
415 @var{count} of the given name from the archive.
418 @cindex dates in archive
419 Preserve the @emph{original} dates of members when extracting them. If
420 you do not specify this modifier, files extracted from the archive
421 are stamped with the time of extraction.
424 Use the full path name when matching names in the archive. @sc{gnu}
425 @command{ar} can not create an archive with a full path name (such archives
426 are not POSIX complaint), but other archive creators can. This option
427 will cause @sc{gnu} @command{ar} to match file names using a complete path
428 name, which can be convenient when extracting a single file from an
429 archive created by another tool.
432 @cindex writing archive index
433 Write an object-file index into the archive, or update an existing one,
434 even if no other change is made to the archive. You may use this modifier
435 flag either with any operation, or alone. Running @samp{ar s} on an
436 archive is equivalent to running @samp{ranlib} on it.
439 @cindex not writing archive index
440 Do not generate an archive symbol table. This can speed up building a
441 large library in several steps. The resulting archive can not be used
442 with the linker. In order to build a symbol table, you must omit the
443 @samp{S} modifier on the last execution of @samp{ar}, or you must run
444 @samp{ranlib} on the archive.
447 @cindex updating an archive
448 Normally, @samp{ar r}@dots{} inserts all files
449 listed into the archive. If you would like to insert @emph{only} those
450 of the files you list that are newer than existing members of the same
451 names, use this modifier. The @samp{u} modifier is allowed only for the
452 operation @samp{r} (replace). In particular, the combination @samp{qu} is
453 not allowed, since checking the timestamps would lose any speed
454 advantage from the operation @samp{q}.
457 This modifier requests the @emph{verbose} version of an operation. Many
458 operations display additional information, such as filenames processed,
459 when the modifier @samp{v} is appended.
462 This modifier shows the version number of @command{ar}.
465 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
466 compatibility with AIX. The behaviour produced by this option is the
467 default for GNU @command{ar}. @command{ar} does not support any of the other
468 @samp{-X} options; in particular, it does not support @option{-X32}
469 which is the default for AIX @command{ar}.
474 @c man begin SEEALSO ar
475 nm(1), ranlib(1), and the Info entries for @file{binutils}.
480 @section Controlling @command{ar} with a script
483 ar -M [ <@var{script} ]
486 @cindex MRI compatibility, @command{ar}
487 @cindex scripts, @command{ar}
488 If you use the single command-line option @samp{-M} with @command{ar}, you
489 can control its operation with a rudimentary command language. This
490 form of @command{ar} operates interactively if standard input is coming
491 directly from a terminal. During interactive use, @command{ar} prompts for
492 input (the prompt is @samp{AR >}), and continues executing even after
493 errors. If you redirect standard input to a script file, no prompts are
494 issued, and @command{ar} abandons execution (with a nonzero exit code)
497 The @command{ar} command language is @emph{not} designed to be equivalent
498 to the command-line options; in fact, it provides somewhat less control
499 over archives. The only purpose of the command language is to ease the
500 transition to @sc{gnu} @command{ar} for developers who already have scripts
501 written for the MRI ``librarian'' program.
503 The syntax for the @command{ar} command language is straightforward:
506 commands are recognized in upper or lower case; for example, @code{LIST}
507 is the same as @code{list}. In the following descriptions, commands are
508 shown in upper case for clarity.
511 a single command may appear on each line; it is the first word on the
515 empty lines are allowed, and have no effect.
518 comments are allowed; text after either of the characters @samp{*}
519 or @samp{;} is ignored.
522 Whenever you use a list of names as part of the argument to an @command{ar}
523 command, you can separate the individual names with either commas or
524 blanks. Commas are shown in the explanations below, for clarity.
527 @samp{+} is used as a line continuation character; if @samp{+} appears
528 at the end of a line, the text on the following line is considered part
529 of the current command.
532 Here are the commands you can use in @command{ar} scripts, or when using
533 @command{ar} interactively. Three of them have special significance:
535 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
536 a temporary file required for most of the other commands.
538 @code{SAVE} commits the changes so far specified by the script. Prior
539 to @code{SAVE}, commands affect only the temporary copy of the current
543 @item ADDLIB @var{archive}
544 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
545 Add all the contents of @var{archive} (or, if specified, each named
546 @var{module} from @var{archive}) to the current archive.
548 Requires prior use of @code{OPEN} or @code{CREATE}.
550 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
551 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
552 @c else like "ar q..."
553 Add each named @var{member} as a module in the current archive.
555 Requires prior use of @code{OPEN} or @code{CREATE}.
558 Discard the contents of the current archive, canceling the effect of
559 any operations since the last @code{SAVE}. May be executed (with no
560 effect) even if no current archive is specified.
562 @item CREATE @var{archive}
563 Creates an archive, and makes it the current archive (required for many
564 other commands). The new archive is created with a temporary name; it
565 is not actually saved as @var{archive} until you use @code{SAVE}.
566 You can overwrite existing archives; similarly, the contents of any
567 existing file named @var{archive} will not be destroyed until @code{SAVE}.
569 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
570 Delete each listed @var{module} from the current archive; equivalent to
571 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
573 Requires prior use of @code{OPEN} or @code{CREATE}.
575 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
576 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
577 List each named @var{module} present in @var{archive}. The separate
578 command @code{VERBOSE} specifies the form of the output: when verbose
579 output is off, output is like that of @samp{ar -t @var{archive}
580 @var{module}@dots{}}. When verbose output is on, the listing is like
581 @samp{ar -tv @var{archive} @var{module}@dots{}}.
583 Output normally goes to the standard output stream; however, if you
584 specify @var{outputfile} as a final argument, @command{ar} directs the
588 Exit from @command{ar}, with a @code{0} exit code to indicate successful
589 completion. This command does not save the output file; if you have
590 changed the current archive since the last @code{SAVE} command, those
593 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
594 Extract each named @var{module} from the current archive, writing them
595 into the current directory as separate files. Equivalent to @samp{ar -x
596 @var{archive} @var{module}@dots{}}.
598 Requires prior use of @code{OPEN} or @code{CREATE}.
601 @c FIXME Tokens but no commands???
608 Display full contents of the current archive, in ``verbose'' style
609 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
610 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
611 enhancement, rather than present for MRI compatibility.)
613 Requires prior use of @code{OPEN} or @code{CREATE}.
615 @item OPEN @var{archive}
616 Opens an existing archive for use as the current archive (required for
617 many other commands). Any changes as the result of subsequent commands
618 will not actually affect @var{archive} until you next use @code{SAVE}.
620 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
621 In the current archive, replace each existing @var{module} (named in
622 the @code{REPLACE} arguments) from files in the current working directory.
623 To execute this command without errors, both the file, and the module in
624 the current archive, must exist.
626 Requires prior use of @code{OPEN} or @code{CREATE}.
629 Toggle an internal flag governing the output from @code{DIRECTORY}.
630 When the flag is on, @code{DIRECTORY} output matches output from
631 @samp{ar -tv }@dots{}.
634 Commit your changes to the current archive, and actually save it as a
635 file with the name specified in the last @code{CREATE} or @code{OPEN}
638 Requires prior use of @code{OPEN} or @code{CREATE}.
647 The @sc{gnu} linker @command{ld} is now described in a separate manual.
648 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
656 @c man title nm list symbols from object files
659 @c man begin SYNOPSIS nm
660 nm [@option{-a}|@option{--debug-syms}] [@option{-g}|@option{--extern-only}]
661 [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]
662 [@option{-s}|@option{--print-armap}] [@option{-A}|@option{-o}|@option{--print-file-name}]
663 [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}]
664 [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}]
665 [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}]
666 [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]
667 [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]
668 [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}]
672 @c man begin DESCRIPTION nm
673 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
674 If no object files are listed as arguments, @command{nm} assumes the file
677 For each symbol, @command{nm} shows:
681 The symbol value, in the radix selected by options (see below), or
682 hexadecimal by default.
685 The symbol type. At least the following types are used; others are, as
686 well, depending on the object file format. If lowercase, the symbol is
687 local; if uppercase, the symbol is global (external).
689 @c Some more detail on exactly what these symbol types are used for
693 The symbol's value is absolute, and will not be changed by further
697 The symbol is in the uninitialized data section (known as BSS).
700 The symbol is common. Common symbols are uninitialized data. When
701 linking, multiple common symbols may appear with the same name. If the
702 symbol is defined anywhere, the common symbols are treated as undefined
705 For more details on common symbols, see the discussion of
706 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
710 The symbol is in the initialized data section.
713 The symbol is in an initialized data section for small objects. Some
714 object file formats permit more efficient access to small data objects,
715 such as a global int variable as opposed to a large global array.
718 The symbol is an indirect reference to another symbol. This is a GNU
719 extension to the a.out object file format which is rarely used.
722 The symbol is a debugging symbol.
725 The symbol is in a read only data section.
728 The symbol is in an uninitialized data section for small objects.
731 The symbol is in the text (code) section.
734 The symbol is undefined.
737 The symbol is a weak object. When a weak defined symbol is linked with
738 a normal defined symbol, the normal defined symbol is used with no error.
739 When a weak undefined symbol is linked and the symbol is not defined,
740 the value of the weak symbol becomes zero with no error.
743 The symbol is a weak symbol that has not been specifically tagged as a
744 weak object symbol. When a weak defined symbol is linked with a normal
745 defined symbol, the normal defined symbol is used with no error.
746 When a weak undefined symbol is linked and the symbol is not defined,
747 the value of the weak symbol becomes zero with no error.
750 The symbol is a stabs symbol in an a.out object file. In this case, the
751 next values printed are the stabs other field, the stabs desc field, and
752 the stab type. Stabs symbols are used to hold debugging information.
754 For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
755 ``stabs'' debug format}.
759 The symbol type is unknown, or object file format specific.
768 @c man begin OPTIONS nm
769 The long and short forms of options, shown here as alternatives, are
775 @itemx --print-file-name
776 @cindex input file name
778 @cindex source file name
779 Precede each symbol by the name of the input file (or archive member)
780 in which it was found, rather than identifying the input file once only,
781 before all of its symbols.
785 @cindex debugging symbols
786 Display all symbols, even debugger-only symbols; normally these are not
790 @cindex @command{nm} format
791 @cindex @command{nm} compatibility
792 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
795 @itemx --demangle[=@var{style}]
796 @cindex demangling in nm
797 Decode (@dfn{demangle}) low-level symbol names into user-level names.
798 Besides removing any initial underscore prepended by the system, this
799 makes C++ function names readable. Different compilers have different
800 mangling styles. The optional demangling style argument can be used to
801 choose an appropriate demangling style for your compiler. @xref{c++filt},
802 for more information on demangling.
805 Do not demangle low-level symbol names. This is the default.
809 @cindex dynamic symbols
810 Display the dynamic symbols rather than the normal symbols. This is
811 only meaningful for dynamic objects, such as certain types of shared
814 @item -f @var{format}
815 @itemx --format=@var{format}
816 @cindex @command{nm} format
817 @cindex @command{nm} compatibility
818 Use the output format @var{format}, which can be @code{bsd},
819 @code{sysv}, or @code{posix}. The default is @code{bsd}.
820 Only the first character of @var{format} is significant; it can be
821 either upper or lower case.
825 @cindex external symbols
826 Display only external symbols.
829 @itemx --line-numbers
830 @cindex symbol line numbers
831 For each symbol, use debugging information to try to find a filename and
832 line number. For a defined symbol, look for the line number of the
833 address of the symbol. For an undefined symbol, look for the line
834 number of a relocation entry which refers to the symbol. If line number
835 information can be found, print it after the other symbol information.
839 @itemx --numeric-sort
840 Sort symbols numerically by their addresses, rather than alphabetically
845 @cindex sorting symbols
846 Do not bother to sort the symbols in any order; print them in the order
851 Use the POSIX.2 standard output format instead of the default format.
852 Equivalent to @samp{-f posix}.
856 @cindex symbol index, listing
857 When listing symbols from archive members, include the index: a mapping
858 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
859 contain definitions for which names.
862 @itemx --reverse-sort
863 Reverse the order of the sort (whether numeric or alphabetic); let the
867 Sort symbols by size. The size is computed as the difference between
868 the value of the symbol and the value of the symbol with the next higher
869 value. The size of the symbol is printed, rather than the value.
872 @itemx --radix=@var{radix}
873 Use @var{radix} as the radix for printing the symbol values. It must be
874 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
876 @item --target=@var{bfdname}
877 @cindex object code format
878 Specify an object code format other than your system's default format.
879 @xref{Target Selection}, for more information.
882 @itemx --undefined-only
883 @cindex external symbols
884 @cindex undefined symbols
885 Display only undefined symbols (those external to each object file).
888 @cindex external symbols
889 @cindex undefined symbols
890 Display only defined symbols for each object file.
894 Show the version number of @command{nm} and exit.
897 This option is ignored for compatibility with the AIX version of
898 @command{nm}. It takes one parameter which must be the string
899 @option{32_64}. The default mode of AIX @command{nm} corresponds
900 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
903 Show a summary of the options to @command{nm} and exit.
909 @c man begin SEEALSO nm
910 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
917 @c man title objcopy copy and translate object files
920 @c man begin SYNOPSIS objcopy
921 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
922 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
923 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
924 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
925 [@option{-S}|@option{--strip-all}] [@option{-g}|@option{--strip-debug}]
926 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
927 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
928 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
929 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
930 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
931 [@option{-x}|@option{--discard-all}] [@option{-X}|@option{--discard-locals}]
932 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
933 [@option{-i} @var{interleave}|@option{--interleave=}@var{interleave}]
934 [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
935 [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
936 [@option{-p}|@option{--preserve-dates}]
937 [@option{--debugging}]
938 [@option{--gap-fill=}@var{val}] [@option{--pad-to=}@var{address}]
939 [@option{--set-start=}@var{val}] [@option{--adjust-start=}@var{incr}]
940 [@option{--change-addresses=}@var{incr}]
941 [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
942 [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
943 [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
944 [@option{--change-warnings}] [@option{--no-change-warnings}]
945 [@option{--set-section-flags} @var{section}=@var{flags}]
946 [@option{--add-section} @var{sectionname}=@var{filename}]
947 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
948 [@option{--change-leading-char} ] [@option{--remove-leading-char}]
949 [@option{--srec-len=}@var{ival} ] [@option{--srec-forceS3}]
950 [@option{--redefine-sym} @var{old}=@var{new} ]
952 [@option{--keep-symbols=}@var{filename}]
953 [@option{--strip-symbols=}@var{filename}]
954 [@option{--keep-global-symbols=}@var{filename}]
955 [@option{--localize-symbols=}@var{filename}]
956 [@option{--weaken-symbols=}@var{filename}]
957 [@option{--alt-machine-code=@var{index}}]
958 [@option{-v}|@option{--verbose}]
959 [@option{-V}|@option{--version}]
961 @var{infile} [@var{outfile}]
965 @c man begin DESCRIPTION objcopy
966 The @sc{gnu} @command{objcopy} utility copies the contents of an object
967 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
968 read and write the object files. It can write the destination object
969 file in a format different from that of the source object file. The
970 exact behavior of @command{objcopy} is controlled by command-line options.
971 Note that @command{objcopy} should be able to copy a fully linked file
972 between any two formats. However, copying a relocatable object file
973 between any two formats may not work as expected.
975 @command{objcopy} creates temporary files to do its translations and
976 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
977 translation work; it has access to all the formats described in @sc{bfd}
978 and thus is able to recognize most formats without being told
979 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
981 @command{objcopy} can be used to generate S-records by using an output
982 target of @samp{srec} (e.g., use @samp{-O srec}).
984 @command{objcopy} can be used to generate a raw binary file by using an
985 output target of @samp{binary} (e.g., use @option{-O binary}). When
986 @command{objcopy} generates a raw binary file, it will essentially produce
987 a memory dump of the contents of the input object file. All symbols and
988 relocation information will be discarded. The memory dump will start at
989 the load address of the lowest section copied into the output file.
991 When generating an S-record or a raw binary file, it may be helpful to
992 use @option{-S} to remove sections containing debugging information. In
993 some cases @option{-R} will be useful to remove sections which contain
994 information that is not needed by the binary file.
996 Note - @command{objcopy} is not able to change the endianness of its input
997 files. If the input format has an endianness, (some formats do not),
998 @command{objcopy} can only copy the inputs into file formats that have the
999 same endianness or which have no endianness (eg @samp{srec}).
1003 @c man begin OPTIONS objcopy
1007 @itemx @var{outfile}
1008 The input and output files, respectively.
1009 If you do not specify @var{outfile}, @command{objcopy} creates a
1010 temporary file and destructively renames the result with
1011 the name of @var{infile}.
1013 @item -I @var{bfdname}
1014 @itemx --input-target=@var{bfdname}
1015 Consider the source file's object format to be @var{bfdname}, rather than
1016 attempting to deduce it. @xref{Target Selection}, for more information.
1018 @item -O @var{bfdname}
1019 @itemx --output-target=@var{bfdname}
1020 Write the output file using the object format @var{bfdname}.
1021 @xref{Target Selection}, for more information.
1023 @item -F @var{bfdname}
1024 @itemx --target=@var{bfdname}
1025 Use @var{bfdname} as the object format for both the input and the output
1026 file; i.e., simply transfer data from source to destination with no
1027 translation. @xref{Target Selection}, for more information.
1029 @item -B @var{bfdarch}
1030 @itemx --binary-architecture=@var{bfdarch}
1031 Useful when transforming a raw binary input file into an object file.
1032 In this case the output architecture can be set to @var{bfdarch}. This
1033 option will be ignored if the input file has a known @var{bfdarch}. You
1034 can access this binary data inside a program by referencing the special
1035 symbols that are created by the conversion process. These symbols are
1036 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1037 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1038 an object file and then access it in your code using these symbols.
1040 @item -j @var{sectionname}
1041 @itemx --only-section=@var{sectionname}
1042 Copy only the named section from the input file to the output file.
1043 This option may be given more than once. Note that using this option
1044 inappropriately may make the output file unusable.
1046 @item -R @var{sectionname}
1047 @itemx --remove-section=@var{sectionname}
1048 Remove any section named @var{sectionname} from the output file. This
1049 option may be given more than once. Note that using this option
1050 inappropriately may make the output file unusable.
1054 Do not copy relocation and symbol information from the source file.
1057 @itemx --strip-debug
1058 Do not copy debugging symbols from the source file.
1060 @item --strip-unneeded
1061 Strip all symbols that are not needed for relocation processing.
1063 @item -K @var{symbolname}
1064 @itemx --keep-symbol=@var{symbolname}
1065 Copy only symbol @var{symbolname} from the source file. This option may
1066 be given more than once.
1068 @item -N @var{symbolname}
1069 @itemx --strip-symbol=@var{symbolname}
1070 Do not copy symbol @var{symbolname} from the source file. This option
1071 may be given more than once.
1073 @item -G @var{symbolname}
1074 @itemx --keep-global-symbol=@var{symbolname}
1075 Keep only symbol @var{symbolname} global. Make all other symbols local
1076 to the file, so that they are not visible externally. This option may
1077 be given more than once.
1079 @item -L @var{symbolname}
1080 @itemx --localize-symbol=@var{symbolname}
1081 Make symbol @var{symbolname} local to the file, so that it is not
1082 visible externally. This option may be given more than once.
1084 @item -W @var{symbolname}
1085 @itemx --weaken-symbol=@var{symbolname}
1086 Make symbol @var{symbolname} weak. This option may be given more than once.
1089 @itemx --discard-all
1090 Do not copy non-global symbols from the source file.
1091 @c FIXME any reason to prefer "non-global" to "local" here?
1094 @itemx --discard-locals
1095 Do not copy compiler-generated local symbols.
1096 (These usually start with @samp{L} or @samp{.}.)
1099 @itemx --byte=@var{byte}
1100 Keep only every @var{byte}th byte of the input file (header data is not
1101 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
1102 where @var{interleave} is given by the @option{-i} or @option{--interleave}
1103 option, or the default of 4. This option is useful for creating files
1104 to program @sc{rom}. It is typically used with an @code{srec} output
1107 @item -i @var{interleave}
1108 @itemx --interleave=@var{interleave}
1109 Only copy one out of every @var{interleave} bytes. Select which byte to
1110 copy with the @option{-b} or @option{--byte} option. The default is 4.
1111 @command{objcopy} ignores this option if you do not specify either @option{-b} or
1115 @itemx --preserve-dates
1116 Set the access and modification dates of the output file to be the same
1117 as those of the input file.
1120 Convert debugging information, if possible. This is not the default
1121 because only certain debugging formats are supported, and the
1122 conversion process can be time consuming.
1124 @item --gap-fill @var{val}
1125 Fill gaps between sections with @var{val}. This operation applies to
1126 the @emph{load address} (LMA) of the sections. It is done by increasing
1127 the size of the section with the lower address, and filling in the extra
1128 space created with @var{val}.
1130 @item --pad-to @var{address}
1131 Pad the output file up to the load address @var{address}. This is
1132 done by increasing the size of the last section. The extra space is
1133 filled in with the value specified by @option{--gap-fill} (default zero).
1135 @item --set-start @var{val}
1136 Set the start address of the new file to @var{val}. Not all object file
1137 formats support setting the start address.
1139 @item --change-start @var{incr}
1140 @itemx --adjust-start @var{incr}
1141 @cindex changing start address
1142 Change the start address by adding @var{incr}. Not all object file
1143 formats support setting the start address.
1145 @item --change-addresses @var{incr}
1146 @itemx --adjust-vma @var{incr}
1147 @cindex changing object addresses
1148 Change the VMA and LMA addresses of all sections, as well as the start
1149 address, by adding @var{incr}. Some object file formats do not permit
1150 section addresses to be changed arbitrarily. Note that this does not
1151 relocate the sections; if the program expects sections to be loaded at a
1152 certain address, and this option is used to change the sections such
1153 that they are loaded at a different address, the program may fail.
1155 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1156 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1157 @cindex changing section address
1158 Set or change both the VMA address and the LMA address of the named
1159 @var{section}. If @samp{=} is used, the section address is set to
1160 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1161 section address. See the comments under @option{--change-addresses},
1162 above. If @var{section} does not exist in the input file, a warning will
1163 be issued, unless @option{--no-change-warnings} is used.
1165 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1166 @cindex changing section LMA
1167 Set or change the LMA address of the named @var{section}. The LMA
1168 address is the address where the section will be loaded into memory at
1169 program load time. Normally this is the same as the VMA address, which
1170 is the address of the section at program run time, but on some systems,
1171 especially those where a program is held in ROM, the two can be
1172 different. If @samp{=} is used, the section address is set to
1173 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1174 section address. See the comments under @option{--change-addresses},
1175 above. If @var{section} does not exist in the input file, a warning
1176 will be issued, unless @option{--no-change-warnings} is used.
1178 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1179 @cindex changing section VMA
1180 Set or change the VMA address of the named @var{section}. The VMA
1181 address is the address where the section will be located once the
1182 program has started executing. Normally this is the same as the LMA
1183 address, which is the address where the section will be loaded into
1184 memory, but on some systems, especially those where a program is held in
1185 ROM, the two can be different. If @samp{=} is used, the section address
1186 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1187 from the section address. See the comments under
1188 @option{--change-addresses}, above. If @var{section} does not exist in
1189 the input file, a warning will be issued, unless
1190 @option{--no-change-warnings} is used.
1192 @item --change-warnings
1193 @itemx --adjust-warnings
1194 If @option{--change-section-address} or @option{--change-section-lma} or
1195 @option{--change-section-vma} is used, and the named section does not
1196 exist, issue a warning. This is the default.
1198 @item --no-change-warnings
1199 @itemx --no-adjust-warnings
1200 Do not issue a warning if @option{--change-section-address} or
1201 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1202 if the named section does not exist.
1204 @item --set-section-flags @var{section}=@var{flags}
1205 Set the flags for the named section. The @var{flags} argument is a
1206 comma separated string of flag names. The recognized names are
1207 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1208 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1209 @samp{debug}. You can set the @samp{contents} flag for a section which
1210 does not have contents, but it is not meaningful to clear the
1211 @samp{contents} flag of a section which does have contents--just remove
1212 the section instead. Not all flags are meaningful for all object file
1215 @item --add-section @var{sectionname}=@var{filename}
1216 Add a new section named @var{sectionname} while copying the file. The
1217 contents of the new section are taken from the file @var{filename}. The
1218 size of the section will be the size of the file. This option only
1219 works on file formats which can support sections with arbitrary names.
1221 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1222 Rename a section from @var{oldname} to @var{newname}, optionally
1223 changing the section's flags to @var{flags} in the process. This has
1224 the advantage over usng a linker script to perform the rename in that
1225 the output stays as an object file and does not become a linked
1228 This option is particularly helpful when the input format is binary,
1229 since this will always create a section called .data. If for example,
1230 you wanted instead to create a section called .rodata containing binary
1231 data you could use the following command line to achieve it:
1234 objcopy -I binary -O <output_format> -B <architecture> \
1235 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1236 <input_binary_file> <output_object_file>
1239 @item --change-leading-char
1240 Some object file formats use special characters at the start of
1241 symbols. The most common such character is underscore, which compilers
1242 often add before every symbol. This option tells @command{objcopy} to
1243 change the leading character of every symbol when it converts between
1244 object file formats. If the object file formats use the same leading
1245 character, this option has no effect. Otherwise, it will add a
1246 character, or remove a character, or change a character, as
1249 @item --remove-leading-char
1250 If the first character of a global symbol is a special symbol leading
1251 character used by the object file format, remove the character. The
1252 most common symbol leading character is underscore. This option will
1253 remove a leading underscore from all global symbols. This can be useful
1254 if you want to link together objects of different file formats with
1255 different conventions for symbol names. This is different from
1256 @option{--change-leading-char} because it always changes the symbol name
1257 when appropriate, regardless of the object file format of the output
1260 @item --srec-len=@var{ival}
1261 Meaningful only for srec output. Set the maximum length of the Srecords
1262 being produced to @var{ival}. This length covers both address, data and
1265 @item --srec-forceS3
1266 Meaningful only for srec output. Avoid generation of S1/S2 records,
1267 creating S3-only record format.
1269 @item --redefine-sym @var{old}=@var{new}
1270 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1271 when one is trying link two things together for which you have no
1272 source, and there are name collisions.
1275 Change all global symbols in the file to be weak. This can be useful
1276 when building an object which will be linked against other objects using
1277 the @option{-R} option to the linker. This option is only effective when
1278 using an object file format which supports weak symbols.
1280 @item --keep-symbols=@var{filename}
1281 Apply @option{--keep-symbol} option to each symbol listed in the file
1282 @var{filename}. @var{filename} is simply a flat file, with one symbol
1283 name per line. Line comments may be introduced by the hash character.
1284 This option may be given more than once.
1286 @item --strip-symbols=@var{filename}
1287 Apply @option{--strip-symbol} option to each symbol listed in the file
1288 @var{filename}. @var{filename} is simply a flat file, with one symbol
1289 name per line. Line comments may be introduced by the hash character.
1290 This option may be given more than once.
1292 @item --keep-global-symbols=@var{filename}
1293 Apply @option{--keep-global-symbol} option to each symbol listed in the
1294 file @var{filename}. @var{filename} is simply a flat file, with one
1295 symbol name per line. Line comments may be introduced by the hash
1296 character. This option may be given more than once.
1298 @item --localize-symbols=@var{filename}
1299 Apply @option{--localize-symbol} option to each symbol listed in the file
1300 @var{filename}. @var{filename} is simply a flat file, with one symbol
1301 name per line. Line comments may be introduced by the hash character.
1302 This option may be given more than once.
1304 @item --weaken-symbols=@var{filename}
1305 Apply @option{--weaken-symbol} option to each symbol listed in the file
1306 @var{filename}. @var{filename} is simply a flat file, with one symbol
1307 name per line. Line comments may be introduced by the hash character.
1308 This option may be given more than once.
1310 @item --alt-machine-code=@var{index}
1311 If the output architecture has alternate machine codes, use the
1312 @var{index}th code instead of the default one. This is useful in case
1313 a machine is assigned an official code and the tool-chain adopts the
1314 new code, but other applications still depend on the original code
1319 Show the version number of @command{objcopy}.
1323 Verbose output: list all object files modified. In the case of
1324 archives, @samp{objcopy -V} lists all members of the archive.
1327 Show a summary of the options to @command{objcopy}.
1333 @c man begin SEEALSO objcopy
1334 ld(1), objdump(1), and the Info entries for @file{binutils}.
1341 @cindex object file information
1344 @c man title objdump display information from object files.
1347 @c man begin SYNOPSIS objdump
1348 objdump [@option{-a}|@option{--archive-headers}]
1349 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1350 [@option{-C}|@option{--demangle}[=@var{style}] ]
1351 [@option{-d}|@option{--disassemble}]
1352 [@option{-D}|@option{--disassemble-all}]
1353 [@option{-z}|@option{--disassemble-zeroes}]
1354 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1355 [@option{-f}|@option{--file-headers}]
1356 [@option{--file-start-context}]
1357 [@option{-g}|@option{--debugging}]
1358 [@option{-h}|@option{--section-headers}|@option{--headers}]
1359 [@option{-i}|@option{--info}]
1360 [@option{-j} @var{section}|@option{--section=}@var{section}]
1361 [@option{-l}|@option{--line-numbers}]
1362 [@option{-S}|@option{--source}]
1363 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1364 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1365 [@option{-p}|@option{--private-headers}]
1366 [@option{-r}|@option{--reloc}]
1367 [@option{-R}|@option{--dynamic-reloc}]
1368 [@option{-s}|@option{--full-contents}]
1369 [@option{-G}|@option{--stabs}]
1370 [@option{-t}|@option{--syms}]
1371 [@option{-T}|@option{--dynamic-syms}]
1372 [@option{-x}|@option{--all-headers}]
1373 [@option{-w}|@option{--wide}]
1374 [@option{--start-address=}@var{address}]
1375 [@option{--stop-address=}@var{address}]
1376 [@option{--prefix-addresses}]
1377 [@option{--[no-]show-raw-insn}]
1378 [@option{--adjust-vma=}@var{offset}]
1379 [@option{-V}|@option{--version}]
1380 [@option{-H}|@option{--help}]
1381 @var{objfile}@dots{}
1385 @c man begin DESCRIPTION objdump
1387 @command{objdump} displays information about one or more object files.
1388 The options control what particular information to display. This
1389 information is mostly useful to programmers who are working on the
1390 compilation tools, as opposed to programmers who just want their
1391 program to compile and work.
1393 @var{objfile}@dots{} are the object files to be examined. When you
1394 specify archives, @command{objdump} shows information on each of the member
1399 @c man begin OPTIONS objdump
1401 The long and short forms of options, shown here as alternatives, are
1402 equivalent. At least one option from the list
1403 @option{-a,-d,-D,-f,-g,-G,-h,-H,-p,-r,-R,-S,-t,-T,-V,-x} must be given.
1407 @itemx --archive-header
1408 @cindex archive headers
1409 If any of the @var{objfile} files are archives, display the archive
1410 header information (in a format similar to @samp{ls -l}). Besides the
1411 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1412 the object file format of each archive member.
1414 @item --adjust-vma=@var{offset}
1415 @cindex section addresses in objdump
1416 @cindex VMA in objdump
1417 When dumping information, first add @var{offset} to all the section
1418 addresses. This is useful if the section addresses do not correspond to
1419 the symbol table, which can happen when putting sections at particular
1420 addresses when using a format which can not represent section addresses,
1423 @item -b @var{bfdname}
1424 @itemx --target=@var{bfdname}
1425 @cindex object code format
1426 Specify that the object-code format for the object files is
1427 @var{bfdname}. This option may not be necessary; @var{objdump} can
1428 automatically recognize many formats.
1432 objdump -b oasys -m vax -h fu.o
1435 displays summary information from the section headers (@option{-h}) of
1436 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1437 file in the format produced by Oasys compilers. You can list the
1438 formats available with the @option{-i} option.
1439 @xref{Target Selection}, for more information.
1442 @itemx --demangle[=@var{style}]
1443 @cindex demangling in objdump
1444 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1445 Besides removing any initial underscore prepended by the system, this
1446 makes C++ function names readable. Different compilers have different
1447 mangling styles. The optional demangling style argument can be used to
1448 choose an appropriate demangling style for your compiler. @xref{c++filt},
1449 for more information on demangling.
1453 Display debugging information. This attempts to parse debugging
1454 information stored in the file and print it out using a C like syntax.
1455 Only certain types of debugging information have been implemented.
1458 @itemx --disassemble
1459 @cindex disassembling object code
1460 @cindex machine instructions
1461 Display the assembler mnemonics for the machine instructions from
1462 @var{objfile}. This option only disassembles those sections which are
1463 expected to contain instructions.
1466 @itemx --disassemble-all
1467 Like @option{-d}, but disassemble the contents of all sections, not just
1468 those expected to contain instructions.
1470 @item --prefix-addresses
1471 When disassembling, print the complete address on each line. This is
1472 the older disassembly format.
1474 @item --disassemble-zeroes
1475 Normally the disassembly output will skip blocks of zeroes. This
1476 option directs the disassembler to disassemble those blocks, just like
1481 @itemx --endian=@{big|little@}
1483 @cindex disassembly endianness
1484 Specify the endianness of the object files. This only affects
1485 disassembly. This can be useful when disassembling a file format which
1486 does not describe endianness information, such as S-records.
1489 @itemx --file-header
1490 @cindex object file header
1491 Display summary information from the overall header of
1492 each of the @var{objfile} files.
1494 @item --file-start-context
1495 @cindex source code context
1496 Specify that when displaying interlisted source code/disassembly
1497 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1498 context to the start of the file.
1501 @itemx --section-header
1503 @cindex section headers
1504 Display summary information from the section headers of the
1507 File segments may be relocated to nonstandard addresses, for example by
1508 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1509 @command{ld}. However, some object file formats, such as a.out, do not
1510 store the starting address of the file segments. In those situations,
1511 although @command{ld} relocates the sections correctly, using @samp{objdump
1512 -h} to list the file section headers cannot show the correct addresses.
1513 Instead, it shows the usual addresses, which are implicit for the
1517 Print a summary of the options to @command{objdump} and exit.
1521 @cindex architectures available
1522 @cindex object formats available
1523 Display a list showing all architectures and object formats available
1524 for specification with @option{-b} or @option{-m}.
1527 @itemx --section=@var{name}
1528 @cindex section information
1529 Display information only for section @var{name}.
1532 @itemx --line-numbers
1533 @cindex source filenames for object files
1534 Label the display (using debugging information) with the filename and
1535 source line numbers corresponding to the object code or relocs shown.
1536 Only useful with @option{-d}, @option{-D}, or @option{-r}.
1538 @item -m @var{machine}
1539 @itemx --architecture=@var{machine}
1540 @cindex architecture
1541 @cindex disassembly architecture
1542 Specify the architecture to use when disassembling object files. This
1543 can be useful when disassembling object files which do not describe
1544 architecture information, such as S-records. You can list the available
1545 architectures with the @option{-i} option.
1547 @item -M @var{options}
1548 @itemx --disassembler-options=@var{options}
1549 Pass target specific information to the disassembler. Only supported on
1552 If the target is an ARM architecture then this switch can be used to
1553 select which register name set is used during disassembler. Specifying
1554 @option{-M reg-name-std} (the default) will select the register names as
1555 used in ARM's instruction set documentation, but with register 13 called
1556 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
1557 @option{-M reg-names-apcs} will select the name set used by the ARM
1558 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
1559 just use @samp{r} followed by the register number.
1561 There are also two variants on the APCS register naming scheme enabled
1562 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
1563 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
1564 with the normal register name or the special register names).
1566 This option can also be used for ARM architectures to force the
1567 disassembler to interpret all instructions as Thumb instructions by
1568 using the switch @option{--disassembler-options=force-thumb}. This can be
1569 useful when attempting to disassemble thumb code produced by other
1573 @itemx --private-headers
1574 Print information that is specific to the object file format. The exact
1575 information printed depends upon the object file format. For some
1576 object file formats, no additional information is printed.
1580 @cindex relocation entries, in object file
1581 Print the relocation entries of the file. If used with @option{-d} or
1582 @option{-D}, the relocations are printed interspersed with the
1586 @itemx --dynamic-reloc
1587 @cindex dynamic relocation entries, in object file
1588 Print the dynamic relocation entries of the file. This is only
1589 meaningful for dynamic objects, such as certain types of shared
1593 @itemx --full-contents
1594 @cindex sections, full contents
1595 @cindex object file sections
1596 Display the full contents of any sections requested.
1600 @cindex source disassembly
1601 @cindex disassembly, with source
1602 Display source code intermixed with disassembly, if possible. Implies
1605 @item --show-raw-insn
1606 When disassembling instructions, print the instruction in hex as well as
1607 in symbolic form. This is the default except when
1608 @option{--prefix-addresses} is used.
1610 @item --no-show-raw-insn
1611 When disassembling instructions, do not print the instruction bytes.
1612 This is the default when @option{--prefix-addresses} is used.
1618 @cindex debug symbols
1619 @cindex ELF object file format
1620 Display the full contents of any sections requested. Display the
1621 contents of the .stab and .stab.index and .stab.excl sections from an
1622 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1623 @code{.stab} debugging symbol-table entries are carried in an ELF
1624 section. In most other file formats, debugging symbol-table entries are
1625 interleaved with linkage symbols, and are visible in the @option{--syms}
1628 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1629 Overview,stabs.info, The ``stabs'' debug format}.
1632 @item --start-address=@var{address}
1633 @cindex start-address
1634 Start displaying data at the specified address. This affects the output
1635 of the @option{-d}, @option{-r} and @option{-s} options.
1637 @item --stop-address=@var{address}
1638 @cindex stop-address
1639 Stop displaying data at the specified address. This affects the output
1640 of the @option{-d}, @option{-r} and @option{-s} options.
1644 @cindex symbol table entries, printing
1645 Print the symbol table entries of the file.
1646 This is similar to the information provided by the @samp{nm} program.
1649 @itemx --dynamic-syms
1650 @cindex dynamic symbol table entries, printing
1651 Print the dynamic symbol table entries of the file. This is only
1652 meaningful for dynamic objects, such as certain types of shared
1653 libraries. This is similar to the information provided by the @samp{nm}
1654 program when given the @option{-D} (@option{--dynamic}) option.
1657 Print the version number of @command{objdump} and exit.
1661 @cindex all header information, object file
1662 @cindex header information, all
1663 Display all available header information, including the symbol table and
1664 relocation entries. Using @option{-x} is equivalent to specifying all of
1665 @option{-a -f -h -r -t}.
1669 @cindex wide output, printing
1670 Format some lines for output devices that have more than 80 columns.
1676 @c man begin SEEALSO objdump
1677 nm(1), readelf(1), and the Info entries for @file{binutils}.
1685 @cindex archive contents
1686 @cindex symbol index
1688 @c man title ranlib generate index to archive.
1691 @c man begin SYNOPSIS ranlib
1692 ranlib [@option{-vV}] @var{archive}
1696 @c man begin DESCRIPTION ranlib
1698 @command{ranlib} generates an index to the contents of an archive and
1699 stores it in the archive. The index lists each symbol defined by a
1700 member of an archive that is a relocatable object file.
1702 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
1704 An archive with such an index speeds up linking to the library and
1705 allows routines in the library to call each other without regard to
1706 their placement in the archive.
1708 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
1709 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
1714 @c man begin OPTIONS ranlib
1720 Show the version number of @command{ranlib}.
1726 @c man begin SEEALSO ranlib
1727 ar(1), nm(1), and the Info entries for @file{binutils}.
1735 @cindex section sizes
1737 @c man title size list section sizes and total size.
1740 @c man begin SYNOPSIS size
1741 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
1742 [@option{--help}] [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
1743 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
1744 [@var{objfile}@dots{}]
1748 @c man begin DESCRIPTION size
1750 The @sc{gnu} @command{size} utility lists the section sizes---and the total
1751 size---for each of the object or archive files @var{objfile} in its
1752 argument list. By default, one line of output is generated for each
1753 object file or each module in an archive.
1755 @var{objfile}@dots{} are the object files to be examined.
1756 If none are specified, the file @code{a.out} will be used.
1760 @c man begin OPTIONS size
1762 The command line options have the following meanings:
1767 @itemx --format=@var{compatibility}
1768 @cindex @command{size} display format
1769 Using one of these options, you can choose whether the output from @sc{gnu}
1770 @command{size} resembles output from System V @command{size} (using @option{-A},
1771 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
1772 @option{--format=berkeley}). The default is the one-line format similar to
1774 @c Bonus for doc-source readers: you can also say --format=strange (or
1775 @c anything else that starts with 's') for sysv, and --format=boring (or
1776 @c anything else that starts with 'b') for Berkeley.
1778 Here is an example of the Berkeley (default) format of output from
1781 $ size --format=Berkeley ranlib size
1782 text data bss dec hex filename
1783 294880 81920 11592 388392 5ed28 ranlib
1784 294880 81920 11888 388688 5ee50 size
1788 This is the same data, but displayed closer to System V conventions:
1791 $ size --format=SysV ranlib size
1809 Show a summary of acceptable arguments and options.
1814 @itemx --radix=@var{number}
1815 @cindex @command{size} number format
1816 @cindex radix for section sizes
1817 Using one of these options, you can control whether the size of each
1818 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
1819 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
1820 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
1821 values (8, 10, 16) are supported. The total size is always given in two
1822 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
1823 octal and hexadecimal if you're using @option{-o}.
1825 @item --target=@var{bfdname}
1826 @cindex object code format
1827 Specify that the object-code format for @var{objfile} is
1828 @var{bfdname}. This option may not be necessary; @command{size} can
1829 automatically recognize many formats.
1830 @xref{Target Selection}, for more information.
1834 Display the version number of @command{size}.
1840 @c man begin SEEALSO size
1841 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
1848 @cindex listings strings
1849 @cindex printing strings
1850 @cindex strings, printing
1852 @c man title strings print the strings of printable characters in files.
1855 @c man begin SYNOPSIS strings
1856 strings [@option{-afov}] [@option{-}@var{min-len}] [@option{-n} @var{min-len}] [@option{-t} @var{radix}] [@option{-}]
1857 [@option{--all}] [@option{--print-file-name}] [@option{--bytes=}@var{min-len}]
1858 [@option{--radix=}@var{radix}] [@option{--target=}@var{bfdname}]
1859 [@option{--help}] [@option{--version}] @var{file}@dots{}
1863 @c man begin DESCRIPTION strings
1865 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
1866 character sequences that are at least 4 characters long (or the number
1867 given with the options below) and are followed by an unprintable
1868 character. By default, it only prints the strings from the initialized
1869 and loaded sections of object files; for other types of files, it prints
1870 the strings from the whole file.
1872 @command{strings} is mainly useful for determining the contents of non-text
1877 @c man begin OPTIONS strings
1883 Do not scan only the initialized and loaded sections of object files;
1884 scan the whole files.
1887 @itemx --print-file-name
1888 Print the name of the file before each string.
1891 Print a summary of the program usage on the standard output and exit.
1893 @item -@var{min-len}
1894 @itemx -n @var{min-len}
1895 @itemx --bytes=@var{min-len}
1896 Print sequences of characters that are at least @var{min-len} characters
1897 long, instead of the default 4.
1900 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
1901 act like @samp{-t d} instead. Since we can not be compatible with both
1902 ways, we simply chose one.
1904 @item -t @var{radix}
1905 @itemx --radix=@var{radix}
1906 Print the offset within the file before each string. The single
1907 character argument specifies the radix of the offset---@samp{o} for
1908 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1910 @item --target=@var{bfdname}
1911 @cindex object code format
1912 Specify an object code format other than your system's default format.
1913 @xref{Target Selection}, for more information.
1917 Print the program version number on the standard output and exit.
1923 @c man begin SEEALSO strings
1924 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
1925 and the Info entries for @file{binutils}.
1933 @cindex removing symbols
1934 @cindex discarding symbols
1935 @cindex symbols, discarding
1937 @c man title strip Discard symbols from object files.
1940 @c man begin SYNOPSIS strip
1941 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname} ]
1942 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname} ]
1943 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname} ]
1944 [@option{-s}|@option{--strip-all}] [@option{-S}|@option{-g}|@option{--strip-debug}]
1945 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname} ]
1946 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname} ]
1947 [@option{-x}|@option{--discard-all} ] [@option{-X} |@option{--discard-locals}]
1948 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname} ]
1949 [@option{-o} @var{file} ] [@option{-p}|@option{--preserve-dates}]
1950 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}] [@option{--help}]
1951 @var{objfile}@dots{}
1955 @c man begin DESCRIPTION strip
1957 @sc{gnu} @command{strip} discards all symbols from object files
1958 @var{objfile}. The list of object files may include archives.
1959 At least one object file must be given.
1961 @command{strip} modifies the files named in its argument,
1962 rather than writing modified copies under different names.
1966 @c man begin OPTIONS strip
1969 @item -F @var{bfdname}
1970 @itemx --target=@var{bfdname}
1971 Treat the original @var{objfile} as a file with the object
1972 code format @var{bfdname}, and rewrite it in the same format.
1973 @xref{Target Selection}, for more information.
1976 Show a summary of the options to @command{strip} and exit.
1978 @item -I @var{bfdname}
1979 @itemx --input-target=@var{bfdname}
1980 Treat the original @var{objfile} as a file with the object
1981 code format @var{bfdname}.
1982 @xref{Target Selection}, for more information.
1984 @item -O @var{bfdname}
1985 @itemx --output-target=@var{bfdname}
1986 Replace @var{objfile} with a file in the output format @var{bfdname}.
1987 @xref{Target Selection}, for more information.
1989 @item -R @var{sectionname}
1990 @itemx --remove-section=@var{sectionname}
1991 Remove any section named @var{sectionname} from the output file. This
1992 option may be given more than once. Note that using this option
1993 inappropriately may make the output file unusable.
2001 @itemx --strip-debug
2002 Remove debugging symbols only.
2004 @item --strip-unneeded
2005 Remove all symbols that are not needed for relocation processing.
2007 @item -K @var{symbolname}
2008 @itemx --keep-symbol=@var{symbolname}
2009 Keep only symbol @var{symbolname} from the source file. This option may
2010 be given more than once.
2012 @item -N @var{symbolname}
2013 @itemx --strip-symbol=@var{symbolname}
2014 Remove symbol @var{symbolname} from the source file. This option may be
2015 given more than once, and may be combined with strip options other than
2019 Put the stripped output in @var{file}, rather than replacing the
2020 existing file. When this argument is used, only one @var{objfile}
2021 argument may be specified.
2024 @itemx --preserve-dates
2025 Preserve the access and modification dates of the file.
2028 @itemx --discard-all
2029 Remove non-global symbols.
2032 @itemx --discard-locals
2033 Remove compiler-generated local symbols.
2034 (These usually start with @samp{L} or @samp{.}.)
2038 Show the version number for @command{strip}.
2042 Verbose output: list all object files modified. In the case of
2043 archives, @samp{strip -v} lists all members of the archive.
2049 @c man begin SEEALSO strip
2050 the Info entries for @file{binutils}.
2054 @node c++filt, addr2line, strip, Top
2058 @cindex demangling C++ symbols
2060 @c man title cxxfilt Demangle C++ and Java symbols.
2063 @c man begin SYNOPSIS cxxfilt
2064 c++filt [@option{-_}|@option{--strip-underscores}]
2065 [@option{-j}|@option{--java}]
2066 [@option{-n}|@option{--no-strip-underscores}]
2067 [@option{-s} @var{format}|@option{--format=}@var{format}]
2068 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2072 @c man begin DESCRIPTION cxxfilt
2075 The C++ and Java languages provides function overloading, which means
2076 that you can write many functions with the same name (providing each
2077 takes parameters of different types). All C++ and Java function names
2078 are encoded into a low-level assembly label (this process is known as
2079 @dfn{mangling}). The @command{c++filt}
2080 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2081 MS-DOS this program is named @command{cxxfilt}.}
2082 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2083 names into user-level names so that the linker can keep these overloaded
2084 functions from clashing.
2086 Every alphanumeric word (consisting of letters, digits, underscores,
2087 dollars, or periods) seen in the input is a potential label. If the
2088 label decodes into a C++ name, the C++ name replaces the low-level
2091 You can use @command{c++filt} to decipher individual symbols:
2094 c++filt @var{symbol}
2097 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
2098 names from the standard input and writes the demangled names to the
2099 standard output. All results are printed on the standard output.
2103 @c man begin OPTIONS cxxfilt
2107 @itemx --strip-underscores
2108 On some systems, both the C and C++ compilers put an underscore in front
2109 of every name. For example, the C name @code{foo} gets the low-level
2110 name @code{_foo}. This option removes the initial underscore. Whether
2111 @command{c++filt} removes the underscore by default is target dependent.
2115 Prints demangled names using Java syntax. The default is to use C++
2119 @itemx --no-strip-underscores
2120 Do not remove the initial underscore.
2122 @item -s @var{format}
2123 @itemx --format=@var{format}
2124 @sc{gnu} @command{nm} can decode three different methods of mangling, used by
2125 different C++ compilers. The argument to this option selects which
2130 the one used by the @sc{gnu} compiler (the default method)
2132 the one used by the Lucid compiler
2134 the one specified by the C++ Annotated Reference Manual
2136 the one used by the HP compiler
2138 the one used by the EDG compiler
2140 the one used by the @sc{gnu} compiler with the new ABI.
2144 Print a summary of the options to @command{c++filt} and exit.
2147 Print the version number of @command{c++filt} and exit.
2153 @c man begin SEEALSO cxxfilt
2154 the Info entries for @file{binutils}.
2159 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
2160 user interface are subject to change in future releases. In particular,
2161 a command-line option may be required in the the future to decode a name
2162 passed as an argument on the command line; in other words,
2165 c++filt @var{symbol}
2169 may in a future release become
2172 c++filt @var{option} @var{symbol}
2180 @cindex address to file name and line number
2182 @c man title addr2line convert addresses into file names and line numbers.
2185 @c man begin SYNOPSIS addr2line
2186 addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
2187 [@option{-C}|@option{--demangle}[=@var{style}]
2188 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
2189 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
2190 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
2195 @c man begin DESCRIPTION addr2line
2197 @command{addr2line} translates program addresses into file names and line
2198 numbers. Given an address and an executable, it uses the debugging
2199 information in the executable to figure out which file name and line
2200 number are associated with a given address.
2202 The executable to use is specified with the @option{-e} option. The
2203 default is the file @file{a.out}.
2205 @command{addr2line} has two modes of operation.
2207 In the first, hexadecimal addresses are specified on the command line,
2208 and @command{addr2line} displays the file name and line number for each
2211 In the second, @command{addr2line} reads hexadecimal addresses from
2212 standard input, and prints the file name and line number for each
2213 address on standard output. In this mode, @command{addr2line} may be used
2214 in a pipe to convert dynamically chosen addresses.
2216 The format of the output is @samp{FILENAME:LINENO}. The file name and
2217 line number for each address is printed on a separate line. If the
2218 @command{-f} option is used, then each @samp{FILENAME:LINENO} line is
2219 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2220 containing the address.
2222 If the file name or function name can not be determined,
2223 @command{addr2line} will print two question marks in their place. If the
2224 line number can not be determined, @command{addr2line} will print 0.
2228 @c man begin OPTIONS addr2line
2230 The long and short forms of options, shown here as alternatives, are
2234 @item -b @var{bfdname}
2235 @itemx --target=@var{bfdname}
2236 @cindex object code format
2237 Specify that the object-code format for the object files is
2241 @itemx --demangle[=@var{style}]
2242 @cindex demangling in objdump
2243 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2244 Besides removing any initial underscore prepended by the system, this
2245 makes C++ function names readable. Different compilers have different
2246 mangling styles. The optional demangling style argument can be used to
2247 choose an appropriate demangling style for your compiler. @xref{c++filt},
2248 for more information on demangling.
2250 @item -e @var{filename}
2251 @itemx --exe=@var{filename}
2252 Specify the name of the executable for which addresses should be
2253 translated. The default file is @file{a.out}.
2257 Display function names as well as file and line number information.
2261 Display only the base of each file name.
2267 @c man begin SEEALSO addr2line
2268 Info entries for @file{binutils}.
2275 @command{nlmconv} converts a relocatable object file into a NetWare
2279 @command{nlmconv} currently works with @samp{i386} object
2280 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
2281 object files in @sc{elf}, or @code{a.out} format@footnote{
2282 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
2283 format in the Binary File Descriptor library. It has only been tested
2284 with the above formats.}.
2288 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
2289 utilities, since it is only useful for NLM targets.
2292 @c man title nlmconv converts object code into an NLM.
2295 @c man begin SYNOPSIS nlmconv
2296 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
2297 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
2298 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
2299 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
2300 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
2301 @var{infile} @var{outfile}
2305 @c man begin DESCRIPTION nlmconv
2307 @command{nlmconv} converts the relocatable @samp{i386} object file
2308 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
2309 reading @var{headerfile} for NLM header information. For instructions
2310 on writing the NLM command file language used in header files, see the
2311 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
2312 Development and Tools Overview}, which is part of the NLM Software
2313 Developer's Kit (``NLM SDK''), available from Novell, Inc.
2314 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
2317 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
2320 @command{nlmconv} can perform a link step. In other words, you can list
2321 more than one object file for input if you list them in the definitions
2322 file (rather than simply specifying one input file on the command line).
2323 In this case, @command{nlmconv} calls the linker for you.
2327 @c man begin OPTIONS nlmconv
2330 @item -I @var{bfdname}
2331 @itemx --input-target=@var{bfdname}
2332 Object format of the input file. @command{nlmconv} can usually determine
2333 the format of a given file (so no default is necessary).
2334 @xref{Target Selection}, for more information.
2336 @item -O @var{bfdname}
2337 @itemx --output-target=@var{bfdname}
2338 Object format of the output file. @command{nlmconv} infers the output
2339 format based on the input format, e.g. for a @samp{i386} input file the
2340 output format is @samp{nlm32-i386}.
2341 @xref{Target Selection}, for more information.
2343 @item -T @var{headerfile}
2344 @itemx --header-file=@var{headerfile}
2345 Reads @var{headerfile} for NLM header information. For instructions on
2346 writing the NLM command file language used in header files, see@ see the
2347 @samp{linkers} section, of the @cite{NLM Development and Tools
2348 Overview}, which is part of the NLM Software Developer's Kit, available
2353 Displays (on standard error) the linker command line used by @command{nlmconv}.
2355 @item -l @var{linker}
2356 @itemx --linker=@var{linker}
2357 Use @var{linker} for any linking. @var{linker} can be an absolute or a
2362 Prints a usage summary.
2366 Prints the version number for @command{nlmconv}.
2372 @c man begin SEEALSO nlmconv
2373 the Info entries for @file{binutils}.
2380 @command{windres} may be used to manipulate Windows resources.
2383 @emph{Warning:} @command{windres} is not always built as part of the binary
2384 utilities, since it is only useful for Windows targets.
2387 @c man title windres manipulate Windows resources.
2390 @c man begin SYNOPSIS windres
2391 windres [options] [input-file] [output-file]
2395 @c man begin DESCRIPTION windres
2397 @command{windres} reads resources from an input file and copies them into
2398 an output file. Either file may be in one of three formats:
2402 A text format read by the Resource Compiler.
2405 A binary format generated by the Resource Compiler.
2408 A COFF object or executable.
2411 The exact description of these different formats is available in
2412 documentation from Microsoft.
2414 When @command{windres} converts from the @code{rc} format to the @code{res}
2415 format, it is acting like the Windows Resource Compiler. When
2416 @command{windres} converts from the @code{res} format to the @code{coff}
2417 format, it is acting like the Windows @code{CVTRES} program.
2419 When @command{windres} generates an @code{rc} file, the output is similar
2420 but not identical to the format expected for the input. When an input
2421 @code{rc} file refers to an external filename, an output @code{rc} file
2422 will instead include the file contents.
2424 If the input or output format is not specified, @command{windres} will
2425 guess based on the file name, or, for the input file, the file contents.
2426 A file with an extension of @file{.rc} will be treated as an @code{rc}
2427 file, a file with an extension of @file{.res} will be treated as a
2428 @code{res} file, and a file with an extension of @file{.o} or
2429 @file{.exe} will be treated as a @code{coff} file.
2431 If no output file is specified, @command{windres} will print the resources
2432 in @code{rc} format to standard output.
2434 The normal use is for you to write an @code{rc} file, use @command{windres}
2435 to convert it to a COFF object file, and then link the COFF file into
2436 your application. This will make the resources described in the
2437 @code{rc} file available to Windows.
2441 @c man begin OPTIONS windres
2444 @item -i @var{filename}
2445 @itemx --input @var{filename}
2446 The name of the input file. If this option is not used, then
2447 @command{windres} will use the first non-option argument as the input file
2448 name. If there are no non-option arguments, then @command{windres} will
2449 read from standard input. @command{windres} can not read a COFF file from
2452 @item -o @var{filename}
2453 @itemx --output @var{filename}
2454 The name of the output file. If this option is not used, then
2455 @command{windres} will use the first non-option argument, after any used
2456 for the input file name, as the output file name. If there is no
2457 non-option argument, then @command{windres} will write to standard output.
2458 @command{windres} can not write a COFF file to standard output.
2460 @item -I @var{format}
2461 @itemx --input-format @var{format}
2462 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
2463 @samp{coff}. If no input format is specified, @command{windres} will
2464 guess, as described above.
2466 @item -O @var{format}
2467 @itemx --output-format @var{format}
2468 The output format to generate. @var{format} may be @samp{res},
2469 @samp{rc}, or @samp{coff}. If no output format is specified,
2470 @command{windres} will guess, as described above.
2472 @item -F @var{target}
2473 @itemx --target @var{target}
2474 Specify the BFD format to use for a COFF file as input or output. This
2475 is a BFD target name; you can use the @option{--help} option to see a list
2476 of supported targets. Normally @command{windres} will use the default
2477 format, which is the first one listed by the @option{--help} option.
2479 @ref{Target Selection}.
2482 @item --preprocessor @var{program}
2483 When @command{windres} reads an @code{rc} file, it runs it through the C
2484 preprocessor first. This option may be used to specify the preprocessor
2485 to use, including any leading arguments. The default preprocessor
2486 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
2488 @item --include-dir @var{directory}
2489 Specify an include directory to use when reading an @code{rc} file.
2490 @command{windres} will pass this to the preprocessor as an @option{-I}
2491 option. @command{windres} will also search this directory when looking for
2492 files named in the @code{rc} file.
2494 @item -D @var{target}
2495 @itemx --define @var{sym}[=@var{val}]
2496 Specify a @option{-D} option to pass to the preprocessor when reading an
2500 Enable verbose mode. This tells you what the preprocessor is if you
2503 @item --language @var{val}
2504 Specify the default language to use when reading an @code{rc} file.
2505 @var{val} should be a hexadecimal language code. The low eight bits are
2506 the language, and the high eight bits are the sublanguage.
2508 @item --use-temp-file
2509 Use a temporary file to instead of using popen to read the output of
2510 the preprocessor. Use this option if the popen implementation is buggy
2511 on the host (eg., certain non-English language versions of Windows 95 and
2512 Windows 98 are known to have buggy popen where the output will instead
2515 @item --no-use-temp-file
2516 Use popen, not a temporary file, to read the output of the preprocessor.
2517 This is the default behaviour.
2520 Prints a usage summary.
2523 Prints the version number for @command{windres}.
2526 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
2527 this will turn on parser debugging.
2533 @c man begin SEEALSO windres
2534 the Info entries for @file{binutils}.
2539 @chapter Create files needed to build and use DLLs
2543 @command{dlltool} may be used to create the files needed to build and use
2544 dynamic link libraries (DLLs).
2547 @emph{Warning:} @command{dlltool} is not always built as part of the binary
2548 utilities, since it is only useful for those targets which support DLLs.
2551 @c man title dlltool Create files needed to build and use DLLs.
2554 @c man begin SYNOPSIS dlltool
2555 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
2556 [@option{-b}|@option{--base-file} @var{base-file-name}]
2557 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
2558 [@option{-z}|@option{--output-def} @var{def-file-name}]
2559 [@option{-l}|@option{--output-lib} @var{library-file-name}]
2560 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
2561 [@option{--exclude-symbols} @var{list}]
2562 [@option{--no-default-excludes}]
2563 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
2564 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
2565 [@option{-a}|@option{--add-indirect}] [@option{-U}|@option{--add-underscore}] [@option{-k}|@option{--kill-at}]
2566 [@option{-A}|@option{--add-stdcall-alias}]
2567 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}] [@option{-i}|@option{--interwork}]
2568 [@option{-n}|@option{--nodelete}] [@option{-v}|@option{--verbose}]
2569 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
2570 [object-file @dots{}]
2574 @c man begin DESCRIPTION dlltool
2576 @command{dlltool} reads its inputs, which can come from the @option{-d} and
2577 @option{-b} options as well as object files specified on the command
2578 line. It then processes these inputs and if the @option{-e} option has
2579 been specified it creates a exports file. If the @option{-l} option
2580 has been specified it creates a library file and if the @option{-z} option
2581 has been specified it creates a def file. Any or all of the @option{-e},
2582 @option{-l} and @option{-z} options can be present in one invocation of
2585 When creating a DLL, along with the source for the DLL, it is necessary
2586 to have three other files. @command{dlltool} can help with the creation of
2589 The first file is a @samp{.def} file which specifies which functions are
2590 exported from the DLL, which functions the DLL imports, and so on. This
2591 is a text file and can be created by hand, or @command{dlltool} can be used
2592 to create it using the @option{-z} option. In this case @command{dlltool}
2593 will scan the object files specified on its command line looking for
2594 those functions which have been specially marked as being exported and
2595 put entries for them in the .def file it creates.
2597 In order to mark a function as being exported from a DLL, it needs to
2598 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
2599 section of the object file. This can be done in C by using the
2603 asm (".section .drectve");
2604 asm (".ascii \"-export:my_func\"");
2606 int my_func (void) @{ @dots{} @}
2609 The second file needed for DLL creation is an exports file. This file
2610 is linked with the object files that make up the body of the DLL and it
2611 handles the interface between the DLL and the outside world. This is a
2612 binary file and it can be created by giving the @option{-e} option to
2613 @command{dlltool} when it is creating or reading in a .def file.
2615 The third file needed for DLL creation is the library file that programs
2616 will link with in order to access the functions in the DLL. This file
2617 can be created by giving the @option{-l} option to dlltool when it
2618 is creating or reading in a .def file.
2620 @command{dlltool} builds the library file by hand, but it builds the
2621 exports file by creating temporary files containing assembler statements
2622 and then assembling these. The @option{-S} command line option can be
2623 used to specify the path to the assembler that dlltool will use,
2624 and the @option{-f} option can be used to pass specific flags to that
2625 assembler. The @option{-n} can be used to prevent dlltool from deleting
2626 these temporary assembler files when it is done, and if @option{-n} is
2627 specified twice then this will prevent dlltool from deleting the
2628 temporary object files it used to build the library.
2630 Here is an example of creating a DLL from a source file @samp{dll.c} and
2631 also creating a program (from an object file called @samp{program.o})
2636 dlltool -e exports.o -l dll.lib dll.o
2637 gcc dll.o exports.o -o dll.dll
2638 gcc program.o dll.lib -o program
2643 @c man begin OPTIONS dlltool
2645 The command line options have the following meanings:
2649 @item -d @var{filename}
2650 @itemx --input-def @var{filename}
2651 @cindex input .def file
2652 Specifies the name of a .def file to be read in and processed.
2654 @item -b @var{filename}
2655 @itemx --base-file @var{filename}
2657 Specifies the name of a base file to be read in and processed. The
2658 contents of this file will be added to the relocation section in the
2659 exports file generated by dlltool.
2661 @item -e @var{filename}
2662 @itemx --output-exp @var{filename}
2663 Specifies the name of the export file to be created by dlltool.
2665 @item -z @var{filename}
2666 @itemx --output-def @var{filename}
2667 Specifies the name of the .def file to be created by dlltool.
2669 @item -l @var{filename}
2670 @itemx --output-lib @var{filename}
2671 Specifies the name of the library file to be created by dlltool.
2673 @item --export-all-symbols
2674 Treat all global and weak defined symbols found in the input object
2675 files as symbols to be exported. There is a small list of symbols which
2676 are not exported by default; see the @option{--no-default-excludes}
2677 option. You may add to the list of symbols to not export by using the
2678 @option{--exclude-symbols} option.
2680 @item --no-export-all-symbols
2681 Only export symbols explicitly listed in an input .def file or in
2682 @samp{.drectve} sections in the input object files. This is the default
2683 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
2684 attributes in the source code.
2686 @item --exclude-symbols @var{list}
2687 Do not export the symbols in @var{list}. This is a list of symbol names
2688 separated by comma or colon characters. The symbol names should not
2689 contain a leading underscore. This is only meaningful when
2690 @option{--export-all-symbols} is used.
2692 @item --no-default-excludes
2693 When @option{--export-all-symbols} is used, it will by default avoid
2694 exporting certain special symbols. The current list of symbols to avoid
2695 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
2696 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
2697 to go ahead and export these special symbols. This is only meaningful
2698 when @option{--export-all-symbols} is used.
2701 @itemx --as @var{path}
2702 Specifies the path, including the filename, of the assembler to be used
2703 to create the exports file.
2705 @item -f @var{switches}
2706 @itemx --as-flags @var{switches}
2707 Specifies any specific command line switches to be passed to the
2708 assembler when building the exports file. This option will work even if
2709 the @option{-S} option is not used. This option only takes one argument,
2710 and if it occurs more than once on the command line, then later
2711 occurrences will override earlier occurrences. So if it is necessary to
2712 pass multiple switches to the assembler they should be enclosed in
2716 @itemx --dll-name @var{name}
2717 Specifies the name to be stored in the .def file as the name of the DLL
2718 when the @option{-e} option is used. If this option is not present, then
2719 the filename given to the @option{-e} option will be used as the name of
2722 @item -m @var{machine}
2723 @itemx -machine @var{machine}
2724 Specifies the type of machine for which the library file should be
2725 built. @command{dlltool} has a built in default type, depending upon how
2726 it was created, but this option can be used to override that. This is
2727 normally only useful when creating DLLs for an ARM processor, when the
2728 contents of the DLL are actually encode using Thumb instructions.
2731 @itemx --add-indirect
2732 Specifies that when @command{dlltool} is creating the exports file it
2733 should add a section which allows the exported functions to be
2734 referenced without using the import library. Whatever the hell that
2738 @itemx --add-underscore
2739 Specifies that when @command{dlltool} is creating the exports file it
2740 should prepend an underscore to the names of the exported functions.
2744 Specifies that when @command{dlltool} is creating the exports file it
2745 should not append the string @samp{@@ <number>}. These numbers are
2746 called ordinal numbers and they represent another way of accessing the
2747 function in a DLL, other than by name.
2750 @itemx --add-stdcall-alias
2751 Specifies that when @command{dlltool} is creating the exports file it
2752 should add aliases for stdcall symbols without @samp{@@ <number>}
2753 in addition to the symbols with @samp{@@ <number>}.
2757 Specifies that when @command{dlltool} is creating the exports and library
2758 files it should omit the @code{.idata4} section. This is for compatibility
2759 with certain operating systems.
2763 Specifies that when @command{dlltool} is creating the exports and library
2764 files it should omit the @code{.idata5} section. This is for compatibility
2765 with certain operating systems.
2769 Specifies that @command{dlltool} should mark the objects in the library
2770 file and exports file that it produces as supporting interworking
2771 between ARM and Thumb code.
2775 Makes @command{dlltool} preserve the temporary assembler files it used to
2776 create the exports file. If this option is repeated then dlltool will
2777 also preserve the temporary object files it uses to create the library
2782 Make dlltool describe what it is doing.
2786 Displays a list of command line options and then exits.
2790 Displays dlltool's version number and then exits.
2797 @c man begin SEEALSO dlltool
2798 the Info entries for @file{binutils}.
2805 @cindex ELF file information
2808 @c man title readelf Displays information about ELF files.
2811 @c man begin SYNOPSIS readelf
2812 readelf [@option{-a}|@option{--all}]
2813 [@option{-h}|@option{--file-header}]
2814 [@option{-l}|@option{--program-headers}|@option{--segments}]
2815 [@option{-S}|@option{--section-headers}|@option{--sections}]
2816 [@option{-e}|@option{--headers}]
2817 [@option{-s}|@option{--syms}|@option{--symbols}]
2818 [@option{-n}|@option{--notes}]
2819 [@option{-r}|@option{--relocs}]
2820 [@option{-u}|@option{--unwind}]
2821 [@option{-d}|@option{--dynamic}]
2822 [@option{-V}|@option{--version-info}]
2823 [@option{-D}|@option{--use-dynamic}]
2824 [@option{-x} <number>|@option{--hex-dump=}<number>]
2825 [@option{-w[liaprmf]}|@option{--debug-dump}[=line,=info,=abbrev,=pubnames,=ranges,=macro,=frames]]
2826 [@option{-histogram}]
2827 [@option{-v}|@option{--version}]
2828 [@option{-H}|@option{--help}]
2829 @var{elffile}@dots{}
2833 @c man begin DESCRIPTION readelf
2835 @command{readelf} displays information about one or more ELF format object
2836 files. The options control what particular information to display.
2838 @var{elffile}@dots{} are the object files to be examined. At the
2839 moment, @command{readelf} does not support examining archives, nor does it
2840 support examing 64 bit ELF files.
2844 @c man begin OPTIONS readelf
2846 The long and short forms of options, shown here as alternatives, are
2847 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
2853 Equivalent to specifiying @option{--file-header},
2854 @option{--program-headers}, @option{--sections}, @option{--symbols},
2855 @option{--relocs}, @option{--dynamic}, @option{--notes} and
2856 @option{--version-info}.
2859 @itemx --file-header
2860 @cindex ELF file header information
2861 Displays the information contained in the ELF header at the start of the
2865 @itemx --program-headers
2867 @cindex ELF program header information
2868 @cindex ELF segment information
2869 Displays the information contained in the file's segment headers, if it
2874 @itemx --section-headers
2875 @cindex ELF section information
2876 Displays the information contained in the file's section headers, if it
2882 @cindex ELF symbol table information
2883 Displays the entries in symbol table section of the file, if it has one.
2887 Display all the headers in the file. Equivalent to @option{-h -l -S}.
2891 @cindex ELF core notes
2892 Displays the contents of the NOTE segment, if it exists.
2896 @cindex ELF reloc information
2897 Displays the contents of the file's relocation section, if it has one.
2901 @cindex unwind information
2902 Displays the contents of the file's unwind section, if it has one. Only
2903 the unwind sections for IA64 ELF files are currently supported.
2907 @cindex ELF dynamic section information
2908 Displays the contents of the file's dynamic section, if it has one.
2911 @itemx --version-info
2912 @cindex ELF version sections informations
2913 Displays the contents of the version sections in the file, it they
2917 @itemx --use-dynamic
2918 When displaying symbols, this option makes @command{readelf} use the
2919 symbol table in the file's dynamic section, rather than the one in the
2923 @itemx --hex-dump=<number>
2924 Displays the contents of the indicated section as a hexadecimal dump.
2927 @itemx --debug-dump[=line,=info,=abbrev,=pubnames,=ranges,=macro,=frames]
2928 Displays the contents of the debug sections in the file, if any are
2929 present. If one of the optional letters or words follows the switch
2930 then only data found in those specific sections will be dumped.
2933 Display a histogram of bucket list lengths when displaying the contents
2934 of the symbol tables.
2938 Display the version number of readelf.
2942 Display the command line options understood by @command{readelf}.
2949 @c man begin SEEALSO readelf
2950 objdump(1), and the Info entries for @file{binutils}.
2954 @node Selecting The Target System
2955 @chapter Selecting the target system
2957 You can specify three aspects of the target system to the @sc{gnu}
2958 binary file utilities, each in several ways:
2968 the linker emulation (which applies to the linker only)
2971 In the following summaries, the lists of ways to specify values are in
2972 order of decreasing precedence. The ways listed first override those
2975 The commands to list valid values only list the values for which the
2976 programs you are running were configured. If they were configured with
2977 @option{--enable-targets=all}, the commands list most of the available
2978 values, but a few are left out; not all targets can be configured in at
2979 once because some of them can only be configured @dfn{native} (on hosts
2980 with the same type as the target system).
2983 * Target Selection::
2984 * Architecture Selection::
2985 * Linker Emulation Selection::
2988 @node Target Selection
2989 @section Target Selection
2991 A @dfn{target} is an object file format. A given target may be
2992 supported for multiple architectures (@pxref{Architecture Selection}).
2993 A target selection may also have variations for different operating
2994 systems or architectures.
2996 The command to list valid target values is @samp{objdump -i}
2997 (the first column of output contains the relevant information).
2999 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
3000 @samp{a.out-sunos-big}.
3002 You can also specify a target using a configuration triplet. This is
3003 the same sort of name that is passed to @file{configure} to specify a
3004 target. When you use a configuration triplet as an argument, it must be
3005 fully canonicalized. You can see the canonical version of a triplet by
3006 running the shell script @file{config.sub} which is included with the
3009 Some sample configuration triplets are: @samp{m68k-hp-bsd},
3010 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
3012 @subheading @command{objdump} Target
3018 command line option: @option{-b} or @option{--target}
3021 environment variable @code{GNUTARGET}
3024 deduced from the input file
3027 @subheading @command{objcopy} and @command{strip} Input Target
3033 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
3036 environment variable @code{GNUTARGET}
3039 deduced from the input file
3042 @subheading @command{objcopy} and @command{strip} Output Target
3048 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
3051 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
3054 environment variable @code{GNUTARGET}
3057 deduced from the input file
3060 @subheading @command{nm}, @command{size}, and @command{strings} Target
3066 command line option: @option{--target}
3069 environment variable @code{GNUTARGET}
3072 deduced from the input file
3075 @subheading Linker Input Target
3081 command line option: @option{-b} or @option{--format}
3082 (@pxref{Options,,Options,ld.info,Using LD})
3085 script command @code{TARGET}
3086 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
3089 environment variable @code{GNUTARGET}
3090 (@pxref{Environment,,Environment,ld.info,Using LD})
3093 the default target of the selected linker emulation
3094 (@pxref{Linker Emulation Selection})
3097 @subheading Linker Output Target
3103 command line option: @option{-oformat}
3104 (@pxref{Options,,Options,ld.info,Using LD})
3107 script command @code{OUTPUT_FORMAT}
3108 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
3111 the linker input target (see ``Linker Input Target'' above)
3114 @node Architecture Selection
3115 @section Architecture selection
3117 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
3118 to run. Its name may contain a colon, separating the name of the
3119 processor family from the name of the particular @sc{cpu}.
3121 The command to list valid architecture values is @samp{objdump -i} (the
3122 second column contains the relevant information).
3124 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
3126 @subheading @command{objdump} Architecture
3132 command line option: @option{-m} or @option{--architecture}
3135 deduced from the input file
3138 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
3144 deduced from the input file
3147 @subheading Linker Input Architecture
3153 deduced from the input file
3156 @subheading Linker Output Architecture
3162 script command @code{OUTPUT_ARCH}
3163 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
3166 the default architecture from the linker output target
3167 (@pxref{Target Selection})
3170 @node Linker Emulation Selection
3171 @section Linker emulation selection
3173 A linker @dfn{emulation} is a ``personality'' of the linker, which gives
3174 the linker default values for the other aspects of the target system.
3175 In particular, it consists of
3185 several ``hook'' functions that are run at certain stages of the linking
3186 process to do special things that some targets require
3189 The command to list valid linker emulation values is @samp{ld -V}.
3191 Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
3197 command line option: @option{-m}
3198 (@pxref{Options,,Options,ld.info,Using LD})
3201 environment variable @code{LDEMULATION}
3204 compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
3205 which comes from @code{EMUL} in @file{config/@var{target}.mt}
3208 @node Reporting Bugs
3209 @chapter Reporting Bugs
3211 @cindex reporting bugs
3213 Your bug reports play an essential role in making the binary utilities
3216 Reporting a bug may help you by bringing a solution to your problem, or
3217 it may not. But in any case the principal function of a bug report is
3218 to help the entire community by making the next version of the binary
3219 utilities work better. Bug reports are your contribution to their
3222 In order for a bug report to serve its purpose, you must include the
3223 information that enables us to fix the bug.
3226 * Bug Criteria:: Have you found a bug?
3227 * Bug Reporting:: How to report bugs
3231 @section Have you found a bug?
3232 @cindex bug criteria
3234 If you are not sure whether you have found a bug, here are some guidelines:
3237 @cindex fatal signal
3240 If a binary utility gets a fatal signal, for any input whatever, that is
3241 a bug. Reliable utilities never crash.
3243 @cindex error on valid input
3245 If a binary utility produces an error message for valid input, that is a
3249 If you are an experienced user of binary utilities, your suggestions for
3250 improvement are welcome in any case.
3254 @section How to report bugs
3256 @cindex bugs, reporting
3258 A number of companies and individuals offer support for @sc{gnu}
3259 products. If you obtained the binary utilities from a support
3260 organization, we recommend you contact that organization first.
3262 You can find contact information for many support companies and
3263 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
3266 In any event, we also recommend that you send bug reports for the binary
3267 utilities to @samp{bug-binutils@@gnu.org}.
3269 The fundamental principle of reporting bugs usefully is this:
3270 @strong{report all the facts}. If you are not sure whether to state a
3271 fact or leave it out, state it!
3273 Often people omit facts because they think they know what causes the
3274 problem and assume that some details do not matter. Thus, you might
3275 assume that the name of a file you use in an example does not matter.
3276 Well, probably it does not, but one cannot be sure. Perhaps the bug is
3277 a stray memory reference which happens to fetch from the location where
3278 that pathname is stored in memory; perhaps, if the pathname were
3279 different, the contents of that location would fool the utility into
3280 doing the right thing despite the bug. Play it safe and give a
3281 specific, complete example. That is the easiest thing for you to do,
3282 and the most helpful.
3284 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
3285 it is new to us. Therefore, always write your bug reports on the assumption
3286 that the bug has not been reported previously.
3288 Sometimes people give a few sketchy facts and ask, ``Does this ring a
3289 bell?'' Those bug reports are useless, and we urge everyone to
3290 @emph{refuse to respond to them} except to chide the sender to report
3293 To enable us to fix the bug, you should include all these things:
3297 The version of the utility. Each utility announces it if you start it
3298 with the @option{--version} argument.
3300 Without this, we will not know whether there is any point in looking for
3301 the bug in the current version of the binary utilities.
3304 Any patches you may have applied to the source, including any patches
3305 made to the @code{BFD} library.
3308 The type of machine you are using, and the operating system name and
3312 What compiler (and its version) was used to compile the utilities---e.g.
3316 The command arguments you gave the utility to observe the bug. To
3317 guarantee you will not omit something important, list them all. A copy
3318 of the Makefile (or the output from make) is sufficient.
3320 If we were to try to guess the arguments, we would probably guess wrong
3321 and then we might not encounter the bug.
3324 A complete input file, or set of input files, that will reproduce the
3325 bug. If the utility is reading an object file or files, then it is
3326 generally most helpful to send the actual object files, uuencoded if
3327 necessary to get them through the mail system. Note that
3328 @samp{bug-binutils@@gnu.org} is a mailing list, so you should avoid
3329 sending very large files to it. Making the files available for
3330 anonymous FTP is OK.
3332 If the source files were produced exclusively using @sc{gnu} programs
3333 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
3334 may be OK to send the source files rather than the object files. In
3335 this case, be sure to say exactly what version of @command{gcc}, or
3336 whatever, was used to produce the object files. Also say how
3337 @command{gcc}, or whatever, was configured.
3340 A description of what behavior you observe that you believe is
3341 incorrect. For example, ``It gets a fatal signal.''
3343 Of course, if the bug is that the utility gets a fatal signal, then we
3344 will certainly notice it. But if the bug is incorrect output, we might
3345 not notice unless it is glaringly wrong. You might as well not give us
3346 a chance to make a mistake.
3348 Even if the problem you experience is a fatal signal, you should still
3349 say so explicitly. Suppose something strange is going on, such as your
3350 copy of the utility is out of synch, or you have encountered a bug in
3351 the C library on your system. (This has happened!) Your copy might
3352 crash and ours would not. If you told us to expect a crash, then when
3353 ours fails to crash, we would know that the bug was not happening for
3354 us. If you had not told us to expect a crash, then we would not be able
3355 to draw any conclusion from our observations.
3358 If you wish to suggest changes to the source, send us context diffs, as
3359 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
3360 option. Always send diffs from the old file to the new file. If you
3361 wish to discuss something in the @command{ld} source, refer to it by
3362 context, not by line number.
3364 The line numbers in our development sources will not match those in your
3365 sources. Your line numbers would convey no useful information to us.
3368 Here are some things that are not necessary:
3372 A description of the envelope of the bug.
3374 Often people who encounter a bug spend a lot of time investigating
3375 which changes to the input file will make the bug go away and which
3376 changes will not affect it.
3378 This is often time consuming and not very useful, because the way we
3379 will find the bug is by running a single example under the debugger
3380 with breakpoints, not by pure deduction from a series of examples.
3381 We recommend that you save your time for something else.
3383 Of course, if you can find a simpler example to report @emph{instead}
3384 of the original one, that is a convenience for us. Errors in the
3385 output will be easier to spot, running under the debugger will take
3386 less time, and so on.
3388 However, simplification is not vital; if you do not want to do this,
3389 report the bug anyway and send us the entire test case you used.
3392 A patch for the bug.
3394 A patch for the bug does help us if it is a good one. But do not omit
3395 the necessary information, such as the test case, on the assumption that
3396 a patch is all we need. We might see problems with your patch and decide
3397 to fix the problem another way, or we might not understand it at all.
3399 Sometimes with programs as complicated as the binary utilities it is
3400 very hard to construct an example that will make the program follow a
3401 certain path through the code. If you do not send us the example, we
3402 will not be able to construct one, so we will not be able to verify that
3405 And if we cannot understand what bug you are trying to fix, or why your
3406 patch should be an improvement, we will not install it. A test case will
3407 help us to understand.
3410 A guess about what the bug is or what it depends on.
3412 Such guesses are usually wrong. Even we cannot guess right about such
3413 things without first using the debugger to find the facts.
3416 @node GNU Free Documentation License
3417 @chapter GNU Free Documentation License
3418 @cindex GNU Free Documentation License
3420 GNU Free Documentation License
3422 Version 1.1, March 2000
3424 Copyright (C) 2000 Free Software Foundation, Inc.
3425 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3427 Everyone is permitted to copy and distribute verbatim copies
3428 of this license document, but changing it is not allowed.
3433 The purpose of this License is to make a manual, textbook, or other
3434 written document "free" in the sense of freedom: to assure everyone
3435 the effective freedom to copy and redistribute it, with or without
3436 modifying it, either commercially or noncommercially. Secondarily,
3437 this License preserves for the author and publisher a way to get
3438 credit for their work, while not being considered responsible for
3439 modifications made by others.
3441 This License is a kind of "copyleft", which means that derivative
3442 works of the document must themselves be free in the same sense. It
3443 complements the GNU General Public License, which is a copyleft
3444 license designed for free software.
3446 We have designed this License in order to use it for manuals for free
3447 software, because free software needs free documentation: a free
3448 program should come with manuals providing the same freedoms that the
3449 software does. But this License is not limited to software manuals;
3450 it can be used for any textual work, regardless of subject matter or
3451 whether it is published as a printed book. We recommend this License
3452 principally for works whose purpose is instruction or reference.
3455 1. APPLICABILITY AND DEFINITIONS
3457 This License applies to any manual or other work that contains a
3458 notice placed by the copyright holder saying it can be distributed
3459 under the terms of this License. The "Document", below, refers to any
3460 such manual or work. Any member of the public is a licensee, and is
3463 A "Modified Version" of the Document means any work containing the
3464 Document or a portion of it, either copied verbatim, or with
3465 modifications and/or translated into another language.
3467 A "Secondary Section" is a named appendix or a front-matter section of
3468 the Document that deals exclusively with the relationship of the
3469 publishers or authors of the Document to the Document's overall subject
3470 (or to related matters) and contains nothing that could fall directly
3471 within that overall subject. (For example, if the Document is in part a
3472 textbook of mathematics, a Secondary Section may not explain any
3473 mathematics.) The relationship could be a matter of historical
3474 connection with the subject or with related matters, or of legal,
3475 commercial, philosophical, ethical or political position regarding
3478 The "Invariant Sections" are certain Secondary Sections whose titles
3479 are designated, as being those of Invariant Sections, in the notice
3480 that says that the Document is released under this License.
3482 The "Cover Texts" are certain short passages of text that are listed,
3483 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3484 the Document is released under this License.
3486 A "Transparent" copy of the Document means a machine-readable copy,
3487 represented in a format whose specification is available to the
3488 general public, whose contents can be viewed and edited directly and
3489 straightforwardly with generic text editors or (for images composed of
3490 pixels) generic paint programs or (for drawings) some widely available
3491 drawing editor, and that is suitable for input to text formatters or
3492 for automatic translation to a variety of formats suitable for input
3493 to text formatters. A copy made in an otherwise Transparent file
3494 format whose markup has been designed to thwart or discourage
3495 subsequent modification by readers is not Transparent. A copy that is
3496 not "Transparent" is called "Opaque".
3498 Examples of suitable formats for Transparent copies include plain
3499 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3500 or XML using a publicly available DTD, and standard-conforming simple
3501 HTML designed for human modification. Opaque formats include
3502 PostScript, PDF, proprietary formats that can be read and edited only
3503 by proprietary word processors, SGML or XML for which the DTD and/or
3504 processing tools are not generally available, and the
3505 machine-generated HTML produced by some word processors for output
3508 The "Title Page" means, for a printed book, the title page itself,
3509 plus such following pages as are needed to hold, legibly, the material
3510 this License requires to appear in the title page. For works in
3511 formats which do not have any title page as such, "Title Page" means
3512 the text near the most prominent appearance of the work's title,
3513 preceding the beginning of the body of the text.
3518 You may copy and distribute the Document in any medium, either
3519 commercially or noncommercially, provided that this License, the
3520 copyright notices, and the license notice saying this License applies
3521 to the Document are reproduced in all copies, and that you add no other
3522 conditions whatsoever to those of this License. You may not use
3523 technical measures to obstruct or control the reading or further
3524 copying of the copies you make or distribute. However, you may accept
3525 compensation in exchange for copies. If you distribute a large enough
3526 number of copies you must also follow the conditions in section 3.
3528 You may also lend copies, under the same conditions stated above, and
3529 you may publicly display copies.
3532 3. COPYING IN QUANTITY
3534 If you publish printed copies of the Document numbering more than 100,
3535 and the Document's license notice requires Cover Texts, you must enclose
3536 the copies in covers that carry, clearly and legibly, all these Cover
3537 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3538 the back cover. Both covers must also clearly and legibly identify
3539 you as the publisher of these copies. The front cover must present
3540 the full title with all words of the title equally prominent and
3541 visible. You may add other material on the covers in addition.
3542 Copying with changes limited to the covers, as long as they preserve
3543 the title of the Document and satisfy these conditions, can be treated
3544 as verbatim copying in other respects.
3546 If the required texts for either cover are too voluminous to fit
3547 legibly, you should put the first ones listed (as many as fit
3548 reasonably) on the actual cover, and continue the rest onto adjacent
3551 If you publish or distribute Opaque copies of the Document numbering
3552 more than 100, you must either include a machine-readable Transparent
3553 copy along with each Opaque copy, or state in or with each Opaque copy
3554 a publicly-accessible computer-network location containing a complete
3555 Transparent copy of the Document, free of added material, which the
3556 general network-using public has access to download anonymously at no
3557 charge using public-standard network protocols. If you use the latter
3558 option, you must take reasonably prudent steps, when you begin
3559 distribution of Opaque copies in quantity, to ensure that this
3560 Transparent copy will remain thus accessible at the stated location
3561 until at least one year after the last time you distribute an Opaque
3562 copy (directly or through your agents or retailers) of that edition to
3565 It is requested, but not required, that you contact the authors of the
3566 Document well before redistributing any large number of copies, to give
3567 them a chance to provide you with an updated version of the Document.
3572 You may copy and distribute a Modified Version of the Document under
3573 the conditions of sections 2 and 3 above, provided that you release
3574 the Modified Version under precisely this License, with the Modified
3575 Version filling the role of the Document, thus licensing distribution
3576 and modification of the Modified Version to whoever possesses a copy
3577 of it. In addition, you must do these things in the Modified Version:
3579 A. Use in the Title Page (and on the covers, if any) a title distinct
3580 from that of the Document, and from those of previous versions
3581 (which should, if there were any, be listed in the History section
3582 of the Document). You may use the same title as a previous version
3583 if the original publisher of that version gives permission.
3584 B. List on the Title Page, as authors, one or more persons or entities
3585 responsible for authorship of the modifications in the Modified
3586 Version, together with at least five of the principal authors of the
3587 Document (all of its principal authors, if it has less than five).
3588 C. State on the Title page the name of the publisher of the
3589 Modified Version, as the publisher.
3590 D. Preserve all the copyright notices of the Document.
3591 E. Add an appropriate copyright notice for your modifications
3592 adjacent to the other copyright notices.
3593 F. Include, immediately after the copyright notices, a license notice
3594 giving the public permission to use the Modified Version under the
3595 terms of this License, in the form shown in the Addendum below.
3596 G. Preserve in that license notice the full lists of Invariant Sections
3597 and required Cover Texts given in the Document's license notice.
3598 H. Include an unaltered copy of this License.
3599 I. Preserve the section entitled "History", and its title, and add to
3600 it an item stating at least the title, year, new authors, and
3601 publisher of the Modified Version as given on the Title Page. If
3602 there is no section entitled "History" in the Document, create one
3603 stating the title, year, authors, and publisher of the Document as
3604 given on its Title Page, then add an item describing the Modified
3605 Version as stated in the previous sentence.
3606 J. Preserve the network location, if any, given in the Document for
3607 public access to a Transparent copy of the Document, and likewise
3608 the network locations given in the Document for previous versions
3609 it was based on. These may be placed in the "History" section.
3610 You may omit a network location for a work that was published at
3611 least four years before the Document itself, or if the original
3612 publisher of the version it refers to gives permission.
3613 K. In any section entitled "Acknowledgements" or "Dedications",
3614 preserve the section's title, and preserve in the section all the
3615 substance and tone of each of the contributor acknowledgements
3616 and/or dedications given therein.
3617 L. Preserve all the Invariant Sections of the Document,
3618 unaltered in their text and in their titles. Section numbers
3619 or the equivalent are not considered part of the section titles.
3620 M. Delete any section entitled "Endorsements". Such a section
3621 may not be included in the Modified Version.
3622 N. Do not retitle any existing section as "Endorsements"
3623 or to conflict in title with any Invariant Section.
3625 If the Modified Version includes new front-matter sections or
3626 appendices that qualify as Secondary Sections and contain no material
3627 copied from the Document, you may at your option designate some or all
3628 of these sections as invariant. To do this, add their titles to the
3629 list of Invariant Sections in the Modified Version's license notice.
3630 These titles must be distinct from any other section titles.
3632 You may add a section entitled "Endorsements", provided it contains
3633 nothing but endorsements of your Modified Version by various
3634 parties--for example, statements of peer review or that the text has
3635 been approved by an organization as the authoritative definition of a
3638 You may add a passage of up to five words as a Front-Cover Text, and a
3639 passage of up to 25 words as a Back-Cover Text, to the end of the list
3640 of Cover Texts in the Modified Version. Only one passage of
3641 Front-Cover Text and one of Back-Cover Text may be added by (or
3642 through arrangements made by) any one entity. If the Document already
3643 includes a cover text for the same cover, previously added by you or
3644 by arrangement made by the same entity you are acting on behalf of,
3645 you may not add another; but you may replace the old one, on explicit
3646 permission from the previous publisher that added the old one.
3648 The author(s) and publisher(s) of the Document do not by this License
3649 give permission to use their names for publicity for or to assert or
3650 imply endorsement of any Modified Version.
3653 5. COMBINING DOCUMENTS
3655 You may combine the Document with other documents released under this
3656 License, under the terms defined in section 4 above for modified
3657 versions, provided that you include in the combination all of the
3658 Invariant Sections of all of the original documents, unmodified, and
3659 list them all as Invariant Sections of your combined work in its
3662 The combined work need only contain one copy of this License, and
3663 multiple identical Invariant Sections may be replaced with a single
3664 copy. If there are multiple Invariant Sections with the same name but
3665 different contents, make the title of each such section unique by
3666 adding at the end of it, in parentheses, the name of the original
3667 author or publisher of that section if known, or else a unique number.
3668 Make the same adjustment to the section titles in the list of
3669 Invariant Sections in the license notice of the combined work.
3671 In the combination, you must combine any sections entitled "History"
3672 in the various original documents, forming one section entitled
3673 "History"; likewise combine any sections entitled "Acknowledgements",
3674 and any sections entitled "Dedications". You must delete all sections
3675 entitled "Endorsements."
3678 6. COLLECTIONS OF DOCUMENTS
3680 You may make a collection consisting of the Document and other documents
3681 released under this License, and replace the individual copies of this
3682 License in the various documents with a single copy that is included in
3683 the collection, provided that you follow the rules of this License for
3684 verbatim copying of each of the documents in all other respects.
3686 You may extract a single document from such a collection, and distribute
3687 it individually under this License, provided you insert a copy of this
3688 License into the extracted document, and follow this License in all
3689 other respects regarding verbatim copying of that document.
3692 7. AGGREGATION WITH INDEPENDENT WORKS
3694 A compilation of the Document or its derivatives with other separate
3695 and independent documents or works, in or on a volume of a storage or
3696 distribution medium, does not as a whole count as a Modified Version
3697 of the Document, provided no compilation copyright is claimed for the
3698 compilation. Such a compilation is called an "aggregate", and this
3699 License does not apply to the other self-contained works thus compiled
3700 with the Document, on account of their being thus compiled, if they
3701 are not themselves derivative works of the Document.
3703 If the Cover Text requirement of section 3 is applicable to these
3704 copies of the Document, then if the Document is less than one quarter
3705 of the entire aggregate, the Document's Cover Texts may be placed on
3706 covers that surround only the Document within the aggregate.
3707 Otherwise they must appear on covers around the whole aggregate.
3712 Translation is considered a kind of modification, so you may
3713 distribute translations of the Document under the terms of section 4.
3714 Replacing Invariant Sections with translations requires special
3715 permission from their copyright holders, but you may include
3716 translations of some or all Invariant Sections in addition to the
3717 original versions of these Invariant Sections. You may include a
3718 translation of this License provided that you also include the
3719 original English version of this License. In case of a disagreement
3720 between the translation and the original English version of this
3721 License, the original English version will prevail.
3726 You may not copy, modify, sublicense, or distribute the Document except
3727 as expressly provided for under this License. Any other attempt to
3728 copy, modify, sublicense or distribute the Document is void, and will
3729 automatically terminate your rights under this License. However,
3730 parties who have received copies, or rights, from you under this
3731 License will not have their licenses terminated so long as such
3732 parties remain in full compliance.
3735 10. FUTURE REVISIONS OF THIS LICENSE
3737 The Free Software Foundation may publish new, revised versions
3738 of the GNU Free Documentation License from time to time. Such new
3739 versions will be similar in spirit to the present version, but may
3740 differ in detail to address new problems or concerns. See
3741 http://www.gnu.org/copyleft/.
3743 Each version of the License is given a distinguishing version number.
3744 If the Document specifies that a particular numbered version of this
3745 License "or any later version" applies to it, you have the option of
3746 following the terms and conditions either of that specified version or
3747 of any later version that has been published (not as a draft) by the
3748 Free Software Foundation. If the Document does not specify a version
3749 number of this License, you may choose any version ever published (not
3750 as a draft) by the Free Software Foundation.
3753 ADDENDUM: How to use this License for your documents
3755 To use this License in a document you have written, include a copy of
3756 the License in the document and put the following copyright and
3757 license notices just after the title page:
3760 Copyright (c) YEAR YOUR NAME.
3761 Permission is granted to copy, distribute and/or modify this document
3762 under the terms of the GNU Free Documentation License, Version 1.1
3763 or any later version published by the Free Software Foundation;
3764 with the Invariant Sections being LIST THEIR TITLES, with the
3765 Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
3766 A copy of the license is included in the section entitled "GNU
3767 Free Documentation License".
3770 If you have no Invariant Sections, write "with no Invariant Sections"
3771 instead of saying which ones are invariant. If you have no
3772 Front-Cover Texts, write "no Front-Cover Texts" instead of
3773 "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
3775 If your document contains nontrivial examples of program code, we
3776 recommend releasing these examples in parallel under your choice of
3777 free software license, such as the GNU General Public License,
3778 to permit their use in free software.