1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991-2016 Free Software Foundation, Inc.
15 Permission is granted to copy, distribute and/or modify this document
16 under the terms of the GNU Free Documentation License, Version 1.3
17 or any later version published by the Free Software Foundation;
18 with no Invariant Sections, with no Front-Cover Texts, and with no
19 Back-Cover Texts. A copy of the license is included in the
20 section entitled ``GNU Free Documentation License''.
25 @dircategory Software development
27 * Binutils: (binutils). The GNU binary utilities.
30 @dircategory Individual utilities
32 * addr2line: (binutils)addr2line. Convert addresses to file and line.
33 * ar: (binutils)ar. Create, modify, and extract from archives.
34 * c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols.
35 * cxxfilt: (binutils)c++filt. MS-DOS name for c++filt.
36 * dlltool: (binutils)dlltool. Create files needed to build and use DLLs.
37 * nlmconv: (binutils)nlmconv. Converts object code into an NLM.
38 * nm: (binutils)nm. List symbols from object files.
39 * objcopy: (binutils)objcopy. Copy and translate object files.
40 * objdump: (binutils)objdump. Display information from object files.
41 * ranlib: (binutils)ranlib. Generate index to archive contents.
42 * readelf: (binutils)readelf. Display the contents of ELF format files.
43 * size: (binutils)size. List section sizes and total size.
44 * strings: (binutils)strings. List printable strings from files.
45 * strip: (binutils)strip. Discard symbols.
46 * elfedit: (binutils)elfedit. Update the ELF header of ELF files.
47 * windmc: (binutils)windmc. Generator for Windows message resources.
48 * windres: (binutils)windres. Manipulate Windows resources.
52 @title The @sc{gnu} Binary Utilities
53 @ifset VERSION_PACKAGE
54 @subtitle @value{VERSION_PACKAGE}
56 @subtitle Version @value{VERSION}
58 @subtitle @value{UPDATED}
59 @author Roland H. Pesch
60 @author Jeffrey M. Osier
61 @author Cygnus Support
65 {\parskip=0pt \hfill Cygnus Support\par \hfill
66 Texinfo \texinfoversion\par }
69 @vskip 0pt plus 1filll
78 This brief manual contains documentation for the @sc{gnu} binary
80 @ifset VERSION_PACKAGE
81 @value{VERSION_PACKAGE}
83 version @value{VERSION}:
88 Create, modify, and extract from archives
91 List symbols from object files
94 Copy and translate object files
97 Display information from object files
100 Generate index to archive contents
103 Display the contents of ELF format files.
106 List file section sizes and total size
109 List printable strings from files
115 Update the ELF header of ELF files.
118 Demangle encoded C++ symbols (on MS-DOS, this program is named
122 Convert addresses into file names and line numbers
125 Convert object code into a Netware Loadable Module
128 Manipulate Windows resources
131 Generator for Windows message resources
134 Create the files needed to build and use Dynamic Link Libraries
138 This document is distributed under the terms of the GNU Free
139 Documentation License version 1.3. A copy of the license is included
140 in the section entitled ``GNU Free Documentation License''.
143 * ar:: Create, modify, and extract from archives
144 * nm:: List symbols from object files
145 * objcopy:: Copy and translate object files
146 * objdump:: Display information from object files
147 * ranlib:: Generate index to archive contents
148 * size:: List section sizes and total size
149 * strings:: List printable strings from files
150 * strip:: Discard symbols
151 * c++filt:: Filter to demangle encoded C++ symbols
152 * cxxfilt: c++filt. MS-DOS name for c++filt
153 * addr2line:: Convert addresses to file and line
154 * nlmconv:: Converts object code into an NLM
155 * windmc:: Generator for Windows message resources
156 * windres:: Manipulate Windows resources
157 * dlltool:: Create files needed to build and use DLLs
158 * readelf:: Display the contents of ELF format files
159 * elfedit:: Update the ELF header of ELF files
160 * Common Options:: Command-line options for all utilities
161 * Selecting the Target System:: How these utilities determine the target
162 * Reporting Bugs:: Reporting Bugs
163 * GNU Free Documentation License:: GNU Free Documentation License
164 * Binutils Index:: Binutils Index
172 @cindex collections of files
174 @c man title ar create, modify, and extract from archives
177 ar [-]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
178 ar -M [ <mri-script ]
181 @c man begin DESCRIPTION ar
183 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
184 archives. An @dfn{archive} is a single file holding a collection of
185 other files in a structure that makes it possible to retrieve
186 the original individual files (called @dfn{members} of the archive).
188 The original files' contents, mode (permissions), timestamp, owner, and
189 group are preserved in the archive, and can be restored on
193 @sc{gnu} @command{ar} can maintain archives whose members have names of any
194 length; however, depending on how @command{ar} is configured on your
195 system, a limit on member-name length may be imposed for compatibility
196 with archive formats maintained with other tools. If it exists, the
197 limit is often 15 characters (typical of formats related to a.out) or 16
198 characters (typical of formats related to coff).
201 @command{ar} is considered a binary utility because archives of this sort
202 are most often used as @dfn{libraries} holding commonly needed
206 @command{ar} creates an index to the symbols defined in relocatable
207 object modules in the archive when you specify the modifier @samp{s}.
208 Once created, this index is updated in the archive whenever @command{ar}
209 makes a change to its contents (save for the @samp{q} update operation).
210 An archive with such an index speeds up linking to the library, and
211 allows routines in the library to call each other without regard to
212 their placement in the archive.
214 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
215 table. If an archive lacks the table, another form of @command{ar} called
216 @command{ranlib} can be used to add just the table.
218 @cindex thin archives
219 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
220 which contains a symbol index and references to the original copies
221 of the member files of the archive. This is useful for building
222 libraries for use within a local build tree, where the relocatable
223 objects are expected to remain available, and copying the contents of
224 each object would only waste time and space.
226 An archive can either be @emph{thin} or it can be normal. It cannot
227 be both at the same time. Once an archive is created its format
228 cannot be changed without first deleting it and then creating a new
229 archive in its place.
231 Thin archives are also @emph{flattened}, so that adding one thin
232 archive to another thin archive does not nest it, as would happen with
233 a normal archive. Instead the elements of the first archive are added
234 individually to the second archive.
236 The paths to the elements of the archive are stored relative to the
239 @cindex compatibility, @command{ar}
240 @cindex @command{ar} compatibility
241 @sc{gnu} @command{ar} is designed to be compatible with two different
242 facilities. You can control its activity using command-line options,
243 like the different varieties of @command{ar} on Unix systems; or, if you
244 specify the single command-line option @option{-M}, you can control it
245 with a script supplied via standard input, like the MRI ``librarian''
251 * ar cmdline:: Controlling @command{ar} on the command line
252 * ar scripts:: Controlling @command{ar} with a script
257 @section Controlling @command{ar} on the Command Line
260 @c man begin SYNOPSIS ar
261 ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
265 @cindex Unix compatibility, @command{ar}
266 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
267 arguments to execute: one keyletter specifying the @emph{operation}
268 (optionally accompanied by other keyletters specifying
269 @emph{modifiers}), and the archive name to act on.
271 Most operations can also accept further @var{member} arguments,
272 specifying particular files to operate on.
274 @c man begin OPTIONS ar
276 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
277 flags @var{mod} in any order, within the first command-line argument.
279 If you wish, you may begin the first command-line argument with a
282 @cindex operations on archive
283 The @var{p} keyletter specifies what operation to execute; it may be
284 any of the following, but you must specify only one of them:
288 @cindex deleting from archive
289 @emph{Delete} modules from the archive. Specify the names of modules to
290 be deleted as @var{member}@dots{}; the archive is untouched if you
291 specify no files to delete.
293 If you specify the @samp{v} modifier, @command{ar} lists each module
297 @cindex moving in archive
298 Use this operation to @emph{move} members in an archive.
300 The ordering of members in an archive can make a difference in how
301 programs are linked using the library, if a symbol is defined in more
304 If no modifiers are used with @code{m}, any members you name in the
305 @var{member} arguments are moved to the @emph{end} of the archive;
306 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
307 specified place instead.
310 @cindex printing from archive
311 @emph{Print} the specified members of the archive, to the standard
312 output file. If the @samp{v} modifier is specified, show the member
313 name before copying its contents to standard output.
315 If you specify no @var{member} arguments, all the files in the archive are
319 @cindex quick append to archive
320 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
321 @var{archive}, without checking for replacement.
323 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
324 operation; new members are always placed at the end of the archive.
326 The modifier @samp{v} makes @command{ar} list each file as it is appended.
328 Since the point of this operation is speed, implementations of
329 @command{ar} have the option of not updating the archive's symbol
330 table if one exists. Too many different systems however assume that
331 symbol tables are always up-to-date, so @sc{gnu} @command{ar} will
332 rebuild the table even with a quick append.
334 Note - @sc{gnu} @command{ar} treats the command @samp{qs} as a
335 synonym for @samp{r} - replacing already existing files in the
336 archive and appending new ones at the end.
339 @cindex replacement in archive
340 Insert the files @var{member}@dots{} into @var{archive} (with
341 @emph{replacement}). This operation differs from @samp{q} in that any
342 previously existing members are deleted if their names match those being
345 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
346 displays an error message, and leaves undisturbed any existing members
347 of the archive matching that name.
349 By default, new members are added at the end of the file; but you may
350 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
351 placement relative to some existing member.
353 The modifier @samp{v} used with this operation elicits a line of
354 output for each file inserted, along with one of the letters @samp{a} or
355 @samp{r} to indicate whether the file was appended (no old member
356 deleted) or replaced.
360 Add an index to the archive, or update it if it already exists. Note
361 this command is an exception to the rule that there can only be one
362 command letter, as it is possible to use it as either a command or a
363 modifier. In either case it does the same thing.
366 @cindex contents of archive
367 Display a @emph{table} listing the contents of @var{archive}, or those
368 of the files listed in @var{member}@dots{} that are present in the
369 archive. Normally only the member name is shown; if you also want to
370 see the modes (permissions), timestamp, owner, group, and size, you can
371 request that by also specifying the @samp{v} modifier.
373 If you do not specify a @var{member}, all files in the archive
376 @cindex repeated names in archive
377 @cindex name duplication in archive
378 If there is more than one file with the same name (say, @samp{fie}) in
379 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
380 first instance; to see them all, you must ask for a complete
381 listing---in our example, @samp{ar t b.a}.
382 @c WRS only; per Gumby, this is implementation-dependent, and in a more
383 @c recent case in fact works the other way.
386 @cindex extract from archive
387 @emph{Extract} members (named @var{member}) from the archive. You can
388 use the @samp{v} modifier with this operation, to request that
389 @command{ar} list each name as it extracts it.
391 If you do not specify a @var{member}, all files in the archive
394 Files cannot be extracted from a thin archive.
397 Displays the list of command line options supported by @command{ar}
401 Displays the version information of @command{ar} and then exits.
405 A number of modifiers (@var{mod}) may immediately follow the @var{p}
406 keyletter, to specify variations on an operation's behavior:
410 @cindex relative placement in archive
411 Add new files @emph{after} an existing member of the
412 archive. If you use the modifier @samp{a}, the name of an existing archive
413 member must be present as the @var{relpos} argument, before the
414 @var{archive} specification.
417 Add new files @emph{before} an existing member of the
418 archive. If you use the modifier @samp{b}, the name of an existing archive
419 member must be present as the @var{relpos} argument, before the
420 @var{archive} specification. (same as @samp{i}).
423 @cindex creating archives
424 @emph{Create} the archive. The specified @var{archive} is always
425 created if it did not exist, when you request an update. But a warning is
426 issued unless you specify in advance that you expect to create it, by
430 @cindex deterministic archives
431 @kindex --enable-deterministic-archives
432 Operate in @emph{deterministic} mode. When adding files and the archive
433 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
434 for all files. When this option is used, if @command{ar} is used with
435 identical options and identical input files, multiple runs will create
436 identical output files regardless of the input files' owners, groups,
437 file modes, or modification times.
439 If @file{binutils} was configured with
440 @option{--enable-deterministic-archives}, then this mode is on by default.
441 It can be disabled with the @samp{U} modifier, below.
444 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
445 names of any length. This will cause it to create archives which are
446 not compatible with the native @command{ar} program on some systems. If
447 this is a concern, the @samp{f} modifier may be used to truncate file
448 names when putting them in the archive.
451 Insert new files @emph{before} an existing member of the
452 archive. If you use the modifier @samp{i}, the name of an existing archive
453 member must be present as the @var{relpos} argument, before the
454 @var{archive} specification. (same as @samp{b}).
457 This modifier is accepted but not used.
458 @c whaffor ar l modifier??? presumably compat; with
459 @c what???---doc@@cygnus.com, 25jan91
462 Uses the @var{count} parameter. This is used if there are multiple
463 entries in the archive with the same name. Extract or delete instance
464 @var{count} of the given name from the archive.
467 @cindex dates in archive
468 Preserve the @emph{original} dates of members when extracting them. If
469 you do not specify this modifier, files extracted from the archive
470 are stamped with the time of extraction.
473 Use the full path name when matching names in the archive. @sc{gnu}
474 @command{ar} can not create an archive with a full path name (such archives
475 are not POSIX complaint), but other archive creators can. This option
476 will cause @sc{gnu} @command{ar} to match file names using a complete path
477 name, which can be convenient when extracting a single file from an
478 archive created by another tool.
481 @cindex writing archive index
482 Write an object-file index into the archive, or update an existing one,
483 even if no other change is made to the archive. You may use this modifier
484 flag either with any operation, or alone. Running @samp{ar s} on an
485 archive is equivalent to running @samp{ranlib} on it.
488 @cindex not writing archive index
489 Do not generate an archive symbol table. This can speed up building a
490 large library in several steps. The resulting archive can not be used
491 with the linker. In order to build a symbol table, you must omit the
492 @samp{S} modifier on the last execution of @samp{ar}, or you must run
493 @samp{ranlib} on the archive.
496 @cindex creating thin archive
497 Make the specified @var{archive} a @emph{thin} archive. If it already
498 exists and is a regular archive, the existing members must be present
499 in the same directory as @var{archive}.
502 @cindex updating an archive
503 Normally, @samp{ar r}@dots{} inserts all files
504 listed into the archive. If you would like to insert @emph{only} those
505 of the files you list that are newer than existing members of the same
506 names, use this modifier. The @samp{u} modifier is allowed only for the
507 operation @samp{r} (replace). In particular, the combination @samp{qu} is
508 not allowed, since checking the timestamps would lose any speed
509 advantage from the operation @samp{q}.
512 @cindex deterministic archives
513 @kindex --enable-deterministic-archives
514 Do @emph{not} operate in @emph{deterministic} mode. This is the inverse
515 of the @samp{D} modifier, above: added files and the archive index will
516 get their actual UID, GID, timestamp, and file mode values.
518 This is the default unless @file{binutils} was configured with
519 @option{--enable-deterministic-archives}.
522 This modifier requests the @emph{verbose} version of an operation. Many
523 operations display additional information, such as filenames processed,
524 when the modifier @samp{v} is appended.
527 This modifier shows the version number of @command{ar}.
530 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
531 compatibility with AIX. The behaviour produced by this option is the
532 default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other
533 @samp{-X} options; in particular, it does not support @option{-X32}
534 which is the default for AIX @command{ar}.
536 The optional command line switch @option{--plugin} @var{name} causes
537 @command{ar} to load the plugin called @var{name} which adds support
538 for more file formats. This option is only available if the toolchain
539 has been built with plugin support enabled.
541 The optional command line switch @option{--target} @var{bfdname}
542 specifies that the archive members are in an object code format
543 different from your system's default format. See
544 @xref{Target Selection}, for more information.
549 @c man begin SEEALSO ar
550 nm(1), ranlib(1), and the Info entries for @file{binutils}.
555 @section Controlling @command{ar} with a Script
558 ar -M [ <@var{script} ]
561 @cindex MRI compatibility, @command{ar}
562 @cindex scripts, @command{ar}
563 If you use the single command-line option @samp{-M} with @command{ar}, you
564 can control its operation with a rudimentary command language. This
565 form of @command{ar} operates interactively if standard input is coming
566 directly from a terminal. During interactive use, @command{ar} prompts for
567 input (the prompt is @samp{AR >}), and continues executing even after
568 errors. If you redirect standard input to a script file, no prompts are
569 issued, and @command{ar} abandons execution (with a nonzero exit code)
572 The @command{ar} command language is @emph{not} designed to be equivalent
573 to the command-line options; in fact, it provides somewhat less control
574 over archives. The only purpose of the command language is to ease the
575 transition to @sc{gnu} @command{ar} for developers who already have scripts
576 written for the MRI ``librarian'' program.
578 The syntax for the @command{ar} command language is straightforward:
581 commands are recognized in upper or lower case; for example, @code{LIST}
582 is the same as @code{list}. In the following descriptions, commands are
583 shown in upper case for clarity.
586 a single command may appear on each line; it is the first word on the
590 empty lines are allowed, and have no effect.
593 comments are allowed; text after either of the characters @samp{*}
594 or @samp{;} is ignored.
597 Whenever you use a list of names as part of the argument to an @command{ar}
598 command, you can separate the individual names with either commas or
599 blanks. Commas are shown in the explanations below, for clarity.
602 @samp{+} is used as a line continuation character; if @samp{+} appears
603 at the end of a line, the text on the following line is considered part
604 of the current command.
607 Here are the commands you can use in @command{ar} scripts, or when using
608 @command{ar} interactively. Three of them have special significance:
610 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
611 a temporary file required for most of the other commands.
613 @code{SAVE} commits the changes so far specified by the script. Prior
614 to @code{SAVE}, commands affect only the temporary copy of the current
618 @item ADDLIB @var{archive}
619 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
620 Add all the contents of @var{archive} (or, if specified, each named
621 @var{module} from @var{archive}) to the current archive.
623 Requires prior use of @code{OPEN} or @code{CREATE}.
625 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
626 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
627 @c else like "ar q..."
628 Add each named @var{member} as a module in the current archive.
630 Requires prior use of @code{OPEN} or @code{CREATE}.
633 Discard the contents of the current archive, canceling the effect of
634 any operations since the last @code{SAVE}. May be executed (with no
635 effect) even if no current archive is specified.
637 @item CREATE @var{archive}
638 Creates an archive, and makes it the current archive (required for many
639 other commands). The new archive is created with a temporary name; it
640 is not actually saved as @var{archive} until you use @code{SAVE}.
641 You can overwrite existing archives; similarly, the contents of any
642 existing file named @var{archive} will not be destroyed until @code{SAVE}.
644 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
645 Delete each listed @var{module} from the current archive; equivalent to
646 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
648 Requires prior use of @code{OPEN} or @code{CREATE}.
650 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
651 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
652 List each named @var{module} present in @var{archive}. The separate
653 command @code{VERBOSE} specifies the form of the output: when verbose
654 output is off, output is like that of @samp{ar -t @var{archive}
655 @var{module}@dots{}}. When verbose output is on, the listing is like
656 @samp{ar -tv @var{archive} @var{module}@dots{}}.
658 Output normally goes to the standard output stream; however, if you
659 specify @var{outputfile} as a final argument, @command{ar} directs the
663 Exit from @command{ar}, with a @code{0} exit code to indicate successful
664 completion. This command does not save the output file; if you have
665 changed the current archive since the last @code{SAVE} command, those
668 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
669 Extract each named @var{module} from the current archive, writing them
670 into the current directory as separate files. Equivalent to @samp{ar -x
671 @var{archive} @var{module}@dots{}}.
673 Requires prior use of @code{OPEN} or @code{CREATE}.
676 @c FIXME Tokens but no commands???
683 Display full contents of the current archive, in ``verbose'' style
684 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
685 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
686 enhancement, rather than present for MRI compatibility.)
688 Requires prior use of @code{OPEN} or @code{CREATE}.
690 @item OPEN @var{archive}
691 Opens an existing archive for use as the current archive (required for
692 many other commands). Any changes as the result of subsequent commands
693 will not actually affect @var{archive} until you next use @code{SAVE}.
695 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
696 In the current archive, replace each existing @var{module} (named in
697 the @code{REPLACE} arguments) from files in the current working directory.
698 To execute this command without errors, both the file, and the module in
699 the current archive, must exist.
701 Requires prior use of @code{OPEN} or @code{CREATE}.
704 Toggle an internal flag governing the output from @code{DIRECTORY}.
705 When the flag is on, @code{DIRECTORY} output matches output from
706 @samp{ar -tv }@dots{}.
709 Commit your changes to the current archive, and actually save it as a
710 file with the name specified in the last @code{CREATE} or @code{OPEN}
713 Requires prior use of @code{OPEN} or @code{CREATE}.
722 The @sc{gnu} linker @command{ld} is now described in a separate manual.
723 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
731 @c man title nm list symbols from object files
734 @c man begin SYNOPSIS nm
735 nm [@option{-A}|@option{-o}|@option{--print-file-name}] [@option{-a}|@option{--debug-syms}]
736 [@option{-B}|@option{--format=bsd}] [@option{-C}|@option{--demangle}[=@var{style}]]
737 [@option{-D}|@option{--dynamic}] [@option{-f}@var{format}|@option{--format=}@var{format}]
738 [@option{-g}|@option{--extern-only}] [@option{-h}|@option{--help}]
739 [@option{-l}|@option{--line-numbers}] [@option{-n}|@option{-v}|@option{--numeric-sort}]
740 [@option{-P}|@option{--portability}] [@option{-p}|@option{--no-sort}]
741 [@option{-r}|@option{--reverse-sort}] [@option{-S}|@option{--print-size}]
742 [@option{-s}|@option{--print-armap}] [@option{-t} @var{radix}|@option{--radix=}@var{radix}]
743 [@option{-u}|@option{--undefined-only}] [@option{-V}|@option{--version}]
744 [@option{-X 32_64}] [@option{--defined-only}] [@option{--no-demangle}]
745 [@option{--plugin} @var{name}] [@option{--size-sort}] [@option{--special-syms}]
746 [@option{--synthetic}] [@option{--target=}@var{bfdname}]
747 [@var{objfile}@dots{}]
751 @c man begin DESCRIPTION nm
752 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
753 If no object files are listed as arguments, @command{nm} assumes the file
756 For each symbol, @command{nm} shows:
760 The symbol value, in the radix selected by options (see below), or
761 hexadecimal by default.
764 The symbol type. At least the following types are used; others are, as
765 well, depending on the object file format. If lowercase, the symbol is
766 usually local; if uppercase, the symbol is global (external). There
767 are however a few lowercase symbols that are shown for special global
768 symbols (@code{u}, @code{v} and @code{w}).
770 @c Some more detail on exactly what these symbol types are used for
774 The symbol's value is absolute, and will not be changed by further
779 The symbol is in the uninitialized data section (known as BSS).
782 The symbol is common. Common symbols are uninitialized data. When
783 linking, multiple common symbols may appear with the same name. If the
784 symbol is defined anywhere, the common symbols are treated as undefined
787 For more details on common symbols, see the discussion of
788 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
793 The symbol is in the initialized data section.
797 The symbol is in an initialized data section for small objects. Some
798 object file formats permit more efficient access to small data objects,
799 such as a global int variable as opposed to a large global array.
802 For PE format files this indicates that the symbol is in a section
803 specific to the implementation of DLLs. For ELF format files this
804 indicates that the symbol is an indirect function. This is a GNU
805 extension to the standard set of ELF symbol types. It indicates a
806 symbol which if referenced by a relocation does not evaluate to its
807 address, but instead must be invoked at runtime. The runtime
808 execution will then return the value to be used in the relocation.
811 The symbol is an indirect reference to another symbol.
814 The symbol is a debugging symbol.
817 The symbols is in a stack unwind section.
821 The symbol is in a read only data section.
825 The symbol is in an uninitialized data section for small objects.
829 The symbol is in the text (code) section.
832 The symbol is undefined.
835 The symbol is a unique global symbol. This is a GNU extension to the
836 standard set of ELF symbol bindings. For such a symbol the dynamic linker
837 will make sure that in the entire process there is just one symbol with
838 this name and type in use.
842 The symbol is a weak object. When a weak defined symbol is linked with
843 a normal defined symbol, the normal defined symbol is used with no error.
844 When a weak undefined symbol is linked and the symbol is not defined,
845 the value of the weak symbol becomes zero with no error. On some
846 systems, uppercase indicates that a default value has been specified.
850 The symbol is a weak symbol that has not been specifically tagged as a
851 weak object symbol. When a weak defined symbol is linked with a normal
852 defined symbol, the normal defined symbol is used with no error.
853 When a weak undefined symbol is linked and the symbol is not defined,
854 the value of the symbol is determined in a system-specific manner without
855 error. On some systems, uppercase indicates that a default value has been
859 The symbol is a stabs symbol in an a.out object file. In this case, the
860 next values printed are the stabs other field, the stabs desc field, and
861 the stab type. Stabs symbols are used to hold debugging information.
864 The symbol type is unknown, or object file format specific.
873 @c man begin OPTIONS nm
874 The long and short forms of options, shown here as alternatives, are
880 @itemx --print-file-name
881 @cindex input file name
883 @cindex source file name
884 Precede each symbol by the name of the input file (or archive member)
885 in which it was found, rather than identifying the input file once only,
886 before all of its symbols.
890 @cindex debugging symbols
891 Display all symbols, even debugger-only symbols; normally these are not
895 @cindex @command{nm} format
896 @cindex @command{nm} compatibility
897 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
900 @itemx --demangle[=@var{style}]
901 @cindex demangling in nm
902 Decode (@dfn{demangle}) low-level symbol names into user-level names.
903 Besides removing any initial underscore prepended by the system, this
904 makes C++ function names readable. Different compilers have different
905 mangling styles. The optional demangling style argument can be used to
906 choose an appropriate demangling style for your compiler. @xref{c++filt},
907 for more information on demangling.
910 Do not demangle low-level symbol names. This is the default.
914 @cindex dynamic symbols
915 Display the dynamic symbols rather than the normal symbols. This is
916 only meaningful for dynamic objects, such as certain types of shared
919 @item -f @var{format}
920 @itemx --format=@var{format}
921 @cindex @command{nm} format
922 @cindex @command{nm} compatibility
923 Use the output format @var{format}, which can be @code{bsd},
924 @code{sysv}, or @code{posix}. The default is @code{bsd}.
925 Only the first character of @var{format} is significant; it can be
926 either upper or lower case.
930 @cindex external symbols
931 Display only external symbols.
935 Show a summary of the options to @command{nm} and exit.
938 @itemx --line-numbers
939 @cindex symbol line numbers
940 For each symbol, use debugging information to try to find a filename and
941 line number. For a defined symbol, look for the line number of the
942 address of the symbol. For an undefined symbol, look for the line
943 number of a relocation entry which refers to the symbol. If line number
944 information can be found, print it after the other symbol information.
948 @itemx --numeric-sort
949 Sort symbols numerically by their addresses, rather than alphabetically
954 @cindex sorting symbols
955 Do not bother to sort the symbols in any order; print them in the order
960 Use the POSIX.2 standard output format instead of the default format.
961 Equivalent to @samp{-f posix}.
964 @itemx --reverse-sort
965 Reverse the order of the sort (whether numeric or alphabetic); let the
970 Print both value and size of defined symbols for the @code{bsd} output style.
971 This option has no effect for object formats that do not record symbol
972 sizes, unless @samp{--size-sort} is also used in which case a
973 calculated size is displayed.
977 @cindex symbol index, listing
978 When listing symbols from archive members, include the index: a mapping
979 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
980 contain definitions for which names.
983 @itemx --radix=@var{radix}
984 Use @var{radix} as the radix for printing the symbol values. It must be
985 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
988 @itemx --undefined-only
989 @cindex external symbols
990 @cindex undefined symbols
991 Display only undefined symbols (those external to each object file).
995 Show the version number of @command{nm} and exit.
998 This option is ignored for compatibility with the AIX version of
999 @command{nm}. It takes one parameter which must be the string
1000 @option{32_64}. The default mode of AIX @command{nm} corresponds
1001 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1003 @item --defined-only
1004 @cindex external symbols
1005 @cindex undefined symbols
1006 Display only defined symbols for each object file.
1008 @item --plugin @var{name}
1010 Load the plugin called @var{name} to add support for extra target
1011 types. This option is only available if the toolchain has been built
1012 with plugin support enabled.
1015 Sort symbols by size. For ELF objects symbol sizes are read from the
1016 ELF, for other object types the symbol sizes are computed as the
1017 difference between the value of the symbol and the value of the symbol
1018 with the next higher value. If the @code{bsd} output format is used
1019 the size of the symbol is printed, rather than the value, and
1020 @samp{-S} must be used in order both size and value to be printed.
1022 @item --special-syms
1023 Display symbols which have a target-specific special meaning. These
1024 symbols are usually used by the target for some special processing and
1025 are not normally helpful when included in the normal symbol lists.
1026 For example for ARM targets this option would skip the mapping symbols
1027 used to mark transitions between ARM code, THUMB code and data.
1030 Include synthetic symbols in the output. These are special symbols
1031 created by the linker for various purposes. They are not shown by
1032 default since they are not part of the binary's original source code.
1034 @item --target=@var{bfdname}
1035 @cindex object code format
1036 Specify an object code format other than your system's default format.
1037 @xref{Target Selection}, for more information.
1044 @c man begin SEEALSO nm
1045 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1052 @c man title objcopy copy and translate object files
1055 @c man begin SYNOPSIS objcopy
1056 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1057 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1058 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1059 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1060 [@option{-S}|@option{--strip-all}]
1061 [@option{-g}|@option{--strip-debug}]
1062 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1063 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1064 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1065 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1066 [@option{--localize-hidden}]
1067 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1068 [@option{--globalize-symbol=}@var{symbolname}]
1069 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1070 [@option{-w}|@option{--wildcard}]
1071 [@option{-x}|@option{--discard-all}]
1072 [@option{-X}|@option{--discard-locals}]
1073 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1074 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1075 [@option{--interleave-width=}@var{width}]
1076 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1077 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1078 [@option{-p}|@option{--preserve-dates}]
1079 [@option{-D}|@option{--enable-deterministic-archives}]
1080 [@option{-U}|@option{--disable-deterministic-archives}]
1081 [@option{--debugging}]
1082 [@option{--gap-fill=}@var{val}]
1083 [@option{--pad-to=}@var{address}]
1084 [@option{--set-start=}@var{val}]
1085 [@option{--adjust-start=}@var{incr}]
1086 [@option{--change-addresses=}@var{incr}]
1087 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1088 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1089 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1090 [@option{--change-warnings}] [@option{--no-change-warnings}]
1091 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1092 [@option{--add-section} @var{sectionname}=@var{filename}]
1093 [@option{--dump-section} @var{sectionname}=@var{filename}]
1094 [@option{--update-section} @var{sectionname}=@var{filename}]
1095 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1096 [@option{--long-section-names} @{enable,disable,keep@}]
1097 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1098 [@option{--reverse-bytes=}@var{num}]
1099 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1100 [@option{--redefine-sym} @var{old}=@var{new}]
1101 [@option{--redefine-syms=}@var{filename}]
1103 [@option{--keep-symbols=}@var{filename}]
1104 [@option{--strip-symbols=}@var{filename}]
1105 [@option{--strip-unneeded-symbols=}@var{filename}]
1106 [@option{--keep-global-symbols=}@var{filename}]
1107 [@option{--localize-symbols=}@var{filename}]
1108 [@option{--globalize-symbols=}@var{filename}]
1109 [@option{--weaken-symbols=}@var{filename}]
1110 [@option{--add-symbol} @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1111 [@option{--alt-machine-code=}@var{index}]
1112 [@option{--prefix-symbols=}@var{string}]
1113 [@option{--prefix-sections=}@var{string}]
1114 [@option{--prefix-alloc-sections=}@var{string}]
1115 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1116 [@option{--keep-file-symbols}]
1117 [@option{--only-keep-debug}]
1118 [@option{--strip-dwo}]
1119 [@option{--extract-dwo}]
1120 [@option{--extract-symbol}]
1121 [@option{--writable-text}]
1122 [@option{--readonly-text}]
1125 [@option{--file-alignment=}@var{num}]
1126 [@option{--heap=}@var{size}]
1127 [@option{--image-base=}@var{address}]
1128 [@option{--section-alignment=}@var{num}]
1129 [@option{--stack=}@var{size}]
1130 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1131 [@option{--compress-debug-sections}]
1132 [@option{--decompress-debug-sections}]
1133 [@option{--elf-stt-common=@var{val}}]
1134 [@option{-v}|@option{--verbose}]
1135 [@option{-V}|@option{--version}]
1136 [@option{--help}] [@option{--info}]
1137 @var{infile} [@var{outfile}]
1141 @c man begin DESCRIPTION objcopy
1142 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1143 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1144 read and write the object files. It can write the destination object
1145 file in a format different from that of the source object file. The
1146 exact behavior of @command{objcopy} is controlled by command-line options.
1147 Note that @command{objcopy} should be able to copy a fully linked file
1148 between any two formats. However, copying a relocatable object file
1149 between any two formats may not work as expected.
1151 @command{objcopy} creates temporary files to do its translations and
1152 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1153 translation work; it has access to all the formats described in @sc{bfd}
1154 and thus is able to recognize most formats without being told
1155 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1157 @command{objcopy} can be used to generate S-records by using an output
1158 target of @samp{srec} (e.g., use @samp{-O srec}).
1160 @command{objcopy} can be used to generate a raw binary file by using an
1161 output target of @samp{binary} (e.g., use @option{-O binary}). When
1162 @command{objcopy} generates a raw binary file, it will essentially produce
1163 a memory dump of the contents of the input object file. All symbols and
1164 relocation information will be discarded. The memory dump will start at
1165 the load address of the lowest section copied into the output file.
1167 When generating an S-record or a raw binary file, it may be helpful to
1168 use @option{-S} to remove sections containing debugging information. In
1169 some cases @option{-R} will be useful to remove sections which contain
1170 information that is not needed by the binary file.
1172 Note---@command{objcopy} is not able to change the endianness of its input
1173 files. If the input format has an endianness (some formats do not),
1174 @command{objcopy} can only copy the inputs into file formats that have the
1175 same endianness or which have no endianness (e.g., @samp{srec}).
1176 (However, see the @option{--reverse-bytes} option.)
1180 @c man begin OPTIONS objcopy
1184 @itemx @var{outfile}
1185 The input and output files, respectively.
1186 If you do not specify @var{outfile}, @command{objcopy} creates a
1187 temporary file and destructively renames the result with
1188 the name of @var{infile}.
1190 @item -I @var{bfdname}
1191 @itemx --input-target=@var{bfdname}
1192 Consider the source file's object format to be @var{bfdname}, rather than
1193 attempting to deduce it. @xref{Target Selection}, for more information.
1195 @item -O @var{bfdname}
1196 @itemx --output-target=@var{bfdname}
1197 Write the output file using the object format @var{bfdname}.
1198 @xref{Target Selection}, for more information.
1200 @item -F @var{bfdname}
1201 @itemx --target=@var{bfdname}
1202 Use @var{bfdname} as the object format for both the input and the output
1203 file; i.e., simply transfer data from source to destination with no
1204 translation. @xref{Target Selection}, for more information.
1206 @item -B @var{bfdarch}
1207 @itemx --binary-architecture=@var{bfdarch}
1208 Useful when transforming a architecture-less input file into an object file.
1209 In this case the output architecture can be set to @var{bfdarch}. This
1210 option will be ignored if the input file has a known @var{bfdarch}. You
1211 can access this binary data inside a program by referencing the special
1212 symbols that are created by the conversion process. These symbols are
1213 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1214 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1215 an object file and then access it in your code using these symbols.
1217 @item -j @var{sectionpattern}
1218 @itemx --only-section=@var{sectionpattern}
1219 Copy only the indicated sections from the input file to the output file.
1220 This option may be given more than once. Note that using this option
1221 inappropriately may make the output file unusable. Wildcard
1222 characters are accepted in @var{sectionpattern}.
1224 If the first character of @var{sectionpattern} is the exclamation
1225 point (!) then matching sections will not be copied, even if earlier
1226 use of @option{--only-section} on the same command line would
1227 otherwise copy it. For example:
1230 --only-section=.text.* --only-section=!.text.foo
1233 will copy all sectinos maching '.text.*' but not the section
1236 @item -R @var{sectionpattern}
1237 @itemx --remove-section=@var{sectionpattern}
1238 Remove any section matching @var{sectionpattern} from the output file.
1239 This option may be given more than once. Note that using this option
1240 inappropriately may make the output file unusable. Wildcard
1241 characters are accepted in @var{sectionpattern}. Using both the
1242 @option{-j} and @option{-R} options together results in undefined
1245 If the first character of @var{sectionpattern} is the exclamation
1246 point (!) then matching sections will not be removed even if an
1247 earlier use of @option{--remove-section} on the same command line
1248 would otherwise remove it. For example:
1251 --remove-section=.text.* --remove-section=!.text.foo
1254 will remove all sections matching the pattern '.text.*', but will not
1255 remove the section '.text.foo'.
1259 Do not copy relocation and symbol information from the source file.
1262 @itemx --strip-debug
1263 Do not copy debugging symbols or sections from the source file.
1265 @item --strip-unneeded
1266 Strip all symbols that are not needed for relocation processing.
1268 @item -K @var{symbolname}
1269 @itemx --keep-symbol=@var{symbolname}
1270 When stripping symbols, keep symbol @var{symbolname} even if it would
1271 normally be stripped. This option may be given more than once.
1273 @item -N @var{symbolname}
1274 @itemx --strip-symbol=@var{symbolname}
1275 Do not copy symbol @var{symbolname} from the source file. This option
1276 may be given more than once.
1278 @item --strip-unneeded-symbol=@var{symbolname}
1279 Do not copy symbol @var{symbolname} from the source file unless it is needed
1280 by a relocation. This option may be given more than once.
1282 @item -G @var{symbolname}
1283 @itemx --keep-global-symbol=@var{symbolname}
1284 Keep only symbol @var{symbolname} global. Make all other symbols local
1285 to the file, so that they are not visible externally. This option may
1286 be given more than once.
1288 @item --localize-hidden
1289 In an ELF object, mark all symbols that have hidden or internal visibility
1290 as local. This option applies on top of symbol-specific localization options
1291 such as @option{-L}.
1293 @item -L @var{symbolname}
1294 @itemx --localize-symbol=@var{symbolname}
1295 Make symbol @var{symbolname} local to the file, so that it is not
1296 visible externally. This option may be given more than once.
1298 @item -W @var{symbolname}
1299 @itemx --weaken-symbol=@var{symbolname}
1300 Make symbol @var{symbolname} weak. This option may be given more than once.
1302 @item --globalize-symbol=@var{symbolname}
1303 Give symbol @var{symbolname} global scoping so that it is visible
1304 outside of the file in which it is defined. This option may be given
1309 Permit regular expressions in @var{symbolname}s used in other command
1310 line options. The question mark (?), asterisk (*), backslash (\) and
1311 square brackets ([]) operators can be used anywhere in the symbol
1312 name. If the first character of the symbol name is the exclamation
1313 point (!) then the sense of the switch is reversed for that symbol.
1320 would cause objcopy to weaken all symbols that start with ``fo''
1321 except for the symbol ``foo''.
1324 @itemx --discard-all
1325 Do not copy non-global symbols from the source file.
1326 @c FIXME any reason to prefer "non-global" to "local" here?
1329 @itemx --discard-locals
1330 Do not copy compiler-generated local symbols.
1331 (These usually start with @samp{L} or @samp{.}.)
1334 @itemx --byte=@var{byte}
1335 If interleaving has been enabled via the @option{--interleave} option
1336 then start the range of bytes to keep at the @var{byte}th byte.
1337 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1338 @var{breadth} is the value given by the @option{--interleave} option.
1340 @item -i [@var{breadth}]
1341 @itemx --interleave[=@var{breadth}]
1342 Only copy a range out of every @var{breadth} bytes. (Header data is
1343 not affected). Select which byte in the range begins the copy with
1344 the @option{--byte} option. Select the width of the range with the
1345 @option{--interleave-width} option.
1347 This option is useful for creating files to program @sc{rom}. It is
1348 typically used with an @code{srec} output target. Note that
1349 @command{objcopy} will complain if you do not specify the
1350 @option{--byte} option as well.
1352 The default interleave breadth is 4, so with @option{--byte} set to 0,
1353 @command{objcopy} would copy the first byte out of every four bytes
1354 from the input to the output.
1356 @item --interleave-width=@var{width}
1357 When used with the @option{--interleave} option, copy @var{width}
1358 bytes at a time. The start of the range of bytes to be copied is set
1359 by the @option{--byte} option, and the extent of the range is set with
1360 the @option{--interleave} option.
1362 The default value for this option is 1. The value of @var{width} plus
1363 the @var{byte} value set by the @option{--byte} option must not exceed
1364 the interleave breadth set by the @option{--interleave} option.
1366 This option can be used to create images for two 16-bit flashes interleaved
1367 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1368 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1369 commands. If the input was '12345678' then the outputs would be
1370 '1256' and '3478' respectively.
1373 @itemx --preserve-dates
1374 Set the access and modification dates of the output file to be the same
1375 as those of the input file.
1378 @itemx --enable-deterministic-archives
1379 @cindex deterministic archives
1380 @kindex --enable-deterministic-archives
1381 Operate in @emph{deterministic} mode. When copying archive members
1382 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1383 and use consistent file modes for all files.
1385 If @file{binutils} was configured with
1386 @option{--enable-deterministic-archives}, then this mode is on by default.
1387 It can be disabled with the @samp{-U} option, below.
1390 @itemx --disable-deterministic-archives
1391 @cindex deterministic archives
1392 @kindex --enable-deterministic-archives
1393 Do @emph{not} operate in @emph{deterministic} mode. This is the
1394 inverse of the @option{-D} option, above: when copying archive members
1395 and writing the archive index, use their actual UID, GID, timestamp,
1396 and file mode values.
1398 This is the default unless @file{binutils} was configured with
1399 @option{--enable-deterministic-archives}.
1402 Convert debugging information, if possible. This is not the default
1403 because only certain debugging formats are supported, and the
1404 conversion process can be time consuming.
1406 @item --gap-fill @var{val}
1407 Fill gaps between sections with @var{val}. This operation applies to
1408 the @emph{load address} (LMA) of the sections. It is done by increasing
1409 the size of the section with the lower address, and filling in the extra
1410 space created with @var{val}.
1412 @item --pad-to @var{address}
1413 Pad the output file up to the load address @var{address}. This is
1414 done by increasing the size of the last section. The extra space is
1415 filled in with the value specified by @option{--gap-fill} (default zero).
1417 @item --set-start @var{val}
1418 Set the start address of the new file to @var{val}. Not all object file
1419 formats support setting the start address.
1421 @item --change-start @var{incr}
1422 @itemx --adjust-start @var{incr}
1423 @cindex changing start address
1424 Change the start address by adding @var{incr}. Not all object file
1425 formats support setting the start address.
1427 @item --change-addresses @var{incr}
1428 @itemx --adjust-vma @var{incr}
1429 @cindex changing object addresses
1430 Change the VMA and LMA addresses of all sections, as well as the start
1431 address, by adding @var{incr}. Some object file formats do not permit
1432 section addresses to be changed arbitrarily. Note that this does not
1433 relocate the sections; if the program expects sections to be loaded at a
1434 certain address, and this option is used to change the sections such
1435 that they are loaded at a different address, the program may fail.
1437 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1438 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1439 @cindex changing section address
1440 Set or change both the VMA address and the LMA address of any section
1441 matching @var{sectionpattern}. If @samp{=} is used, the section
1442 address is set to @var{val}. Otherwise, @var{val} is added to or
1443 subtracted from the section address. See the comments under
1444 @option{--change-addresses}, above. If @var{sectionpattern} does not
1445 match any sections in the input file, a warning will be issued, unless
1446 @option{--no-change-warnings} is used.
1448 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1449 @cindex changing section LMA
1450 Set or change the LMA address of any sections matching
1451 @var{sectionpattern}. The LMA address is the address where the
1452 section will be loaded into memory at program load time. Normally
1453 this is the same as the VMA address, which is the address of the
1454 section at program run time, but on some systems, especially those
1455 where a program is held in ROM, the two can be different. If @samp{=}
1456 is used, the section address is set to @var{val}. Otherwise,
1457 @var{val} is added to or subtracted from the section address. See the
1458 comments under @option{--change-addresses}, above. If
1459 @var{sectionpattern} does not match any sections in the input file, a
1460 warning will be issued, unless @option{--no-change-warnings} is used.
1462 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1463 @cindex changing section VMA
1464 Set or change the VMA address of any section matching
1465 @var{sectionpattern}. The VMA address is the address where the
1466 section will be located once the program has started executing.
1467 Normally this is the same as the LMA address, which is the address
1468 where the section will be loaded into memory, but on some systems,
1469 especially those where a program is held in ROM, the two can be
1470 different. If @samp{=} is used, the section address is set to
1471 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1472 section address. See the comments under @option{--change-addresses},
1473 above. If @var{sectionpattern} does not match any sections in the
1474 input file, a warning will be issued, unless
1475 @option{--no-change-warnings} is used.
1477 @item --change-warnings
1478 @itemx --adjust-warnings
1479 If @option{--change-section-address} or @option{--change-section-lma} or
1480 @option{--change-section-vma} is used, and the section pattern does not
1481 match any sections, issue a warning. This is the default.
1483 @item --no-change-warnings
1484 @itemx --no-adjust-warnings
1485 Do not issue a warning if @option{--change-section-address} or
1486 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1487 if the section pattern does not match any sections.
1489 @item --set-section-flags @var{sectionpattern}=@var{flags}
1490 Set the flags for any sections matching @var{sectionpattern}. The
1491 @var{flags} argument is a comma separated string of flag names. The
1492 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1493 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1494 @samp{share}, and @samp{debug}. You can set the @samp{contents} flag
1495 for a section which does not have contents, but it is not meaningful
1496 to clear the @samp{contents} flag of a section which does have
1497 contents--just remove the section instead. Not all flags are
1498 meaningful for all object file formats.
1500 @item --add-section @var{sectionname}=@var{filename}
1501 Add a new section named @var{sectionname} while copying the file. The
1502 contents of the new section are taken from the file @var{filename}. The
1503 size of the section will be the size of the file. This option only
1504 works on file formats which can support sections with arbitrary names.
1505 Note - it may be necessary to use the @option{--set-section-flags}
1506 option to set the attributes of the newly created section.
1508 @item --dump-section @var{sectionname}=@var{filename}
1509 Place the contents of section named @var{sectionname} into the file
1510 @var{filename}, overwriting any contents that may have been there
1511 previously. This option is the inverse of @option{--add-section}.
1512 This option is similar to the @option{--only-section} option except
1513 that it does not create a formatted file, it just dumps the contents
1514 as raw binary data, without applying any relocations. The option can
1515 be specified more than once.
1517 @item --update-section @var{sectionname}=@var{filename}
1518 Replace the existing contents of a section named @var{sectionname}
1519 with the contents of file @var{filename}. The size of the section
1520 will be adjusted to the size of the file. The section flags for
1521 @var{sectionname} will be unchanged. For ELF format files the section
1522 to segment mapping will also remain unchanged, something which is not
1523 possible using @option{--remove-section} followed by
1524 @option{--add-section}. The option can be specified more than once.
1526 Note - it is possible to use @option{--rename-section} and
1527 @option{--update-section} to both update and rename a section from one
1528 command line. In this case, pass the original section name to
1529 @option{--update-section}, and the original and new section names to
1530 @option{--rename-section}.
1532 @item --add-symbol @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1533 Add a new symbol named @var{name} while copying the file. This option may be
1534 specified multiple times. If the @var{section} is given, the symbol will be
1535 associated with and relative to that section, otherwise it will be an ABS
1536 symbol. Specifying an undefined section will result in a fatal error. There
1537 is no check for the value, it will be taken as specified. Symbol flags can
1538 be specified and not all flags will be meaningful for all object file
1539 formats. By default, the symbol will be global. The special flag
1540 'before=@var{othersym}' will insert the new symbol in front of the specified
1541 @var{othersym}, otherwise the symbol(s) will be added at the end of the
1542 symbol table in the order they appear.
1544 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1545 Rename a section from @var{oldname} to @var{newname}, optionally
1546 changing the section's flags to @var{flags} in the process. This has
1547 the advantage over usng a linker script to perform the rename in that
1548 the output stays as an object file and does not become a linked
1551 This option is particularly helpful when the input format is binary,
1552 since this will always create a section called .data. If for example,
1553 you wanted instead to create a section called .rodata containing binary
1554 data you could use the following command line to achieve it:
1557 objcopy -I binary -O <output_format> -B <architecture> \
1558 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1559 <input_binary_file> <output_object_file>
1562 @item --long-section-names @{enable,disable,keep@}
1563 Controls the handling of long section names when processing @code{COFF}
1564 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1565 is to preserve long section names if any are present in the input file.
1566 The @samp{enable} and @samp{disable} options forcibly enable or disable
1567 the use of long section names in the output object; when @samp{disable}
1568 is in effect, any long section names in the input object will be truncated.
1569 The @samp{enable} option will only emit long section names if any are
1570 present in the inputs; this is mostly the same as @samp{keep}, but it
1571 is left undefined whether the @samp{enable} option might force the
1572 creation of an empty string table in the output file.
1574 @item --change-leading-char
1575 Some object file formats use special characters at the start of
1576 symbols. The most common such character is underscore, which compilers
1577 often add before every symbol. This option tells @command{objcopy} to
1578 change the leading character of every symbol when it converts between
1579 object file formats. If the object file formats use the same leading
1580 character, this option has no effect. Otherwise, it will add a
1581 character, or remove a character, or change a character, as
1584 @item --remove-leading-char
1585 If the first character of a global symbol is a special symbol leading
1586 character used by the object file format, remove the character. The
1587 most common symbol leading character is underscore. This option will
1588 remove a leading underscore from all global symbols. This can be useful
1589 if you want to link together objects of different file formats with
1590 different conventions for symbol names. This is different from
1591 @option{--change-leading-char} because it always changes the symbol name
1592 when appropriate, regardless of the object file format of the output
1595 @item --reverse-bytes=@var{num}
1596 Reverse the bytes in a section with output contents. A section length must
1597 be evenly divisible by the value given in order for the swap to be able to
1598 take place. Reversing takes place before the interleaving is performed.
1600 This option is used typically in generating ROM images for problematic
1601 target systems. For example, on some target boards, the 32-bit words
1602 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1603 regardless of the CPU byte order. Depending on the programming model, the
1604 endianness of the ROM may need to be modified.
1606 Consider a simple file with a section containing the following eight
1607 bytes: @code{12345678}.
1609 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1610 output file would be ordered @code{21436587}.
1612 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1613 output file would be ordered @code{43218765}.
1615 By using @samp{--reverse-bytes=2} for the above example, followed by
1616 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1617 output file would be ordered @code{34127856}.
1619 @item --srec-len=@var{ival}
1620 Meaningful only for srec output. Set the maximum length of the Srecords
1621 being produced to @var{ival}. This length covers both address, data and
1624 @item --srec-forceS3
1625 Meaningful only for srec output. Avoid generation of S1/S2 records,
1626 creating S3-only record format.
1628 @item --redefine-sym @var{old}=@var{new}
1629 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1630 when one is trying link two things together for which you have no
1631 source, and there are name collisions.
1633 @item --redefine-syms=@var{filename}
1634 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1635 listed in the file @var{filename}. @var{filename} is simply a flat file,
1636 with one symbol pair per line. Line comments may be introduced by the hash
1637 character. This option may be given more than once.
1640 Change all global symbols in the file to be weak. This can be useful
1641 when building an object which will be linked against other objects using
1642 the @option{-R} option to the linker. This option is only effective when
1643 using an object file format which supports weak symbols.
1645 @item --keep-symbols=@var{filename}
1646 Apply @option{--keep-symbol} option to each symbol listed in the file
1647 @var{filename}. @var{filename} is simply a flat file, with one symbol
1648 name per line. Line comments may be introduced by the hash character.
1649 This option may be given more than once.
1651 @item --strip-symbols=@var{filename}
1652 Apply @option{--strip-symbol} option to each symbol listed in the file
1653 @var{filename}. @var{filename} is simply a flat file, with one symbol
1654 name per line. Line comments may be introduced by the hash character.
1655 This option may be given more than once.
1657 @item --strip-unneeded-symbols=@var{filename}
1658 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1659 the file @var{filename}. @var{filename} is simply a flat file, with one
1660 symbol name per line. Line comments may be introduced by the hash
1661 character. This option may be given more than once.
1663 @item --keep-global-symbols=@var{filename}
1664 Apply @option{--keep-global-symbol} option to each symbol listed in the
1665 file @var{filename}. @var{filename} is simply a flat file, with one
1666 symbol name per line. Line comments may be introduced by the hash
1667 character. This option may be given more than once.
1669 @item --localize-symbols=@var{filename}
1670 Apply @option{--localize-symbol} option to each symbol listed in the file
1671 @var{filename}. @var{filename} is simply a flat file, with one symbol
1672 name per line. Line comments may be introduced by the hash character.
1673 This option may be given more than once.
1675 @item --globalize-symbols=@var{filename}
1676 Apply @option{--globalize-symbol} option to each symbol listed in the file
1677 @var{filename}. @var{filename} is simply a flat file, with one symbol
1678 name per line. Line comments may be introduced by the hash character.
1679 This option may be given more than once.
1681 @item --weaken-symbols=@var{filename}
1682 Apply @option{--weaken-symbol} option to each symbol listed in the file
1683 @var{filename}. @var{filename} is simply a flat file, with one symbol
1684 name per line. Line comments may be introduced by the hash character.
1685 This option may be given more than once.
1687 @item --alt-machine-code=@var{index}
1688 If the output architecture has alternate machine codes, use the
1689 @var{index}th code instead of the default one. This is useful in case
1690 a machine is assigned an official code and the tool-chain adopts the
1691 new code, but other applications still depend on the original code
1692 being used. For ELF based architectures if the @var{index}
1693 alternative does not exist then the value is treated as an absolute
1694 number to be stored in the e_machine field of the ELF header.
1696 @item --writable-text
1697 Mark the output text as writable. This option isn't meaningful for all
1698 object file formats.
1700 @item --readonly-text
1701 Make the output text write protected. This option isn't meaningful for all
1702 object file formats.
1705 Mark the output file as demand paged. This option isn't meaningful for all
1706 object file formats.
1709 Mark the output file as impure. This option isn't meaningful for all
1710 object file formats.
1712 @item --prefix-symbols=@var{string}
1713 Prefix all symbols in the output file with @var{string}.
1715 @item --prefix-sections=@var{string}
1716 Prefix all section names in the output file with @var{string}.
1718 @item --prefix-alloc-sections=@var{string}
1719 Prefix all the names of all allocated sections in the output file with
1722 @item --add-gnu-debuglink=@var{path-to-file}
1723 Creates a .gnu_debuglink section which contains a reference to
1724 @var{path-to-file} and adds it to the output file. Note: the file at
1725 @var{path-to-file} must exist. Part of the process of adding the
1726 .gnu_debuglink section involves embedding a checksum of the contents
1727 of the debug info file into the section.
1729 If the debug info file is built in one location but it is going to be
1730 installed at a later time into a different location then do not use
1731 the path to the installed location. The @option{--add-gnu-debuglink}
1732 option will fail because the installed file does not exist yet.
1733 Instead put the debug info file in the current directory and use the
1734 @option{--add-gnu-debuglink} option without any directory components,
1738 objcopy --add-gnu-debuglink=foo.debug
1741 At debug time the debugger will attempt to look for the separate debug
1742 info file in a set of known locations. The exact set of these
1743 locations varies depending upon the distribution being used, but it
1748 @item * The same directory as the executable.
1750 @item * A sub-directory of the directory containing the executable
1753 @item * A global debug directory such as /usr/lib/debug.
1756 As long as the debug info file has been installed into one of these
1757 locations before the debugger is run everything should work
1760 @item --keep-file-symbols
1761 When stripping a file, perhaps with @option{--strip-debug} or
1762 @option{--strip-unneeded}, retain any symbols specifying source file names,
1763 which would otherwise get stripped.
1765 @item --only-keep-debug
1766 Strip a file, removing contents of any sections that would not be
1767 stripped by @option{--strip-debug} and leaving the debugging sections
1768 intact. In ELF files, this preserves all note sections in the output.
1770 Note - the section headers of the stripped sections are preserved,
1771 including their sizes, but the contents of the section are discarded.
1772 The section headers are preserved so that other tools can match up the
1773 debuginfo file with the real executable, even if that executable has
1774 been relocated to a different address space.
1776 The intention is that this option will be used in conjunction with
1777 @option{--add-gnu-debuglink} to create a two part executable. One a
1778 stripped binary which will occupy less space in RAM and in a
1779 distribution and the second a debugging information file which is only
1780 needed if debugging abilities are required. The suggested procedure
1781 to create these files is as follows:
1784 @item Link the executable as normal. Assuming that is is called
1786 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1787 create a file containing the debugging info.
1788 @item Run @code{objcopy --strip-debug foo} to create a
1789 stripped executable.
1790 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1791 to add a link to the debugging info into the stripped executable.
1794 Note---the choice of @code{.dbg} as an extension for the debug info
1795 file is arbitrary. Also the @code{--only-keep-debug} step is
1796 optional. You could instead do this:
1799 @item Link the executable as normal.
1800 @item Copy @code{foo} to @code{foo.full}
1801 @item Run @code{objcopy --strip-debug foo}
1802 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1805 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1806 full executable. It does not have to be a file created by the
1807 @option{--only-keep-debug} switch.
1809 Note---this switch is only intended for use on fully linked files. It
1810 does not make sense to use it on object files where the debugging
1811 information may be incomplete. Besides the gnu_debuglink feature
1812 currently only supports the presence of one filename containing
1813 debugging information, not multiple filenames on a one-per-object-file
1817 Remove the contents of all DWARF .dwo sections, leaving the
1818 remaining debugging sections and all symbols intact.
1819 This option is intended for use by the compiler as part of
1820 the @option{-gsplit-dwarf} option, which splits debug information
1821 between the .o file and a separate .dwo file. The compiler
1822 generates all debug information in the same file, then uses
1823 the @option{--extract-dwo} option to copy the .dwo sections to
1824 the .dwo file, then the @option{--strip-dwo} option to remove
1825 those sections from the original .o file.
1828 Extract the contents of all DWARF .dwo sections. See the
1829 @option{--strip-dwo} option for more information.
1831 @item --file-alignment @var{num}
1832 Specify the file alignment. Sections in the file will always begin at
1833 file offsets which are multiples of this number. This defaults to
1835 [This option is specific to PE targets.]
1837 @item --heap @var{reserve}
1838 @itemx --heap @var{reserve},@var{commit}
1839 Specify the number of bytes of memory to reserve (and optionally commit)
1840 to be used as heap for this program.
1841 [This option is specific to PE targets.]
1843 @item --image-base @var{value}
1844 Use @var{value} as the base address of your program or dll. This is
1845 the lowest memory location that will be used when your program or dll
1846 is loaded. To reduce the need to relocate and improve performance of
1847 your dlls, each should have a unique base address and not overlap any
1848 other dlls. The default is 0x400000 for executables, and 0x10000000
1850 [This option is specific to PE targets.]
1852 @item --section-alignment @var{num}
1853 Sets the section alignment. Sections in memory will always begin at
1854 addresses which are a multiple of this number. Defaults to 0x1000.
1855 [This option is specific to PE targets.]
1857 @item --stack @var{reserve}
1858 @itemx --stack @var{reserve},@var{commit}
1859 Specify the number of bytes of memory to reserve (and optionally commit)
1860 to be used as stack for this program.
1861 [This option is specific to PE targets.]
1863 @item --subsystem @var{which}
1864 @itemx --subsystem @var{which}:@var{major}
1865 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1866 Specifies the subsystem under which your program will execute. The
1867 legal values for @var{which} are @code{native}, @code{windows},
1868 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1869 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1870 the subsystem version also. Numeric values are also accepted for
1872 [This option is specific to PE targets.]
1874 @item --extract-symbol
1875 Keep the file's section flags and symbols but remove all section data.
1876 Specifically, the option:
1879 @item removes the contents of all sections;
1880 @item sets the size of every section to zero; and
1881 @item sets the file's start address to zero.
1884 This option is used to build a @file{.sym} file for a VxWorks kernel.
1885 It can also be a useful way of reducing the size of a @option{--just-symbols}
1888 @item --compress-debug-sections
1889 Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
1890 ELF ABI. Note - if compression would actually make a section
1891 @emph{larger}, then it is not compressed.
1893 @item --compress-debug-sections=none
1894 @itemx --compress-debug-sections=zlib
1895 @itemx --compress-debug-sections=zlib-gnu
1896 @itemx --compress-debug-sections=zlib-gabi
1897 For ELF files, these options control how DWARF debug sections are
1898 compressed. @option{--compress-debug-sections=none} is equivalent
1899 to @option{--decompress-debug-sections}.
1900 @option{--compress-debug-sections=zlib} and
1901 @option{--compress-debug-sections=zlib-gabi} are equivalent to
1902 @option{--compress-debug-sections}.
1903 @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug
1904 sections using zlib. The debug sections are renamed to begin with
1905 @samp{.zdebug} instead of @samp{.debug}. Note - if compression would
1906 actually make a section @emph{larger}, then it is not compressed nor
1909 @item --decompress-debug-sections
1910 Decompress DWARF debug sections using zlib. The original section
1911 names of the compressed sections are restored.
1913 @item --elf-stt-common=yes
1914 @itemx --elf-stt-common=no
1915 For ELF files, these options control whether common symbols should be
1916 converted to the @code{STT_COMMON} or @code{STT_OBJECT} type.
1917 @option{--elf-stt-common=yes} converts common symbol type to
1918 @code{STT_COMMON}. @option{--elf-stt-common=no} converts common symbol
1919 type to @code{STT_OBJECT}.
1923 Show the version number of @command{objcopy}.
1927 Verbose output: list all object files modified. In the case of
1928 archives, @samp{objcopy -V} lists all members of the archive.
1931 Show a summary of the options to @command{objcopy}.
1934 Display a list showing all architectures and object formats available.
1940 @c man begin SEEALSO objcopy
1941 ld(1), objdump(1), and the Info entries for @file{binutils}.
1948 @cindex object file information
1951 @c man title objdump display information from object files.
1954 @c man begin SYNOPSIS objdump
1955 objdump [@option{-a}|@option{--archive-headers}]
1956 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1957 [@option{-C}|@option{--demangle}[=@var{style}] ]
1958 [@option{-d}|@option{--disassemble}]
1959 [@option{-D}|@option{--disassemble-all}]
1960 [@option{-z}|@option{--disassemble-zeroes}]
1961 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1962 [@option{-f}|@option{--file-headers}]
1963 [@option{-F}|@option{--file-offsets}]
1964 [@option{--file-start-context}]
1965 [@option{-g}|@option{--debugging}]
1966 [@option{-e}|@option{--debugging-tags}]
1967 [@option{-h}|@option{--section-headers}|@option{--headers}]
1968 [@option{-i}|@option{--info}]
1969 [@option{-j} @var{section}|@option{--section=}@var{section}]
1970 [@option{-l}|@option{--line-numbers}]
1971 [@option{-S}|@option{--source}]
1972 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1973 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1974 [@option{-p}|@option{--private-headers}]
1975 [@option{-P} @var{options}|@option{--private=}@var{options}]
1976 [@option{-r}|@option{--reloc}]
1977 [@option{-R}|@option{--dynamic-reloc}]
1978 [@option{-s}|@option{--full-contents}]
1979 [@option{-W[lLiaprmfFsoRt]}|
1980 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames]
1981 [=aranges,=macro,=frames,=frames-interp,=str,=loc]
1982 [=Ranges,=pubtypes,=trace_info,=trace_abbrev]
1983 [=trace_aranges,=gdb_index]
1984 [@option{-G}|@option{--stabs}]
1985 [@option{-t}|@option{--syms}]
1986 [@option{-T}|@option{--dynamic-syms}]
1987 [@option{-x}|@option{--all-headers}]
1988 [@option{-w}|@option{--wide}]
1989 [@option{--start-address=}@var{address}]
1990 [@option{--stop-address=}@var{address}]
1991 [@option{--prefix-addresses}]
1992 [@option{--[no-]show-raw-insn}]
1993 [@option{--adjust-vma=}@var{offset}]
1994 [@option{--dwarf-depth=@var{n}}]
1995 [@option{--dwarf-start=@var{n}}]
1996 [@option{--special-syms}]
1997 [@option{--prefix=}@var{prefix}]
1998 [@option{--prefix-strip=}@var{level}]
1999 [@option{--insn-width=}@var{width}]
2000 [@option{-V}|@option{--version}]
2001 [@option{-H}|@option{--help}]
2002 @var{objfile}@dots{}
2006 @c man begin DESCRIPTION objdump
2008 @command{objdump} displays information about one or more object files.
2009 The options control what particular information to display. This
2010 information is mostly useful to programmers who are working on the
2011 compilation tools, as opposed to programmers who just want their
2012 program to compile and work.
2014 @var{objfile}@dots{} are the object files to be examined. When you
2015 specify archives, @command{objdump} shows information on each of the member
2020 @c man begin OPTIONS objdump
2022 The long and short forms of options, shown here as alternatives, are
2023 equivalent. At least one option from the list
2024 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
2028 @itemx --archive-header
2029 @cindex archive headers
2030 If any of the @var{objfile} files are archives, display the archive
2031 header information (in a format similar to @samp{ls -l}). Besides the
2032 information you could list with @samp{ar tv}, @samp{objdump -a} shows
2033 the object file format of each archive member.
2035 @item --adjust-vma=@var{offset}
2036 @cindex section addresses in objdump
2037 @cindex VMA in objdump
2038 When dumping information, first add @var{offset} to all the section
2039 addresses. This is useful if the section addresses do not correspond to
2040 the symbol table, which can happen when putting sections at particular
2041 addresses when using a format which can not represent section addresses,
2044 @item -b @var{bfdname}
2045 @itemx --target=@var{bfdname}
2046 @cindex object code format
2047 Specify that the object-code format for the object files is
2048 @var{bfdname}. This option may not be necessary; @var{objdump} can
2049 automatically recognize many formats.
2053 objdump -b oasys -m vax -h fu.o
2056 displays summary information from the section headers (@option{-h}) of
2057 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
2058 file in the format produced by Oasys compilers. You can list the
2059 formats available with the @option{-i} option.
2060 @xref{Target Selection}, for more information.
2063 @itemx --demangle[=@var{style}]
2064 @cindex demangling in objdump
2065 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2066 Besides removing any initial underscore prepended by the system, this
2067 makes C++ function names readable. Different compilers have different
2068 mangling styles. The optional demangling style argument can be used to
2069 choose an appropriate demangling style for your compiler. @xref{c++filt},
2070 for more information on demangling.
2074 Display debugging information. This attempts to parse STABS and IEEE
2075 debugging format information stored in the file and print it out using
2076 a C like syntax. If neither of these formats are found this option
2077 falls back on the @option{-W} option to print any DWARF information in
2081 @itemx --debugging-tags
2082 Like @option{-g}, but the information is generated in a format compatible
2086 @itemx --disassemble
2087 @cindex disassembling object code
2088 @cindex machine instructions
2089 Display the assembler mnemonics for the machine instructions from
2090 @var{objfile}. This option only disassembles those sections which are
2091 expected to contain instructions.
2094 @itemx --disassemble-all
2095 Like @option{-d}, but disassemble the contents of all sections, not just
2096 those expected to contain instructions.
2098 This option also has a subtle effect on the disassembly of
2099 instructions in code sections. When option @option{-d} is in effect
2100 objdump will assume that any symbols present in a code section occur
2101 on the boundary between instructions and it will refuse to disassemble
2102 across such a boundary. When option @option{-D} is in effect however
2103 this assumption is supressed. This means that it is possible for the
2104 output of @option{-d} and @option{-D} to differ if, for example, data
2105 is stored in code sections.
2107 If the target is an ARM architecture this switch also has the effect
2108 of forcing the disassembler to decode pieces of data found in code
2109 sections as if they were instructions.
2111 @item --prefix-addresses
2112 When disassembling, print the complete address on each line. This is
2113 the older disassembly format.
2117 @itemx --endian=@{big|little@}
2119 @cindex disassembly endianness
2120 Specify the endianness of the object files. This only affects
2121 disassembly. This can be useful when disassembling a file format which
2122 does not describe endianness information, such as S-records.
2125 @itemx --file-headers
2126 @cindex object file header
2127 Display summary information from the overall header of
2128 each of the @var{objfile} files.
2131 @itemx --file-offsets
2132 @cindex object file offsets
2133 When disassembling sections, whenever a symbol is displayed, also
2134 display the file offset of the region of data that is about to be
2135 dumped. If zeroes are being skipped, then when disassembly resumes,
2136 tell the user how many zeroes were skipped and the file offset of the
2137 location from where the disassembly resumes. When dumping sections,
2138 display the file offset of the location from where the dump starts.
2140 @item --file-start-context
2141 @cindex source code context
2142 Specify that when displaying interlisted source code/disassembly
2143 (assumes @option{-S}) from a file that has not yet been displayed, extend the
2144 context to the start of the file.
2147 @itemx --section-headers
2149 @cindex section headers
2150 Display summary information from the section headers of the
2153 File segments may be relocated to nonstandard addresses, for example by
2154 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2155 @command{ld}. However, some object file formats, such as a.out, do not
2156 store the starting address of the file segments. In those situations,
2157 although @command{ld} relocates the sections correctly, using @samp{objdump
2158 -h} to list the file section headers cannot show the correct addresses.
2159 Instead, it shows the usual addresses, which are implicit for the
2162 Note, in some cases it is possible for a section to have both the
2163 READONLY and the NOREAD attributes set. In such cases the NOREAD
2164 attribute takes precedence, but @command{objdump} will report both
2165 since the exact setting of the flag bits might be important.
2169 Print a summary of the options to @command{objdump} and exit.
2173 @cindex architectures available
2174 @cindex object formats available
2175 Display a list showing all architectures and object formats available
2176 for specification with @option{-b} or @option{-m}.
2179 @itemx --section=@var{name}
2180 @cindex section information
2181 Display information only for section @var{name}.
2184 @itemx --line-numbers
2185 @cindex source filenames for object files
2186 Label the display (using debugging information) with the filename and
2187 source line numbers corresponding to the object code or relocs shown.
2188 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2190 @item -m @var{machine}
2191 @itemx --architecture=@var{machine}
2192 @cindex architecture
2193 @cindex disassembly architecture
2194 Specify the architecture to use when disassembling object files. This
2195 can be useful when disassembling object files which do not describe
2196 architecture information, such as S-records. You can list the available
2197 architectures with the @option{-i} option.
2199 If the target is an ARM architecture then this switch has an
2200 additional effect. It restricts the disassembly to only those
2201 instructions supported by the architecture specified by @var{machine}.
2202 If it is necessary to use this switch because the input file does not
2203 contain any architecture information, but it is also desired to
2204 disassemble all the instructions use @option{-marm}.
2206 @item -M @var{options}
2207 @itemx --disassembler-options=@var{options}
2208 Pass target specific information to the disassembler. Only supported on
2209 some targets. If it is necessary to specify more than one
2210 disassembler option then multiple @option{-M} options can be used or
2211 can be placed together into a comma separated list.
2213 If the target is an ARM architecture then this switch can be used to
2214 select which register name set is used during disassembler. Specifying
2215 @option{-M reg-names-std} (the default) will select the register names as
2216 used in ARM's instruction set documentation, but with register 13 called
2217 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2218 @option{-M reg-names-apcs} will select the name set used by the ARM
2219 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2220 just use @samp{r} followed by the register number.
2222 There are also two variants on the APCS register naming scheme enabled
2223 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2224 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2225 with the normal register names or the special register names).
2227 This option can also be used for ARM architectures to force the
2228 disassembler to interpret all instructions as Thumb instructions by
2229 using the switch @option{--disassembler-options=force-thumb}. This can be
2230 useful when attempting to disassemble thumb code produced by other
2233 For the x86, some of the options duplicate functions of the @option{-m}
2234 switch, but allow finer grained control. Multiple selections from the
2235 following may be specified as a comma separated string.
2240 Select disassembly for the given architecture.
2244 Select between intel syntax mode and AT&T syntax mode.
2248 Select between AMD64 ISA and Intel64 ISA.
2250 @item intel-mnemonic
2252 Select between intel mnemonic mode and AT&T mnemonic mode.
2253 Note: @code{intel-mnemonic} implies @code{intel} and
2254 @code{att-mnemonic} implies @code{att}.
2261 Specify the default address size and operand size. These four options
2262 will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2263 appear later in the option string.
2266 When in AT&T mode, instructs the disassembler to print a mnemonic
2267 suffix even when the suffix could be inferred by the operands.
2270 For PowerPC, @option{booke} controls the disassembly of BookE
2271 instructions. @option{32} and @option{64} select PowerPC and
2272 PowerPC64 disassembly, respectively. @option{e300} selects
2273 disassembly for the e300 family. @option{440} selects disassembly for
2274 the PowerPC 440. @option{ppcps} selects disassembly for the paired
2275 single instructions of the PPC750CL.
2277 For MIPS, this option controls the printing of instruction mnemonic
2278 names and register names in disassembled instructions. Multiple
2279 selections from the following may be specified as a comma separated
2280 string, and invalid options are ignored:
2284 Print the 'raw' instruction mnemonic instead of some pseudo
2285 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2286 'sll' instead of 'nop', etc.
2289 Disassemble MSA instructions.
2292 Disassemble the virtualization ASE instructions.
2295 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2297 @item gpr-names=@var{ABI}
2298 Print GPR (general-purpose register) names as appropriate
2299 for the specified ABI. By default, GPR names are selected according to
2300 the ABI of the binary being disassembled.
2302 @item fpr-names=@var{ABI}
2303 Print FPR (floating-point register) names as
2304 appropriate for the specified ABI. By default, FPR numbers are printed
2307 @item cp0-names=@var{ARCH}
2308 Print CP0 (system control coprocessor; coprocessor 0) register names
2309 as appropriate for the CPU or architecture specified by
2310 @var{ARCH}. By default, CP0 register names are selected according to
2311 the architecture and CPU of the binary being disassembled.
2313 @item hwr-names=@var{ARCH}
2314 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2315 as appropriate for the CPU or architecture specified by
2316 @var{ARCH}. By default, HWR names are selected according to
2317 the architecture and CPU of the binary being disassembled.
2319 @item reg-names=@var{ABI}
2320 Print GPR and FPR names as appropriate for the selected ABI.
2322 @item reg-names=@var{ARCH}
2323 Print CPU-specific register names (CP0 register and HWR names)
2324 as appropriate for the selected CPU or architecture.
2327 For any of the options listed above, @var{ABI} or
2328 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2329 rather than names, for the selected types of registers.
2330 You can list the available values of @var{ABI} and @var{ARCH} using
2331 the @option{--help} option.
2333 For VAX, you can specify function entry addresses with @option{-M
2334 entry:0xf00ba}. You can use this multiple times to properly
2335 disassemble VAX binary files that don't contain symbol tables (like
2336 ROM dumps). In these cases, the function entry mask would otherwise
2337 be decoded as VAX instructions, which would probably lead the rest
2338 of the function being wrongly disassembled.
2341 @itemx --private-headers
2342 Print information that is specific to the object file format. The exact
2343 information printed depends upon the object file format. For some
2344 object file formats, no additional information is printed.
2346 @item -P @var{options}
2347 @itemx --private=@var{options}
2348 Print information that is specific to the object file format. The
2349 argument @var{options} is a comma separated list that depends on the
2350 format (the lists of options is displayed with the help).
2352 For XCOFF, the available options are:
2368 Not all object formats support this option. In particular the ELF
2369 format does not use it.
2373 @cindex relocation entries, in object file
2374 Print the relocation entries of the file. If used with @option{-d} or
2375 @option{-D}, the relocations are printed interspersed with the
2379 @itemx --dynamic-reloc
2380 @cindex dynamic relocation entries, in object file
2381 Print the dynamic relocation entries of the file. This is only
2382 meaningful for dynamic objects, such as certain types of shared
2383 libraries. As for @option{-r}, if used with @option{-d} or
2384 @option{-D}, the relocations are printed interspersed with the
2388 @itemx --full-contents
2389 @cindex sections, full contents
2390 @cindex object file sections
2391 Display the full contents of any sections requested. By default all
2392 non-empty sections are displayed.
2396 @cindex source disassembly
2397 @cindex disassembly, with source
2398 Display source code intermixed with disassembly, if possible. Implies
2401 @item --prefix=@var{prefix}
2402 @cindex Add prefix to absolute paths
2403 Specify @var{prefix} to add to the absolute paths when used with
2406 @item --prefix-strip=@var{level}
2407 @cindex Strip absolute paths
2408 Indicate how many initial directory names to strip off the hardwired
2409 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2411 @item --show-raw-insn
2412 When disassembling instructions, print the instruction in hex as well as
2413 in symbolic form. This is the default except when
2414 @option{--prefix-addresses} is used.
2416 @item --no-show-raw-insn
2417 When disassembling instructions, do not print the instruction bytes.
2418 This is the default when @option{--prefix-addresses} is used.
2420 @item --insn-width=@var{width}
2421 @cindex Instruction width
2422 Display @var{width} bytes on a single line when disassembling
2425 @item -W[lLiaprmfFsoRt]
2426 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames]
2427 @itemx --dwarf[=aranges,=macro,=frames,=frames-interp,=str,=loc]
2428 @itemx --dwarf[=Ranges,=pubtypes,=trace_info,=trace_abbrev]
2429 @itemx --dwarf[=trace_aranges,=gdb_index]
2431 @cindex debug symbols
2432 Displays the contents of the debug sections in the file, if any are
2433 present. If one of the optional letters or words follows the switch
2434 then only data found in those specific sections will be dumped.
2436 Note that there is no single letter option to display the content of
2437 trace sections or .gdb_index.
2439 Note: the output from the @option{=info} option can also be affected
2440 by the options @option{--dwarf-depth}, the @option{--dwarf-start} and
2441 the @option{--dwarf-check}.
2443 @item --dwarf-depth=@var{n}
2444 Limit the dump of the @code{.debug_info} section to @var{n} children.
2445 This is only useful with @option{--dwarf=info}. The default is
2446 to print all DIEs; the special value 0 for @var{n} will also have this
2449 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
2450 levels will not be printed. The range for @var{n} is zero-based.
2452 @item --dwarf-start=@var{n}
2453 Print only DIEs beginning with the DIE numbered @var{n}. This is only
2454 useful with @option{--dwarf=info}.
2456 If specified, this option will suppress printing of any header
2457 information and all DIEs before the DIE numbered @var{n}. Only
2458 siblings and children of the specified DIE will be printed.
2460 This can be used in conjunction with @option{--dwarf-depth}.
2463 Enable additional checks for consistency of Dwarf information.
2469 @cindex debug symbols
2470 @cindex ELF object file format
2471 Display the full contents of any sections requested. Display the
2472 contents of the .stab and .stab.index and .stab.excl sections from an
2473 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2474 @code{.stab} debugging symbol-table entries are carried in an ELF
2475 section. In most other file formats, debugging symbol-table entries are
2476 interleaved with linkage symbols, and are visible in the @option{--syms}
2479 @item --start-address=@var{address}
2480 @cindex start-address
2481 Start displaying data at the specified address. This affects the output
2482 of the @option{-d}, @option{-r} and @option{-s} options.
2484 @item --stop-address=@var{address}
2485 @cindex stop-address
2486 Stop displaying data at the specified address. This affects the output
2487 of the @option{-d}, @option{-r} and @option{-s} options.
2491 @cindex symbol table entries, printing
2492 Print the symbol table entries of the file.
2493 This is similar to the information provided by the @samp{nm} program,
2494 although the display format is different. The format of the output
2495 depends upon the format of the file being dumped, but there are two main
2496 types. One looks like this:
2499 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2500 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2503 where the number inside the square brackets is the number of the entry
2504 in the symbol table, the @var{sec} number is the section number, the
2505 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2506 symbol's type, the @var{scl} number is the symbol's storage class and
2507 the @var{nx} value is the number of auxilary entries associated with
2508 the symbol. The last two fields are the symbol's value and its name.
2510 The other common output format, usually seen with ELF based files,
2514 00000000 l d .bss 00000000 .bss
2515 00000000 g .text 00000000 fred
2518 Here the first number is the symbol's value (sometimes refered to as
2519 its address). The next field is actually a set of characters and
2520 spaces indicating the flag bits that are set on the symbol. These
2521 characters are described below. Next is the section with which the
2522 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2523 not connected with any section), or @emph{*UND*} if the section is
2524 referenced in the file being dumped, but not defined there.
2526 After the section name comes another field, a number, which for common
2527 symbols is the alignment and for other symbol is the size. Finally
2528 the symbol's name is displayed.
2530 The flag characters are divided into 7 groups as follows:
2536 The symbol is a local (l), global (g), unique global (u), neither
2537 global nor local (a space) or both global and local (!). A
2538 symbol can be neither local or global for a variety of reasons, e.g.,
2539 because it is used for debugging, but it is probably an indication of
2540 a bug if it is ever both local and global. Unique global symbols are
2541 a GNU extension to the standard set of ELF symbol bindings. For such
2542 a symbol the dynamic linker will make sure that in the entire process
2543 there is just one symbol with this name and type in use.
2546 The symbol is weak (w) or strong (a space).
2549 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2552 The symbol is a warning (W) or a normal symbol (a space). A warning
2553 symbol's name is a message to be displayed if the symbol following the
2554 warning symbol is ever referenced.
2558 The symbol is an indirect reference to another symbol (I), a function
2559 to be evaluated during reloc processing (i) or a normal symbol (a
2564 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2565 normal symbol (a space).
2570 The symbol is the name of a function (F) or a file (f) or an object
2571 (O) or just a normal symbol (a space).
2575 @itemx --dynamic-syms
2576 @cindex dynamic symbol table entries, printing
2577 Print the dynamic symbol table entries of the file. This is only
2578 meaningful for dynamic objects, such as certain types of shared
2579 libraries. This is similar to the information provided by the @samp{nm}
2580 program when given the @option{-D} (@option{--dynamic}) option.
2582 @item --special-syms
2583 When displaying symbols include those which the target considers to be
2584 special in some way and which would not normally be of interest to the
2589 Print the version number of @command{objdump} and exit.
2592 @itemx --all-headers
2593 @cindex all header information, object file
2594 @cindex header information, all
2595 Display all available header information, including the symbol table and
2596 relocation entries. Using @option{-x} is equivalent to specifying all of
2597 @option{-a -f -h -p -r -t}.
2601 @cindex wide output, printing
2602 Format some lines for output devices that have more than 80 columns.
2603 Also do not truncate symbol names when they are displayed.
2606 @itemx --disassemble-zeroes
2607 Normally the disassembly output will skip blocks of zeroes. This
2608 option directs the disassembler to disassemble those blocks, just like
2615 @c man begin SEEALSO objdump
2616 nm(1), readelf(1), and the Info entries for @file{binutils}.
2624 @cindex archive contents
2625 @cindex symbol index
2627 @c man title ranlib generate index to archive.
2630 @c man begin SYNOPSIS ranlib
2631 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2635 @c man begin DESCRIPTION ranlib
2637 @command{ranlib} generates an index to the contents of an archive and
2638 stores it in the archive. The index lists each symbol defined by a
2639 member of an archive that is a relocatable object file.
2641 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2643 An archive with such an index speeds up linking to the library and
2644 allows routines in the library to call each other without regard to
2645 their placement in the archive.
2647 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2648 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2653 @c man begin OPTIONS ranlib
2659 Show usage information for @command{ranlib}.
2664 Show the version number of @command{ranlib}.
2667 @cindex deterministic archives
2668 @kindex --enable-deterministic-archives
2669 Operate in @emph{deterministic} mode. The symbol map archive member's
2670 header will show zero for the UID, GID, and timestamp. When this
2671 option is used, multiple runs will produce identical output files.
2673 If @file{binutils} was configured with
2674 @option{--enable-deterministic-archives}, then this mode is on by
2675 default. It can be disabled with the @samp{-U} option, described
2679 Update the timestamp of the symbol map of an archive.
2682 @cindex deterministic archives
2683 @kindex --enable-deterministic-archives
2684 Do @emph{not} operate in @emph{deterministic} mode. This is the
2685 inverse of the @samp{-D} option, above: the archive index will get
2686 actual UID, GID, timestamp, and file mode values.
2688 If @file{binutils} was configured @emph{without}
2689 @option{--enable-deterministic-archives}, then this mode is on by
2697 @c man begin SEEALSO ranlib
2698 ar(1), nm(1), and the Info entries for @file{binutils}.
2706 @cindex section sizes
2708 @c man title size list section sizes and total size.
2711 @c man begin SYNOPSIS size
2712 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2714 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2716 [@option{-t}|@option{--totals}]
2717 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2718 [@var{objfile}@dots{}]
2722 @c man begin DESCRIPTION size
2724 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2725 size---for each of the object or archive files @var{objfile} in its
2726 argument list. By default, one line of output is generated for each
2727 object file or each module in an archive.
2729 @var{objfile}@dots{} are the object files to be examined.
2730 If none are specified, the file @code{a.out} will be used.
2734 @c man begin OPTIONS size
2736 The command line options have the following meanings:
2741 @itemx --format=@var{compatibility}
2742 @cindex @command{size} display format
2743 Using one of these options, you can choose whether the output from @sc{gnu}
2744 @command{size} resembles output from System V @command{size} (using @option{-A},
2745 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2746 @option{--format=berkeley}). The default is the one-line format similar to
2748 @c Bonus for doc-source readers: you can also say --format=strange (or
2749 @c anything else that starts with 's') for sysv, and --format=boring (or
2750 @c anything else that starts with 'b') for Berkeley.
2752 Here is an example of the Berkeley (default) format of output from
2755 $ size --format=Berkeley ranlib size
2756 text data bss dec hex filename
2757 294880 81920 11592 388392 5ed28 ranlib
2758 294880 81920 11888 388688 5ee50 size
2762 This is the same data, but displayed closer to System V conventions:
2765 $ size --format=SysV ranlib size
2783 Show a summary of acceptable arguments and options.
2788 @itemx --radix=@var{number}
2789 @cindex @command{size} number format
2790 @cindex radix for section sizes
2791 Using one of these options, you can control whether the size of each
2792 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2793 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2794 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2795 values (8, 10, 16) are supported. The total size is always given in two
2796 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2797 octal and hexadecimal if you're using @option{-o}.
2800 Print total size of common symbols in each file. When using Berkeley
2801 format these are included in the bss size.
2805 Show totals of all objects listed (Berkeley format listing mode only).
2807 @item --target=@var{bfdname}
2808 @cindex object code format
2809 Specify that the object-code format for @var{objfile} is
2810 @var{bfdname}. This option may not be necessary; @command{size} can
2811 automatically recognize many formats.
2812 @xref{Target Selection}, for more information.
2816 Display the version number of @command{size}.
2822 @c man begin SEEALSO size
2823 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2830 @cindex listings strings
2831 @cindex printing strings
2832 @cindex strings, printing
2834 @c man title strings print the strings of printable characters in files.
2837 @c man begin SYNOPSIS strings
2838 strings [@option{-afovV}] [@option{-}@var{min-len}]
2839 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2840 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2841 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2842 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2843 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2844 [@option{-w}] [@option{--include-all-whitespace}]
2845 [@option{-s}] [@option{--output-separator}@var{sep_string}]
2846 [@option{--help}] [@option{--version}] @var{file}@dots{}
2850 @c man begin DESCRIPTION strings
2852 For each @var{file} given, @sc{gnu} @command{strings} prints the
2853 printable character sequences that are at least 4 characters long (or
2854 the number given with the options below) and are followed by an
2855 unprintable character.
2857 Depending upon how the strings program was configured it will default
2858 to either displaying all the printable sequences that it can find in
2859 each file, or only those sequences that are in loadable, initialized
2860 data sections. If the file type in unrecognizable, or if strings is
2861 reading from stdin then it will always display all of the printable
2862 sequences that it can find.
2864 For backwards compatibility any file that occurs after a command line
2865 option of just @option{-} will also be scanned in full, regardless of
2866 the presence of any @option{-d} option.
2868 @command{strings} is mainly useful for determining the contents of
2873 @c man begin OPTIONS strings
2879 Scan the whole file, regardless of what sections it contains or
2880 whether those sections are loaded or initialized. Normally this is
2881 the default behaviour, but strings can be configured so that the
2882 @option{-d} is the default instead.
2884 The @option{-} option is position dependent and forces strings to
2885 perform full scans of any file that is mentioned after the @option{-}
2886 on the command line, even if the @option{-d} option has been
2891 Only print strings from initialized, loaded data sections in the
2892 file. This may reduce the amount of garbage in the output, but it
2893 also exposes the strings program to any security flaws that may be
2894 present in the BFD library used to scan and load sections. Strings
2895 can be configured so that this option is the default behaviour. In
2896 such cases the @option{-a} option can be used to avoid using the BFD
2897 library and instead just print all of the strings found in the file.
2900 @itemx --print-file-name
2901 Print the name of the file before each string.
2904 Print a summary of the program usage on the standard output and exit.
2906 @item -@var{min-len}
2907 @itemx -n @var{min-len}
2908 @itemx --bytes=@var{min-len}
2909 Print sequences of characters that are at least @var{min-len} characters
2910 long, instead of the default 4.
2913 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2914 act like @samp{-t d} instead. Since we can not be compatible with both
2915 ways, we simply chose one.
2917 @item -t @var{radix}
2918 @itemx --radix=@var{radix}
2919 Print the offset within the file before each string. The single
2920 character argument specifies the radix of the offset---@samp{o} for
2921 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2923 @item -e @var{encoding}
2924 @itemx --encoding=@var{encoding}
2925 Select the character encoding of the strings that are to be found.
2926 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2927 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2928 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2929 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2930 littleendian. Useful for finding wide character strings. (@samp{l}
2931 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2933 @item -T @var{bfdname}
2934 @itemx --target=@var{bfdname}
2935 @cindex object code format
2936 Specify an object code format other than your system's default format.
2937 @xref{Target Selection}, for more information.
2942 Print the program version number on the standard output and exit.
2945 @itemx --include-all-whitespace
2946 By default tab and space characters are included in the strings that
2947 are displayed, but other whitespace characters, such a newlines and
2948 carriage returns, are not. The @option{-w} option changes this so
2949 that all whitespace characters are considered to be part of a string.
2952 @itemx --output-separator
2953 By default, output strings are delimited by a new-line. This option
2954 allows you to supply any string to be used as the output record
2955 separator. Useful with --include-all-whitespace where strings
2956 may contain new-lines internally.
2962 @c man begin SEEALSO strings
2963 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2964 and the Info entries for @file{binutils}.
2972 @cindex removing symbols
2973 @cindex discarding symbols
2974 @cindex symbols, discarding
2976 @c man title strip Discard symbols from object files.
2979 @c man begin SYNOPSIS strip
2980 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2981 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2982 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2983 [@option{-s}|@option{--strip-all}]
2984 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2985 [@option{--strip-dwo}]
2986 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2987 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2988 [@option{-w}|@option{--wildcard}]
2989 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2990 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2991 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2992 [@option{-D}|@option{--enable-deterministic-archives}]
2993 [@option{-U}|@option{--disable-deterministic-archives}]
2994 [@option{--keep-file-symbols}]
2995 [@option{--only-keep-debug}]
2996 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2997 [@option{--help}] [@option{--info}]
2998 @var{objfile}@dots{}
3002 @c man begin DESCRIPTION strip
3004 @sc{gnu} @command{strip} discards all symbols from object files
3005 @var{objfile}. The list of object files may include archives.
3006 At least one object file must be given.
3008 @command{strip} modifies the files named in its argument,
3009 rather than writing modified copies under different names.
3013 @c man begin OPTIONS strip
3016 @item -F @var{bfdname}
3017 @itemx --target=@var{bfdname}
3018 Treat the original @var{objfile} as a file with the object
3019 code format @var{bfdname}, and rewrite it in the same format.
3020 @xref{Target Selection}, for more information.
3023 Show a summary of the options to @command{strip} and exit.
3026 Display a list showing all architectures and object formats available.
3028 @item -I @var{bfdname}
3029 @itemx --input-target=@var{bfdname}
3030 Treat the original @var{objfile} as a file with the object
3031 code format @var{bfdname}.
3032 @xref{Target Selection}, for more information.
3034 @item -O @var{bfdname}
3035 @itemx --output-target=@var{bfdname}
3036 Replace @var{objfile} with a file in the output format @var{bfdname}.
3037 @xref{Target Selection}, for more information.
3039 @item -R @var{sectionname}
3040 @itemx --remove-section=@var{sectionname}
3041 Remove any section named @var{sectionname} from the output file, in
3042 addition to whatever sections would otherwise be removed. This
3043 option may be given more than once. Note that using this option
3044 inappropriately may make the output file unusable. The wildcard
3045 character @samp{*} may be given at the end of @var{sectionname}. If
3046 so, then any section starting with @var{sectionname} will be removed.
3048 If the first character of @var{sectionpattern} is the exclamation
3049 point (!) then matching sections will not be removed even if an
3050 earlier use of @option{--remove-section} on the same command line
3051 would otherwise remove it. For example:
3054 --remove-section=.text.* --remove-section=!.text.foo
3057 will remove all sections matching the pattern '.text.*', but will not
3058 remove the section '.text.foo'.
3067 @itemx --strip-debug
3068 Remove debugging symbols only.
3071 Remove the contents of all DWARF .dwo sections, leaving the
3072 remaining debugging sections and all symbols intact.
3073 See the description of this option in the @command{objcopy} section
3074 for more information.
3076 @item --strip-unneeded
3077 Remove all symbols that are not needed for relocation processing.
3079 @item -K @var{symbolname}
3080 @itemx --keep-symbol=@var{symbolname}
3081 When stripping symbols, keep symbol @var{symbolname} even if it would
3082 normally be stripped. This option may be given more than once.
3084 @item -N @var{symbolname}
3085 @itemx --strip-symbol=@var{symbolname}
3086 Remove symbol @var{symbolname} from the source file. This option may be
3087 given more than once, and may be combined with strip options other than
3091 Put the stripped output in @var{file}, rather than replacing the
3092 existing file. When this argument is used, only one @var{objfile}
3093 argument may be specified.
3096 @itemx --preserve-dates
3097 Preserve the access and modification dates of the file.
3100 @itemx --enable-deterministic-archives
3101 @cindex deterministic archives
3102 @kindex --enable-deterministic-archives
3103 Operate in @emph{deterministic} mode. When copying archive members
3104 and writing the archive index, use zero for UIDs, GIDs, timestamps,
3105 and use consistent file modes for all files.
3107 If @file{binutils} was configured with
3108 @option{--enable-deterministic-archives}, then this mode is on by default.
3109 It can be disabled with the @samp{-U} option, below.
3112 @itemx --disable-deterministic-archives
3113 @cindex deterministic archives
3114 @kindex --enable-deterministic-archives
3115 Do @emph{not} operate in @emph{deterministic} mode. This is the
3116 inverse of the @option{-D} option, above: when copying archive members
3117 and writing the archive index, use their actual UID, GID, timestamp,
3118 and file mode values.
3120 This is the default unless @file{binutils} was configured with
3121 @option{--enable-deterministic-archives}.
3125 Permit regular expressions in @var{symbolname}s used in other command
3126 line options. The question mark (?), asterisk (*), backslash (\) and
3127 square brackets ([]) operators can be used anywhere in the symbol
3128 name. If the first character of the symbol name is the exclamation
3129 point (!) then the sense of the switch is reversed for that symbol.
3136 would cause strip to only keep symbols that start with the letters
3137 ``fo'', but to discard the symbol ``foo''.
3140 @itemx --discard-all
3141 Remove non-global symbols.
3144 @itemx --discard-locals
3145 Remove compiler-generated local symbols.
3146 (These usually start with @samp{L} or @samp{.}.)
3148 @item --keep-file-symbols
3149 When stripping a file, perhaps with @option{--strip-debug} or
3150 @option{--strip-unneeded}, retain any symbols specifying source file names,
3151 which would otherwise get stripped.
3153 @item --only-keep-debug
3154 Strip a file, emptying the contents of any sections that would not be
3155 stripped by @option{--strip-debug} and leaving the debugging sections
3156 intact. In ELF files, this preserves all the note sections in the
3159 Note - the section headers of the stripped sections are preserved,
3160 including their sizes, but the contents of the section are discarded.
3161 The section headers are preserved so that other tools can match up the
3162 debuginfo file with the real executable, even if that executable has
3163 been relocated to a different address space.
3165 The intention is that this option will be used in conjunction with
3166 @option{--add-gnu-debuglink} to create a two part executable. One a
3167 stripped binary which will occupy less space in RAM and in a
3168 distribution and the second a debugging information file which is only
3169 needed if debugging abilities are required. The suggested procedure
3170 to create these files is as follows:
3173 @item Link the executable as normal. Assuming that is is called
3175 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3176 create a file containing the debugging info.
3177 @item Run @code{objcopy --strip-debug foo} to create a
3178 stripped executable.
3179 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3180 to add a link to the debugging info into the stripped executable.
3183 Note---the choice of @code{.dbg} as an extension for the debug info
3184 file is arbitrary. Also the @code{--only-keep-debug} step is
3185 optional. You could instead do this:
3188 @item Link the executable as normal.
3189 @item Copy @code{foo} to @code{foo.full}
3190 @item Run @code{strip --strip-debug foo}
3191 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3194 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
3195 full executable. It does not have to be a file created by the
3196 @option{--only-keep-debug} switch.
3198 Note---this switch is only intended for use on fully linked files. It
3199 does not make sense to use it on object files where the debugging
3200 information may be incomplete. Besides the gnu_debuglink feature
3201 currently only supports the presence of one filename containing
3202 debugging information, not multiple filenames on a one-per-object-file
3207 Show the version number for @command{strip}.
3211 Verbose output: list all object files modified. In the case of
3212 archives, @samp{strip -v} lists all members of the archive.
3218 @c man begin SEEALSO strip
3219 the Info entries for @file{binutils}.
3223 @node c++filt, addr2line, strip, Top
3227 @cindex demangling C++ symbols
3229 @c man title cxxfilt Demangle C++ and Java symbols.
3232 @c man begin SYNOPSIS cxxfilt
3233 c++filt [@option{-_}|@option{--strip-underscore}]
3234 [@option{-n}|@option{--no-strip-underscore}]
3235 [@option{-p}|@option{--no-params}]
3236 [@option{-t}|@option{--types}]
3237 [@option{-i}|@option{--no-verbose}]
3238 [@option{-s} @var{format}|@option{--format=}@var{format}]
3239 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
3243 @c man begin DESCRIPTION cxxfilt
3246 The C++ and Java languages provide function overloading, which means
3247 that you can write many functions with the same name, providing that
3248 each function takes parameters of different types. In order to be
3249 able to distinguish these similarly named functions C++ and Java
3250 encode them into a low-level assembler name which uniquely identifies
3251 each different version. This process is known as @dfn{mangling}. The
3253 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3254 MS-DOS this program is named @command{CXXFILT}.}
3255 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3256 names into user-level names so that they can be read.
3258 Every alphanumeric word (consisting of letters, digits, underscores,
3259 dollars, or periods) seen in the input is a potential mangled name.
3260 If the name decodes into a C++ name, the C++ name replaces the
3261 low-level name in the output, otherwise the original word is output.
3262 In this way you can pass an entire assembler source file, containing
3263 mangled names, through @command{c++filt} and see the same source file
3264 containing demangled names.
3266 You can also use @command{c++filt} to decipher individual symbols by
3267 passing them on the command line:
3270 c++filt @var{symbol}
3273 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3274 names from the standard input instead. All the results are printed on
3275 the standard output. The difference between reading names from the
3276 command line versus reading names from the standard input is that
3277 command line arguments are expected to be just mangled names and no
3278 checking is performed to separate them from surrounding text. Thus
3285 will work and demangle the name to ``f()'' whereas:
3291 will not work. (Note the extra comma at the end of the mangled
3292 name which makes it invalid). This command however will work:
3295 echo _Z1fv, | c++filt -n
3298 and will display ``f(),'', i.e., the demangled name followed by a
3299 trailing comma. This behaviour is because when the names are read
3300 from the standard input it is expected that they might be part of an
3301 assembler source file where there might be extra, extraneous
3302 characters trailing after a mangled name. For example:
3305 .type _Z1fv, @@function
3310 @c man begin OPTIONS cxxfilt
3314 @itemx --strip-underscore
3315 On some systems, both the C and C++ compilers put an underscore in front
3316 of every name. For example, the C name @code{foo} gets the low-level
3317 name @code{_foo}. This option removes the initial underscore. Whether
3318 @command{c++filt} removes the underscore by default is target dependent.
3321 @itemx --no-strip-underscore
3322 Do not remove the initial underscore.
3326 When demangling the name of a function, do not display the types of
3327 the function's parameters.
3331 Attempt to demangle types as well as function names. This is disabled
3332 by default since mangled types are normally only used internally in
3333 the compiler, and they can be confused with non-mangled names. For example,
3334 a function called ``a'' treated as a mangled type name would be
3335 demangled to ``signed char''.
3339 Do not include implementation details (if any) in the demangled
3342 @item -s @var{format}
3343 @itemx --format=@var{format}
3344 @command{c++filt} can decode various methods of mangling, used by
3345 different compilers. The argument to this option selects which
3350 Automatic selection based on executable (the default method)
3352 the one used by the @sc{gnu} C++ compiler (g++)
3354 the one used by the Lucid compiler (lcc)
3356 the one specified by the C++ Annotated Reference Manual
3358 the one used by the HP compiler (aCC)
3360 the one used by the EDG compiler
3362 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3364 the one used by the @sc{gnu} Java compiler (gcj)
3366 the one used by the @sc{gnu} Ada compiler (GNAT).
3370 Print a summary of the options to @command{c++filt} and exit.
3373 Print the version number of @command{c++filt} and exit.
3379 @c man begin SEEALSO cxxfilt
3380 the Info entries for @file{binutils}.
3385 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3386 user interface are subject to change in future releases. In particular,
3387 a command-line option may be required in the future to decode a name
3388 passed as an argument on the command line; in other words,
3391 c++filt @var{symbol}
3395 may in a future release become
3398 c++filt @var{option} @var{symbol}
3406 @cindex address to file name and line number
3408 @c man title addr2line convert addresses into file names and line numbers.
3411 @c man begin SYNOPSIS addr2line
3412 addr2line [@option{-a}|@option{--addresses}]
3413 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3414 [@option{-C}|@option{--demangle}[=@var{style}]]
3415 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3416 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3417 [@option{-i}|@option{--inlines}]
3418 [@option{-p}|@option{--pretty-print}]
3419 [@option{-j}|@option{--section=}@var{name}]
3420 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3425 @c man begin DESCRIPTION addr2line
3427 @command{addr2line} translates addresses into file names and line numbers.
3428 Given an address in an executable or an offset in a section of a relocatable
3429 object, it uses the debugging information to figure out which file name and
3430 line number are associated with it.
3432 The executable or relocatable object to use is specified with the @option{-e}
3433 option. The default is the file @file{a.out}. The section in the relocatable
3434 object to use is specified with the @option{-j} option.
3436 @command{addr2line} has two modes of operation.
3438 In the first, hexadecimal addresses are specified on the command line,
3439 and @command{addr2line} displays the file name and line number for each
3442 In the second, @command{addr2line} reads hexadecimal addresses from
3443 standard input, and prints the file name and line number for each
3444 address on standard output. In this mode, @command{addr2line} may be used
3445 in a pipe to convert dynamically chosen addresses.
3447 The format of the output is @samp{FILENAME:LINENO}. By default
3448 each input address generates one line of output.
3450 Two options can generate additional lines before each
3451 @samp{FILENAME:LINENO} line (in that order).
3453 If the @option{-a} option is used then a line with the input address
3456 If the @option{-f} option is used, then a line with the
3457 @samp{FUNCTIONNAME} is displayed. This is the name of the function
3458 containing the address.
3460 One option can generate additional lines after the
3461 @samp{FILENAME:LINENO} line.
3463 If the @option{-i} option is used and the code at the given address is
3464 present there because of inlining by the compiler then additional
3465 lines are displayed afterwards. One or two extra lines (if the
3466 @option{-f} option is used) are displayed for each inlined function.
3468 Alternatively if the @option{-p} option is used then each input
3469 address generates a single, long, output line containing the address,
3470 the function name, the file name and the line number. If the
3471 @option{-i} option has also been used then any inlined functions will
3472 be displayed in the same manner, but on separate lines, and prefixed
3473 by the text @samp{(inlined by)}.
3475 If the file name or function name can not be determined,
3476 @command{addr2line} will print two question marks in their place. If the
3477 line number can not be determined, @command{addr2line} will print 0.
3481 @c man begin OPTIONS addr2line
3483 The long and short forms of options, shown here as alternatives, are
3489 Display the address before the function name, file and line number
3490 information. The address is printed with a @samp{0x} prefix to easily
3493 @item -b @var{bfdname}
3494 @itemx --target=@var{bfdname}
3495 @cindex object code format
3496 Specify that the object-code format for the object files is
3500 @itemx --demangle[=@var{style}]
3501 @cindex demangling in objdump
3502 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3503 Besides removing any initial underscore prepended by the system, this
3504 makes C++ function names readable. Different compilers have different
3505 mangling styles. The optional demangling style argument can be used to
3506 choose an appropriate demangling style for your compiler. @xref{c++filt},
3507 for more information on demangling.
3509 @item -e @var{filename}
3510 @itemx --exe=@var{filename}
3511 Specify the name of the executable for which addresses should be
3512 translated. The default file is @file{a.out}.
3516 Display function names as well as file and line number information.
3520 Display only the base of each file name.
3524 If the address belongs to a function that was inlined, the source
3525 information for all enclosing scopes back to the first non-inlined
3526 function will also be printed. For example, if @code{main} inlines
3527 @code{callee1} which inlines @code{callee2}, and address is from
3528 @code{callee2}, the source information for @code{callee1} and @code{main}
3529 will also be printed.
3533 Read offsets relative to the specified section instead of absolute addresses.
3536 @itemx --pretty-print
3537 Make the output more human friendly: each location are printed on one line.
3538 If option @option{-i} is specified, lines for all enclosing scopes are
3539 prefixed with @samp{(inlined by)}.
3545 @c man begin SEEALSO addr2line
3546 Info entries for @file{binutils}.
3553 @command{nlmconv} converts a relocatable object file into a NetWare
3557 @command{nlmconv} currently works with @samp{i386} object
3558 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
3559 object files in @sc{elf}, or @code{a.out} format@footnote{
3560 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
3561 format in the Binary File Descriptor library. It has only been tested
3562 with the above formats.}.
3566 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
3567 utilities, since it is only useful for NLM targets.
3570 @c man title nlmconv converts object code into an NLM.
3573 @c man begin SYNOPSIS nlmconv
3574 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3575 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3576 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3577 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3578 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3579 @var{infile} @var{outfile}
3583 @c man begin DESCRIPTION nlmconv
3585 @command{nlmconv} converts the relocatable @samp{i386} object file
3586 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3587 reading @var{headerfile} for NLM header information. For instructions
3588 on writing the NLM command file language used in header files, see the
3589 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3590 Development and Tools Overview}, which is part of the NLM Software
3591 Developer's Kit (``NLM SDK''), available from Novell, Inc.
3592 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
3595 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3598 @command{nlmconv} can perform a link step. In other words, you can list
3599 more than one object file for input if you list them in the definitions
3600 file (rather than simply specifying one input file on the command line).
3601 In this case, @command{nlmconv} calls the linker for you.
3605 @c man begin OPTIONS nlmconv
3608 @item -I @var{bfdname}
3609 @itemx --input-target=@var{bfdname}
3610 Object format of the input file. @command{nlmconv} can usually determine
3611 the format of a given file (so no default is necessary).
3612 @xref{Target Selection}, for more information.
3614 @item -O @var{bfdname}
3615 @itemx --output-target=@var{bfdname}
3616 Object format of the output file. @command{nlmconv} infers the output
3617 format based on the input format, e.g. for a @samp{i386} input file the
3618 output format is @samp{nlm32-i386}.
3619 @xref{Target Selection}, for more information.
3621 @item -T @var{headerfile}
3622 @itemx --header-file=@var{headerfile}
3623 Reads @var{headerfile} for NLM header information. For instructions on
3624 writing the NLM command file language used in header files, see@ see the
3625 @samp{linkers} section, of the @cite{NLM Development and Tools
3626 Overview}, which is part of the NLM Software Developer's Kit, available
3631 Displays (on standard error) the linker command line used by @command{nlmconv}.
3633 @item -l @var{linker}
3634 @itemx --linker=@var{linker}
3635 Use @var{linker} for any linking. @var{linker} can be an absolute or a
3640 Prints a usage summary.
3644 Prints the version number for @command{nlmconv}.
3650 @c man begin SEEALSO nlmconv
3651 the Info entries for @file{binutils}.
3658 @command{windmc} may be used to generator Windows message resources.
3661 @emph{Warning:} @command{windmc} is not always built as part of the binary
3662 utilities, since it is only useful for Windows targets.
3665 @c man title windmc generates Windows message resources.
3668 @c man begin SYNOPSIS windmc
3669 windmc [options] input-file
3673 @c man begin DESCRIPTION windmc
3675 @command{windmc} reads message definitions from an input file (.mc) and
3676 translate them into a set of output files. The output files may be of
3681 A C header file containing the message definitions.
3684 A resource file compilable by the @command{windres} tool.
3687 One or more binary files containing the resource data for a specific
3691 A C include file that maps message id's to their symbolic name.
3694 The exact description of these different formats is available in
3695 documentation from Microsoft.
3697 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3698 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3699 Windows Message Compiler.
3703 @c man begin OPTIONS windmc
3708 Specifies that the input file specified is ASCII. This is the default
3713 Specifies that messages in the output @code{bin} files should be in ASCII
3718 Specifies that @code{bin} filenames should have to be prefixed by the
3719 basename of the source file.
3723 Sets the customer bit in all message id's.
3725 @item -C @var{codepage}
3726 @itemx --codepage_in @var{codepage}
3727 Sets the default codepage to be used to convert input file to UTF16. The
3728 default is ocdepage 1252.
3731 @itemx --decimal_values
3732 Outputs the constants in the header file in decimal. Default is using
3736 @itemx --extension @var{ext}
3737 The extension for the header file. The default is .h extension.
3739 @item -F @var{target}
3740 @itemx --target @var{target}
3741 Specify the BFD format to use for a bin file as output. This
3742 is a BFD target name; you can use the @option{--help} option to see a list
3743 of supported targets. Normally @command{windmc} will use the default
3744 format, which is the first one listed by the @option{--help} option.
3746 @ref{Target Selection}.
3750 @itemx --headerdir @var{path}
3751 The target directory of the generated header file. The default is the
3756 Displays a list of command line options and then exits.
3758 @item -m @var{characters}
3759 @itemx --maxlength @var{characters}
3760 Instructs @command{windmc} to generate a warning if the length
3761 of any message exceeds the number specified.
3764 @itemx --nullterminate
3765 Terminate message text in @code{bin} files by zero. By default they are
3766 terminated by CR/LF.
3769 @itemx --hresult_use
3770 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3771 file, using HRESULT definitions. Status codes are used if the flag is not
3774 @item -O @var{codepage}
3775 @itemx --codepage_out @var{codepage}
3776 Sets the default codepage to be used to output text files. The default
3780 @itemx --rcdir @var{path}
3781 The target directory for the generated @code{rc} script and the generated
3782 @code{bin} files that the resource compiler script includes. The default
3783 is the current directory.
3787 Specifies that the input file is UTF16.
3790 @itemx --unicode_out
3791 Specifies that messages in the output @code{bin} file should be in UTF16
3792 format. This is the default behaviour.
3796 Enable verbose mode.
3800 Prints the version number for @command{windmc}.
3803 @itemx --xdgb @var{path}
3804 The path of the @code{dbg} C include file that maps message id's to the
3805 symbolic name. No such file is generated without specifying the switch.
3811 @c man begin SEEALSO windmc
3812 the Info entries for @file{binutils}.
3819 @command{windres} may be used to manipulate Windows resources.
3822 @emph{Warning:} @command{windres} is not always built as part of the binary
3823 utilities, since it is only useful for Windows targets.
3826 @c man title windres manipulate Windows resources.
3829 @c man begin SYNOPSIS windres
3830 windres [options] [input-file] [output-file]
3834 @c man begin DESCRIPTION windres
3836 @command{windres} reads resources from an input file and copies them into
3837 an output file. Either file may be in one of three formats:
3841 A text format read by the Resource Compiler.
3844 A binary format generated by the Resource Compiler.
3847 A COFF object or executable.
3850 The exact description of these different formats is available in
3851 documentation from Microsoft.
3853 When @command{windres} converts from the @code{rc} format to the @code{res}
3854 format, it is acting like the Windows Resource Compiler. When
3855 @command{windres} converts from the @code{res} format to the @code{coff}
3856 format, it is acting like the Windows @code{CVTRES} program.
3858 When @command{windres} generates an @code{rc} file, the output is similar
3859 but not identical to the format expected for the input. When an input
3860 @code{rc} file refers to an external filename, an output @code{rc} file
3861 will instead include the file contents.
3863 If the input or output format is not specified, @command{windres} will
3864 guess based on the file name, or, for the input file, the file contents.
3865 A file with an extension of @file{.rc} will be treated as an @code{rc}
3866 file, a file with an extension of @file{.res} will be treated as a
3867 @code{res} file, and a file with an extension of @file{.o} or
3868 @file{.exe} will be treated as a @code{coff} file.
3870 If no output file is specified, @command{windres} will print the resources
3871 in @code{rc} format to standard output.
3873 The normal use is for you to write an @code{rc} file, use @command{windres}
3874 to convert it to a COFF object file, and then link the COFF file into
3875 your application. This will make the resources described in the
3876 @code{rc} file available to Windows.
3880 @c man begin OPTIONS windres
3883 @item -i @var{filename}
3884 @itemx --input @var{filename}
3885 The name of the input file. If this option is not used, then
3886 @command{windres} will use the first non-option argument as the input file
3887 name. If there are no non-option arguments, then @command{windres} will
3888 read from standard input. @command{windres} can not read a COFF file from
3891 @item -o @var{filename}
3892 @itemx --output @var{filename}
3893 The name of the output file. If this option is not used, then
3894 @command{windres} will use the first non-option argument, after any used
3895 for the input file name, as the output file name. If there is no
3896 non-option argument, then @command{windres} will write to standard output.
3897 @command{windres} can not write a COFF file to standard output. Note,
3898 for compatibility with @command{rc} the option @option{-fo} is also
3899 accepted, but its use is not recommended.
3901 @item -J @var{format}
3902 @itemx --input-format @var{format}
3903 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3904 @samp{coff}. If no input format is specified, @command{windres} will
3905 guess, as described above.
3907 @item -O @var{format}
3908 @itemx --output-format @var{format}
3909 The output format to generate. @var{format} may be @samp{res},
3910 @samp{rc}, or @samp{coff}. If no output format is specified,
3911 @command{windres} will guess, as described above.
3913 @item -F @var{target}
3914 @itemx --target @var{target}
3915 Specify the BFD format to use for a COFF file as input or output. This
3916 is a BFD target name; you can use the @option{--help} option to see a list
3917 of supported targets. Normally @command{windres} will use the default
3918 format, which is the first one listed by the @option{--help} option.
3920 @ref{Target Selection}.
3923 @item --preprocessor @var{program}
3924 When @command{windres} reads an @code{rc} file, it runs it through the C
3925 preprocessor first. This option may be used to specify the preprocessor
3926 to use, including any leading arguments. The default preprocessor
3927 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3929 @item --preprocessor-arg @var{option}
3930 When @command{windres} reads an @code{rc} file, it runs it through
3931 the C preprocessor first. This option may be used to specify additional
3932 text to be passed to preprocessor on its command line.
3933 This option can be used multiple times to add multiple options to the
3934 preprocessor command line.
3936 @item -I @var{directory}
3937 @itemx --include-dir @var{directory}
3938 Specify an include directory to use when reading an @code{rc} file.
3939 @command{windres} will pass this to the preprocessor as an @option{-I}
3940 option. @command{windres} will also search this directory when looking for
3941 files named in the @code{rc} file. If the argument passed to this command
3942 matches any of the supported @var{formats} (as described in the @option{-J}
3943 option), it will issue a deprecation warning, and behave just like the
3944 @option{-J} option. New programs should not use this behaviour. If a
3945 directory happens to match a @var{format}, simple prefix it with @samp{./}
3946 to disable the backward compatibility.
3948 @item -D @var{target}
3949 @itemx --define @var{sym}[=@var{val}]
3950 Specify a @option{-D} option to pass to the preprocessor when reading an
3953 @item -U @var{target}
3954 @itemx --undefine @var{sym}
3955 Specify a @option{-U} option to pass to the preprocessor when reading an
3959 Ignored for compatibility with rc.
3962 Enable verbose mode. This tells you what the preprocessor is if you
3966 @item --codepage @var{val}
3967 Specify the default codepage to use when reading an @code{rc} file.
3968 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3969 codepage code. The valid range is from zero up to 0xffff, but the
3970 validity of the codepage is host and configuration dependent.
3973 @item --language @var{val}
3974 Specify the default language to use when reading an @code{rc} file.
3975 @var{val} should be a hexadecimal language code. The low eight bits are
3976 the language, and the high eight bits are the sublanguage.
3978 @item --use-temp-file
3979 Use a temporary file to instead of using popen to read the output of
3980 the preprocessor. Use this option if the popen implementation is buggy
3981 on the host (eg., certain non-English language versions of Windows 95 and
3982 Windows 98 are known to have buggy popen where the output will instead
3985 @item --no-use-temp-file
3986 Use popen, not a temporary file, to read the output of the preprocessor.
3987 This is the default behaviour.
3991 Prints a usage summary.
3995 Prints the version number for @command{windres}.
3998 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3999 this will turn on parser debugging.
4005 @c man begin SEEALSO windres
4006 the Info entries for @file{binutils}.
4015 @command{dlltool} is used to create the files needed to create dynamic
4016 link libraries (DLLs) on systems which understand PE format image
4017 files such as Windows. A DLL contains an export table which contains
4018 information that the runtime loader needs to resolve references from a
4019 referencing program.
4021 The export table is generated by this program by reading in a
4022 @file{.def} file or scanning the @file{.a} and @file{.o} files which
4023 will be in the DLL. A @file{.o} file can contain information in
4024 special @samp{.drectve} sections with export information.
4027 @emph{Note:} @command{dlltool} is not always built as part of the
4028 binary utilities, since it is only useful for those targets which
4032 @c man title dlltool Create files needed to build and use DLLs.
4035 @c man begin SYNOPSIS dlltool
4036 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
4037 [@option{-b}|@option{--base-file} @var{base-file-name}]
4038 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
4039 [@option{-z}|@option{--output-def} @var{def-file-name}]
4040 [@option{-l}|@option{--output-lib} @var{library-file-name}]
4041 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
4042 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
4043 [@option{--exclude-symbols} @var{list}]
4044 [@option{--no-default-excludes}]
4045 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
4046 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
4047 [@option{-a}|@option{--add-indirect}]
4048 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
4049 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
4050 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
4051 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
4052 [@option{--use-nul-prefixed-import-tables}]
4053 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
4054 [@option{-i}|@option{--interwork}]
4055 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
4056 [@option{-v}|@option{--verbose}]
4057 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
4058 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
4059 [object-file @dots{}]
4063 @c man begin DESCRIPTION dlltool
4065 @command{dlltool} reads its inputs, which can come from the @option{-d} and
4066 @option{-b} options as well as object files specified on the command
4067 line. It then processes these inputs and if the @option{-e} option has
4068 been specified it creates a exports file. If the @option{-l} option
4069 has been specified it creates a library file and if the @option{-z} option
4070 has been specified it creates a def file. Any or all of the @option{-e},
4071 @option{-l} and @option{-z} options can be present in one invocation of
4074 When creating a DLL, along with the source for the DLL, it is necessary
4075 to have three other files. @command{dlltool} can help with the creation of
4078 The first file is a @file{.def} file which specifies which functions are
4079 exported from the DLL, which functions the DLL imports, and so on. This
4080 is a text file and can be created by hand, or @command{dlltool} can be used
4081 to create it using the @option{-z} option. In this case @command{dlltool}
4082 will scan the object files specified on its command line looking for
4083 those functions which have been specially marked as being exported and
4084 put entries for them in the @file{.def} file it creates.
4086 In order to mark a function as being exported from a DLL, it needs to
4087 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
4088 section of the object file. This can be done in C by using the
4092 asm (".section .drectve");
4093 asm (".ascii \"-export:my_func\"");
4095 int my_func (void) @{ @dots{} @}
4098 The second file needed for DLL creation is an exports file. This file
4099 is linked with the object files that make up the body of the DLL and it
4100 handles the interface between the DLL and the outside world. This is a
4101 binary file and it can be created by giving the @option{-e} option to
4102 @command{dlltool} when it is creating or reading in a @file{.def} file.
4104 The third file needed for DLL creation is the library file that programs
4105 will link with in order to access the functions in the DLL (an `import
4106 library'). This file can be created by giving the @option{-l} option to
4107 dlltool when it is creating or reading in a @file{.def} file.
4109 If the @option{-y} option is specified, dlltool generates a delay-import
4110 library that can be used instead of the normal import library to allow
4111 a program to link to the dll only as soon as an imported function is
4112 called for the first time. The resulting executable will need to be
4113 linked to the static delayimp library containing __delayLoadHelper2(),
4114 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4116 @command{dlltool} builds the library file by hand, but it builds the
4117 exports file by creating temporary files containing assembler statements
4118 and then assembling these. The @option{-S} command line option can be
4119 used to specify the path to the assembler that dlltool will use,
4120 and the @option{-f} option can be used to pass specific flags to that
4121 assembler. The @option{-n} can be used to prevent dlltool from deleting
4122 these temporary assembler files when it is done, and if @option{-n} is
4123 specified twice then this will prevent dlltool from deleting the
4124 temporary object files it used to build the library.
4126 Here is an example of creating a DLL from a source file @samp{dll.c} and
4127 also creating a program (from an object file called @samp{program.o})
4132 dlltool -e exports.o -l dll.lib dll.o
4133 gcc dll.o exports.o -o dll.dll
4134 gcc program.o dll.lib -o program
4138 @command{dlltool} may also be used to query an existing import library
4139 to determine the name of the DLL to which it is associated. See the
4140 description of the @option{-I} or @option{--identify} option.
4144 @c man begin OPTIONS dlltool
4146 The command line options have the following meanings:
4150 @item -d @var{filename}
4151 @itemx --input-def @var{filename}
4152 @cindex input .def file
4153 Specifies the name of a @file{.def} file to be read in and processed.
4155 @item -b @var{filename}
4156 @itemx --base-file @var{filename}
4158 Specifies the name of a base file to be read in and processed. The
4159 contents of this file will be added to the relocation section in the
4160 exports file generated by dlltool.
4162 @item -e @var{filename}
4163 @itemx --output-exp @var{filename}
4164 Specifies the name of the export file to be created by dlltool.
4166 @item -z @var{filename}
4167 @itemx --output-def @var{filename}
4168 Specifies the name of the @file{.def} file to be created by dlltool.
4170 @item -l @var{filename}
4171 @itemx --output-lib @var{filename}
4172 Specifies the name of the library file to be created by dlltool.
4174 @item -y @var{filename}
4175 @itemx --output-delaylib @var{filename}
4176 Specifies the name of the delay-import library file to be created by dlltool.
4178 @item --export-all-symbols
4179 Treat all global and weak defined symbols found in the input object
4180 files as symbols to be exported. There is a small list of symbols which
4181 are not exported by default; see the @option{--no-default-excludes}
4182 option. You may add to the list of symbols to not export by using the
4183 @option{--exclude-symbols} option.
4185 @item --no-export-all-symbols
4186 Only export symbols explicitly listed in an input @file{.def} file or in
4187 @samp{.drectve} sections in the input object files. This is the default
4188 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
4189 attributes in the source code.
4191 @item --exclude-symbols @var{list}
4192 Do not export the symbols in @var{list}. This is a list of symbol names
4193 separated by comma or colon characters. The symbol names should not
4194 contain a leading underscore. This is only meaningful when
4195 @option{--export-all-symbols} is used.
4197 @item --no-default-excludes
4198 When @option{--export-all-symbols} is used, it will by default avoid
4199 exporting certain special symbols. The current list of symbols to avoid
4200 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
4201 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
4202 to go ahead and export these special symbols. This is only meaningful
4203 when @option{--export-all-symbols} is used.
4206 @itemx --as @var{path}
4207 Specifies the path, including the filename, of the assembler to be used
4208 to create the exports file.
4210 @item -f @var{options}
4211 @itemx --as-flags @var{options}
4212 Specifies any specific command line options to be passed to the
4213 assembler when building the exports file. This option will work even if
4214 the @option{-S} option is not used. This option only takes one argument,
4215 and if it occurs more than once on the command line, then later
4216 occurrences will override earlier occurrences. So if it is necessary to
4217 pass multiple options to the assembler they should be enclosed in
4221 @itemx --dll-name @var{name}
4222 Specifies the name to be stored in the @file{.def} file as the name of
4223 the DLL when the @option{-e} option is used. If this option is not
4224 present, then the filename given to the @option{-e} option will be
4225 used as the name of the DLL.
4227 @item -m @var{machine}
4228 @itemx -machine @var{machine}
4229 Specifies the type of machine for which the library file should be
4230 built. @command{dlltool} has a built in default type, depending upon how
4231 it was created, but this option can be used to override that. This is
4232 normally only useful when creating DLLs for an ARM processor, when the
4233 contents of the DLL are actually encode using Thumb instructions.
4236 @itemx --add-indirect
4237 Specifies that when @command{dlltool} is creating the exports file it
4238 should add a section which allows the exported functions to be
4239 referenced without using the import library. Whatever the hell that
4243 @itemx --add-underscore
4244 Specifies that when @command{dlltool} is creating the exports file it
4245 should prepend an underscore to the names of @emph{all} exported symbols.
4247 @item --no-leading-underscore
4248 @item --leading-underscore
4249 Specifies whether standard symbol should be forced to be prefixed, or
4252 @item --add-stdcall-underscore
4253 Specifies that when @command{dlltool} is creating the exports file it
4254 should prepend an underscore to the names of exported @emph{stdcall}
4255 functions. Variable names and non-stdcall function names are not modified.
4256 This option is useful when creating GNU-compatible import libs for third
4257 party DLLs that were built with MS-Windows tools.
4261 Specifies that @samp{@@<number>} suffixes should be omitted from the names
4262 of stdcall functions that will be imported from the DLL. This is
4263 useful when creating an import library for a DLL which exports stdcall
4264 functions but without the usual @samp{@@<number>} symbol name suffix.
4266 This does not change the naming of symbols provided by the import library
4267 to programs linked against it, but only the entries in the import table
4268 (ie the .idata section).
4271 @itemx --add-stdcall-alias
4272 Specifies that when @command{dlltool} is creating the exports file it
4273 should add aliases for stdcall symbols without @samp{@@ <number>}
4274 in addition to the symbols with @samp{@@ <number>}.
4277 @itemx --ext-prefix-alias @var{prefix}
4278 Causes @command{dlltool} to create external aliases for all DLL
4279 imports with the specified prefix. The aliases are created for both
4280 external and import symbols with no leading underscore.
4284 Specifies that when @command{dlltool} is creating the exports and library
4285 files it should omit the @code{.idata4} section. This is for compatibility
4286 with certain operating systems.
4288 @item --use-nul-prefixed-import-tables
4289 Specifies that when @command{dlltool} is creating the exports and library
4290 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4291 element. This emulates old gnu import library generation of
4292 @code{dlltool}. By default this option is turned off.
4296 Specifies that when @command{dlltool} is creating the exports and library
4297 files it should omit the @code{.idata5} section. This is for compatibility
4298 with certain operating systems.
4300 @item -I @var{filename}
4301 @itemx --identify @var{filename}
4302 Specifies that @command{dlltool} should inspect the import library
4303 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4304 of the associated DLL(s). This can be performed in addition to any
4305 other operations indicated by the other options and arguments.
4306 @command{dlltool} fails if the import library does not exist or is not
4307 actually an import library. See also @option{--identify-strict}.
4309 @item --identify-strict
4310 Modifies the behavior of the @option{--identify} option, such
4311 that an error is reported if @var{filename} is associated with
4316 Specifies that @command{dlltool} should mark the objects in the library
4317 file and exports file that it produces as supporting interworking
4318 between ARM and Thumb code.
4322 Makes @command{dlltool} preserve the temporary assembler files it used to
4323 create the exports file. If this option is repeated then dlltool will
4324 also preserve the temporary object files it uses to create the library
4327 @item -t @var{prefix}
4328 @itemx --temp-prefix @var{prefix}
4329 Makes @command{dlltool} use @var{prefix} when constructing the names of
4330 temporary assembler and object files. By default, the temp file prefix
4331 is generated from the pid.
4335 Make dlltool describe what it is doing.
4339 Displays a list of command line options and then exits.
4343 Displays dlltool's version number and then exits.
4350 * def file format:: The format of the dlltool @file{.def} file
4353 @node def file format
4354 @section The format of the @command{dlltool} @file{.def} file
4356 A @file{.def} file contains any number of the following commands:
4360 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4361 The result is going to be named @var{name}@code{.exe}.
4363 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4364 The result is going to be named @var{name}@code{.dll}.
4365 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4366 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4369 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4370 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4371 Declares @var{name1} as an exported symbol from the DLL, with optional
4372 ordinal number @var{integer}, or declares @var{name1} as an alias
4373 (forward) of the function @var{external-name} in the DLL.
4374 If @var{its_name} is specified, this name is used as string in export table.
4376 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4377 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4378 If you want to use LIBRARY as name then you need to quote it.
4380 @item @code{IMPORTS ( (} @var{internal-name} @code{=} @var{module-name} @code{.} @var{integer} @code{) | [} @var{internal-name} @code{= ]} @var{module-name} @code{.} @var{external-name} @code{) [ == ) @var{its_name} @code{]} *}
4381 Declares that @var{external-name} or the exported function whose
4382 ordinal number is @var{integer} is to be imported from the file
4383 @var{module-name}. If @var{internal-name} is specified then this is
4384 the name that the imported function will be referred to in the body of
4386 If @var{its_name} is specified, this name is used as string in import table.
4387 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4388 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4389 If you want to use LIBRARY as name then you need to quote it.
4391 @item @code{DESCRIPTION} @var{string}
4392 Puts @var{string} into the output @file{.exp} file in the
4393 @code{.rdata} section.
4395 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4396 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4397 Generates @code{--stack} or @code{--heap}
4398 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4399 section. The linker will see this and act upon it.
4401 @item @code{CODE} @var{attr} @code{+}
4402 @item @code{DATA} @var{attr} @code{+}
4403 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4404 Generates @code{--attr} @var{section-name} @var{attr} in the output
4405 @code{.drectve} section, where @var{attr} is one of @code{READ},
4406 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4407 this and act upon it.
4412 @c man begin SEEALSO dlltool
4413 The Info pages for @file{binutils}.
4420 @cindex ELF file information
4423 @c man title readelf Displays information about ELF files.
4426 @c man begin SYNOPSIS readelf
4427 readelf [@option{-a}|@option{--all}]
4428 [@option{-h}|@option{--file-header}]
4429 [@option{-l}|@option{--program-headers}|@option{--segments}]
4430 [@option{-S}|@option{--section-headers}|@option{--sections}]
4431 [@option{-g}|@option{--section-groups}]
4432 [@option{-t}|@option{--section-details}]
4433 [@option{-e}|@option{--headers}]
4434 [@option{-s}|@option{--syms}|@option{--symbols}]
4435 [@option{--dyn-syms}]
4436 [@option{-n}|@option{--notes}]
4437 [@option{-r}|@option{--relocs}]
4438 [@option{-u}|@option{--unwind}]
4439 [@option{-d}|@option{--dynamic}]
4440 [@option{-V}|@option{--version-info}]
4441 [@option{-A}|@option{--arch-specific}]
4442 [@option{-D}|@option{--use-dynamic}]
4443 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4444 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4445 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4446 [@option{-z}|@option{--decompress}]
4447 [@option{-c}|@option{--archive-index}]
4448 [@option{-w[lLiaprmfFsoRt]}|
4449 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]]
4450 [@option{--dwarf-depth=@var{n}}]
4451 [@option{--dwarf-start=@var{n}}]
4452 [@option{-I}|@option{--histogram}]
4453 [@option{-v}|@option{--version}]
4454 [@option{-W}|@option{--wide}]
4455 [@option{-H}|@option{--help}]
4456 @var{elffile}@dots{}
4460 @c man begin DESCRIPTION readelf
4462 @command{readelf} displays information about one or more ELF format object
4463 files. The options control what particular information to display.
4465 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4466 64-bit ELF files are supported, as are archives containing ELF files.
4468 This program performs a similar function to @command{objdump} but it
4469 goes into more detail and it exists independently of the @sc{bfd}
4470 library, so if there is a bug in @sc{bfd} then readelf will not be
4475 @c man begin OPTIONS readelf
4477 The long and short forms of options, shown here as alternatives, are
4478 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4484 Equivalent to specifying @option{--file-header},
4485 @option{--program-headers}, @option{--sections}, @option{--symbols},
4486 @option{--relocs}, @option{--dynamic}, @option{--notes} and
4487 @option{--version-info}.
4490 @itemx --file-header
4491 @cindex ELF file header information
4492 Displays the information contained in the ELF header at the start of the
4496 @itemx --program-headers
4498 @cindex ELF program header information
4499 @cindex ELF segment information
4500 Displays the information contained in the file's segment headers, if it
4505 @itemx --section-headers
4506 @cindex ELF section information
4507 Displays the information contained in the file's section headers, if it
4511 @itemx --section-groups
4512 @cindex ELF section group information
4513 Displays the information contained in the file's section groups, if it
4517 @itemx --section-details
4518 @cindex ELF section information
4519 Displays the detailed section information. Implies @option{-S}.
4524 @cindex ELF symbol table information
4525 Displays the entries in symbol table section of the file, if it has one.
4528 @cindex ELF dynamic symbol table information
4529 Displays the entries in dynamic symbol table section of the file, if it
4534 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4539 Displays the contents of the NOTE segments and/or sections, if any.
4543 @cindex ELF reloc information
4544 Displays the contents of the file's relocation section, if it has one.
4548 @cindex unwind information
4549 Displays the contents of the file's unwind section, if it has one. Only
4550 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4551 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported.
4555 @cindex ELF dynamic section information
4556 Displays the contents of the file's dynamic section, if it has one.
4559 @itemx --version-info
4560 @cindex ELF version sections information
4561 Displays the contents of the version sections in the file, it they
4565 @itemx --arch-specific
4566 Displays architecture-specific information in the file, if there
4570 @itemx --use-dynamic
4571 When displaying symbols, this option makes @command{readelf} use the
4572 symbol hash tables in the file's dynamic section, rather than the
4573 symbol table sections.
4575 @item -x <number or name>
4576 @itemx --hex-dump=<number or name>
4577 Displays the contents of the indicated section as a hexadecimal bytes.
4578 A number identifies a particular section by index in the section table;
4579 any other string identifies all sections with that name in the object file.
4581 @item -R <number or name>
4582 @itemx --relocated-dump=<number or name>
4583 Displays the contents of the indicated section as a hexadecimal
4584 bytes. A number identifies a particular section by index in the
4585 section table; any other string identifies all sections with that name
4586 in the object file. The contents of the section will be relocated
4587 before they are displayed.
4589 @item -p <number or name>
4590 @itemx --string-dump=<number or name>
4591 Displays the contents of the indicated section as printable strings.
4592 A number identifies a particular section by index in the section table;
4593 any other string identifies all sections with that name in the object file.
4597 Requests that the section(s) being dumped by @option{x}, @option{R} or
4598 @option{p} options are decompressed before being displayed. If the
4599 section(s) are not compressed then they are displayed as is.
4602 @itemx --archive-index
4603 @cindex Archive file symbol index information
4604 Displays the file symbol index information contained in the header part
4605 of binary archives. Performs the same function as the @option{t}
4606 command to @command{ar}, but without using the BFD library. @xref{ar}.
4608 @item -w[lLiaprmfFsoRt]
4609 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]
4610 Displays the contents of the debug sections in the file, if any are
4611 present. If one of the optional letters or words follows the switch
4612 then only data found in those specific sections will be dumped.
4614 Note that there is no single letter option to display the content of
4615 trace sections or .gdb_index.
4617 Note: the @option{=decodedline} option will display the interpreted
4618 contents of a .debug_line section whereas the @option{=rawline} option
4619 dumps the contents in a raw format.
4621 Note: the @option{=frames-interp} option will display the interpreted
4622 contents of a .debug_frame section whereas the @option{=frames} option
4623 dumps the contents in a raw format.
4625 Note: the output from the @option{=info} option can also be affected
4626 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
4628 @item --dwarf-depth=@var{n}
4629 Limit the dump of the @code{.debug_info} section to @var{n} children.
4630 This is only useful with @option{--debug-dump=info}. The default is
4631 to print all DIEs; the special value 0 for @var{n} will also have this
4634 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
4635 levels will not be printed. The range for @var{n} is zero-based.
4637 @item --dwarf-start=@var{n}
4638 Print only DIEs beginning with the DIE numbered @var{n}. This is only
4639 useful with @option{--debug-dump=info}.
4641 If specified, this option will suppress printing of any header
4642 information and all DIEs before the DIE numbered @var{n}. Only
4643 siblings and children of the specified DIE will be printed.
4645 This can be used in conjunction with @option{--dwarf-depth}.
4649 Display a histogram of bucket list lengths when displaying the contents
4650 of the symbol tables.
4654 Display the version number of readelf.
4658 Don't break output lines to fit into 80 columns. By default
4659 @command{readelf} breaks section header and segment listing lines for
4660 64-bit ELF files, so that they fit into 80 columns. This option causes
4661 @command{readelf} to print each section header resp. each segment one a
4662 single line, which is far more readable on terminals wider than 80 columns.
4666 Display the command line options understood by @command{readelf}.
4673 @c man begin SEEALSO readelf
4674 objdump(1), and the Info entries for @file{binutils}.
4681 @cindex Update ELF header
4684 @c man title elfedit Update the ELF header of ELF files.
4687 @c man begin SYNOPSIS elfedit
4688 elfedit [@option{--input-mach=}@var{machine}]
4689 [@option{--input-type=}@var{type}]
4690 [@option{--input-osabi=}@var{osabi}]
4691 @option{--output-mach=}@var{machine}
4692 @option{--output-type=}@var{type}
4693 @option{--output-osabi=}@var{osabi}
4694 [@option{-v}|@option{--version}]
4695 [@option{-h}|@option{--help}]
4696 @var{elffile}@dots{}
4700 @c man begin DESCRIPTION elfedit
4702 @command{elfedit} updates the ELF header of ELF files which have
4703 the matching ELF machine and file types. The options control how and
4704 which fields in the ELF header should be updated.
4706 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4707 64-bit ELF files are supported, as are archives containing ELF files.
4710 @c man begin OPTIONS elfedit
4712 The long and short forms of options, shown here as alternatives, are
4713 equivalent. At least one of the @option{--output-mach},
4714 @option{--output-type} and @option{--output-osabi} options must be given.
4718 @item --input-mach=@var{machine}
4719 Set the matching input ELF machine type to @var{machine}. If
4720 @option{--input-mach} isn't specified, it will match any ELF
4723 The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
4724 @var{K1OM} and @var{x86-64}.
4726 @item --output-mach=@var{machine}
4727 Change the ELF machine type in the ELF header to @var{machine}. The
4728 supported ELF machine types are the same as @option{--input-mach}.
4730 @item --input-type=@var{type}
4731 Set the matching input ELF file type to @var{type}. If
4732 @option{--input-type} isn't specified, it will match any ELF file types.
4734 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4736 @item --output-type=@var{type}
4737 Change the ELF file type in the ELF header to @var{type}. The
4738 supported ELF types are the same as @option{--input-type}.
4740 @item --input-osabi=@var{osabi}
4741 Set the matching input ELF file OSABI to @var{osabi}. If
4742 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4744 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4745 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4746 @var{Solaris}, @var{AIX}, @var{Irix},
4747 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4748 @var{NSK}, @var{AROS} and @var{FenixOS}.
4750 @item --output-osabi=@var{osabi}
4751 Change the ELF OSABI in the ELF header to @var{osabi}. The
4752 supported ELF OSABI are the same as @option{--input-osabi}.
4756 Display the version number of @command{elfedit}.
4760 Display the command line options understood by @command{elfedit}.
4767 @c man begin SEEALSO elfedit
4768 readelf(1), and the Info entries for @file{binutils}.
4772 @node Common Options
4773 @chapter Common Options
4775 The following command-line options are supported by all of the
4776 programs described in this manual.
4778 @c man begin OPTIONS
4780 @include at-file.texi
4784 Display the command-line options supported by the program.
4787 Display the version number of the program.
4789 @c man begin OPTIONS
4793 @node Selecting the Target System
4794 @chapter Selecting the Target System
4796 You can specify two aspects of the target system to the @sc{gnu}
4797 binary file utilities, each in several ways:
4807 In the following summaries, the lists of ways to specify values are in
4808 order of decreasing precedence. The ways listed first override those
4811 The commands to list valid values only list the values for which the
4812 programs you are running were configured. If they were configured with
4813 @option{--enable-targets=all}, the commands list most of the available
4814 values, but a few are left out; not all targets can be configured in at
4815 once because some of them can only be configured @dfn{native} (on hosts
4816 with the same type as the target system).
4819 * Target Selection::
4820 * Architecture Selection::
4823 @node Target Selection
4824 @section Target Selection
4826 A @dfn{target} is an object file format. A given target may be
4827 supported for multiple architectures (@pxref{Architecture Selection}).
4828 A target selection may also have variations for different operating
4829 systems or architectures.
4831 The command to list valid target values is @samp{objdump -i}
4832 (the first column of output contains the relevant information).
4834 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4835 @samp{a.out-sunos-big}.
4837 You can also specify a target using a configuration triplet. This is
4838 the same sort of name that is passed to @file{configure} to specify a
4839 target. When you use a configuration triplet as an argument, it must be
4840 fully canonicalized. You can see the canonical version of a triplet by
4841 running the shell script @file{config.sub} which is included with the
4844 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4845 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4847 @subheading @command{objdump} Target
4853 command line option: @option{-b} or @option{--target}
4856 environment variable @code{GNUTARGET}
4859 deduced from the input file
4862 @subheading @command{objcopy} and @command{strip} Input Target
4868 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4871 environment variable @code{GNUTARGET}
4874 deduced from the input file
4877 @subheading @command{objcopy} and @command{strip} Output Target
4883 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4886 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4889 environment variable @code{GNUTARGET}
4892 deduced from the input file
4895 @subheading @command{nm}, @command{size}, and @command{strings} Target
4901 command line option: @option{--target}
4904 environment variable @code{GNUTARGET}
4907 deduced from the input file
4910 @node Architecture Selection
4911 @section Architecture Selection
4913 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4914 to run. Its name may contain a colon, separating the name of the
4915 processor family from the name of the particular @sc{cpu}.
4917 The command to list valid architecture values is @samp{objdump -i} (the
4918 second column contains the relevant information).
4920 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4922 @subheading @command{objdump} Architecture
4928 command line option: @option{-m} or @option{--architecture}
4931 deduced from the input file
4934 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4940 deduced from the input file
4943 @node Reporting Bugs
4944 @chapter Reporting Bugs
4946 @cindex reporting bugs
4948 Your bug reports play an essential role in making the binary utilities
4951 Reporting a bug may help you by bringing a solution to your problem, or
4952 it may not. But in any case the principal function of a bug report is
4953 to help the entire community by making the next version of the binary
4954 utilities work better. Bug reports are your contribution to their
4957 In order for a bug report to serve its purpose, you must include the
4958 information that enables us to fix the bug.
4961 * Bug Criteria:: Have you found a bug?
4962 * Bug Reporting:: How to report bugs
4966 @section Have You Found a Bug?
4967 @cindex bug criteria
4969 If you are not sure whether you have found a bug, here are some guidelines:
4972 @cindex fatal signal
4975 If a binary utility gets a fatal signal, for any input whatever, that is
4976 a bug. Reliable utilities never crash.
4978 @cindex error on valid input
4980 If a binary utility produces an error message for valid input, that is a
4984 If you are an experienced user of binary utilities, your suggestions for
4985 improvement are welcome in any case.
4989 @section How to Report Bugs
4991 @cindex bugs, reporting
4993 A number of companies and individuals offer support for @sc{gnu}
4994 products. If you obtained the binary utilities from a support
4995 organization, we recommend you contact that organization first.
4997 You can find contact information for many support companies and
4998 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5002 In any event, we also recommend that you send bug reports for the binary
5003 utilities to @value{BUGURL}.
5006 The fundamental principle of reporting bugs usefully is this:
5007 @strong{report all the facts}. If you are not sure whether to state a
5008 fact or leave it out, state it!
5010 Often people omit facts because they think they know what causes the
5011 problem and assume that some details do not matter. Thus, you might
5012 assume that the name of a file you use in an example does not matter.
5013 Well, probably it does not, but one cannot be sure. Perhaps the bug is
5014 a stray memory reference which happens to fetch from the location where
5015 that pathname is stored in memory; perhaps, if the pathname were
5016 different, the contents of that location would fool the utility into
5017 doing the right thing despite the bug. Play it safe and give a
5018 specific, complete example. That is the easiest thing for you to do,
5019 and the most helpful.
5021 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5022 it is new to us. Therefore, always write your bug reports on the assumption
5023 that the bug has not been reported previously.
5025 Sometimes people give a few sketchy facts and ask, ``Does this ring a
5026 bell?'' This cannot help us fix a bug, so it is basically useless. We
5027 respond by asking for enough details to enable us to investigate.
5028 You might as well expedite matters by sending them to begin with.
5030 To enable us to fix the bug, you should include all these things:
5034 The version of the utility. Each utility announces it if you start it
5035 with the @option{--version} argument.
5037 Without this, we will not know whether there is any point in looking for
5038 the bug in the current version of the binary utilities.
5041 Any patches you may have applied to the source, including any patches
5042 made to the @code{BFD} library.
5045 The type of machine you are using, and the operating system name and
5049 What compiler (and its version) was used to compile the utilities---e.g.
5053 The command arguments you gave the utility to observe the bug. To
5054 guarantee you will not omit something important, list them all. A copy
5055 of the Makefile (or the output from make) is sufficient.
5057 If we were to try to guess the arguments, we would probably guess wrong
5058 and then we might not encounter the bug.
5061 A complete input file, or set of input files, that will reproduce the
5062 bug. If the utility is reading an object file or files, then it is
5063 generally most helpful to send the actual object files.
5065 If the source files were produced exclusively using @sc{gnu} programs
5066 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
5067 may be OK to send the source files rather than the object files. In
5068 this case, be sure to say exactly what version of @command{gcc}, or
5069 whatever, was used to produce the object files. Also say how
5070 @command{gcc}, or whatever, was configured.
5073 A description of what behavior you observe that you believe is
5074 incorrect. For example, ``It gets a fatal signal.''
5076 Of course, if the bug is that the utility gets a fatal signal, then we
5077 will certainly notice it. But if the bug is incorrect output, we might
5078 not notice unless it is glaringly wrong. You might as well not give us
5079 a chance to make a mistake.
5081 Even if the problem you experience is a fatal signal, you should still
5082 say so explicitly. Suppose something strange is going on, such as your
5083 copy of the utility is out of sync, or you have encountered a bug in
5084 the C library on your system. (This has happened!) Your copy might
5085 crash and ours would not. If you told us to expect a crash, then when
5086 ours fails to crash, we would know that the bug was not happening for
5087 us. If you had not told us to expect a crash, then we would not be able
5088 to draw any conclusion from our observations.
5091 If you wish to suggest changes to the source, send us context diffs, as
5092 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
5093 option. Always send diffs from the old file to the new file. If you
5094 wish to discuss something in the @command{ld} source, refer to it by
5095 context, not by line number.
5097 The line numbers in our development sources will not match those in your
5098 sources. Your line numbers would convey no useful information to us.
5101 Here are some things that are not necessary:
5105 A description of the envelope of the bug.
5107 Often people who encounter a bug spend a lot of time investigating
5108 which changes to the input file will make the bug go away and which
5109 changes will not affect it.
5111 This is often time consuming and not very useful, because the way we
5112 will find the bug is by running a single example under the debugger
5113 with breakpoints, not by pure deduction from a series of examples.
5114 We recommend that you save your time for something else.
5116 Of course, if you can find a simpler example to report @emph{instead}
5117 of the original one, that is a convenience for us. Errors in the
5118 output will be easier to spot, running under the debugger will take
5119 less time, and so on.
5121 However, simplification is not vital; if you do not want to do this,
5122 report the bug anyway and send us the entire test case you used.
5125 A patch for the bug.
5127 A patch for the bug does help us if it is a good one. But do not omit
5128 the necessary information, such as the test case, on the assumption that
5129 a patch is all we need. We might see problems with your patch and decide
5130 to fix the problem another way, or we might not understand it at all.
5132 Sometimes with programs as complicated as the binary utilities it is
5133 very hard to construct an example that will make the program follow a
5134 certain path through the code. If you do not send us the example, we
5135 will not be able to construct one, so we will not be able to verify that
5138 And if we cannot understand what bug you are trying to fix, or why your
5139 patch should be an improvement, we will not install it. A test case will
5140 help us to understand.
5143 A guess about what the bug is or what it depends on.
5145 Such guesses are usually wrong. Even we cannot guess right about such
5146 things without first using the debugger to find the facts.
5149 @node GNU Free Documentation License
5150 @appendix GNU Free Documentation License
5154 @node Binutils Index
5155 @unnumbered Binutils Index