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{-v}|@option{--verbose}]
958 [@option{-V}|@option{--version}]
960 @var{infile} [@var{outfile}]
964 @c man begin DESCRIPTION objcopy
965 The @sc{gnu} @command{objcopy} utility copies the contents of an object
966 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
967 read and write the object files. It can write the destination object
968 file in a format different from that of the source object file. The
969 exact behavior of @command{objcopy} is controlled by command-line options.
970 Note that @command{objcopy} should be able to copy a fully linked file
971 between any two formats. However, copying a relocatable object file
972 between any two formats may not work as expected.
974 @command{objcopy} creates temporary files to do its translations and
975 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
976 translation work; it has access to all the formats described in @sc{bfd}
977 and thus is able to recognize most formats without being told
978 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
980 @command{objcopy} can be used to generate S-records by using an output
981 target of @samp{srec} (e.g., use @samp{-O srec}).
983 @command{objcopy} can be used to generate a raw binary file by using an
984 output target of @samp{binary} (e.g., use @option{-O binary}). When
985 @command{objcopy} generates a raw binary file, it will essentially produce
986 a memory dump of the contents of the input object file. All symbols and
987 relocation information will be discarded. The memory dump will start at
988 the load address of the lowest section copied into the output file.
990 When generating an S-record or a raw binary file, it may be helpful to
991 use @option{-S} to remove sections containing debugging information. In
992 some cases @option{-R} will be useful to remove sections which contain
993 information that is not needed by the binary file.
995 Note - @command{objcopy} is not able to change the endianness of its input
996 files. If the input format has an endianness, (some formats do not),
997 @command{objcopy} can only copy the inputs into file formats that have the
998 same endianness or which have no endianness (eg @samp{srec}).
1002 @c man begin OPTIONS objcopy
1006 @itemx @var{outfile}
1007 The input and output files, respectively.
1008 If you do not specify @var{outfile}, @command{objcopy} creates a
1009 temporary file and destructively renames the result with
1010 the name of @var{infile}.
1012 @item -I @var{bfdname}
1013 @itemx --input-target=@var{bfdname}
1014 Consider the source file's object format to be @var{bfdname}, rather than
1015 attempting to deduce it. @xref{Target Selection}, for more information.
1017 @item -O @var{bfdname}
1018 @itemx --output-target=@var{bfdname}
1019 Write the output file using the object format @var{bfdname}.
1020 @xref{Target Selection}, for more information.
1022 @item -F @var{bfdname}
1023 @itemx --target=@var{bfdname}
1024 Use @var{bfdname} as the object format for both the input and the output
1025 file; i.e., simply transfer data from source to destination with no
1026 translation. @xref{Target Selection}, for more information.
1028 @item -B @var{bfdarch}
1029 @itemx --binary-architecture=@var{bfdarch}
1030 Useful when transforming a raw binary input file into an object file.
1031 In this case the output architecture can be set to @var{bfdarch}. This
1032 option will be ignored if the input file has a known @var{bfdarch}. You
1033 can access this binary data inside a program by referencing the special
1034 symbols that are created by the conversion process. These symbols are
1035 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1036 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1037 an object file and then access it in your code using these symbols.
1039 @item -j @var{sectionname}
1040 @itemx --only-section=@var{sectionname}
1041 Copy only the named section from the input file to the output file.
1042 This option may be given more than once. Note that using this option
1043 inappropriately may make the output file unusable.
1045 @item -R @var{sectionname}
1046 @itemx --remove-section=@var{sectionname}
1047 Remove any section named @var{sectionname} from the output file. This
1048 option may be given more than once. Note that using this option
1049 inappropriately may make the output file unusable.
1053 Do not copy relocation and symbol information from the source file.
1056 @itemx --strip-debug
1057 Do not copy debugging symbols from the source file.
1059 @item --strip-unneeded
1060 Strip all symbols that are not needed for relocation processing.
1062 @item -K @var{symbolname}
1063 @itemx --keep-symbol=@var{symbolname}
1064 Copy only symbol @var{symbolname} from the source file. This option may
1065 be given more than once.
1067 @item -N @var{symbolname}
1068 @itemx --strip-symbol=@var{symbolname}
1069 Do not copy symbol @var{symbolname} from the source file. This option
1070 may be given more than once.
1072 @item -G @var{symbolname}
1073 @itemx --keep-global-symbol=@var{symbolname}
1074 Keep only symbol @var{symbolname} global. Make all other symbols local
1075 to the file, so that they are not visible externally. This option may
1076 be given more than once.
1078 @item -L @var{symbolname}
1079 @itemx --localize-symbol=@var{symbolname}
1080 Make symbol @var{symbolname} local to the file, so that it is not
1081 visible externally. This option may be given more than once.
1083 @item -W @var{symbolname}
1084 @itemx --weaken-symbol=@var{symbolname}
1085 Make symbol @var{symbolname} weak. This option may be given more than once.
1088 @itemx --discard-all
1089 Do not copy non-global symbols from the source file.
1090 @c FIXME any reason to prefer "non-global" to "local" here?
1093 @itemx --discard-locals
1094 Do not copy compiler-generated local symbols.
1095 (These usually start with @samp{L} or @samp{.}.)
1098 @itemx --byte=@var{byte}
1099 Keep only every @var{byte}th byte of the input file (header data is not
1100 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
1101 where @var{interleave} is given by the @option{-i} or @option{--interleave}
1102 option, or the default of 4. This option is useful for creating files
1103 to program @sc{rom}. It is typically used with an @code{srec} output
1106 @item -i @var{interleave}
1107 @itemx --interleave=@var{interleave}
1108 Only copy one out of every @var{interleave} bytes. Select which byte to
1109 copy with the @option{-b} or @option{--byte} option. The default is 4.
1110 @command{objcopy} ignores this option if you do not specify either @option{-b} or
1114 @itemx --preserve-dates
1115 Set the access and modification dates of the output file to be the same
1116 as those of the input file.
1119 Convert debugging information, if possible. This is not the default
1120 because only certain debugging formats are supported, and the
1121 conversion process can be time consuming.
1123 @item --gap-fill @var{val}
1124 Fill gaps between sections with @var{val}. This operation applies to
1125 the @emph{load address} (LMA) of the sections. It is done by increasing
1126 the size of the section with the lower address, and filling in the extra
1127 space created with @var{val}.
1129 @item --pad-to @var{address}
1130 Pad the output file up to the load address @var{address}. This is
1131 done by increasing the size of the last section. The extra space is
1132 filled in with the value specified by @option{--gap-fill} (default zero).
1134 @item --set-start @var{val}
1135 Set the start address of the new file to @var{val}. Not all object file
1136 formats support setting the start address.
1138 @item --change-start @var{incr}
1139 @itemx --adjust-start @var{incr}
1140 @cindex changing start address
1141 Change the start address by adding @var{incr}. Not all object file
1142 formats support setting the start address.
1144 @item --change-addresses @var{incr}
1145 @itemx --adjust-vma @var{incr}
1146 @cindex changing object addresses
1147 Change the VMA and LMA addresses of all sections, as well as the start
1148 address, by adding @var{incr}. Some object file formats do not permit
1149 section addresses to be changed arbitrarily. Note that this does not
1150 relocate the sections; if the program expects sections to be loaded at a
1151 certain address, and this option is used to change the sections such
1152 that they are loaded at a different address, the program may fail.
1154 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1155 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1156 @cindex changing section address
1157 Set or change both the VMA address and the LMA address of the named
1158 @var{section}. If @samp{=} is used, the section address is set to
1159 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1160 section address. See the comments under @option{--change-addresses},
1161 above. If @var{section} does not exist in the input file, a warning will
1162 be issued, unless @option{--no-change-warnings} is used.
1164 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1165 @cindex changing section LMA
1166 Set or change the LMA address of the named @var{section}. The LMA
1167 address is the address where the section will be loaded into memory at
1168 program load time. Normally this is the same as the VMA address, which
1169 is the address of the section at program run time, but on some systems,
1170 especially those where a program is held in ROM, the two can be
1171 different. If @samp{=} is used, the section address is set to
1172 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1173 section address. See the comments under @option{--change-addresses},
1174 above. If @var{section} does not exist in the input file, a warning
1175 will be issued, unless @option{--no-change-warnings} is used.
1177 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1178 @cindex changing section VMA
1179 Set or change the VMA address of the named @var{section}. The VMA
1180 address is the address where the section will be located once the
1181 program has started executing. Normally this is the same as the LMA
1182 address, which is the address where the section will be loaded into
1183 memory, but on some systems, especially those where a program is held in
1184 ROM, the two can be different. If @samp{=} is used, the section address
1185 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1186 from the section address. See the comments under
1187 @option{--change-addresses}, above. If @var{section} does not exist in
1188 the input file, a warning will be issued, unless
1189 @option{--no-change-warnings} is used.
1191 @item --change-warnings
1192 @itemx --adjust-warnings
1193 If @option{--change-section-address} or @option{--change-section-lma} or
1194 @option{--change-section-vma} is used, and the named section does not
1195 exist, issue a warning. This is the default.
1197 @item --no-change-warnings
1198 @itemx --no-adjust-warnings
1199 Do not issue a warning if @option{--change-section-address} or
1200 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1201 if the named section does not exist.
1203 @item --set-section-flags @var{section}=@var{flags}
1204 Set the flags for the named section. The @var{flags} argument is a
1205 comma separated string of flag names. The recognized names are
1206 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1207 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1208 @samp{debug}. You can set the @samp{contents} flag for a section which
1209 does not have contents, but it is not meaningful to clear the
1210 @samp{contents} flag of a section which does have contents--just remove
1211 the section instead. Not all flags are meaningful for all object file
1214 @item --add-section @var{sectionname}=@var{filename}
1215 Add a new section named @var{sectionname} while copying the file. The
1216 contents of the new section are taken from the file @var{filename}. The
1217 size of the section will be the size of the file. This option only
1218 works on file formats which can support sections with arbitrary names.
1220 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1221 Rename a section from @var{oldname} to @var{newname}, optionally
1222 changing the section's flags to @var{flags} in the process. This has
1223 the advantage over usng a linker script to perform the rename in that
1224 the output stays as an object file and does not become a linked
1227 This option is particularly helpful when the input format is binary,
1228 since this will always create a section called .data. If for example,
1229 you wanted instead to create a section called .rodata containing binary
1230 data you could use the following command line to achieve it:
1233 objcopy -I binary -O <output_format> -B <architecture> \
1234 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1235 <input_binary_file> <output_object_file>
1238 @item --change-leading-char
1239 Some object file formats use special characters at the start of
1240 symbols. The most common such character is underscore, which compilers
1241 often add before every symbol. This option tells @command{objcopy} to
1242 change the leading character of every symbol when it converts between
1243 object file formats. If the object file formats use the same leading
1244 character, this option has no effect. Otherwise, it will add a
1245 character, or remove a character, or change a character, as
1248 @item --remove-leading-char
1249 If the first character of a global symbol is a special symbol leading
1250 character used by the object file format, remove the character. The
1251 most common symbol leading character is underscore. This option will
1252 remove a leading underscore from all global symbols. This can be useful
1253 if you want to link together objects of different file formats with
1254 different conventions for symbol names. This is different from
1255 @option{--change-leading-char} because it always changes the symbol name
1256 when appropriate, regardless of the object file format of the output
1259 @item --srec-len=@var{ival}
1260 Meaningful only for srec output. Set the maximum length of the Srecords
1261 being produced to @var{ival}. This length covers both address, data and
1264 @item --srec-forceS3
1265 Meaningful only for srec output. Avoid generation of S1/S2 records,
1266 creating S3-only record format.
1268 @item --redefine-sym @var{old}=@var{new}
1269 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1270 when one is trying link two things together for which you have no
1271 source, and there are name collisions.
1274 Change all global symbols in the file to be weak. This can be useful
1275 when building an object which will be linked against other objects using
1276 the @option{-R} option to the linker. This option is only effective when
1277 using an object file format which supports weak symbols.
1279 @item --keep-symbols=@var{filename}
1280 Apply @option{--keep-symbol} option to each symbol listed in the file
1281 @var{filename}. @var{filename} is simply a flat file, with one symbol
1282 name per line. Line comments may be introduced by the hash character.
1283 This option may be given more than once.
1285 @item --strip-symbols=@var{filename}
1286 Apply @option{--strip-symbol} option to each symbol listed in the file
1287 @var{filename}. @var{filename} is simply a flat file, with one symbol
1288 name per line. Line comments may be introduced by the hash character.
1289 This option may be given more than once.
1291 @item --keep-global-symbols=@var{filename}
1292 Apply @option{--keep-global-symbol} option to each symbol listed in the
1293 file @var{filename}. @var{filename} is simply a flat file, with one
1294 symbol name per line. Line comments may be introduced by the hash
1295 character. This option may be given more than once.
1297 @item --localize-symbols=@var{filename}
1298 Apply @option{--localize-symbol} option to each symbol listed in the file
1299 @var{filename}. @var{filename} is simply a flat file, with one symbol
1300 name per line. Line comments may be introduced by the hash character.
1301 This option may be given more than once.
1303 @item --weaken-symbols=@var{filename}
1304 Apply @option{--weaken-symbol} option to each symbol listed in the file
1305 @var{filename}. @var{filename} is simply a flat file, with one symbol
1306 name per line. Line comments may be introduced by the hash character.
1307 This option may be given more than once.
1311 Show the version number of @command{objcopy}.
1315 Verbose output: list all object files modified. In the case of
1316 archives, @samp{objcopy -V} lists all members of the archive.
1319 Show a summary of the options to @command{objcopy}.
1325 @c man begin SEEALSO objcopy
1326 ld(1), objdump(1), and the Info entries for @file{binutils}.
1333 @cindex object file information
1336 @c man title objdump display information from object files.
1339 @c man begin SYNOPSIS objdump
1340 objdump [@option{-a}|@option{--archive-headers}]
1341 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1342 [@option{-C}|@option{--demangle}[=@var{style}] ]
1343 [@option{-d}|@option{--disassemble}]
1344 [@option{-D}|@option{--disassemble-all}]
1345 [@option{-z}|@option{--disassemble-zeroes}]
1346 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1347 [@option{-f}|@option{--file-headers}]
1348 [@option{--file-start-context}]
1349 [@option{-g}|@option{--debugging}]
1350 [@option{-h}|@option{--section-headers}|@option{--headers}]
1351 [@option{-i}|@option{--info}]
1352 [@option{-j} @var{section}|@option{--section=}@var{section}]
1353 [@option{-l}|@option{--line-numbers}]
1354 [@option{-S}|@option{--source}]
1355 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1356 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1357 [@option{-p}|@option{--private-headers}]
1358 [@option{-r}|@option{--reloc}]
1359 [@option{-R}|@option{--dynamic-reloc}]
1360 [@option{-s}|@option{--full-contents}]
1361 [@option{-G}|@option{--stabs}]
1362 [@option{-t}|@option{--syms}]
1363 [@option{-T}|@option{--dynamic-syms}]
1364 [@option{-x}|@option{--all-headers}]
1365 [@option{-w}|@option{--wide}]
1366 [@option{--start-address=}@var{address}]
1367 [@option{--stop-address=}@var{address}]
1368 [@option{--prefix-addresses}]
1369 [@option{--[no-]show-raw-insn}]
1370 [@option{--adjust-vma=}@var{offset}]
1371 [@option{-V}|@option{--version}]
1372 [@option{-H}|@option{--help}]
1373 @var{objfile}@dots{}
1377 @c man begin DESCRIPTION objdump
1379 @command{objdump} displays information about one or more object files.
1380 The options control what particular information to display. This
1381 information is mostly useful to programmers who are working on the
1382 compilation tools, as opposed to programmers who just want their
1383 program to compile and work.
1385 @var{objfile}@dots{} are the object files to be examined. When you
1386 specify archives, @command{objdump} shows information on each of the member
1391 @c man begin OPTIONS objdump
1393 The long and short forms of options, shown here as alternatives, are
1394 equivalent. At least one option from the list
1395 @option{-a,-d,-D,-f,-g,-G,-h,-H,-p,-r,-R,-S,-t,-T,-V,-x} must be given.
1399 @itemx --archive-header
1400 @cindex archive headers
1401 If any of the @var{objfile} files are archives, display the archive
1402 header information (in a format similar to @samp{ls -l}). Besides the
1403 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1404 the object file format of each archive member.
1406 @item --adjust-vma=@var{offset}
1407 @cindex section addresses in objdump
1408 @cindex VMA in objdump
1409 When dumping information, first add @var{offset} to all the section
1410 addresses. This is useful if the section addresses do not correspond to
1411 the symbol table, which can happen when putting sections at particular
1412 addresses when using a format which can not represent section addresses,
1415 @item -b @var{bfdname}
1416 @itemx --target=@var{bfdname}
1417 @cindex object code format
1418 Specify that the object-code format for the object files is
1419 @var{bfdname}. This option may not be necessary; @var{objdump} can
1420 automatically recognize many formats.
1424 objdump -b oasys -m vax -h fu.o
1427 displays summary information from the section headers (@option{-h}) of
1428 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1429 file in the format produced by Oasys compilers. You can list the
1430 formats available with the @option{-i} option.
1431 @xref{Target Selection}, for more information.
1434 @itemx --demangle[=@var{style}]
1435 @cindex demangling in objdump
1436 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1437 Besides removing any initial underscore prepended by the system, this
1438 makes C++ function names readable. Different compilers have different
1439 mangling styles. The optional demangling style argument can be used to
1440 choose an appropriate demangling style for your compiler. @xref{c++filt},
1441 for more information on demangling.
1445 Display debugging information. This attempts to parse debugging
1446 information stored in the file and print it out using a C like syntax.
1447 Only certain types of debugging information have been implemented.
1450 @itemx --disassemble
1451 @cindex disassembling object code
1452 @cindex machine instructions
1453 Display the assembler mnemonics for the machine instructions from
1454 @var{objfile}. This option only disassembles those sections which are
1455 expected to contain instructions.
1458 @itemx --disassemble-all
1459 Like @option{-d}, but disassemble the contents of all sections, not just
1460 those expected to contain instructions.
1462 @item --prefix-addresses
1463 When disassembling, print the complete address on each line. This is
1464 the older disassembly format.
1466 @item --disassemble-zeroes
1467 Normally the disassembly output will skip blocks of zeroes. This
1468 option directs the disassembler to disassemble those blocks, just like
1473 @itemx --endian=@{big|little@}
1475 @cindex disassembly endianness
1476 Specify the endianness of the object files. This only affects
1477 disassembly. This can be useful when disassembling a file format which
1478 does not describe endianness information, such as S-records.
1481 @itemx --file-header
1482 @cindex object file header
1483 Display summary information from the overall header of
1484 each of the @var{objfile} files.
1486 @item --file-start-context
1487 @cindex source code context
1488 Specify that when displaying interlisted source code/disassembly
1489 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1490 context to the start of the file.
1493 @itemx --section-header
1495 @cindex section headers
1496 Display summary information from the section headers of the
1499 File segments may be relocated to nonstandard addresses, for example by
1500 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1501 @command{ld}. However, some object file formats, such as a.out, do not
1502 store the starting address of the file segments. In those situations,
1503 although @command{ld} relocates the sections correctly, using @samp{objdump
1504 -h} to list the file section headers cannot show the correct addresses.
1505 Instead, it shows the usual addresses, which are implicit for the
1509 Print a summary of the options to @command{objdump} and exit.
1513 @cindex architectures available
1514 @cindex object formats available
1515 Display a list showing all architectures and object formats available
1516 for specification with @option{-b} or @option{-m}.
1519 @itemx --section=@var{name}
1520 @cindex section information
1521 Display information only for section @var{name}.
1524 @itemx --line-numbers
1525 @cindex source filenames for object files
1526 Label the display (using debugging information) with the filename and
1527 source line numbers corresponding to the object code or relocs shown.
1528 Only useful with @option{-d}, @option{-D}, or @option{-r}.
1530 @item -m @var{machine}
1531 @itemx --architecture=@var{machine}
1532 @cindex architecture
1533 @cindex disassembly architecture
1534 Specify the architecture to use when disassembling object files. This
1535 can be useful when disassembling object files which do not describe
1536 architecture information, such as S-records. You can list the available
1537 architectures with the @option{-i} option.
1539 @item -M @var{options}
1540 @itemx --disassembler-options=@var{options}
1541 Pass target specific information to the disassembler. Only supported on
1544 If the target is an ARM architecture then this switch can be used to
1545 select which register name set is used during disassembler. Specifying
1546 @option{-M reg-name-std} (the default) will select the register names as
1547 used in ARM's instruction set documentation, but with register 13 called
1548 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
1549 @option{-M reg-names-apcs} will select the name set used by the ARM
1550 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
1551 just use @samp{r} followed by the register number.
1553 There are also two variants on the APCS register naming scheme enabled
1554 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
1555 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
1556 with the normal register name or the special register names).
1558 This option can also be used for ARM architectures to force the
1559 disassembler to interpret all instructions as THUMB instructions by
1560 using the switch @option{--disassembler-options=force-thumb}. This can be
1561 useful when attempting to disassemble thumb code produced by other
1565 @itemx --private-headers
1566 Print information that is specific to the object file format. The exact
1567 information printed depends upon the object file format. For some
1568 object file formats, no additional information is printed.
1572 @cindex relocation entries, in object file
1573 Print the relocation entries of the file. If used with @option{-d} or
1574 @option{-D}, the relocations are printed interspersed with the
1578 @itemx --dynamic-reloc
1579 @cindex dynamic relocation entries, in object file
1580 Print the dynamic relocation entries of the file. This is only
1581 meaningful for dynamic objects, such as certain types of shared
1585 @itemx --full-contents
1586 @cindex sections, full contents
1587 @cindex object file sections
1588 Display the full contents of any sections requested.
1592 @cindex source disassembly
1593 @cindex disassembly, with source
1594 Display source code intermixed with disassembly, if possible. Implies
1597 @item --show-raw-insn
1598 When disassembling instructions, print the instruction in hex as well as
1599 in symbolic form. This is the default except when
1600 @option{--prefix-addresses} is used.
1602 @item --no-show-raw-insn
1603 When disassembling instructions, do not print the instruction bytes.
1604 This is the default when @option{--prefix-addresses} is used.
1610 @cindex debug symbols
1611 @cindex ELF object file format
1612 Display the full contents of any sections requested. Display the
1613 contents of the .stab and .stab.index and .stab.excl sections from an
1614 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1615 @code{.stab} debugging symbol-table entries are carried in an ELF
1616 section. In most other file formats, debugging symbol-table entries are
1617 interleaved with linkage symbols, and are visible in the @option{--syms}
1620 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1621 Overview,stabs.info, The ``stabs'' debug format}.
1624 @item --start-address=@var{address}
1625 @cindex start-address
1626 Start displaying data at the specified address. This affects the output
1627 of the @option{-d}, @option{-r} and @option{-s} options.
1629 @item --stop-address=@var{address}
1630 @cindex stop-address
1631 Stop displaying data at the specified address. This affects the output
1632 of the @option{-d}, @option{-r} and @option{-s} options.
1636 @cindex symbol table entries, printing
1637 Print the symbol table entries of the file.
1638 This is similar to the information provided by the @samp{nm} program.
1641 @itemx --dynamic-syms
1642 @cindex dynamic symbol table entries, printing
1643 Print the dynamic symbol table entries of the file. This is only
1644 meaningful for dynamic objects, such as certain types of shared
1645 libraries. This is similar to the information provided by the @samp{nm}
1646 program when given the @option{-D} (@option{--dynamic}) option.
1649 Print the version number of @command{objdump} and exit.
1653 @cindex all header information, object file
1654 @cindex header information, all
1655 Display all available header information, including the symbol table and
1656 relocation entries. Using @option{-x} is equivalent to specifying all of
1657 @option{-a -f -h -r -t}.
1661 @cindex wide output, printing
1662 Format some lines for output devices that have more than 80 columns.
1668 @c man begin SEEALSO objdump
1669 nm(1), readelf(1), and the Info entries for @file{binutils}.
1677 @cindex archive contents
1678 @cindex symbol index
1680 @c man title ranlib generate index to archive.
1683 @c man begin SYNOPSIS ranlib
1684 ranlib [@option{-vV}] @var{archive}
1688 @c man begin DESCRIPTION ranlib
1690 @command{ranlib} generates an index to the contents of an archive and
1691 stores it in the archive. The index lists each symbol defined by a
1692 member of an archive that is a relocatable object file.
1694 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
1696 An archive with such an index speeds up linking to the library and
1697 allows routines in the library to call each other without regard to
1698 their placement in the archive.
1700 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
1701 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
1706 @c man begin OPTIONS ranlib
1712 Show the version number of @command{ranlib}.
1718 @c man begin SEEALSO ranlib
1719 ar(1), nm(1), and the Info entries for @file{binutils}.
1727 @cindex section sizes
1729 @c man title size list section sizes and total size.
1732 @c man begin SYNOPSIS size
1733 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
1734 [@option{--help}] [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
1735 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
1736 [@var{objfile}@dots{}]
1740 @c man begin DESCRIPTION size
1742 The @sc{gnu} @command{size} utility lists the section sizes---and the total
1743 size---for each of the object or archive files @var{objfile} in its
1744 argument list. By default, one line of output is generated for each
1745 object file or each module in an archive.
1747 @var{objfile}@dots{} are the object files to be examined.
1748 If none are specified, the file @code{a.out} will be used.
1752 @c man begin OPTIONS size
1754 The command line options have the following meanings:
1759 @itemx --format=@var{compatibility}
1760 @cindex @command{size} display format
1761 Using one of these options, you can choose whether the output from @sc{gnu}
1762 @command{size} resembles output from System V @command{size} (using @option{-A},
1763 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
1764 @option{--format=berkeley}). The default is the one-line format similar to
1766 @c Bonus for doc-source readers: you can also say --format=strange (or
1767 @c anything else that starts with 's') for sysv, and --format=boring (or
1768 @c anything else that starts with 'b') for Berkeley.
1770 Here is an example of the Berkeley (default) format of output from
1773 $ size --format=Berkeley ranlib size
1774 text data bss dec hex filename
1775 294880 81920 11592 388392 5ed28 ranlib
1776 294880 81920 11888 388688 5ee50 size
1780 This is the same data, but displayed closer to System V conventions:
1783 $ size --format=SysV ranlib size
1801 Show a summary of acceptable arguments and options.
1806 @itemx --radix=@var{number}
1807 @cindex @command{size} number format
1808 @cindex radix for section sizes
1809 Using one of these options, you can control whether the size of each
1810 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
1811 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
1812 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
1813 values (8, 10, 16) are supported. The total size is always given in two
1814 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
1815 octal and hexadecimal if you're using @option{-o}.
1817 @item --target=@var{bfdname}
1818 @cindex object code format
1819 Specify that the object-code format for @var{objfile} is
1820 @var{bfdname}. This option may not be necessary; @command{size} can
1821 automatically recognize many formats.
1822 @xref{Target Selection}, for more information.
1826 Display the version number of @command{size}.
1832 @c man begin SEEALSO size
1833 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
1840 @cindex listings strings
1841 @cindex printing strings
1842 @cindex strings, printing
1844 @c man title strings print the strings of printable characters in files.
1847 @c man begin SYNOPSIS strings
1848 strings [@option{-afov}] [@option{-}@var{min-len}] [@option{-n} @var{min-len}] [@option{-t} @var{radix}] [@option{-}]
1849 [@option{--all}] [@option{--print-file-name}] [@option{--bytes=}@var{min-len}]
1850 [@option{--radix=}@var{radix}] [@option{--target=}@var{bfdname}]
1851 [@option{--help}] [@option{--version}] @var{file}@dots{}
1855 @c man begin DESCRIPTION strings
1857 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
1858 character sequences that are at least 4 characters long (or the number
1859 given with the options below) and are followed by an unprintable
1860 character. By default, it only prints the strings from the initialized
1861 and loaded sections of object files; for other types of files, it prints
1862 the strings from the whole file.
1864 @command{strings} is mainly useful for determining the contents of non-text
1869 @c man begin OPTIONS strings
1875 Do not scan only the initialized and loaded sections of object files;
1876 scan the whole files.
1879 @itemx --print-file-name
1880 Print the name of the file before each string.
1883 Print a summary of the program usage on the standard output and exit.
1885 @item -@var{min-len}
1886 @itemx -n @var{min-len}
1887 @itemx --bytes=@var{min-len}
1888 Print sequences of characters that are at least @var{min-len} characters
1889 long, instead of the default 4.
1892 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
1893 act like @samp{-t d} instead. Since we can not be compatible with both
1894 ways, we simply chose one.
1896 @item -t @var{radix}
1897 @itemx --radix=@var{radix}
1898 Print the offset within the file before each string. The single
1899 character argument specifies the radix of the offset---@samp{o} for
1900 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1902 @item --target=@var{bfdname}
1903 @cindex object code format
1904 Specify an object code format other than your system's default format.
1905 @xref{Target Selection}, for more information.
1909 Print the program version number on the standard output and exit.
1915 @c man begin SEEALSO strings
1916 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
1917 and the Info entries for @file{binutils}.
1925 @cindex removing symbols
1926 @cindex discarding symbols
1927 @cindex symbols, discarding
1929 @c man title strip Discard symbols from object files.
1932 @c man begin SYNOPSIS strip
1933 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname} ]
1934 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname} ]
1935 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname} ]
1936 [@option{-s}|@option{--strip-all}] [@option{-S}|@option{-g}|@option{--strip-debug}]
1937 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname} ]
1938 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname} ]
1939 [@option{-x}|@option{--discard-all} ] [@option{-X} |@option{--discard-locals}]
1940 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname} ]
1941 [@option{-o} @var{file} ] [@option{-p}|@option{--preserve-dates}]
1942 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}] [@option{--help}]
1943 @var{objfile}@dots{}
1947 @c man begin DESCRIPTION strip
1949 @sc{gnu} @command{strip} discards all symbols from object files
1950 @var{objfile}. The list of object files may include archives.
1951 At least one object file must be given.
1953 @command{strip} modifies the files named in its argument,
1954 rather than writing modified copies under different names.
1958 @c man begin OPTIONS strip
1961 @item -F @var{bfdname}
1962 @itemx --target=@var{bfdname}
1963 Treat the original @var{objfile} as a file with the object
1964 code format @var{bfdname}, and rewrite it in the same format.
1965 @xref{Target Selection}, for more information.
1968 Show a summary of the options to @command{strip} and exit.
1970 @item -I @var{bfdname}
1971 @itemx --input-target=@var{bfdname}
1972 Treat the original @var{objfile} as a file with the object
1973 code format @var{bfdname}.
1974 @xref{Target Selection}, for more information.
1976 @item -O @var{bfdname}
1977 @itemx --output-target=@var{bfdname}
1978 Replace @var{objfile} with a file in the output format @var{bfdname}.
1979 @xref{Target Selection}, for more information.
1981 @item -R @var{sectionname}
1982 @itemx --remove-section=@var{sectionname}
1983 Remove any section named @var{sectionname} from the output file. This
1984 option may be given more than once. Note that using this option
1985 inappropriately may make the output file unusable.
1993 @itemx --strip-debug
1994 Remove debugging symbols only.
1996 @item --strip-unneeded
1997 Remove all symbols that are not needed for relocation processing.
1999 @item -K @var{symbolname}
2000 @itemx --keep-symbol=@var{symbolname}
2001 Keep only symbol @var{symbolname} from the source file. This option may
2002 be given more than once.
2004 @item -N @var{symbolname}
2005 @itemx --strip-symbol=@var{symbolname}
2006 Remove symbol @var{symbolname} from the source file. This option may be
2007 given more than once, and may be combined with strip options other than
2011 Put the stripped output in @var{file}, rather than replacing the
2012 existing file. When this argument is used, only one @var{objfile}
2013 argument may be specified.
2016 @itemx --preserve-dates
2017 Preserve the access and modification dates of the file.
2020 @itemx --discard-all
2021 Remove non-global symbols.
2024 @itemx --discard-locals
2025 Remove compiler-generated local symbols.
2026 (These usually start with @samp{L} or @samp{.}.)
2030 Show the version number for @command{strip}.
2034 Verbose output: list all object files modified. In the case of
2035 archives, @samp{strip -v} lists all members of the archive.
2041 @c man begin SEEALSO strip
2042 the Info entries for @file{binutils}.
2046 @node c++filt, addr2line, strip, Top
2050 @cindex demangling C++ symbols
2052 @c man title cxxfilt Demangle C++ and Java symbols.
2055 @c man begin SYNOPSIS cxxfilt
2056 c++filt [@option{-_}|@option{--strip-underscores}]
2057 [@option{-j}|@option{--java}]
2058 [@option{-n}|@option{--no-strip-underscores}]
2059 [@option{-s} @var{format}|@option{--format=}@var{format}]
2060 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2064 @c man begin DESCRIPTION cxxfilt
2067 The C++ and Java languages provides function overloading, which means
2068 that you can write many functions with the same name (providing each
2069 takes parameters of different types). All C++ and Java function names
2070 are encoded into a low-level assembly label (this process is known as
2071 @dfn{mangling}). The @command{c++filt}
2072 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2073 MS-DOS this program is named @command{cxxfilt}.}
2074 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2075 names into user-level names so that the linker can keep these overloaded
2076 functions from clashing.
2078 Every alphanumeric word (consisting of letters, digits, underscores,
2079 dollars, or periods) seen in the input is a potential label. If the
2080 label decodes into a C++ name, the C++ name replaces the low-level
2083 You can use @command{c++filt} to decipher individual symbols:
2086 c++filt @var{symbol}
2089 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
2090 names from the standard input and writes the demangled names to the
2091 standard output. All results are printed on the standard output.
2095 @c man begin OPTIONS cxxfilt
2099 @itemx --strip-underscores
2100 On some systems, both the C and C++ compilers put an underscore in front
2101 of every name. For example, the C name @code{foo} gets the low-level
2102 name @code{_foo}. This option removes the initial underscore. Whether
2103 @command{c++filt} removes the underscore by default is target dependent.
2107 Prints demangled names using Java syntax. The default is to use C++
2111 @itemx --no-strip-underscores
2112 Do not remove the initial underscore.
2114 @item -s @var{format}
2115 @itemx --format=@var{format}
2116 @sc{gnu} @command{nm} can decode three different methods of mangling, used by
2117 different C++ compilers. The argument to this option selects which
2122 the one used by the @sc{gnu} compiler (the default method)
2124 the one used by the Lucid compiler
2126 the one specified by the C++ Annotated Reference Manual
2128 the one used by the HP compiler
2130 the one used by the EDG compiler
2132 the one used by the @sc{gnu} compiler with the new ABI.
2136 Print a summary of the options to @command{c++filt} and exit.
2139 Print the version number of @command{c++filt} and exit.
2145 @c man begin SEEALSO cxxfilt
2146 the Info entries for @file{binutils}.
2151 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
2152 user interface are subject to change in future releases. In particular,
2153 a command-line option may be required in the the future to decode a name
2154 passed as an argument on the command line; in other words,
2157 c++filt @var{symbol}
2161 may in a future release become
2164 c++filt @var{option} @var{symbol}
2172 @cindex address to file name and line number
2174 @c man title addr2line convert addresses into file names and line numbers.
2177 @c man begin SYNOPSIS addr2line
2178 addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
2179 [@option{-C}|@option{--demangle}[=@var{style}]
2180 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
2181 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
2182 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
2187 @c man begin DESCRIPTION addr2line
2189 @command{addr2line} translates program addresses into file names and line
2190 numbers. Given an address and an executable, it uses the debugging
2191 information in the executable to figure out which file name and line
2192 number are associated with a given address.
2194 The executable to use is specified with the @option{-e} option. The
2195 default is the file @file{a.out}.
2197 @command{addr2line} has two modes of operation.
2199 In the first, hexadecimal addresses are specified on the command line,
2200 and @command{addr2line} displays the file name and line number for each
2203 In the second, @command{addr2line} reads hexadecimal addresses from
2204 standard input, and prints the file name and line number for each
2205 address on standard output. In this mode, @command{addr2line} may be used
2206 in a pipe to convert dynamically chosen addresses.
2208 The format of the output is @samp{FILENAME:LINENO}. The file name and
2209 line number for each address is printed on a separate line. If the
2210 @command{-f} option is used, then each @samp{FILENAME:LINENO} line is
2211 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2212 containing the address.
2214 If the file name or function name can not be determined,
2215 @command{addr2line} will print two question marks in their place. If the
2216 line number can not be determined, @command{addr2line} will print 0.
2220 @c man begin OPTIONS addr2line
2222 The long and short forms of options, shown here as alternatives, are
2226 @item -b @var{bfdname}
2227 @itemx --target=@var{bfdname}
2228 @cindex object code format
2229 Specify that the object-code format for the object files is
2233 @itemx --demangle[=@var{style}]
2234 @cindex demangling in objdump
2235 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2236 Besides removing any initial underscore prepended by the system, this
2237 makes C++ function names readable. Different compilers have different
2238 mangling styles. The optional demangling style argument can be used to
2239 choose an appropriate demangling style for your compiler. @xref{c++filt},
2240 for more information on demangling.
2242 @item -e @var{filename}
2243 @itemx --exe=@var{filename}
2244 Specify the name of the executable for which addresses should be
2245 translated. The default file is @file{a.out}.
2249 Display function names as well as file and line number information.
2253 Display only the base of each file name.
2259 @c man begin SEEALSO addr2line
2260 Info entries for @file{binutils}.
2267 @command{nlmconv} converts a relocatable object file into a NetWare
2271 @command{nlmconv} currently works with @samp{i386} object
2272 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
2273 object files in @sc{elf}, or @code{a.out} format@footnote{
2274 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
2275 format in the Binary File Descriptor library. It has only been tested
2276 with the above formats.}.
2280 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
2281 utilities, since it is only useful for NLM targets.
2284 @c man title nlmconv converts object code into an NLM.
2287 @c man begin SYNOPSIS nlmconv
2288 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
2289 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
2290 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
2291 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
2292 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
2293 @var{infile} @var{outfile}
2297 @c man begin DESCRIPTION nlmconv
2299 @command{nlmconv} converts the relocatable @samp{i386} object file
2300 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
2301 reading @var{headerfile} for NLM header information. For instructions
2302 on writing the NLM command file language used in header files, see the
2303 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
2304 Development and Tools Overview}, which is part of the NLM Software
2305 Developer's Kit (``NLM SDK''), available from Novell, Inc.
2306 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
2309 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
2312 @command{nlmconv} can perform a link step. In other words, you can list
2313 more than one object file for input if you list them in the definitions
2314 file (rather than simply specifying one input file on the command line).
2315 In this case, @command{nlmconv} calls the linker for you.
2319 @c man begin OPTIONS nlmconv
2322 @item -I @var{bfdname}
2323 @itemx --input-target=@var{bfdname}
2324 Object format of the input file. @command{nlmconv} can usually determine
2325 the format of a given file (so no default is necessary).
2326 @xref{Target Selection}, for more information.
2328 @item -O @var{bfdname}
2329 @itemx --output-target=@var{bfdname}
2330 Object format of the output file. @command{nlmconv} infers the output
2331 format based on the input format, e.g. for a @samp{i386} input file the
2332 output format is @samp{nlm32-i386}.
2333 @xref{Target Selection}, for more information.
2335 @item -T @var{headerfile}
2336 @itemx --header-file=@var{headerfile}
2337 Reads @var{headerfile} for NLM header information. For instructions on
2338 writing the NLM command file language used in header files, see@ see the
2339 @samp{linkers} section, of the @cite{NLM Development and Tools
2340 Overview}, which is part of the NLM Software Developer's Kit, available
2345 Displays (on standard error) the linker command line used by @command{nlmconv}.
2347 @item -l @var{linker}
2348 @itemx --linker=@var{linker}
2349 Use @var{linker} for any linking. @var{linker} can be an absolute or a
2354 Prints a usage summary.
2358 Prints the version number for @command{nlmconv}.
2364 @c man begin SEEALSO nlmconv
2365 the Info entries for @file{binutils}.
2372 @command{windres} may be used to manipulate Windows resources.
2375 @emph{Warning:} @command{windres} is not always built as part of the binary
2376 utilities, since it is only useful for Windows targets.
2379 @c man title windres manipulate Windows resources.
2382 @c man begin SYNOPSIS windres
2383 windres [options] [input-file] [output-file]
2387 @c man begin DESCRIPTION windres
2389 @command{windres} reads resources from an input file and copies them into
2390 an output file. Either file may be in one of three formats:
2394 A text format read by the Resource Compiler.
2397 A binary format generated by the Resource Compiler.
2400 A COFF object or executable.
2403 The exact description of these different formats is available in
2404 documentation from Microsoft.
2406 When @command{windres} converts from the @code{rc} format to the @code{res}
2407 format, it is acting like the Windows Resource Compiler. When
2408 @command{windres} converts from the @code{res} format to the @code{coff}
2409 format, it is acting like the Windows @code{CVTRES} program.
2411 When @command{windres} generates an @code{rc} file, the output is similar
2412 but not identical to the format expected for the input. When an input
2413 @code{rc} file refers to an external filename, an output @code{rc} file
2414 will instead include the file contents.
2416 If the input or output format is not specified, @command{windres} will
2417 guess based on the file name, or, for the input file, the file contents.
2418 A file with an extension of @file{.rc} will be treated as an @code{rc}
2419 file, a file with an extension of @file{.res} will be treated as a
2420 @code{res} file, and a file with an extension of @file{.o} or
2421 @file{.exe} will be treated as a @code{coff} file.
2423 If no output file is specified, @command{windres} will print the resources
2424 in @code{rc} format to standard output.
2426 The normal use is for you to write an @code{rc} file, use @command{windres}
2427 to convert it to a COFF object file, and then link the COFF file into
2428 your application. This will make the resources described in the
2429 @code{rc} file available to Windows.
2433 @c man begin OPTIONS windres
2436 @item -i @var{filename}
2437 @itemx --input @var{filename}
2438 The name of the input file. If this option is not used, then
2439 @command{windres} will use the first non-option argument as the input file
2440 name. If there are no non-option arguments, then @command{windres} will
2441 read from standard input. @command{windres} can not read a COFF file from
2444 @item -o @var{filename}
2445 @itemx --output @var{filename}
2446 The name of the output file. If this option is not used, then
2447 @command{windres} will use the first non-option argument, after any used
2448 for the input file name, as the output file name. If there is no
2449 non-option argument, then @command{windres} will write to standard output.
2450 @command{windres} can not write a COFF file to standard output.
2452 @item -I @var{format}
2453 @itemx --input-format @var{format}
2454 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
2455 @samp{coff}. If no input format is specified, @command{windres} will
2456 guess, as described above.
2458 @item -O @var{format}
2459 @itemx --output-format @var{format}
2460 The output format to generate. @var{format} may be @samp{res},
2461 @samp{rc}, or @samp{coff}. If no output format is specified,
2462 @command{windres} will guess, as described above.
2464 @item -F @var{target}
2465 @itemx --target @var{target}
2466 Specify the BFD format to use for a COFF file as input or output. This
2467 is a BFD target name; you can use the @option{--help} option to see a list
2468 of supported targets. Normally @command{windres} will use the default
2469 format, which is the first one listed by the @option{--help} option.
2471 @ref{Target Selection}.
2474 @item --preprocessor @var{program}
2475 When @command{windres} reads an @code{rc} file, it runs it through the C
2476 preprocessor first. This option may be used to specify the preprocessor
2477 to use, including any leading arguments. The default preprocessor
2478 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
2480 @item --include-dir @var{directory}
2481 Specify an include directory to use when reading an @code{rc} file.
2482 @command{windres} will pass this to the preprocessor as an @option{-I}
2483 option. @command{windres} will also search this directory when looking for
2484 files named in the @code{rc} file.
2486 @item -D @var{target}
2487 @itemx --define @var{sym}[=@var{val}]
2488 Specify a @option{-D} option to pass to the preprocessor when reading an
2492 Enable verbose mode. This tells you what the preprocessor is if you
2495 @item --language @var{val}
2496 Specify the default language to use when reading an @code{rc} file.
2497 @var{val} should be a hexadecimal language code. The low eight bits are
2498 the language, and the high eight bits are the sublanguage.
2500 @item --use-temp-file
2501 Use a temporary file to instead of using popen to read the output of
2502 the preprocessor. Use this option if the popen implementation is buggy
2503 on the host (eg., certain non-English language versions of Windows 95 and
2504 Windows 98 are known to have buggy popen where the output will instead
2507 @item --no-use-temp-file
2508 Use popen, not a temporary file, to read the output of the preprocessor.
2509 This is the default behaviour.
2512 Prints a usage summary.
2515 Prints the version number for @command{windres}.
2518 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
2519 this will turn on parser debugging.
2525 @c man begin SEEALSO windres
2526 the Info entries for @file{binutils}.
2531 @chapter Create files needed to build and use DLLs
2535 @command{dlltool} may be used to create the files needed to build and use
2536 dynamic link libraries (DLLs).
2539 @emph{Warning:} @command{dlltool} is not always built as part of the binary
2540 utilities, since it is only useful for those targets which support DLLs.
2543 @c man title dlltool Create files needed to build and use DLLs.
2546 @c man begin SYNOPSIS dlltool
2547 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
2548 [@option{-b}|@option{--base-file} @var{base-file-name}]
2549 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
2550 [@option{-z}|@option{--output-def} @var{def-file-name}]
2551 [@option{-l}|@option{--output-lib} @var{library-file-name}]
2552 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
2553 [@option{--exclude-symbols} @var{list}]
2554 [@option{--no-default-excludes}]
2555 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
2556 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
2557 [@option{-a}|@option{--add-indirect}] [@option{-U}|@option{--add-underscore}] [@option{-k}|@option{--kill-at}]
2558 [@option{-A}|@option{--add-stdcall-alias}]
2559 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}] [@option{-i}|@option{--interwork}]
2560 [@option{-n}|@option{--nodelete}] [@option{-v}|@option{--verbose}]
2561 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
2562 [object-file @dots{}]
2566 @c man begin DESCRIPTION dlltool
2568 @command{dlltool} reads its inputs, which can come from the @option{-d} and
2569 @option{-b} options as well as object files specified on the command
2570 line. It then processes these inputs and if the @option{-e} option has
2571 been specified it creates a exports file. If the @option{-l} option
2572 has been specified it creates a library file and if the @option{-z} option
2573 has been specified it creates a def file. Any or all of the @option{-e},
2574 @option{-l} and @option{-z} options can be present in one invocation of
2577 When creating a DLL, along with the source for the DLL, it is necessary
2578 to have three other files. @command{dlltool} can help with the creation of
2581 The first file is a @samp{.def} file which specifies which functions are
2582 exported from the DLL, which functions the DLL imports, and so on. This
2583 is a text file and can be created by hand, or @command{dlltool} can be used
2584 to create it using the @option{-z} option. In this case @command{dlltool}
2585 will scan the object files specified on its command line looking for
2586 those functions which have been specially marked as being exported and
2587 put entries for them in the .def file it creates.
2589 In order to mark a function as being exported from a DLL, it needs to
2590 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
2591 section of the object file. This can be done in C by using the
2595 asm (".section .drectve");
2596 asm (".ascii \"-export:my_func\"");
2598 int my_func (void) @{ @dots{} @}
2601 The second file needed for DLL creation is an exports file. This file
2602 is linked with the object files that make up the body of the DLL and it
2603 handles the interface between the DLL and the outside world. This is a
2604 binary file and it can be created by giving the @option{-e} option to
2605 @command{dlltool} when it is creating or reading in a .def file.
2607 The third file needed for DLL creation is the library file that programs
2608 will link with in order to access the functions in the DLL. This file
2609 can be created by giving the @option{-l} option to dlltool when it
2610 is creating or reading in a .def file.
2612 @command{dlltool} builds the library file by hand, but it builds the
2613 exports file by creating temporary files containing assembler statements
2614 and then assembling these. The @option{-S} command line option can be
2615 used to specify the path to the assembler that dlltool will use,
2616 and the @option{-f} option can be used to pass specific flags to that
2617 assembler. The @option{-n} can be used to prevent dlltool from deleting
2618 these temporary assembler files when it is done, and if @option{-n} is
2619 specified twice then this will prevent dlltool from deleting the
2620 temporary object files it used to build the library.
2622 Here is an example of creating a DLL from a source file @samp{dll.c} and
2623 also creating a program (from an object file called @samp{program.o})
2628 dlltool -e exports.o -l dll.lib dll.o
2629 gcc dll.o exports.o -o dll.dll
2630 gcc program.o dll.lib -o program
2635 @c man begin OPTIONS dlltool
2637 The command line options have the following meanings:
2641 @item -d @var{filename}
2642 @itemx --input-def @var{filename}
2643 @cindex input .def file
2644 Specifies the name of a .def file to be read in and processed.
2646 @item -b @var{filename}
2647 @itemx --base-file @var{filename}
2649 Specifies the name of a base file to be read in and processed. The
2650 contents of this file will be added to the relocation section in the
2651 exports file generated by dlltool.
2653 @item -e @var{filename}
2654 @itemx --output-exp @var{filename}
2655 Specifies the name of the export file to be created by dlltool.
2657 @item -z @var{filename}
2658 @itemx --output-def @var{filename}
2659 Specifies the name of the .def file to be created by dlltool.
2661 @item -l @var{filename}
2662 @itemx --output-lib @var{filename}
2663 Specifies the name of the library file to be created by dlltool.
2665 @item --export-all-symbols
2666 Treat all global and weak defined symbols found in the input object
2667 files as symbols to be exported. There is a small list of symbols which
2668 are not exported by default; see the @option{--no-default-excludes}
2669 option. You may add to the list of symbols to not export by using the
2670 @option{--exclude-symbols} option.
2672 @item --no-export-all-symbols
2673 Only export symbols explicitly listed in an input .def file or in
2674 @samp{.drectve} sections in the input object files. This is the default
2675 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
2676 attributes in the source code.
2678 @item --exclude-symbols @var{list}
2679 Do not export the symbols in @var{list}. This is a list of symbol names
2680 separated by comma or colon characters. The symbol names should not
2681 contain a leading underscore. This is only meaningful when
2682 @option{--export-all-symbols} is used.
2684 @item --no-default-excludes
2685 When @option{--export-all-symbols} is used, it will by default avoid
2686 exporting certain special symbols. The current list of symbols to avoid
2687 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
2688 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
2689 to go ahead and export these special symbols. This is only meaningful
2690 when @option{--export-all-symbols} is used.
2693 @itemx --as @var{path}
2694 Specifies the path, including the filename, of the assembler to be used
2695 to create the exports file.
2697 @item -f @var{switches}
2698 @itemx --as-flags @var{switches}
2699 Specifies any specific command line switches to be passed to the
2700 assembler when building the exports file. This option will work even if
2701 the @option{-S} option is not used. This option only takes one argument,
2702 and if it occurs more than once on the command line, then later
2703 occurrences will override earlier occurrences. So if it is necessary to
2704 pass multiple switches to the assembler they should be enclosed in
2708 @itemx --dll-name @var{name}
2709 Specifies the name to be stored in the .def file as the name of the DLL
2710 when the @option{-e} option is used. If this option is not present, then
2711 the filename given to the @option{-e} option will be used as the name of
2714 @item -m @var{machine}
2715 @itemx -machine @var{machine}
2716 Specifies the type of machine for which the library file should be
2717 built. @command{dlltool} has a built in default type, depending upon how
2718 it was created, but this option can be used to override that. This is
2719 normally only useful when creating DLLs for an ARM processor, when the
2720 contents of the DLL are actually encode using THUMB instructions.
2723 @itemx --add-indirect
2724 Specifies that when @command{dlltool} is creating the exports file it
2725 should add a section which allows the exported functions to be
2726 referenced without using the import library. Whatever the hell that
2730 @itemx --add-underscore
2731 Specifies that when @command{dlltool} is creating the exports file it
2732 should prepend an underscore to the names of the exported functions.
2736 Specifies that when @command{dlltool} is creating the exports file it
2737 should not append the string @samp{@@ <number>}. These numbers are
2738 called ordinal numbers and they represent another way of accessing the
2739 function in a DLL, other than by name.
2742 @itemx --add-stdcall-alias
2743 Specifies that when @command{dlltool} is creating the exports file it
2744 should add aliases for stdcall symbols without @samp{@@ <number>}
2745 in addition to the symbols with @samp{@@ <number>}.
2749 Specifies that when @command{dlltool} is creating the exports and library
2750 files it should omit the @code{.idata4} section. This is for compatibility
2751 with certain operating systems.
2755 Specifies that when @command{dlltool} is creating the exports and library
2756 files it should omit the @code{.idata5} section. This is for compatibility
2757 with certain operating systems.
2761 Specifies that @command{dlltool} should mark the objects in the library
2762 file and exports file that it produces as supporting interworking
2763 between ARM and THUMB code.
2767 Makes @command{dlltool} preserve the temporary assembler files it used to
2768 create the exports file. If this option is repeated then dlltool will
2769 also preserve the temporary object files it uses to create the library
2774 Make dlltool describe what it is doing.
2778 Displays a list of command line options and then exits.
2782 Displays dlltool's version number and then exits.
2789 @c man begin SEEALSO dlltool
2790 the Info entries for @file{binutils}.
2797 @cindex ELF file information
2800 @c man title readelf Displays information about ELF files.
2803 @c man begin SYNOPSIS readelf
2804 readelf [@option{-a}|@option{--all}]
2805 [@option{-h}|@option{--file-header}]
2806 [@option{-l}|@option{--program-headers}|@option{--segments}]
2807 [@option{-S}|@option{--section-headers}|@option{--sections}]
2808 [@option{-e}|@option{--headers}]
2809 [@option{-s}|@option{--syms}|@option{--symbols}]
2810 [@option{-n}|@option{--notes}]
2811 [@option{-r}|@option{--relocs}]
2812 [@option{-u}|@option{--unwind}]
2813 [@option{-d}|@option{--dynamic}]
2814 [@option{-V}|@option{--version-info}]
2815 [@option{-D}|@option{--use-dynamic}]
2816 [@option{-x} <number>|@option{--hex-dump=}<number>]
2817 [@option{-w[liaprmf]}|@option{--debug-dump}[=line,=info,=abbrev,=pubnames,=ranges,=macro,=frames]]
2818 [@option{-histogram}]
2819 [@option{-v}|@option{--version}]
2820 [@option{-H}|@option{--help}]
2821 @var{elffile}@dots{}
2825 @c man begin DESCRIPTION readelf
2827 @command{readelf} displays information about one or more ELF format object
2828 files. The options control what particular information to display.
2830 @var{elffile}@dots{} are the object files to be examined. At the
2831 moment, @command{readelf} does not support examining archives, nor does it
2832 support examing 64 bit ELF files.
2836 @c man begin OPTIONS readelf
2838 The long and short forms of options, shown here as alternatives, are
2839 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
2845 Equivalent to specifiying @option{--file-header},
2846 @option{--program-headers}, @option{--sections}, @option{--symbols},
2847 @option{--relocs}, @option{--dynamic}, @option{--notes} and
2848 @option{--version-info}.
2851 @itemx --file-header
2852 @cindex ELF file header information
2853 Displays the information contained in the ELF header at the start of the
2857 @itemx --program-headers
2859 @cindex ELF program header information
2860 @cindex ELF segment information
2861 Displays the information contained in the file's segment headers, if it
2866 @itemx --section-headers
2867 @cindex ELF section information
2868 Displays the information contained in the file's section headers, if it
2874 @cindex ELF symbol table information
2875 Displays the entries in symbol table section of the file, if it has one.
2879 Display all the headers in the file. Equivalent to @option{-h -l -S}.
2883 @cindex ELF core notes
2884 Displays the contents of the NOTE segment, if it exists.
2888 @cindex ELF reloc information
2889 Displays the contents of the file's relocation section, if it has one.
2893 @cindex unwind information
2894 Displays the contents of the file's unwind section, if it has one. Only
2895 the unwind sections for IA64 ELF files are currently supported.
2899 @cindex ELF dynamic section information
2900 Displays the contents of the file's dynamic section, if it has one.
2903 @itemx --version-info
2904 @cindex ELF version sections informations
2905 Displays the contents of the version sections in the file, it they
2909 @itemx --use-dynamic
2910 When displaying symbols, this option makes @command{readelf} use the
2911 symbol table in the file's dynamic section, rather than the one in the
2915 @itemx --hex-dump=<number>
2916 Displays the contents of the indicated section as a hexadecimal dump.
2919 @itemx --debug-dump[=line,=info,=abbrev,=pubnames,=ranges,=macro,=frames]
2920 Displays the contents of the debug sections in the file, if any are
2921 present. If one of the optional letters or words follows the switch
2922 then only data found in those specific sections will be dumped.
2925 Display a histogram of bucket list lengths when displaying the contents
2926 of the symbol tables.
2930 Display the version number of readelf.
2934 Display the command line options understood by @command{readelf}.
2941 @c man begin SEEALSO readelf
2942 objdump(1), and the Info entries for @file{binutils}.
2946 @node Selecting The Target System
2947 @chapter Selecting the target system
2949 You can specify three aspects of the target system to the @sc{gnu}
2950 binary file utilities, each in several ways:
2960 the linker emulation (which applies to the linker only)
2963 In the following summaries, the lists of ways to specify values are in
2964 order of decreasing precedence. The ways listed first override those
2967 The commands to list valid values only list the values for which the
2968 programs you are running were configured. If they were configured with
2969 @option{--enable-targets=all}, the commands list most of the available
2970 values, but a few are left out; not all targets can be configured in at
2971 once because some of them can only be configured @dfn{native} (on hosts
2972 with the same type as the target system).
2975 * Target Selection::
2976 * Architecture Selection::
2977 * Linker Emulation Selection::
2980 @node Target Selection
2981 @section Target Selection
2983 A @dfn{target} is an object file format. A given target may be
2984 supported for multiple architectures (@pxref{Architecture Selection}).
2985 A target selection may also have variations for different operating
2986 systems or architectures.
2988 The command to list valid target values is @samp{objdump -i}
2989 (the first column of output contains the relevant information).
2991 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
2992 @samp{a.out-sunos-big}.
2994 You can also specify a target using a configuration triplet. This is
2995 the same sort of name that is passed to @file{configure} to specify a
2996 target. When you use a configuration triplet as an argument, it must be
2997 fully canonicalized. You can see the canonical version of a triplet by
2998 running the shell script @file{config.sub} which is included with the
3001 Some sample configuration triplets are: @samp{m68k-hp-bsd},
3002 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
3004 @subheading @command{objdump} Target
3010 command line option: @option{-b} or @option{--target}
3013 environment variable @code{GNUTARGET}
3016 deduced from the input file
3019 @subheading @command{objcopy} and @command{strip} Input Target
3025 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
3028 environment variable @code{GNUTARGET}
3031 deduced from the input file
3034 @subheading @command{objcopy} and @command{strip} Output Target
3040 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
3043 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
3046 environment variable @code{GNUTARGET}
3049 deduced from the input file
3052 @subheading @command{nm}, @command{size}, and @command{strings} Target
3058 command line option: @option{--target}
3061 environment variable @code{GNUTARGET}
3064 deduced from the input file
3067 @subheading Linker Input Target
3073 command line option: @option{-b} or @option{--format}
3074 (@pxref{Options,,Options,ld.info,Using LD})
3077 script command @code{TARGET}
3078 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
3081 environment variable @code{GNUTARGET}
3082 (@pxref{Environment,,Environment,ld.info,Using LD})
3085 the default target of the selected linker emulation
3086 (@pxref{Linker Emulation Selection})
3089 @subheading Linker Output Target
3095 command line option: @option{-oformat}
3096 (@pxref{Options,,Options,ld.info,Using LD})
3099 script command @code{OUTPUT_FORMAT}
3100 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
3103 the linker input target (see ``Linker Input Target'' above)
3106 @node Architecture Selection
3107 @section Architecture selection
3109 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
3110 to run. Its name may contain a colon, separating the name of the
3111 processor family from the name of the particular @sc{cpu}.
3113 The command to list valid architecture values is @samp{objdump -i} (the
3114 second column contains the relevant information).
3116 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
3118 @subheading @command{objdump} Architecture
3124 command line option: @option{-m} or @option{--architecture}
3127 deduced from the input file
3130 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
3136 deduced from the input file
3139 @subheading Linker Input Architecture
3145 deduced from the input file
3148 @subheading Linker Output Architecture
3154 script command @code{OUTPUT_ARCH}
3155 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
3158 the default architecture from the linker output target
3159 (@pxref{Target Selection})
3162 @node Linker Emulation Selection
3163 @section Linker emulation selection
3165 A linker @dfn{emulation} is a ``personality'' of the linker, which gives
3166 the linker default values for the other aspects of the target system.
3167 In particular, it consists of
3177 several ``hook'' functions that are run at certain stages of the linking
3178 process to do special things that some targets require
3181 The command to list valid linker emulation values is @samp{ld -V}.
3183 Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
3189 command line option: @option{-m}
3190 (@pxref{Options,,Options,ld.info,Using LD})
3193 environment variable @code{LDEMULATION}
3196 compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
3197 which comes from @code{EMUL} in @file{config/@var{target}.mt}
3200 @node Reporting Bugs
3201 @chapter Reporting Bugs
3203 @cindex reporting bugs
3205 Your bug reports play an essential role in making the binary utilities
3208 Reporting a bug may help you by bringing a solution to your problem, or
3209 it may not. But in any case the principal function of a bug report is
3210 to help the entire community by making the next version of the binary
3211 utilities work better. Bug reports are your contribution to their
3214 In order for a bug report to serve its purpose, you must include the
3215 information that enables us to fix the bug.
3218 * Bug Criteria:: Have you found a bug?
3219 * Bug Reporting:: How to report bugs
3223 @section Have you found a bug?
3224 @cindex bug criteria
3226 If you are not sure whether you have found a bug, here are some guidelines:
3229 @cindex fatal signal
3232 If a binary utility gets a fatal signal, for any input whatever, that is
3233 a bug. Reliable utilities never crash.
3235 @cindex error on valid input
3237 If a binary utility produces an error message for valid input, that is a
3241 If you are an experienced user of binary utilities, your suggestions for
3242 improvement are welcome in any case.
3246 @section How to report bugs
3248 @cindex bugs, reporting
3250 A number of companies and individuals offer support for @sc{gnu}
3251 products. If you obtained the binary utilities from a support
3252 organization, we recommend you contact that organization first.
3254 You can find contact information for many support companies and
3255 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
3258 In any event, we also recommend that you send bug reports for the binary
3259 utilities to @samp{bug-binutils@@gnu.org}.
3261 The fundamental principle of reporting bugs usefully is this:
3262 @strong{report all the facts}. If you are not sure whether to state a
3263 fact or leave it out, state it!
3265 Often people omit facts because they think they know what causes the
3266 problem and assume that some details do not matter. Thus, you might
3267 assume that the name of a file you use in an example does not matter.
3268 Well, probably it does not, but one cannot be sure. Perhaps the bug is
3269 a stray memory reference which happens to fetch from the location where
3270 that pathname is stored in memory; perhaps, if the pathname were
3271 different, the contents of that location would fool the utility into
3272 doing the right thing despite the bug. Play it safe and give a
3273 specific, complete example. That is the easiest thing for you to do,
3274 and the most helpful.
3276 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
3277 it is new to us. Therefore, always write your bug reports on the assumption
3278 that the bug has not been reported previously.
3280 Sometimes people give a few sketchy facts and ask, ``Does this ring a
3281 bell?'' Those bug reports are useless, and we urge everyone to
3282 @emph{refuse to respond to them} except to chide the sender to report
3285 To enable us to fix the bug, you should include all these things:
3289 The version of the utility. Each utility announces it if you start it
3290 with the @option{--version} argument.
3292 Without this, we will not know whether there is any point in looking for
3293 the bug in the current version of the binary utilities.
3296 Any patches you may have applied to the source, including any patches
3297 made to the @code{BFD} library.
3300 The type of machine you are using, and the operating system name and
3304 What compiler (and its version) was used to compile the utilities---e.g.
3308 The command arguments you gave the utility to observe the bug. To
3309 guarantee you will not omit something important, list them all. A copy
3310 of the Makefile (or the output from make) is sufficient.
3312 If we were to try to guess the arguments, we would probably guess wrong
3313 and then we might not encounter the bug.
3316 A complete input file, or set of input files, that will reproduce the
3317 bug. If the utility is reading an object file or files, then it is
3318 generally most helpful to send the actual object files, uuencoded if
3319 necessary to get them through the mail system. Note that
3320 @samp{bug-binutils@@gnu.org} is a mailing list, so you should avoid
3321 sending very large files to it. Making the files available for
3322 anonymous FTP is OK.
3324 If the source files were produced exclusively using @sc{gnu} programs
3325 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
3326 may be OK to send the source files rather than the object files. In
3327 this case, be sure to say exactly what version of @command{gcc}, or
3328 whatever, was used to produce the object files. Also say how
3329 @command{gcc}, or whatever, was configured.
3332 A description of what behavior you observe that you believe is
3333 incorrect. For example, ``It gets a fatal signal.''
3335 Of course, if the bug is that the utility gets a fatal signal, then we
3336 will certainly notice it. But if the bug is incorrect output, we might
3337 not notice unless it is glaringly wrong. You might as well not give us
3338 a chance to make a mistake.
3340 Even if the problem you experience is a fatal signal, you should still
3341 say so explicitly. Suppose something strange is going on, such as your
3342 copy of the utility is out of synch, or you have encountered a bug in
3343 the C library on your system. (This has happened!) Your copy might
3344 crash and ours would not. If you told us to expect a crash, then when
3345 ours fails to crash, we would know that the bug was not happening for
3346 us. If you had not told us to expect a crash, then we would not be able
3347 to draw any conclusion from our observations.
3350 If you wish to suggest changes to the source, send us context diffs, as
3351 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
3352 option. Always send diffs from the old file to the new file. If you
3353 wish to discuss something in the @command{ld} source, refer to it by
3354 context, not by line number.
3356 The line numbers in our development sources will not match those in your
3357 sources. Your line numbers would convey no useful information to us.
3360 Here are some things that are not necessary:
3364 A description of the envelope of the bug.
3366 Often people who encounter a bug spend a lot of time investigating
3367 which changes to the input file will make the bug go away and which
3368 changes will not affect it.
3370 This is often time consuming and not very useful, because the way we
3371 will find the bug is by running a single example under the debugger
3372 with breakpoints, not by pure deduction from a series of examples.
3373 We recommend that you save your time for something else.
3375 Of course, if you can find a simpler example to report @emph{instead}
3376 of the original one, that is a convenience for us. Errors in the
3377 output will be easier to spot, running under the debugger will take
3378 less time, and so on.
3380 However, simplification is not vital; if you do not want to do this,
3381 report the bug anyway and send us the entire test case you used.
3384 A patch for the bug.
3386 A patch for the bug does help us if it is a good one. But do not omit
3387 the necessary information, such as the test case, on the assumption that
3388 a patch is all we need. We might see problems with your patch and decide
3389 to fix the problem another way, or we might not understand it at all.
3391 Sometimes with programs as complicated as the binary utilities it is
3392 very hard to construct an example that will make the program follow a
3393 certain path through the code. If you do not send us the example, we
3394 will not be able to construct one, so we will not be able to verify that
3397 And if we cannot understand what bug you are trying to fix, or why your
3398 patch should be an improvement, we will not install it. A test case will
3399 help us to understand.
3402 A guess about what the bug is or what it depends on.
3404 Such guesses are usually wrong. Even we cannot guess right about such
3405 things without first using the debugger to find the facts.
3408 @node GNU Free Documentation License
3409 @chapter GNU Free Documentation License
3410 @cindex GNU Free Documentation License
3412 GNU Free Documentation License
3414 Version 1.1, March 2000
3416 Copyright (C) 2000 Free Software Foundation, Inc.
3417 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3419 Everyone is permitted to copy and distribute verbatim copies
3420 of this license document, but changing it is not allowed.
3425 The purpose of this License is to make a manual, textbook, or other
3426 written document "free" in the sense of freedom: to assure everyone
3427 the effective freedom to copy and redistribute it, with or without
3428 modifying it, either commercially or noncommercially. Secondarily,
3429 this License preserves for the author and publisher a way to get
3430 credit for their work, while not being considered responsible for
3431 modifications made by others.
3433 This License is a kind of "copyleft", which means that derivative
3434 works of the document must themselves be free in the same sense. It
3435 complements the GNU General Public License, which is a copyleft
3436 license designed for free software.
3438 We have designed this License in order to use it for manuals for free
3439 software, because free software needs free documentation: a free
3440 program should come with manuals providing the same freedoms that the
3441 software does. But this License is not limited to software manuals;
3442 it can be used for any textual work, regardless of subject matter or
3443 whether it is published as a printed book. We recommend this License
3444 principally for works whose purpose is instruction or reference.
3447 1. APPLICABILITY AND DEFINITIONS
3449 This License applies to any manual or other work that contains a
3450 notice placed by the copyright holder saying it can be distributed
3451 under the terms of this License. The "Document", below, refers to any
3452 such manual or work. Any member of the public is a licensee, and is
3455 A "Modified Version" of the Document means any work containing the
3456 Document or a portion of it, either copied verbatim, or with
3457 modifications and/or translated into another language.
3459 A "Secondary Section" is a named appendix or a front-matter section of
3460 the Document that deals exclusively with the relationship of the
3461 publishers or authors of the Document to the Document's overall subject
3462 (or to related matters) and contains nothing that could fall directly
3463 within that overall subject. (For example, if the Document is in part a
3464 textbook of mathematics, a Secondary Section may not explain any
3465 mathematics.) The relationship could be a matter of historical
3466 connection with the subject or with related matters, or of legal,
3467 commercial, philosophical, ethical or political position regarding
3470 The "Invariant Sections" are certain Secondary Sections whose titles
3471 are designated, as being those of Invariant Sections, in the notice
3472 that says that the Document is released under this License.
3474 The "Cover Texts" are certain short passages of text that are listed,
3475 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3476 the Document is released under this License.
3478 A "Transparent" copy of the Document means a machine-readable copy,
3479 represented in a format whose specification is available to the
3480 general public, whose contents can be viewed and edited directly and
3481 straightforwardly with generic text editors or (for images composed of
3482 pixels) generic paint programs or (for drawings) some widely available
3483 drawing editor, and that is suitable for input to text formatters or
3484 for automatic translation to a variety of formats suitable for input
3485 to text formatters. A copy made in an otherwise Transparent file
3486 format whose markup has been designed to thwart or discourage
3487 subsequent modification by readers is not Transparent. A copy that is
3488 not "Transparent" is called "Opaque".
3490 Examples of suitable formats for Transparent copies include plain
3491 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3492 or XML using a publicly available DTD, and standard-conforming simple
3493 HTML designed for human modification. Opaque formats include
3494 PostScript, PDF, proprietary formats that can be read and edited only
3495 by proprietary word processors, SGML or XML for which the DTD and/or
3496 processing tools are not generally available, and the
3497 machine-generated HTML produced by some word processors for output
3500 The "Title Page" means, for a printed book, the title page itself,
3501 plus such following pages as are needed to hold, legibly, the material
3502 this License requires to appear in the title page. For works in
3503 formats which do not have any title page as such, "Title Page" means
3504 the text near the most prominent appearance of the work's title,
3505 preceding the beginning of the body of the text.
3510 You may copy and distribute the Document in any medium, either
3511 commercially or noncommercially, provided that this License, the
3512 copyright notices, and the license notice saying this License applies
3513 to the Document are reproduced in all copies, and that you add no other
3514 conditions whatsoever to those of this License. You may not use
3515 technical measures to obstruct or control the reading or further
3516 copying of the copies you make or distribute. However, you may accept
3517 compensation in exchange for copies. If you distribute a large enough
3518 number of copies you must also follow the conditions in section 3.
3520 You may also lend copies, under the same conditions stated above, and
3521 you may publicly display copies.
3524 3. COPYING IN QUANTITY
3526 If you publish printed copies of the Document numbering more than 100,
3527 and the Document's license notice requires Cover Texts, you must enclose
3528 the copies in covers that carry, clearly and legibly, all these Cover
3529 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3530 the back cover. Both covers must also clearly and legibly identify
3531 you as the publisher of these copies. The front cover must present
3532 the full title with all words of the title equally prominent and
3533 visible. You may add other material on the covers in addition.
3534 Copying with changes limited to the covers, as long as they preserve
3535 the title of the Document and satisfy these conditions, can be treated
3536 as verbatim copying in other respects.
3538 If the required texts for either cover are too voluminous to fit
3539 legibly, you should put the first ones listed (as many as fit
3540 reasonably) on the actual cover, and continue the rest onto adjacent
3543 If you publish or distribute Opaque copies of the Document numbering
3544 more than 100, you must either include a machine-readable Transparent
3545 copy along with each Opaque copy, or state in or with each Opaque copy
3546 a publicly-accessible computer-network location containing a complete
3547 Transparent copy of the Document, free of added material, which the
3548 general network-using public has access to download anonymously at no
3549 charge using public-standard network protocols. If you use the latter
3550 option, you must take reasonably prudent steps, when you begin
3551 distribution of Opaque copies in quantity, to ensure that this
3552 Transparent copy will remain thus accessible at the stated location
3553 until at least one year after the last time you distribute an Opaque
3554 copy (directly or through your agents or retailers) of that edition to
3557 It is requested, but not required, that you contact the authors of the
3558 Document well before redistributing any large number of copies, to give
3559 them a chance to provide you with an updated version of the Document.
3564 You may copy and distribute a Modified Version of the Document under
3565 the conditions of sections 2 and 3 above, provided that you release
3566 the Modified Version under precisely this License, with the Modified
3567 Version filling the role of the Document, thus licensing distribution
3568 and modification of the Modified Version to whoever possesses a copy
3569 of it. In addition, you must do these things in the Modified Version:
3571 A. Use in the Title Page (and on the covers, if any) a title distinct
3572 from that of the Document, and from those of previous versions
3573 (which should, if there were any, be listed in the History section
3574 of the Document). You may use the same title as a previous version
3575 if the original publisher of that version gives permission.
3576 B. List on the Title Page, as authors, one or more persons or entities
3577 responsible for authorship of the modifications in the Modified
3578 Version, together with at least five of the principal authors of the
3579 Document (all of its principal authors, if it has less than five).
3580 C. State on the Title page the name of the publisher of the
3581 Modified Version, as the publisher.
3582 D. Preserve all the copyright notices of the Document.
3583 E. Add an appropriate copyright notice for your modifications
3584 adjacent to the other copyright notices.
3585 F. Include, immediately after the copyright notices, a license notice
3586 giving the public permission to use the Modified Version under the
3587 terms of this License, in the form shown in the Addendum below.
3588 G. Preserve in that license notice the full lists of Invariant Sections
3589 and required Cover Texts given in the Document's license notice.
3590 H. Include an unaltered copy of this License.
3591 I. Preserve the section entitled "History", and its title, and add to
3592 it an item stating at least the title, year, new authors, and
3593 publisher of the Modified Version as given on the Title Page. If
3594 there is no section entitled "History" in the Document, create one
3595 stating the title, year, authors, and publisher of the Document as
3596 given on its Title Page, then add an item describing the Modified
3597 Version as stated in the previous sentence.
3598 J. Preserve the network location, if any, given in the Document for
3599 public access to a Transparent copy of the Document, and likewise
3600 the network locations given in the Document for previous versions
3601 it was based on. These may be placed in the "History" section.
3602 You may omit a network location for a work that was published at
3603 least four years before the Document itself, or if the original
3604 publisher of the version it refers to gives permission.
3605 K. In any section entitled "Acknowledgements" or "Dedications",
3606 preserve the section's title, and preserve in the section all the
3607 substance and tone of each of the contributor acknowledgements
3608 and/or dedications given therein.
3609 L. Preserve all the Invariant Sections of the Document,
3610 unaltered in their text and in their titles. Section numbers
3611 or the equivalent are not considered part of the section titles.
3612 M. Delete any section entitled "Endorsements". Such a section
3613 may not be included in the Modified Version.
3614 N. Do not retitle any existing section as "Endorsements"
3615 or to conflict in title with any Invariant Section.
3617 If the Modified Version includes new front-matter sections or
3618 appendices that qualify as Secondary Sections and contain no material
3619 copied from the Document, you may at your option designate some or all
3620 of these sections as invariant. To do this, add their titles to the
3621 list of Invariant Sections in the Modified Version's license notice.
3622 These titles must be distinct from any other section titles.
3624 You may add a section entitled "Endorsements", provided it contains
3625 nothing but endorsements of your Modified Version by various
3626 parties--for example, statements of peer review or that the text has
3627 been approved by an organization as the authoritative definition of a
3630 You may add a passage of up to five words as a Front-Cover Text, and a
3631 passage of up to 25 words as a Back-Cover Text, to the end of the list
3632 of Cover Texts in the Modified Version. Only one passage of
3633 Front-Cover Text and one of Back-Cover Text may be added by (or
3634 through arrangements made by) any one entity. If the Document already
3635 includes a cover text for the same cover, previously added by you or
3636 by arrangement made by the same entity you are acting on behalf of,
3637 you may not add another; but you may replace the old one, on explicit
3638 permission from the previous publisher that added the old one.
3640 The author(s) and publisher(s) of the Document do not by this License
3641 give permission to use their names for publicity for or to assert or
3642 imply endorsement of any Modified Version.
3645 5. COMBINING DOCUMENTS
3647 You may combine the Document with other documents released under this
3648 License, under the terms defined in section 4 above for modified
3649 versions, provided that you include in the combination all of the
3650 Invariant Sections of all of the original documents, unmodified, and
3651 list them all as Invariant Sections of your combined work in its
3654 The combined work need only contain one copy of this License, and
3655 multiple identical Invariant Sections may be replaced with a single
3656 copy. If there are multiple Invariant Sections with the same name but
3657 different contents, make the title of each such section unique by
3658 adding at the end of it, in parentheses, the name of the original
3659 author or publisher of that section if known, or else a unique number.
3660 Make the same adjustment to the section titles in the list of
3661 Invariant Sections in the license notice of the combined work.
3663 In the combination, you must combine any sections entitled "History"
3664 in the various original documents, forming one section entitled
3665 "History"; likewise combine any sections entitled "Acknowledgements",
3666 and any sections entitled "Dedications". You must delete all sections
3667 entitled "Endorsements."
3670 6. COLLECTIONS OF DOCUMENTS
3672 You may make a collection consisting of the Document and other documents
3673 released under this License, and replace the individual copies of this
3674 License in the various documents with a single copy that is included in
3675 the collection, provided that you follow the rules of this License for
3676 verbatim copying of each of the documents in all other respects.
3678 You may extract a single document from such a collection, and distribute
3679 it individually under this License, provided you insert a copy of this
3680 License into the extracted document, and follow this License in all
3681 other respects regarding verbatim copying of that document.
3684 7. AGGREGATION WITH INDEPENDENT WORKS
3686 A compilation of the Document or its derivatives with other separate
3687 and independent documents or works, in or on a volume of a storage or
3688 distribution medium, does not as a whole count as a Modified Version
3689 of the Document, provided no compilation copyright is claimed for the
3690 compilation. Such a compilation is called an "aggregate", and this
3691 License does not apply to the other self-contained works thus compiled
3692 with the Document, on account of their being thus compiled, if they
3693 are not themselves derivative works of the Document.
3695 If the Cover Text requirement of section 3 is applicable to these
3696 copies of the Document, then if the Document is less than one quarter
3697 of the entire aggregate, the Document's Cover Texts may be placed on
3698 covers that surround only the Document within the aggregate.
3699 Otherwise they must appear on covers around the whole aggregate.
3704 Translation is considered a kind of modification, so you may
3705 distribute translations of the Document under the terms of section 4.
3706 Replacing Invariant Sections with translations requires special
3707 permission from their copyright holders, but you may include
3708 translations of some or all Invariant Sections in addition to the
3709 original versions of these Invariant Sections. You may include a
3710 translation of this License provided that you also include the
3711 original English version of this License. In case of a disagreement
3712 between the translation and the original English version of this
3713 License, the original English version will prevail.
3718 You may not copy, modify, sublicense, or distribute the Document except
3719 as expressly provided for under this License. Any other attempt to
3720 copy, modify, sublicense or distribute the Document is void, and will
3721 automatically terminate your rights under this License. However,
3722 parties who have received copies, or rights, from you under this
3723 License will not have their licenses terminated so long as such
3724 parties remain in full compliance.
3727 10. FUTURE REVISIONS OF THIS LICENSE
3729 The Free Software Foundation may publish new, revised versions
3730 of the GNU Free Documentation License from time to time. Such new
3731 versions will be similar in spirit to the present version, but may
3732 differ in detail to address new problems or concerns. See
3733 http://www.gnu.org/copyleft/.
3735 Each version of the License is given a distinguishing version number.
3736 If the Document specifies that a particular numbered version of this
3737 License "or any later version" applies to it, you have the option of
3738 following the terms and conditions either of that specified version or
3739 of any later version that has been published (not as a draft) by the
3740 Free Software Foundation. If the Document does not specify a version
3741 number of this License, you may choose any version ever published (not
3742 as a draft) by the Free Software Foundation.
3745 ADDENDUM: How to use this License for your documents
3747 To use this License in a document you have written, include a copy of
3748 the License in the document and put the following copyright and
3749 license notices just after the title page:
3752 Copyright (c) YEAR YOUR NAME.
3753 Permission is granted to copy, distribute and/or modify this document
3754 under the terms of the GNU Free Documentation License, Version 1.1
3755 or any later version published by the Free Software Foundation;
3756 with the Invariant Sections being LIST THEIR TITLES, with the
3757 Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
3758 A copy of the license is included in the section entitled "GNU
3759 Free Documentation License".
3762 If you have no Invariant Sections, write "with no Invariant Sections"
3763 instead of saying which ones are invariant. If you have no
3764 Front-Cover Texts, write "no Front-Cover Texts" instead of
3765 "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
3767 If your document contains nontrivial examples of program code, we
3768 recommend releasing these examples in parallel under your choice of
3769 free software license, such as the GNU General Public License,
3770 to permit their use in free software.