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. The size is computed as the difference between
1016 the value of the symbol and the value of the symbol with the next higher
1017 value. If the @code{bsd} output format is used the size of the symbol
1018 is printed, rather than the value, and @samp{-S} must be used in order
1019 both size and value to be printed.
1021 @item --special-syms
1022 Display symbols which have a target-specific special meaning. These
1023 symbols are usually used by the target for some special processing and
1024 are not normally helpful when included in the normal symbol lists.
1025 For example for ARM targets this option would skip the mapping symbols
1026 used to mark transitions between ARM code, THUMB code and data.
1029 Include synthetic symbols in the output. These are special symbols
1030 created by the linker for various purposes. They are not shown by
1031 default since they are not part of the binary's original source code.
1033 @item --target=@var{bfdname}
1034 @cindex object code format
1035 Specify an object code format other than your system's default format.
1036 @xref{Target Selection}, for more information.
1043 @c man begin SEEALSO nm
1044 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1051 @c man title objcopy copy and translate object files
1054 @c man begin SYNOPSIS objcopy
1055 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1056 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1057 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1058 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1059 [@option{-S}|@option{--strip-all}]
1060 [@option{-g}|@option{--strip-debug}]
1061 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1062 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1063 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1064 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1065 [@option{--localize-hidden}]
1066 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1067 [@option{--globalize-symbol=}@var{symbolname}]
1068 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1069 [@option{-w}|@option{--wildcard}]
1070 [@option{-x}|@option{--discard-all}]
1071 [@option{-X}|@option{--discard-locals}]
1072 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1073 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1074 [@option{--interleave-width=}@var{width}]
1075 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1076 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1077 [@option{-p}|@option{--preserve-dates}]
1078 [@option{-D}|@option{--enable-deterministic-archives}]
1079 [@option{-U}|@option{--disable-deterministic-archives}]
1080 [@option{--debugging}]
1081 [@option{--gap-fill=}@var{val}]
1082 [@option{--pad-to=}@var{address}]
1083 [@option{--set-start=}@var{val}]
1084 [@option{--adjust-start=}@var{incr}]
1085 [@option{--change-addresses=}@var{incr}]
1086 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1087 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1088 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1089 [@option{--change-warnings}] [@option{--no-change-warnings}]
1090 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1091 [@option{--add-section} @var{sectionname}=@var{filename}]
1092 [@option{--dump-section} @var{sectionname}=@var{filename}]
1093 [@option{--update-section} @var{sectionname}=@var{filename}]
1094 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1095 [@option{--long-section-names} @{enable,disable,keep@}]
1096 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1097 [@option{--reverse-bytes=}@var{num}]
1098 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1099 [@option{--redefine-sym} @var{old}=@var{new}]
1100 [@option{--redefine-syms=}@var{filename}]
1102 [@option{--keep-symbols=}@var{filename}]
1103 [@option{--strip-symbols=}@var{filename}]
1104 [@option{--strip-unneeded-symbols=}@var{filename}]
1105 [@option{--keep-global-symbols=}@var{filename}]
1106 [@option{--localize-symbols=}@var{filename}]
1107 [@option{--globalize-symbols=}@var{filename}]
1108 [@option{--weaken-symbols=}@var{filename}]
1109 [@option{--add-symbol} @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1110 [@option{--alt-machine-code=}@var{index}]
1111 [@option{--prefix-symbols=}@var{string}]
1112 [@option{--prefix-sections=}@var{string}]
1113 [@option{--prefix-alloc-sections=}@var{string}]
1114 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1115 [@option{--keep-file-symbols}]
1116 [@option{--only-keep-debug}]
1117 [@option{--strip-dwo}]
1118 [@option{--extract-dwo}]
1119 [@option{--extract-symbol}]
1120 [@option{--writable-text}]
1121 [@option{--readonly-text}]
1124 [@option{--file-alignment=}@var{num}]
1125 [@option{--heap=}@var{size}]
1126 [@option{--image-base=}@var{address}]
1127 [@option{--section-alignment=}@var{num}]
1128 [@option{--stack=}@var{size}]
1129 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1130 [@option{--compress-debug-sections}]
1131 [@option{--decompress-debug-sections}]
1132 [@option{--dwarf-depth=@var{n}}]
1133 [@option{--dwarf-start=@var{n}}]
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 @item -R @var{sectionpattern}
1225 @itemx --remove-section=@var{sectionpattern}
1226 Remove any section matching @var{sectionpattern} from the output file.
1227 This option may be given more than once. Note that using this option
1228 inappropriately may make the output file unusable. Wildcard
1229 characters are accepted in @var{sectionpattern}. Using both the
1230 @option{-j} and @option{-R} options together results in undefined
1235 Do not copy relocation and symbol information from the source file.
1238 @itemx --strip-debug
1239 Do not copy debugging symbols or sections from the source file.
1241 @item --strip-unneeded
1242 Strip all symbols that are not needed for relocation processing.
1244 @item -K @var{symbolname}
1245 @itemx --keep-symbol=@var{symbolname}
1246 When stripping symbols, keep symbol @var{symbolname} even if it would
1247 normally be stripped. This option may be given more than once.
1249 @item -N @var{symbolname}
1250 @itemx --strip-symbol=@var{symbolname}
1251 Do not copy symbol @var{symbolname} from the source file. This option
1252 may be given more than once.
1254 @item --strip-unneeded-symbol=@var{symbolname}
1255 Do not copy symbol @var{symbolname} from the source file unless it is needed
1256 by a relocation. This option may be given more than once.
1258 @item -G @var{symbolname}
1259 @itemx --keep-global-symbol=@var{symbolname}
1260 Keep only symbol @var{symbolname} global. Make all other symbols local
1261 to the file, so that they are not visible externally. This option may
1262 be given more than once.
1264 @item --localize-hidden
1265 In an ELF object, mark all symbols that have hidden or internal visibility
1266 as local. This option applies on top of symbol-specific localization options
1267 such as @option{-L}.
1269 @item -L @var{symbolname}
1270 @itemx --localize-symbol=@var{symbolname}
1271 Make symbol @var{symbolname} local to the file, so that it is not
1272 visible externally. This option may be given more than once.
1274 @item -W @var{symbolname}
1275 @itemx --weaken-symbol=@var{symbolname}
1276 Make symbol @var{symbolname} weak. This option may be given more than once.
1278 @item --globalize-symbol=@var{symbolname}
1279 Give symbol @var{symbolname} global scoping so that it is visible
1280 outside of the file in which it is defined. This option may be given
1285 Permit regular expressions in @var{symbolname}s used in other command
1286 line options. The question mark (?), asterisk (*), backslash (\) and
1287 square brackets ([]) operators can be used anywhere in the symbol
1288 name. If the first character of the symbol name is the exclamation
1289 point (!) then the sense of the switch is reversed for that symbol.
1296 would cause objcopy to weaken all symbols that start with ``fo''
1297 except for the symbol ``foo''.
1300 @itemx --discard-all
1301 Do not copy non-global symbols from the source file.
1302 @c FIXME any reason to prefer "non-global" to "local" here?
1305 @itemx --discard-locals
1306 Do not copy compiler-generated local symbols.
1307 (These usually start with @samp{L} or @samp{.}.)
1310 @itemx --byte=@var{byte}
1311 If interleaving has been enabled via the @option{--interleave} option
1312 then start the range of bytes to keep at the @var{byte}th byte.
1313 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1314 @var{breadth} is the value given by the @option{--interleave} option.
1316 @item -i [@var{breadth}]
1317 @itemx --interleave[=@var{breadth}]
1318 Only copy a range out of every @var{breadth} bytes. (Header data is
1319 not affected). Select which byte in the range begins the copy with
1320 the @option{--byte} option. Select the width of the range with the
1321 @option{--interleave-width} option.
1323 This option is useful for creating files to program @sc{rom}. It is
1324 typically used with an @code{srec} output target. Note that
1325 @command{objcopy} will complain if you do not specify the
1326 @option{--byte} option as well.
1328 The default interleave breadth is 4, so with @option{--byte} set to 0,
1329 @command{objcopy} would copy the first byte out of every four bytes
1330 from the input to the output.
1332 @item --interleave-width=@var{width}
1333 When used with the @option{--interleave} option, copy @var{width}
1334 bytes at a time. The start of the range of bytes to be copied is set
1335 by the @option{--byte} option, and the extent of the range is set with
1336 the @option{--interleave} option.
1338 The default value for this option is 1. The value of @var{width} plus
1339 the @var{byte} value set by the @option{--byte} option must not exceed
1340 the interleave breadth set by the @option{--interleave} option.
1342 This option can be used to create images for two 16-bit flashes interleaved
1343 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1344 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1345 commands. If the input was '12345678' then the outputs would be
1346 '1256' and '3478' respectively.
1349 @itemx --preserve-dates
1350 Set the access and modification dates of the output file to be the same
1351 as those of the input file.
1354 @itemx --enable-deterministic-archives
1355 @cindex deterministic archives
1356 @kindex --enable-deterministic-archives
1357 Operate in @emph{deterministic} mode. When copying archive members
1358 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1359 and use consistent file modes for all files.
1361 If @file{binutils} was configured with
1362 @option{--enable-deterministic-archives}, then this mode is on by default.
1363 It can be disabled with the @samp{-U} option, below.
1366 @itemx --disable-deterministic-archives
1367 @cindex deterministic archives
1368 @kindex --enable-deterministic-archives
1369 Do @emph{not} operate in @emph{deterministic} mode. This is the
1370 inverse of the @option{-D} option, above: when copying archive members
1371 and writing the archive index, use their actual UID, GID, timestamp,
1372 and file mode values.
1374 This is the default unless @file{binutils} was configured with
1375 @option{--enable-deterministic-archives}.
1378 Convert debugging information, if possible. This is not the default
1379 because only certain debugging formats are supported, and the
1380 conversion process can be time consuming.
1382 @item --gap-fill @var{val}
1383 Fill gaps between sections with @var{val}. This operation applies to
1384 the @emph{load address} (LMA) of the sections. It is done by increasing
1385 the size of the section with the lower address, and filling in the extra
1386 space created with @var{val}.
1388 @item --pad-to @var{address}
1389 Pad the output file up to the load address @var{address}. This is
1390 done by increasing the size of the last section. The extra space is
1391 filled in with the value specified by @option{--gap-fill} (default zero).
1393 @item --set-start @var{val}
1394 Set the start address of the new file to @var{val}. Not all object file
1395 formats support setting the start address.
1397 @item --change-start @var{incr}
1398 @itemx --adjust-start @var{incr}
1399 @cindex changing start address
1400 Change the start address by adding @var{incr}. Not all object file
1401 formats support setting the start address.
1403 @item --change-addresses @var{incr}
1404 @itemx --adjust-vma @var{incr}
1405 @cindex changing object addresses
1406 Change the VMA and LMA addresses of all sections, as well as the start
1407 address, by adding @var{incr}. Some object file formats do not permit
1408 section addresses to be changed arbitrarily. Note that this does not
1409 relocate the sections; if the program expects sections to be loaded at a
1410 certain address, and this option is used to change the sections such
1411 that they are loaded at a different address, the program may fail.
1413 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1414 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1415 @cindex changing section address
1416 Set or change both the VMA address and the LMA address of any section
1417 matching @var{sectionpattern}. If @samp{=} is used, the section
1418 address is set to @var{val}. Otherwise, @var{val} is added to or
1419 subtracted from the section address. See the comments under
1420 @option{--change-addresses}, above. If @var{sectionpattern} does not
1421 match any sections in the input file, a warning will be issued, unless
1422 @option{--no-change-warnings} is used.
1424 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1425 @cindex changing section LMA
1426 Set or change the LMA address of any sections matching
1427 @var{sectionpattern}. The LMA address is the address where the
1428 section will be loaded into memory at program load time. Normally
1429 this is the same as the VMA address, which is the address of the
1430 section at program run time, but on some systems, especially those
1431 where a program is held in ROM, the two can be different. If @samp{=}
1432 is used, the section address is set to @var{val}. Otherwise,
1433 @var{val} is added to or subtracted from the section address. See the
1434 comments under @option{--change-addresses}, above. If
1435 @var{sectionpattern} does not match any sections in the input file, a
1436 warning will be issued, unless @option{--no-change-warnings} is used.
1438 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1439 @cindex changing section VMA
1440 Set or change the VMA address of any section matching
1441 @var{sectionpattern}. The VMA address is the address where the
1442 section will be located once the program has started executing.
1443 Normally this is the same as the LMA address, which is the address
1444 where the section will be loaded into memory, but on some systems,
1445 especially those where a program is held in ROM, the two can be
1446 different. If @samp{=} is used, the section address is set to
1447 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1448 section address. See the comments under @option{--change-addresses},
1449 above. If @var{sectionpattern} does not match any sections in the
1450 input file, a warning will be issued, unless
1451 @option{--no-change-warnings} is used.
1453 @item --change-warnings
1454 @itemx --adjust-warnings
1455 If @option{--change-section-address} or @option{--change-section-lma} or
1456 @option{--change-section-vma} is used, and the section pattern does not
1457 match any sections, issue a warning. This is the default.
1459 @item --no-change-warnings
1460 @itemx --no-adjust-warnings
1461 Do not issue a warning if @option{--change-section-address} or
1462 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1463 if the section pattern does not match any sections.
1465 @item --set-section-flags @var{sectionpattern}=@var{flags}
1466 Set the flags for any sections matching @var{sectionpattern}. The
1467 @var{flags} argument is a comma separated string of flag names. The
1468 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1469 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1470 @samp{share}, and @samp{debug}. You can set the @samp{contents} flag
1471 for a section which does not have contents, but it is not meaningful
1472 to clear the @samp{contents} flag of a section which does have
1473 contents--just remove the section instead. Not all flags are
1474 meaningful for all object file formats.
1476 @item --add-section @var{sectionname}=@var{filename}
1477 Add a new section named @var{sectionname} while copying the file. The
1478 contents of the new section are taken from the file @var{filename}. The
1479 size of the section will be the size of the file. This option only
1480 works on file formats which can support sections with arbitrary names.
1481 Note - it may be necessary to use the @option{--set-section-flags}
1482 option to set the attributes of the newly created section.
1484 @item --dump-section @var{sectionname}=@var{filename}
1485 Place the contents of section named @var{sectionname} into the file
1486 @var{filename}, overwriting any contents that may have been there
1487 previously. This option is the inverse of @option{--add-section}.
1488 This option is similar to the @option{--only-section} option except
1489 that it does not create a formatted file, it just dumps the contents
1490 as raw binary data, without applying any relocations. The option can
1491 be specified more than once.
1493 @item --update-section @var{sectionname}=@var{filename}
1494 Replace the existing contents of a section named @var{sectionname}
1495 with the contents of file @var{filename}. The size of the section
1496 will be adjusted to the size of the file. The section flags for
1497 @var{sectionname} will be unchanged. For ELF format files the section
1498 to segment mapping will also remain unchanged, something which is not
1499 possible using @option{--remove-section} followed by
1500 @option{--add-section}. The option can be specified more than once.
1502 Note - it is possible to use @option{--rename-section} and
1503 @option{--update-section} to both update and rename a section from one
1504 command line. In this case, pass the original section name to
1505 @option{--update-section}, and the original and new section names to
1506 @option{--rename-section}.
1508 @item --add-symbol @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1509 Add a new symbol named @var{name} while copying the file. This option may be
1510 specified multiple times. If the @var{section} is given, the symbol will be
1511 associated with and relative to that section, otherwise it will be an ABS
1512 symbol. Specifying an undefined section will result in a fatal error. There
1513 is no check for the value, it will be taken as specified. Symbol flags can
1514 be specified and not all flags will be meaningful for all object file
1515 formats. By default, the symbol will be global. The special flag
1516 'before=@var{othersym}' will insert the new symbol in front of the specified
1517 @var{othersym}, otherwise the symbol(s) will be added at the end of the
1518 symbol table in the order they appear.
1520 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1521 Rename a section from @var{oldname} to @var{newname}, optionally
1522 changing the section's flags to @var{flags} in the process. This has
1523 the advantage over usng a linker script to perform the rename in that
1524 the output stays as an object file and does not become a linked
1527 This option is particularly helpful when the input format is binary,
1528 since this will always create a section called .data. If for example,
1529 you wanted instead to create a section called .rodata containing binary
1530 data you could use the following command line to achieve it:
1533 objcopy -I binary -O <output_format> -B <architecture> \
1534 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1535 <input_binary_file> <output_object_file>
1538 @item --long-section-names @{enable,disable,keep@}
1539 Controls the handling of long section names when processing @code{COFF}
1540 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1541 is to preserve long section names if any are present in the input file.
1542 The @samp{enable} and @samp{disable} options forcibly enable or disable
1543 the use of long section names in the output object; when @samp{disable}
1544 is in effect, any long section names in the input object will be truncated.
1545 The @samp{enable} option will only emit long section names if any are
1546 present in the inputs; this is mostly the same as @samp{keep}, but it
1547 is left undefined whether the @samp{enable} option might force the
1548 creation of an empty string table in the output file.
1550 @item --change-leading-char
1551 Some object file formats use special characters at the start of
1552 symbols. The most common such character is underscore, which compilers
1553 often add before every symbol. This option tells @command{objcopy} to
1554 change the leading character of every symbol when it converts between
1555 object file formats. If the object file formats use the same leading
1556 character, this option has no effect. Otherwise, it will add a
1557 character, or remove a character, or change a character, as
1560 @item --remove-leading-char
1561 If the first character of a global symbol is a special symbol leading
1562 character used by the object file format, remove the character. The
1563 most common symbol leading character is underscore. This option will
1564 remove a leading underscore from all global symbols. This can be useful
1565 if you want to link together objects of different file formats with
1566 different conventions for symbol names. This is different from
1567 @option{--change-leading-char} because it always changes the symbol name
1568 when appropriate, regardless of the object file format of the output
1571 @item --reverse-bytes=@var{num}
1572 Reverse the bytes in a section with output contents. A section length must
1573 be evenly divisible by the value given in order for the swap to be able to
1574 take place. Reversing takes place before the interleaving is performed.
1576 This option is used typically in generating ROM images for problematic
1577 target systems. For example, on some target boards, the 32-bit words
1578 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1579 regardless of the CPU byte order. Depending on the programming model, the
1580 endianness of the ROM may need to be modified.
1582 Consider a simple file with a section containing the following eight
1583 bytes: @code{12345678}.
1585 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1586 output file would be ordered @code{21436587}.
1588 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1589 output file would be ordered @code{43218765}.
1591 By using @samp{--reverse-bytes=2} for the above example, followed by
1592 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1593 output file would be ordered @code{34127856}.
1595 @item --srec-len=@var{ival}
1596 Meaningful only for srec output. Set the maximum length of the Srecords
1597 being produced to @var{ival}. This length covers both address, data and
1600 @item --srec-forceS3
1601 Meaningful only for srec output. Avoid generation of S1/S2 records,
1602 creating S3-only record format.
1604 @item --redefine-sym @var{old}=@var{new}
1605 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1606 when one is trying link two things together for which you have no
1607 source, and there are name collisions.
1609 @item --redefine-syms=@var{filename}
1610 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1611 listed in the file @var{filename}. @var{filename} is simply a flat file,
1612 with one symbol pair per line. Line comments may be introduced by the hash
1613 character. This option may be given more than once.
1616 Change all global symbols in the file to be weak. This can be useful
1617 when building an object which will be linked against other objects using
1618 the @option{-R} option to the linker. This option is only effective when
1619 using an object file format which supports weak symbols.
1621 @item --keep-symbols=@var{filename}
1622 Apply @option{--keep-symbol} option to each symbol listed in the file
1623 @var{filename}. @var{filename} is simply a flat file, with one symbol
1624 name per line. Line comments may be introduced by the hash character.
1625 This option may be given more than once.
1627 @item --strip-symbols=@var{filename}
1628 Apply @option{--strip-symbol} option to each symbol listed in the file
1629 @var{filename}. @var{filename} is simply a flat file, with one symbol
1630 name per line. Line comments may be introduced by the hash character.
1631 This option may be given more than once.
1633 @item --strip-unneeded-symbols=@var{filename}
1634 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1635 the file @var{filename}. @var{filename} is simply a flat file, with one
1636 symbol name per line. Line comments may be introduced by the hash
1637 character. This option may be given more than once.
1639 @item --keep-global-symbols=@var{filename}
1640 Apply @option{--keep-global-symbol} option to each symbol listed in the
1641 file @var{filename}. @var{filename} is simply a flat file, with one
1642 symbol name per line. Line comments may be introduced by the hash
1643 character. This option may be given more than once.
1645 @item --localize-symbols=@var{filename}
1646 Apply @option{--localize-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 --globalize-symbols=@var{filename}
1652 Apply @option{--globalize-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 --weaken-symbols=@var{filename}
1658 Apply @option{--weaken-symbol} option to each symbol listed in the file
1659 @var{filename}. @var{filename} is simply a flat file, with one symbol
1660 name per line. Line comments may be introduced by the hash character.
1661 This option may be given more than once.
1663 @item --alt-machine-code=@var{index}
1664 If the output architecture has alternate machine codes, use the
1665 @var{index}th code instead of the default one. This is useful in case
1666 a machine is assigned an official code and the tool-chain adopts the
1667 new code, but other applications still depend on the original code
1668 being used. For ELF based architectures if the @var{index}
1669 alternative does not exist then the value is treated as an absolute
1670 number to be stored in the e_machine field of the ELF header.
1672 @item --writable-text
1673 Mark the output text as writable. This option isn't meaningful for all
1674 object file formats.
1676 @item --readonly-text
1677 Make the output text write protected. This option isn't meaningful for all
1678 object file formats.
1681 Mark the output file as demand paged. This option isn't meaningful for all
1682 object file formats.
1685 Mark the output file as impure. This option isn't meaningful for all
1686 object file formats.
1688 @item --prefix-symbols=@var{string}
1689 Prefix all symbols in the output file with @var{string}.
1691 @item --prefix-sections=@var{string}
1692 Prefix all section names in the output file with @var{string}.
1694 @item --prefix-alloc-sections=@var{string}
1695 Prefix all the names of all allocated sections in the output file with
1698 @item --add-gnu-debuglink=@var{path-to-file}
1699 Creates a .gnu_debuglink section which contains a reference to
1700 @var{path-to-file} and adds it to the output file. Note: the file at
1701 @var{path-to-file} must exist. Part of the process of adding the
1702 .gnu_debuglink section involves embedding a checksum of the contents
1703 of the debug info file into the section.
1705 If the debug info file is built in one location but it is going to be
1706 installed at a later time into a different location then do not use
1707 the path to the installed location. The @option{--add-gnu-debuglink}
1708 option will fail because the installed file does not exist yet.
1709 Instead put the debug info file in the current directory and use the
1710 @option{--add-gnu-debuglink} option without any directory components,
1714 objcopy --add-gnu-debuglink=foo.debug
1717 At debug time the debugger will attempt to look for the separate debug
1718 info file in a set of known locations. The exact set of these
1719 locations varies depending upon the distribution being used, but it
1724 @item * The same directory as the executable.
1726 @item * A sub-directory of the directory containing the executable
1729 @item * A global debug directory such as /usr/lib/debug.
1732 As long as the debug info file has been installed into one of these
1733 locations before the debugger is run everything should work
1736 @item --keep-file-symbols
1737 When stripping a file, perhaps with @option{--strip-debug} or
1738 @option{--strip-unneeded}, retain any symbols specifying source file names,
1739 which would otherwise get stripped.
1741 @item --only-keep-debug
1742 Strip a file, removing contents of any sections that would not be
1743 stripped by @option{--strip-debug} and leaving the debugging sections
1744 intact. In ELF files, this preserves all note sections in the output.
1746 Note - the section headers of the stripped sections are preserved,
1747 including their sizes, but the contents of the section are discarded.
1748 The section headers are preserved so that other tools can match up the
1749 debuginfo file with the real executable, even if that executable has
1750 been relocated to a different address space.
1752 The intention is that this option will be used in conjunction with
1753 @option{--add-gnu-debuglink} to create a two part executable. One a
1754 stripped binary which will occupy less space in RAM and in a
1755 distribution and the second a debugging information file which is only
1756 needed if debugging abilities are required. The suggested procedure
1757 to create these files is as follows:
1760 @item Link the executable as normal. Assuming that is is called
1762 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1763 create a file containing the debugging info.
1764 @item Run @code{objcopy --strip-debug foo} to create a
1765 stripped executable.
1766 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1767 to add a link to the debugging info into the stripped executable.
1770 Note---the choice of @code{.dbg} as an extension for the debug info
1771 file is arbitrary. Also the @code{--only-keep-debug} step is
1772 optional. You could instead do this:
1775 @item Link the executable as normal.
1776 @item Copy @code{foo} to @code{foo.full}
1777 @item Run @code{objcopy --strip-debug foo}
1778 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1781 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1782 full executable. It does not have to be a file created by the
1783 @option{--only-keep-debug} switch.
1785 Note---this switch is only intended for use on fully linked files. It
1786 does not make sense to use it on object files where the debugging
1787 information may be incomplete. Besides the gnu_debuglink feature
1788 currently only supports the presence of one filename containing
1789 debugging information, not multiple filenames on a one-per-object-file
1793 Remove the contents of all DWARF .dwo sections, leaving the
1794 remaining debugging sections and all symbols intact.
1795 This option is intended for use by the compiler as part of
1796 the @option{-gsplit-dwarf} option, which splits debug information
1797 between the .o file and a separate .dwo file. The compiler
1798 generates all debug information in the same file, then uses
1799 the @option{--extract-dwo} option to copy the .dwo sections to
1800 the .dwo file, then the @option{--strip-dwo} option to remove
1801 those sections from the original .o file.
1804 Extract the contents of all DWARF .dwo sections. See the
1805 @option{--strip-dwo} option for more information.
1807 @item --file-alignment @var{num}
1808 Specify the file alignment. Sections in the file will always begin at
1809 file offsets which are multiples of this number. This defaults to
1811 [This option is specific to PE targets.]
1813 @item --heap @var{reserve}
1814 @itemx --heap @var{reserve},@var{commit}
1815 Specify the number of bytes of memory to reserve (and optionally commit)
1816 to be used as heap for this program.
1817 [This option is specific to PE targets.]
1819 @item --image-base @var{value}
1820 Use @var{value} as the base address of your program or dll. This is
1821 the lowest memory location that will be used when your program or dll
1822 is loaded. To reduce the need to relocate and improve performance of
1823 your dlls, each should have a unique base address and not overlap any
1824 other dlls. The default is 0x400000 for executables, and 0x10000000
1826 [This option is specific to PE targets.]
1828 @item --section-alignment @var{num}
1829 Sets the section alignment. Sections in memory will always begin at
1830 addresses which are a multiple of this number. Defaults to 0x1000.
1831 [This option is specific to PE targets.]
1833 @item --stack @var{reserve}
1834 @itemx --stack @var{reserve},@var{commit}
1835 Specify the number of bytes of memory to reserve (and optionally commit)
1836 to be used as stack for this program.
1837 [This option is specific to PE targets.]
1839 @item --subsystem @var{which}
1840 @itemx --subsystem @var{which}:@var{major}
1841 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1842 Specifies the subsystem under which your program will execute. The
1843 legal values for @var{which} are @code{native}, @code{windows},
1844 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1845 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1846 the subsystem version also. Numeric values are also accepted for
1848 [This option is specific to PE targets.]
1850 @item --extract-symbol
1851 Keep the file's section flags and symbols but remove all section data.
1852 Specifically, the option:
1855 @item removes the contents of all sections;
1856 @item sets the size of every section to zero; and
1857 @item sets the file's start address to zero.
1860 This option is used to build a @file{.sym} file for a VxWorks kernel.
1861 It can also be a useful way of reducing the size of a @option{--just-symbols}
1864 @item --compress-debug-sections
1865 Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
1866 ELF ABI. Note - if compression would actually make a section
1867 @emph{larger}, then it is not compressed.
1869 @item --compress-debug-sections=none
1870 @itemx --compress-debug-sections=zlib
1871 @itemx --compress-debug-sections=zlib-gnu
1872 @itemx --compress-debug-sections=zlib-gabi
1873 For ELF files, these options control how DWARF debug sections are
1874 compressed. @option{--compress-debug-sections=none} is equivalent
1875 to @option{--decompress-debug-sections}.
1876 @option{--compress-debug-sections=zlib} and
1877 @option{--compress-debug-sections=zlib-gabi} are equivalent to
1878 @option{--compress-debug-sections}.
1879 @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug
1880 sections using zlib. The debug sections are renamed to begin with
1881 @samp{.zdebug} instead of @samp{.debug}. Note - if compression would
1882 actually make a section @emph{larger}, then it is not compressed nor
1885 @item --decompress-debug-sections
1886 Decompress DWARF debug sections using zlib. The original section
1887 names of the compressed sections are restored.
1891 Show the version number of @command{objcopy}.
1895 Verbose output: list all object files modified. In the case of
1896 archives, @samp{objcopy -V} lists all members of the archive.
1899 Show a summary of the options to @command{objcopy}.
1902 Display a list showing all architectures and object formats available.
1908 @c man begin SEEALSO objcopy
1909 ld(1), objdump(1), and the Info entries for @file{binutils}.
1916 @cindex object file information
1919 @c man title objdump display information from object files.
1922 @c man begin SYNOPSIS objdump
1923 objdump [@option{-a}|@option{--archive-headers}]
1924 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1925 [@option{-C}|@option{--demangle}[=@var{style}] ]
1926 [@option{-d}|@option{--disassemble}]
1927 [@option{-D}|@option{--disassemble-all}]
1928 [@option{-z}|@option{--disassemble-zeroes}]
1929 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1930 [@option{-f}|@option{--file-headers}]
1931 [@option{-F}|@option{--file-offsets}]
1932 [@option{--file-start-context}]
1933 [@option{-g}|@option{--debugging}]
1934 [@option{-e}|@option{--debugging-tags}]
1935 [@option{-h}|@option{--section-headers}|@option{--headers}]
1936 [@option{-i}|@option{--info}]
1937 [@option{-j} @var{section}|@option{--section=}@var{section}]
1938 [@option{-l}|@option{--line-numbers}]
1939 [@option{-S}|@option{--source}]
1940 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1941 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1942 [@option{-p}|@option{--private-headers}]
1943 [@option{-P} @var{options}|@option{--private=}@var{options}]
1944 [@option{-r}|@option{--reloc}]
1945 [@option{-R}|@option{--dynamic-reloc}]
1946 [@option{-s}|@option{--full-contents}]
1947 [@option{-W[lLiaprmfFsoRt]}|
1948 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames]
1949 [=aranges,=macro,=frames,=frames-interp,=str,=loc]
1950 [=Ranges,=pubtypes,=trace_info,=trace_abbrev]
1951 [=trace_aranges,=gdb_index]
1952 [@option{-G}|@option{--stabs}]
1953 [@option{-t}|@option{--syms}]
1954 [@option{-T}|@option{--dynamic-syms}]
1955 [@option{-x}|@option{--all-headers}]
1956 [@option{-w}|@option{--wide}]
1957 [@option{--start-address=}@var{address}]
1958 [@option{--stop-address=}@var{address}]
1959 [@option{--prefix-addresses}]
1960 [@option{--[no-]show-raw-insn}]
1961 [@option{--adjust-vma=}@var{offset}]
1962 [@option{--special-syms}]
1963 [@option{--prefix=}@var{prefix}]
1964 [@option{--prefix-strip=}@var{level}]
1965 [@option{--insn-width=}@var{width}]
1966 [@option{-V}|@option{--version}]
1967 [@option{-H}|@option{--help}]
1968 @var{objfile}@dots{}
1972 @c man begin DESCRIPTION objdump
1974 @command{objdump} displays information about one or more object files.
1975 The options control what particular information to display. This
1976 information is mostly useful to programmers who are working on the
1977 compilation tools, as opposed to programmers who just want their
1978 program to compile and work.
1980 @var{objfile}@dots{} are the object files to be examined. When you
1981 specify archives, @command{objdump} shows information on each of the member
1986 @c man begin OPTIONS objdump
1988 The long and short forms of options, shown here as alternatives, are
1989 equivalent. At least one option from the list
1990 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1994 @itemx --archive-header
1995 @cindex archive headers
1996 If any of the @var{objfile} files are archives, display the archive
1997 header information (in a format similar to @samp{ls -l}). Besides the
1998 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1999 the object file format of each archive member.
2001 @item --adjust-vma=@var{offset}
2002 @cindex section addresses in objdump
2003 @cindex VMA in objdump
2004 When dumping information, first add @var{offset} to all the section
2005 addresses. This is useful if the section addresses do not correspond to
2006 the symbol table, which can happen when putting sections at particular
2007 addresses when using a format which can not represent section addresses,
2010 @item -b @var{bfdname}
2011 @itemx --target=@var{bfdname}
2012 @cindex object code format
2013 Specify that the object-code format for the object files is
2014 @var{bfdname}. This option may not be necessary; @var{objdump} can
2015 automatically recognize many formats.
2019 objdump -b oasys -m vax -h fu.o
2022 displays summary information from the section headers (@option{-h}) of
2023 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
2024 file in the format produced by Oasys compilers. You can list the
2025 formats available with the @option{-i} option.
2026 @xref{Target Selection}, for more information.
2029 @itemx --demangle[=@var{style}]
2030 @cindex demangling in objdump
2031 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2032 Besides removing any initial underscore prepended by the system, this
2033 makes C++ function names readable. Different compilers have different
2034 mangling styles. The optional demangling style argument can be used to
2035 choose an appropriate demangling style for your compiler. @xref{c++filt},
2036 for more information on demangling.
2040 Display debugging information. This attempts to parse STABS and IEEE
2041 debugging format information stored in the file and print it out using
2042 a C like syntax. If neither of these formats are found this option
2043 falls back on the @option{-W} option to print any DWARF information in
2047 @itemx --debugging-tags
2048 Like @option{-g}, but the information is generated in a format compatible
2052 @itemx --disassemble
2053 @cindex disassembling object code
2054 @cindex machine instructions
2055 Display the assembler mnemonics for the machine instructions from
2056 @var{objfile}. This option only disassembles those sections which are
2057 expected to contain instructions.
2060 @itemx --disassemble-all
2061 Like @option{-d}, but disassemble the contents of all sections, not just
2062 those expected to contain instructions.
2064 This option also has a subtle effect on the disassembly of
2065 instructions in code sections. When option @option{-d} is in effect
2066 objdump will assume that any symbols present in a code section occur
2067 on the boundary between instructions and it will refuse to disassemble
2068 across such a boundary. When option @option{-D} is in effect however
2069 this assumption is supressed. This means that it is possible for the
2070 output of @option{-d} and @option{-D} to differ if, for example, data
2071 is stored in code sections.
2073 If the target is an ARM architecture this switch also has the effect
2074 of forcing the disassembler to decode pieces of data found in code
2075 sections as if they were instructions.
2077 @item --prefix-addresses
2078 When disassembling, print the complete address on each line. This is
2079 the older disassembly format.
2083 @itemx --endian=@{big|little@}
2085 @cindex disassembly endianness
2086 Specify the endianness of the object files. This only affects
2087 disassembly. This can be useful when disassembling a file format which
2088 does not describe endianness information, such as S-records.
2091 @itemx --file-headers
2092 @cindex object file header
2093 Display summary information from the overall header of
2094 each of the @var{objfile} files.
2097 @itemx --file-offsets
2098 @cindex object file offsets
2099 When disassembling sections, whenever a symbol is displayed, also
2100 display the file offset of the region of data that is about to be
2101 dumped. If zeroes are being skipped, then when disassembly resumes,
2102 tell the user how many zeroes were skipped and the file offset of the
2103 location from where the disassembly resumes. When dumping sections,
2104 display the file offset of the location from where the dump starts.
2106 @item --file-start-context
2107 @cindex source code context
2108 Specify that when displaying interlisted source code/disassembly
2109 (assumes @option{-S}) from a file that has not yet been displayed, extend the
2110 context to the start of the file.
2113 @itemx --section-headers
2115 @cindex section headers
2116 Display summary information from the section headers of the
2119 File segments may be relocated to nonstandard addresses, for example by
2120 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2121 @command{ld}. However, some object file formats, such as a.out, do not
2122 store the starting address of the file segments. In those situations,
2123 although @command{ld} relocates the sections correctly, using @samp{objdump
2124 -h} to list the file section headers cannot show the correct addresses.
2125 Instead, it shows the usual addresses, which are implicit for the
2128 Note, in some cases it is possible for a section to have both the
2129 READONLY and the NOREAD attributes set. In such cases the NOREAD
2130 attribute takes precedence, but @command{objdump} will report both
2131 since the exact setting of the flag bits might be important.
2135 Print a summary of the options to @command{objdump} and exit.
2139 @cindex architectures available
2140 @cindex object formats available
2141 Display a list showing all architectures and object formats available
2142 for specification with @option{-b} or @option{-m}.
2145 @itemx --section=@var{name}
2146 @cindex section information
2147 Display information only for section @var{name}.
2150 @itemx --line-numbers
2151 @cindex source filenames for object files
2152 Label the display (using debugging information) with the filename and
2153 source line numbers corresponding to the object code or relocs shown.
2154 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2156 @item -m @var{machine}
2157 @itemx --architecture=@var{machine}
2158 @cindex architecture
2159 @cindex disassembly architecture
2160 Specify the architecture to use when disassembling object files. This
2161 can be useful when disassembling object files which do not describe
2162 architecture information, such as S-records. You can list the available
2163 architectures with the @option{-i} option.
2165 If the target is an ARM architecture then this switch has an
2166 additional effect. It restricts the disassembly to only those
2167 instructions supported by the architecture specified by @var{machine}.
2168 If it is necessary to use this switch because the input file does not
2169 contain any architecture information, but it is also desired to
2170 disassemble all the instructions use @option{-marm}.
2172 @item -M @var{options}
2173 @itemx --disassembler-options=@var{options}
2174 Pass target specific information to the disassembler. Only supported on
2175 some targets. If it is necessary to specify more than one
2176 disassembler option then multiple @option{-M} options can be used or
2177 can be placed together into a comma separated list.
2179 If the target is an ARM architecture then this switch can be used to
2180 select which register name set is used during disassembler. Specifying
2181 @option{-M reg-names-std} (the default) will select the register names as
2182 used in ARM's instruction set documentation, but with register 13 called
2183 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2184 @option{-M reg-names-apcs} will select the name set used by the ARM
2185 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2186 just use @samp{r} followed by the register number.
2188 There are also two variants on the APCS register naming scheme enabled
2189 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2190 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2191 with the normal register names or the special register names).
2193 This option can also be used for ARM architectures to force the
2194 disassembler to interpret all instructions as Thumb instructions by
2195 using the switch @option{--disassembler-options=force-thumb}. This can be
2196 useful when attempting to disassemble thumb code produced by other
2199 For the x86, some of the options duplicate functions of the @option{-m}
2200 switch, but allow finer grained control. Multiple selections from the
2201 following may be specified as a comma separated string.
2206 Select disassembly for the given architecture.
2210 Select between intel syntax mode and AT&T syntax mode.
2214 Select between AMD64 ISA and Intel64 ISA.
2216 @item intel-mnemonic
2218 Select between intel mnemonic mode and AT&T mnemonic mode.
2219 Note: @code{intel-mnemonic} implies @code{intel} and
2220 @code{att-mnemonic} implies @code{att}.
2227 Specify the default address size and operand size. These four options
2228 will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2229 appear later in the option string.
2232 When in AT&T mode, instructs the disassembler to print a mnemonic
2233 suffix even when the suffix could be inferred by the operands.
2236 For PowerPC, @option{booke} controls the disassembly of BookE
2237 instructions. @option{32} and @option{64} select PowerPC and
2238 PowerPC64 disassembly, respectively. @option{e300} selects
2239 disassembly for the e300 family. @option{440} selects disassembly for
2240 the PowerPC 440. @option{ppcps} selects disassembly for the paired
2241 single instructions of the PPC750CL.
2243 For MIPS, this option controls the printing of instruction mnemonic
2244 names and register names in disassembled instructions. Multiple
2245 selections from the following may be specified as a comma separated
2246 string, and invalid options are ignored:
2250 Print the 'raw' instruction mnemonic instead of some pseudo
2251 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2252 'sll' instead of 'nop', etc.
2255 Disassemble MSA instructions.
2258 Disassemble the virtualization ASE instructions.
2261 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2263 @item gpr-names=@var{ABI}
2264 Print GPR (general-purpose register) names as appropriate
2265 for the specified ABI. By default, GPR names are selected according to
2266 the ABI of the binary being disassembled.
2268 @item fpr-names=@var{ABI}
2269 Print FPR (floating-point register) names as
2270 appropriate for the specified ABI. By default, FPR numbers are printed
2273 @item cp0-names=@var{ARCH}
2274 Print CP0 (system control coprocessor; coprocessor 0) register names
2275 as appropriate for the CPU or architecture specified by
2276 @var{ARCH}. By default, CP0 register names are selected according to
2277 the architecture and CPU of the binary being disassembled.
2279 @item hwr-names=@var{ARCH}
2280 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2281 as appropriate for the CPU or architecture specified by
2282 @var{ARCH}. By default, HWR names are selected according to
2283 the architecture and CPU of the binary being disassembled.
2285 @item reg-names=@var{ABI}
2286 Print GPR and FPR names as appropriate for the selected ABI.
2288 @item reg-names=@var{ARCH}
2289 Print CPU-specific register names (CP0 register and HWR names)
2290 as appropriate for the selected CPU or architecture.
2293 For any of the options listed above, @var{ABI} or
2294 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2295 rather than names, for the selected types of registers.
2296 You can list the available values of @var{ABI} and @var{ARCH} using
2297 the @option{--help} option.
2299 For VAX, you can specify function entry addresses with @option{-M
2300 entry:0xf00ba}. You can use this multiple times to properly
2301 disassemble VAX binary files that don't contain symbol tables (like
2302 ROM dumps). In these cases, the function entry mask would otherwise
2303 be decoded as VAX instructions, which would probably lead the rest
2304 of the function being wrongly disassembled.
2307 @itemx --private-headers
2308 Print information that is specific to the object file format. The exact
2309 information printed depends upon the object file format. For some
2310 object file formats, no additional information is printed.
2312 @item -P @var{options}
2313 @itemx --private=@var{options}
2314 Print information that is specific to the object file format. The
2315 argument @var{options} is a comma separated list that depends on the
2316 format (the lists of options is displayed with the help).
2318 For XCOFF, the available options are:
2334 Not all object formats support this option. In particular the ELF
2335 format does not use it.
2339 @cindex relocation entries, in object file
2340 Print the relocation entries of the file. If used with @option{-d} or
2341 @option{-D}, the relocations are printed interspersed with the
2345 @itemx --dynamic-reloc
2346 @cindex dynamic relocation entries, in object file
2347 Print the dynamic relocation entries of the file. This is only
2348 meaningful for dynamic objects, such as certain types of shared
2349 libraries. As for @option{-r}, if used with @option{-d} or
2350 @option{-D}, the relocations are printed interspersed with the
2354 @itemx --full-contents
2355 @cindex sections, full contents
2356 @cindex object file sections
2357 Display the full contents of any sections requested. By default all
2358 non-empty sections are displayed.
2362 @cindex source disassembly
2363 @cindex disassembly, with source
2364 Display source code intermixed with disassembly, if possible. Implies
2367 @item --prefix=@var{prefix}
2368 @cindex Add prefix to absolute paths
2369 Specify @var{prefix} to add to the absolute paths when used with
2372 @item --prefix-strip=@var{level}
2373 @cindex Strip absolute paths
2374 Indicate how many initial directory names to strip off the hardwired
2375 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2377 @item --show-raw-insn
2378 When disassembling instructions, print the instruction in hex as well as
2379 in symbolic form. This is the default except when
2380 @option{--prefix-addresses} is used.
2382 @item --no-show-raw-insn
2383 When disassembling instructions, do not print the instruction bytes.
2384 This is the default when @option{--prefix-addresses} is used.
2386 @item --insn-width=@var{width}
2387 @cindex Instruction width
2388 Display @var{width} bytes on a single line when disassembling
2391 @item -W[lLiaprmfFsoRt]
2392 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames]
2393 @itemx --dwarf[=aranges,=macro,=frames,=frames-interp,=str,=loc]
2394 @itemx --dwarf[=Ranges,=pubtypes,=trace_info,=trace_abbrev]
2395 @itemx --dwarf[=trace_aranges,=gdb_index]
2397 @cindex debug symbols
2398 Displays the contents of the debug sections in the file, if any are
2399 present. If one of the optional letters or words follows the switch
2400 then only data found in those specific sections will be dumped.
2402 Note that there is no single letter option to display the content of
2403 trace sections or .gdb_index.
2405 Note: the output from the @option{=info} option can also be affected
2406 by the options @option{--dwarf-depth}, the @option{--dwarf-start} and
2407 the @option{--dwarf-check}.
2409 @item --dwarf-depth=@var{n}
2410 Limit the dump of the @code{.debug_info} section to @var{n} children.
2411 This is only useful with @option{--dwarf=info}. The default is
2412 to print all DIEs; the special value 0 for @var{n} will also have this
2415 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
2416 levels will not be printed. The range for @var{n} is zero-based.
2418 @item --dwarf-start=@var{n}
2419 Print only DIEs beginning with the DIE numbered @var{n}. This is only
2420 useful with @option{--dwarf=info}.
2422 If specified, this option will suppress printing of any header
2423 information and all DIEs before the DIE numbered @var{n}. Only
2424 siblings and children of the specified DIE will be printed.
2426 This can be used in conjunction with @option{--dwarf-depth}.
2429 Enable additional checks for consistency of Dwarf information.
2435 @cindex debug symbols
2436 @cindex ELF object file format
2437 Display the full contents of any sections requested. Display the
2438 contents of the .stab and .stab.index and .stab.excl sections from an
2439 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2440 @code{.stab} debugging symbol-table entries are carried in an ELF
2441 section. In most other file formats, debugging symbol-table entries are
2442 interleaved with linkage symbols, and are visible in the @option{--syms}
2445 @item --start-address=@var{address}
2446 @cindex start-address
2447 Start displaying data at the specified address. This affects the output
2448 of the @option{-d}, @option{-r} and @option{-s} options.
2450 @item --stop-address=@var{address}
2451 @cindex stop-address
2452 Stop displaying data at the specified address. This affects the output
2453 of the @option{-d}, @option{-r} and @option{-s} options.
2457 @cindex symbol table entries, printing
2458 Print the symbol table entries of the file.
2459 This is similar to the information provided by the @samp{nm} program,
2460 although the display format is different. The format of the output
2461 depends upon the format of the file being dumped, but there are two main
2462 types. One looks like this:
2465 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2466 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2469 where the number inside the square brackets is the number of the entry
2470 in the symbol table, the @var{sec} number is the section number, the
2471 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2472 symbol's type, the @var{scl} number is the symbol's storage class and
2473 the @var{nx} value is the number of auxilary entries associated with
2474 the symbol. The last two fields are the symbol's value and its name.
2476 The other common output format, usually seen with ELF based files,
2480 00000000 l d .bss 00000000 .bss
2481 00000000 g .text 00000000 fred
2484 Here the first number is the symbol's value (sometimes refered to as
2485 its address). The next field is actually a set of characters and
2486 spaces indicating the flag bits that are set on the symbol. These
2487 characters are described below. Next is the section with which the
2488 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2489 not connected with any section), or @emph{*UND*} if the section is
2490 referenced in the file being dumped, but not defined there.
2492 After the section name comes another field, a number, which for common
2493 symbols is the alignment and for other symbol is the size. Finally
2494 the symbol's name is displayed.
2496 The flag characters are divided into 7 groups as follows:
2502 The symbol is a local (l), global (g), unique global (u), neither
2503 global nor local (a space) or both global and local (!). A
2504 symbol can be neither local or global for a variety of reasons, e.g.,
2505 because it is used for debugging, but it is probably an indication of
2506 a bug if it is ever both local and global. Unique global symbols are
2507 a GNU extension to the standard set of ELF symbol bindings. For such
2508 a symbol the dynamic linker will make sure that in the entire process
2509 there is just one symbol with this name and type in use.
2512 The symbol is weak (w) or strong (a space).
2515 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2518 The symbol is a warning (W) or a normal symbol (a space). A warning
2519 symbol's name is a message to be displayed if the symbol following the
2520 warning symbol is ever referenced.
2524 The symbol is an indirect reference to another symbol (I), a function
2525 to be evaluated during reloc processing (i) or a normal symbol (a
2530 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2531 normal symbol (a space).
2536 The symbol is the name of a function (F) or a file (f) or an object
2537 (O) or just a normal symbol (a space).
2541 @itemx --dynamic-syms
2542 @cindex dynamic symbol table entries, printing
2543 Print the dynamic symbol table entries of the file. This is only
2544 meaningful for dynamic objects, such as certain types of shared
2545 libraries. This is similar to the information provided by the @samp{nm}
2546 program when given the @option{-D} (@option{--dynamic}) option.
2548 @item --special-syms
2549 When displaying symbols include those which the target considers to be
2550 special in some way and which would not normally be of interest to the
2555 Print the version number of @command{objdump} and exit.
2558 @itemx --all-headers
2559 @cindex all header information, object file
2560 @cindex header information, all
2561 Display all available header information, including the symbol table and
2562 relocation entries. Using @option{-x} is equivalent to specifying all of
2563 @option{-a -f -h -p -r -t}.
2567 @cindex wide output, printing
2568 Format some lines for output devices that have more than 80 columns.
2569 Also do not truncate symbol names when they are displayed.
2572 @itemx --disassemble-zeroes
2573 Normally the disassembly output will skip blocks of zeroes. This
2574 option directs the disassembler to disassemble those blocks, just like
2581 @c man begin SEEALSO objdump
2582 nm(1), readelf(1), and the Info entries for @file{binutils}.
2590 @cindex archive contents
2591 @cindex symbol index
2593 @c man title ranlib generate index to archive.
2596 @c man begin SYNOPSIS ranlib
2597 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2601 @c man begin DESCRIPTION ranlib
2603 @command{ranlib} generates an index to the contents of an archive and
2604 stores it in the archive. The index lists each symbol defined by a
2605 member of an archive that is a relocatable object file.
2607 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2609 An archive with such an index speeds up linking to the library and
2610 allows routines in the library to call each other without regard to
2611 their placement in the archive.
2613 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2614 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2619 @c man begin OPTIONS ranlib
2625 Show usage information for @command{ranlib}.
2630 Show the version number of @command{ranlib}.
2633 @cindex deterministic archives
2634 @kindex --enable-deterministic-archives
2635 Operate in @emph{deterministic} mode. The symbol map archive member's
2636 header will show zero for the UID, GID, and timestamp. When this
2637 option is used, multiple runs will produce identical output files.
2639 If @file{binutils} was configured with
2640 @option{--enable-deterministic-archives}, then this mode is on by
2641 default. It can be disabled with the @samp{-U} option, described
2645 Update the timestamp of the symbol map of an archive.
2648 @cindex deterministic archives
2649 @kindex --enable-deterministic-archives
2650 Do @emph{not} operate in @emph{deterministic} mode. This is the
2651 inverse of the @samp{-D} option, above: the archive index will get
2652 actual UID, GID, timestamp, and file mode values.
2654 If @file{binutils} was configured @emph{without}
2655 @option{--enable-deterministic-archives}, then this mode is on by
2663 @c man begin SEEALSO ranlib
2664 ar(1), nm(1), and the Info entries for @file{binutils}.
2672 @cindex section sizes
2674 @c man title size list section sizes and total size.
2677 @c man begin SYNOPSIS size
2678 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2680 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2682 [@option{-t}|@option{--totals}]
2683 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2684 [@var{objfile}@dots{}]
2688 @c man begin DESCRIPTION size
2690 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2691 size---for each of the object or archive files @var{objfile} in its
2692 argument list. By default, one line of output is generated for each
2693 object file or each module in an archive.
2695 @var{objfile}@dots{} are the object files to be examined.
2696 If none are specified, the file @code{a.out} will be used.
2700 @c man begin OPTIONS size
2702 The command line options have the following meanings:
2707 @itemx --format=@var{compatibility}
2708 @cindex @command{size} display format
2709 Using one of these options, you can choose whether the output from @sc{gnu}
2710 @command{size} resembles output from System V @command{size} (using @option{-A},
2711 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2712 @option{--format=berkeley}). The default is the one-line format similar to
2714 @c Bonus for doc-source readers: you can also say --format=strange (or
2715 @c anything else that starts with 's') for sysv, and --format=boring (or
2716 @c anything else that starts with 'b') for Berkeley.
2718 Here is an example of the Berkeley (default) format of output from
2721 $ size --format=Berkeley ranlib size
2722 text data bss dec hex filename
2723 294880 81920 11592 388392 5ed28 ranlib
2724 294880 81920 11888 388688 5ee50 size
2728 This is the same data, but displayed closer to System V conventions:
2731 $ size --format=SysV ranlib size
2749 Show a summary of acceptable arguments and options.
2754 @itemx --radix=@var{number}
2755 @cindex @command{size} number format
2756 @cindex radix for section sizes
2757 Using one of these options, you can control whether the size of each
2758 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2759 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2760 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2761 values (8, 10, 16) are supported. The total size is always given in two
2762 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2763 octal and hexadecimal if you're using @option{-o}.
2766 Print total size of common symbols in each file. When using Berkeley
2767 format these are included in the bss size.
2771 Show totals of all objects listed (Berkeley format listing mode only).
2773 @item --target=@var{bfdname}
2774 @cindex object code format
2775 Specify that the object-code format for @var{objfile} is
2776 @var{bfdname}. This option may not be necessary; @command{size} can
2777 automatically recognize many formats.
2778 @xref{Target Selection}, for more information.
2782 Display the version number of @command{size}.
2788 @c man begin SEEALSO size
2789 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2796 @cindex listings strings
2797 @cindex printing strings
2798 @cindex strings, printing
2800 @c man title strings print the strings of printable characters in files.
2803 @c man begin SYNOPSIS strings
2804 strings [@option{-afovV}] [@option{-}@var{min-len}]
2805 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2806 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2807 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2808 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2809 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2810 [@option{-w}] [@option{--include-all-whitespace}]
2811 [@option{-s}] [@option{--output-separator}@var{sep_string}]
2812 [@option{--help}] [@option{--version}] @var{file}@dots{}
2816 @c man begin DESCRIPTION strings
2818 For each @var{file} given, @sc{gnu} @command{strings} prints the
2819 printable character sequences that are at least 4 characters long (or
2820 the number given with the options below) and are followed by an
2821 unprintable character.
2823 Depending upon how the strings program was configured it will default
2824 to either displaying all the printable sequences that it can find in
2825 each file, or only those sequences that are in loadable, initialized
2826 data sections. If the file type in unrecognizable, or if strings is
2827 reading from stdin then it will always display all of the printable
2828 sequences that it can find.
2830 For backwards compatibility any file that occurs after a command line
2831 option of just @option{-} will also be scanned in full, regardless of
2832 the presence of any @option{-d} option.
2834 @command{strings} is mainly useful for determining the contents of
2839 @c man begin OPTIONS strings
2845 Scan the whole file, regardless of what sections it contains or
2846 whether those sections are loaded or initialized. Normally this is
2847 the default behaviour, but strings can be configured so that the
2848 @option{-d} is the default instead.
2850 The @option{-} option is position dependent and forces strings to
2851 perform full scans of any file that is mentioned after the @option{-}
2852 on the command line, even if the @option{-d} option has been
2857 Only print strings from initialized, loaded data sections in the
2858 file. This may reduce the amount of garbage in the output, but it
2859 also exposes the strings program to any security flaws that may be
2860 present in the BFD library used to scan and load sections. Strings
2861 can be configured so that this option is the default behaviour. In
2862 such cases the @option{-a} option can be used to avoid using the BFD
2863 library and instead just print all of the strings found in the file.
2866 @itemx --print-file-name
2867 Print the name of the file before each string.
2870 Print a summary of the program usage on the standard output and exit.
2872 @item -@var{min-len}
2873 @itemx -n @var{min-len}
2874 @itemx --bytes=@var{min-len}
2875 Print sequences of characters that are at least @var{min-len} characters
2876 long, instead of the default 4.
2879 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2880 act like @samp{-t d} instead. Since we can not be compatible with both
2881 ways, we simply chose one.
2883 @item -t @var{radix}
2884 @itemx --radix=@var{radix}
2885 Print the offset within the file before each string. The single
2886 character argument specifies the radix of the offset---@samp{o} for
2887 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2889 @item -e @var{encoding}
2890 @itemx --encoding=@var{encoding}
2891 Select the character encoding of the strings that are to be found.
2892 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2893 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2894 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2895 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2896 littleendian. Useful for finding wide character strings. (@samp{l}
2897 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2899 @item -T @var{bfdname}
2900 @itemx --target=@var{bfdname}
2901 @cindex object code format
2902 Specify an object code format other than your system's default format.
2903 @xref{Target Selection}, for more information.
2908 Print the program version number on the standard output and exit.
2911 @itemx --include-all-whitespace
2912 By default tab and space characters are included in the strings that
2913 are displayed, but other whitespace characters, such a newlines and
2914 carriage returns, are not. The @option{-w} option changes this so
2915 that all whitespace characters are considered to be part of a string.
2918 @itemx --output-separator
2919 By default, output strings are delimited by a new-line. This option
2920 allows you to supply any string to be used as the output record
2921 separator. Useful with --include-all-whitespace where strings
2922 may contain new-lines internally.
2928 @c man begin SEEALSO strings
2929 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2930 and the Info entries for @file{binutils}.
2938 @cindex removing symbols
2939 @cindex discarding symbols
2940 @cindex symbols, discarding
2942 @c man title strip Discard symbols from object files.
2945 @c man begin SYNOPSIS strip
2946 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2947 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2948 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2949 [@option{-s}|@option{--strip-all}]
2950 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2951 [@option{--strip-dwo}]
2952 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2953 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2954 [@option{-w}|@option{--wildcard}]
2955 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2956 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2957 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2958 [@option{-D}|@option{--enable-deterministic-archives}]
2959 [@option{-U}|@option{--disable-deterministic-archives}]
2960 [@option{--keep-file-symbols}]
2961 [@option{--only-keep-debug}]
2962 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2963 [@option{--help}] [@option{--info}]
2964 @var{objfile}@dots{}
2968 @c man begin DESCRIPTION strip
2970 @sc{gnu} @command{strip} discards all symbols from object files
2971 @var{objfile}. The list of object files may include archives.
2972 At least one object file must be given.
2974 @command{strip} modifies the files named in its argument,
2975 rather than writing modified copies under different names.
2979 @c man begin OPTIONS strip
2982 @item -F @var{bfdname}
2983 @itemx --target=@var{bfdname}
2984 Treat the original @var{objfile} as a file with the object
2985 code format @var{bfdname}, and rewrite it in the same format.
2986 @xref{Target Selection}, for more information.
2989 Show a summary of the options to @command{strip} and exit.
2992 Display a list showing all architectures and object formats available.
2994 @item -I @var{bfdname}
2995 @itemx --input-target=@var{bfdname}
2996 Treat the original @var{objfile} as a file with the object
2997 code format @var{bfdname}.
2998 @xref{Target Selection}, for more information.
3000 @item -O @var{bfdname}
3001 @itemx --output-target=@var{bfdname}
3002 Replace @var{objfile} with a file in the output format @var{bfdname}.
3003 @xref{Target Selection}, for more information.
3005 @item -R @var{sectionname}
3006 @itemx --remove-section=@var{sectionname}
3007 Remove any section named @var{sectionname} from the output file, in
3008 addition to whatever sections would otherwise be removed. This
3009 option may be given more than once. Note that using this option
3010 inappropriately may make the output file unusable. The wildcard
3011 character @samp{*} may be given at the end of @var{sectionname}. If
3012 so, then any section starting with @var{sectionname} will be removed.
3021 @itemx --strip-debug
3022 Remove debugging symbols only.
3025 Remove the contents of all DWARF .dwo sections, leaving the
3026 remaining debugging sections and all symbols intact.
3027 See the description of this option in the @command{objcopy} section
3028 for more information.
3030 @item --strip-unneeded
3031 Remove all symbols that are not needed for relocation processing.
3033 @item -K @var{symbolname}
3034 @itemx --keep-symbol=@var{symbolname}
3035 When stripping symbols, keep symbol @var{symbolname} even if it would
3036 normally be stripped. This option may be given more than once.
3038 @item -N @var{symbolname}
3039 @itemx --strip-symbol=@var{symbolname}
3040 Remove symbol @var{symbolname} from the source file. This option may be
3041 given more than once, and may be combined with strip options other than
3045 Put the stripped output in @var{file}, rather than replacing the
3046 existing file. When this argument is used, only one @var{objfile}
3047 argument may be specified.
3050 @itemx --preserve-dates
3051 Preserve the access and modification dates of the file.
3054 @itemx --enable-deterministic-archives
3055 @cindex deterministic archives
3056 @kindex --enable-deterministic-archives
3057 Operate in @emph{deterministic} mode. When copying archive members
3058 and writing the archive index, use zero for UIDs, GIDs, timestamps,
3059 and use consistent file modes for all files.
3061 If @file{binutils} was configured with
3062 @option{--enable-deterministic-archives}, then this mode is on by default.
3063 It can be disabled with the @samp{-U} option, below.
3066 @itemx --disable-deterministic-archives
3067 @cindex deterministic archives
3068 @kindex --enable-deterministic-archives
3069 Do @emph{not} operate in @emph{deterministic} mode. This is the
3070 inverse of the @option{-D} option, above: when copying archive members
3071 and writing the archive index, use their actual UID, GID, timestamp,
3072 and file mode values.
3074 This is the default unless @file{binutils} was configured with
3075 @option{--enable-deterministic-archives}.
3079 Permit regular expressions in @var{symbolname}s used in other command
3080 line options. The question mark (?), asterisk (*), backslash (\) and
3081 square brackets ([]) operators can be used anywhere in the symbol
3082 name. If the first character of the symbol name is the exclamation
3083 point (!) then the sense of the switch is reversed for that symbol.
3090 would cause strip to only keep symbols that start with the letters
3091 ``fo'', but to discard the symbol ``foo''.
3094 @itemx --discard-all
3095 Remove non-global symbols.
3098 @itemx --discard-locals
3099 Remove compiler-generated local symbols.
3100 (These usually start with @samp{L} or @samp{.}.)
3102 @item --keep-file-symbols
3103 When stripping a file, perhaps with @option{--strip-debug} or
3104 @option{--strip-unneeded}, retain any symbols specifying source file names,
3105 which would otherwise get stripped.
3107 @item --only-keep-debug
3108 Strip a file, emptying the contents of any sections that would not be
3109 stripped by @option{--strip-debug} and leaving the debugging sections
3110 intact. In ELF files, this preserves all the note sections in the
3113 Note - the section headers of the stripped sections are preserved,
3114 including their sizes, but the contents of the section are discarded.
3115 The section headers are preserved so that other tools can match up the
3116 debuginfo file with the real executable, even if that executable has
3117 been relocated to a different address space.
3119 The intention is that this option will be used in conjunction with
3120 @option{--add-gnu-debuglink} to create a two part executable. One a
3121 stripped binary which will occupy less space in RAM and in a
3122 distribution and the second a debugging information file which is only
3123 needed if debugging abilities are required. The suggested procedure
3124 to create these files is as follows:
3127 @item Link the executable as normal. Assuming that is is called
3129 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3130 create a file containing the debugging info.
3131 @item Run @code{objcopy --strip-debug foo} to create a
3132 stripped executable.
3133 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3134 to add a link to the debugging info into the stripped executable.
3137 Note---the choice of @code{.dbg} as an extension for the debug info
3138 file is arbitrary. Also the @code{--only-keep-debug} step is
3139 optional. You could instead do this:
3142 @item Link the executable as normal.
3143 @item Copy @code{foo} to @code{foo.full}
3144 @item Run @code{strip --strip-debug foo}
3145 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3148 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
3149 full executable. It does not have to be a file created by the
3150 @option{--only-keep-debug} switch.
3152 Note---this switch is only intended for use on fully linked files. It
3153 does not make sense to use it on object files where the debugging
3154 information may be incomplete. Besides the gnu_debuglink feature
3155 currently only supports the presence of one filename containing
3156 debugging information, not multiple filenames on a one-per-object-file
3161 Show the version number for @command{strip}.
3165 Verbose output: list all object files modified. In the case of
3166 archives, @samp{strip -v} lists all members of the archive.
3172 @c man begin SEEALSO strip
3173 the Info entries for @file{binutils}.
3177 @node c++filt, addr2line, strip, Top
3181 @cindex demangling C++ symbols
3183 @c man title cxxfilt Demangle C++ and Java symbols.
3186 @c man begin SYNOPSIS cxxfilt
3187 c++filt [@option{-_}|@option{--strip-underscore}]
3188 [@option{-n}|@option{--no-strip-underscore}]
3189 [@option{-p}|@option{--no-params}]
3190 [@option{-t}|@option{--types}]
3191 [@option{-i}|@option{--no-verbose}]
3192 [@option{-s} @var{format}|@option{--format=}@var{format}]
3193 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
3197 @c man begin DESCRIPTION cxxfilt
3200 The C++ and Java languages provide function overloading, which means
3201 that you can write many functions with the same name, providing that
3202 each function takes parameters of different types. In order to be
3203 able to distinguish these similarly named functions C++ and Java
3204 encode them into a low-level assembler name which uniquely identifies
3205 each different version. This process is known as @dfn{mangling}. The
3207 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3208 MS-DOS this program is named @command{CXXFILT}.}
3209 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3210 names into user-level names so that they can be read.
3212 Every alphanumeric word (consisting of letters, digits, underscores,
3213 dollars, or periods) seen in the input is a potential mangled name.
3214 If the name decodes into a C++ name, the C++ name replaces the
3215 low-level name in the output, otherwise the original word is output.
3216 In this way you can pass an entire assembler source file, containing
3217 mangled names, through @command{c++filt} and see the same source file
3218 containing demangled names.
3220 You can also use @command{c++filt} to decipher individual symbols by
3221 passing them on the command line:
3224 c++filt @var{symbol}
3227 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3228 names from the standard input instead. All the results are printed on
3229 the standard output. The difference between reading names from the
3230 command line versus reading names from the standard input is that
3231 command line arguments are expected to be just mangled names and no
3232 checking is performed to separate them from surrounding text. Thus
3239 will work and demangle the name to ``f()'' whereas:
3245 will not work. (Note the extra comma at the end of the mangled
3246 name which makes it invalid). This command however will work:
3249 echo _Z1fv, | c++filt -n
3252 and will display ``f(),'', i.e., the demangled name followed by a
3253 trailing comma. This behaviour is because when the names are read
3254 from the standard input it is expected that they might be part of an
3255 assembler source file where there might be extra, extraneous
3256 characters trailing after a mangled name. For example:
3259 .type _Z1fv, @@function
3264 @c man begin OPTIONS cxxfilt
3268 @itemx --strip-underscore
3269 On some systems, both the C and C++ compilers put an underscore in front
3270 of every name. For example, the C name @code{foo} gets the low-level
3271 name @code{_foo}. This option removes the initial underscore. Whether
3272 @command{c++filt} removes the underscore by default is target dependent.
3275 @itemx --no-strip-underscore
3276 Do not remove the initial underscore.
3280 When demangling the name of a function, do not display the types of
3281 the function's parameters.
3285 Attempt to demangle types as well as function names. This is disabled
3286 by default since mangled types are normally only used internally in
3287 the compiler, and they can be confused with non-mangled names. For example,
3288 a function called ``a'' treated as a mangled type name would be
3289 demangled to ``signed char''.
3293 Do not include implementation details (if any) in the demangled
3296 @item -s @var{format}
3297 @itemx --format=@var{format}
3298 @command{c++filt} can decode various methods of mangling, used by
3299 different compilers. The argument to this option selects which
3304 Automatic selection based on executable (the default method)
3306 the one used by the @sc{gnu} C++ compiler (g++)
3308 the one used by the Lucid compiler (lcc)
3310 the one specified by the C++ Annotated Reference Manual
3312 the one used by the HP compiler (aCC)
3314 the one used by the EDG compiler
3316 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3318 the one used by the @sc{gnu} Java compiler (gcj)
3320 the one used by the @sc{gnu} Ada compiler (GNAT).
3324 Print a summary of the options to @command{c++filt} and exit.
3327 Print the version number of @command{c++filt} and exit.
3333 @c man begin SEEALSO cxxfilt
3334 the Info entries for @file{binutils}.
3339 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3340 user interface are subject to change in future releases. In particular,
3341 a command-line option may be required in the future to decode a name
3342 passed as an argument on the command line; in other words,
3345 c++filt @var{symbol}
3349 may in a future release become
3352 c++filt @var{option} @var{symbol}
3360 @cindex address to file name and line number
3362 @c man title addr2line convert addresses into file names and line numbers.
3365 @c man begin SYNOPSIS addr2line
3366 addr2line [@option{-a}|@option{--addresses}]
3367 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3368 [@option{-C}|@option{--demangle}[=@var{style}]]
3369 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3370 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3371 [@option{-i}|@option{--inlines}]
3372 [@option{-p}|@option{--pretty-print}]
3373 [@option{-j}|@option{--section=}@var{name}]
3374 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3379 @c man begin DESCRIPTION addr2line
3381 @command{addr2line} translates addresses into file names and line numbers.
3382 Given an address in an executable or an offset in a section of a relocatable
3383 object, it uses the debugging information to figure out which file name and
3384 line number are associated with it.
3386 The executable or relocatable object to use is specified with the @option{-e}
3387 option. The default is the file @file{a.out}. The section in the relocatable
3388 object to use is specified with the @option{-j} option.
3390 @command{addr2line} has two modes of operation.
3392 In the first, hexadecimal addresses are specified on the command line,
3393 and @command{addr2line} displays the file name and line number for each
3396 In the second, @command{addr2line} reads hexadecimal addresses from
3397 standard input, and prints the file name and line number for each
3398 address on standard output. In this mode, @command{addr2line} may be used
3399 in a pipe to convert dynamically chosen addresses.
3401 The format of the output is @samp{FILENAME:LINENO}. By default
3402 each input address generates one line of output.
3404 Two options can generate additional lines before each
3405 @samp{FILENAME:LINENO} line (in that order).
3407 If the @option{-a} option is used then a line with the input address
3410 If the @option{-f} option is used, then a line with the
3411 @samp{FUNCTIONNAME} is displayed. This is the name of the function
3412 containing the address.
3414 One option can generate additional lines after the
3415 @samp{FILENAME:LINENO} line.
3417 If the @option{-i} option is used and the code at the given address is
3418 present there because of inlining by the compiler then additional
3419 lines are displayed afterwards. One or two extra lines (if the
3420 @option{-f} option is used) are displayed for each inlined function.
3422 Alternatively if the @option{-p} option is used then each input
3423 address generates a single, long, output line containing the address,
3424 the function name, the file name and the line number. If the
3425 @option{-i} option has also been used then any inlined functions will
3426 be displayed in the same manner, but on separate lines, and prefixed
3427 by the text @samp{(inlined by)}.
3429 If the file name or function name can not be determined,
3430 @command{addr2line} will print two question marks in their place. If the
3431 line number can not be determined, @command{addr2line} will print 0.
3435 @c man begin OPTIONS addr2line
3437 The long and short forms of options, shown here as alternatives, are
3443 Display the address before the function name, file and line number
3444 information. The address is printed with a @samp{0x} prefix to easily
3447 @item -b @var{bfdname}
3448 @itemx --target=@var{bfdname}
3449 @cindex object code format
3450 Specify that the object-code format for the object files is
3454 @itemx --demangle[=@var{style}]
3455 @cindex demangling in objdump
3456 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3457 Besides removing any initial underscore prepended by the system, this
3458 makes C++ function names readable. Different compilers have different
3459 mangling styles. The optional demangling style argument can be used to
3460 choose an appropriate demangling style for your compiler. @xref{c++filt},
3461 for more information on demangling.
3463 @item -e @var{filename}
3464 @itemx --exe=@var{filename}
3465 Specify the name of the executable for which addresses should be
3466 translated. The default file is @file{a.out}.
3470 Display function names as well as file and line number information.
3474 Display only the base of each file name.
3478 If the address belongs to a function that was inlined, the source
3479 information for all enclosing scopes back to the first non-inlined
3480 function will also be printed. For example, if @code{main} inlines
3481 @code{callee1} which inlines @code{callee2}, and address is from
3482 @code{callee2}, the source information for @code{callee1} and @code{main}
3483 will also be printed.
3487 Read offsets relative to the specified section instead of absolute addresses.
3490 @itemx --pretty-print
3491 Make the output more human friendly: each location are printed on one line.
3492 If option @option{-i} is specified, lines for all enclosing scopes are
3493 prefixed with @samp{(inlined by)}.
3499 @c man begin SEEALSO addr2line
3500 Info entries for @file{binutils}.
3507 @command{nlmconv} converts a relocatable object file into a NetWare
3511 @command{nlmconv} currently works with @samp{i386} object
3512 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
3513 object files in @sc{elf}, or @code{a.out} format@footnote{
3514 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
3515 format in the Binary File Descriptor library. It has only been tested
3516 with the above formats.}.
3520 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
3521 utilities, since it is only useful for NLM targets.
3524 @c man title nlmconv converts object code into an NLM.
3527 @c man begin SYNOPSIS nlmconv
3528 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3529 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3530 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3531 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3532 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3533 @var{infile} @var{outfile}
3537 @c man begin DESCRIPTION nlmconv
3539 @command{nlmconv} converts the relocatable @samp{i386} object file
3540 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3541 reading @var{headerfile} for NLM header information. For instructions
3542 on writing the NLM command file language used in header files, see the
3543 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3544 Development and Tools Overview}, which is part of the NLM Software
3545 Developer's Kit (``NLM SDK''), available from Novell, Inc.
3546 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
3549 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3552 @command{nlmconv} can perform a link step. In other words, you can list
3553 more than one object file for input if you list them in the definitions
3554 file (rather than simply specifying one input file on the command line).
3555 In this case, @command{nlmconv} calls the linker for you.
3559 @c man begin OPTIONS nlmconv
3562 @item -I @var{bfdname}
3563 @itemx --input-target=@var{bfdname}
3564 Object format of the input file. @command{nlmconv} can usually determine
3565 the format of a given file (so no default is necessary).
3566 @xref{Target Selection}, for more information.
3568 @item -O @var{bfdname}
3569 @itemx --output-target=@var{bfdname}
3570 Object format of the output file. @command{nlmconv} infers the output
3571 format based on the input format, e.g. for a @samp{i386} input file the
3572 output format is @samp{nlm32-i386}.
3573 @xref{Target Selection}, for more information.
3575 @item -T @var{headerfile}
3576 @itemx --header-file=@var{headerfile}
3577 Reads @var{headerfile} for NLM header information. For instructions on
3578 writing the NLM command file language used in header files, see@ see the
3579 @samp{linkers} section, of the @cite{NLM Development and Tools
3580 Overview}, which is part of the NLM Software Developer's Kit, available
3585 Displays (on standard error) the linker command line used by @command{nlmconv}.
3587 @item -l @var{linker}
3588 @itemx --linker=@var{linker}
3589 Use @var{linker} for any linking. @var{linker} can be an absolute or a
3594 Prints a usage summary.
3598 Prints the version number for @command{nlmconv}.
3604 @c man begin SEEALSO nlmconv
3605 the Info entries for @file{binutils}.
3612 @command{windmc} may be used to generator Windows message resources.
3615 @emph{Warning:} @command{windmc} is not always built as part of the binary
3616 utilities, since it is only useful for Windows targets.
3619 @c man title windmc generates Windows message resources.
3622 @c man begin SYNOPSIS windmc
3623 windmc [options] input-file
3627 @c man begin DESCRIPTION windmc
3629 @command{windmc} reads message definitions from an input file (.mc) and
3630 translate them into a set of output files. The output files may be of
3635 A C header file containing the message definitions.
3638 A resource file compilable by the @command{windres} tool.
3641 One or more binary files containing the resource data for a specific
3645 A C include file that maps message id's to their symbolic name.
3648 The exact description of these different formats is available in
3649 documentation from Microsoft.
3651 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3652 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3653 Windows Message Compiler.
3657 @c man begin OPTIONS windmc
3662 Specifies that the input file specified is ASCII. This is the default
3667 Specifies that messages in the output @code{bin} files should be in ASCII
3672 Specifies that @code{bin} filenames should have to be prefixed by the
3673 basename of the source file.
3677 Sets the customer bit in all message id's.
3679 @item -C @var{codepage}
3680 @itemx --codepage_in @var{codepage}
3681 Sets the default codepage to be used to convert input file to UTF16. The
3682 default is ocdepage 1252.
3685 @itemx --decimal_values
3686 Outputs the constants in the header file in decimal. Default is using
3690 @itemx --extension @var{ext}
3691 The extension for the header file. The default is .h extension.
3693 @item -F @var{target}
3694 @itemx --target @var{target}
3695 Specify the BFD format to use for a bin file as output. This
3696 is a BFD target name; you can use the @option{--help} option to see a list
3697 of supported targets. Normally @command{windmc} will use the default
3698 format, which is the first one listed by the @option{--help} option.
3700 @ref{Target Selection}.
3704 @itemx --headerdir @var{path}
3705 The target directory of the generated header file. The default is the
3710 Displays a list of command line options and then exits.
3712 @item -m @var{characters}
3713 @itemx --maxlength @var{characters}
3714 Instructs @command{windmc} to generate a warning if the length
3715 of any message exceeds the number specified.
3718 @itemx --nullterminate
3719 Terminate message text in @code{bin} files by zero. By default they are
3720 terminated by CR/LF.
3723 @itemx --hresult_use
3724 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3725 file, using HRESULT definitions. Status codes are used if the flag is not
3728 @item -O @var{codepage}
3729 @itemx --codepage_out @var{codepage}
3730 Sets the default codepage to be used to output text files. The default
3734 @itemx --rcdir @var{path}
3735 The target directory for the generated @code{rc} script and the generated
3736 @code{bin} files that the resource compiler script includes. The default
3737 is the current directory.
3741 Specifies that the input file is UTF16.
3744 @itemx --unicode_out
3745 Specifies that messages in the output @code{bin} file should be in UTF16
3746 format. This is the default behaviour.
3750 Enable verbose mode.
3754 Prints the version number for @command{windmc}.
3757 @itemx --xdgb @var{path}
3758 The path of the @code{dbg} C include file that maps message id's to the
3759 symbolic name. No such file is generated without specifying the switch.
3765 @c man begin SEEALSO windmc
3766 the Info entries for @file{binutils}.
3773 @command{windres} may be used to manipulate Windows resources.
3776 @emph{Warning:} @command{windres} is not always built as part of the binary
3777 utilities, since it is only useful for Windows targets.
3780 @c man title windres manipulate Windows resources.
3783 @c man begin SYNOPSIS windres
3784 windres [options] [input-file] [output-file]
3788 @c man begin DESCRIPTION windres
3790 @command{windres} reads resources from an input file and copies them into
3791 an output file. Either file may be in one of three formats:
3795 A text format read by the Resource Compiler.
3798 A binary format generated by the Resource Compiler.
3801 A COFF object or executable.
3804 The exact description of these different formats is available in
3805 documentation from Microsoft.
3807 When @command{windres} converts from the @code{rc} format to the @code{res}
3808 format, it is acting like the Windows Resource Compiler. When
3809 @command{windres} converts from the @code{res} format to the @code{coff}
3810 format, it is acting like the Windows @code{CVTRES} program.
3812 When @command{windres} generates an @code{rc} file, the output is similar
3813 but not identical to the format expected for the input. When an input
3814 @code{rc} file refers to an external filename, an output @code{rc} file
3815 will instead include the file contents.
3817 If the input or output format is not specified, @command{windres} will
3818 guess based on the file name, or, for the input file, the file contents.
3819 A file with an extension of @file{.rc} will be treated as an @code{rc}
3820 file, a file with an extension of @file{.res} will be treated as a
3821 @code{res} file, and a file with an extension of @file{.o} or
3822 @file{.exe} will be treated as a @code{coff} file.
3824 If no output file is specified, @command{windres} will print the resources
3825 in @code{rc} format to standard output.
3827 The normal use is for you to write an @code{rc} file, use @command{windres}
3828 to convert it to a COFF object file, and then link the COFF file into
3829 your application. This will make the resources described in the
3830 @code{rc} file available to Windows.
3834 @c man begin OPTIONS windres
3837 @item -i @var{filename}
3838 @itemx --input @var{filename}
3839 The name of the input file. If this option is not used, then
3840 @command{windres} will use the first non-option argument as the input file
3841 name. If there are no non-option arguments, then @command{windres} will
3842 read from standard input. @command{windres} can not read a COFF file from
3845 @item -o @var{filename}
3846 @itemx --output @var{filename}
3847 The name of the output file. If this option is not used, then
3848 @command{windres} will use the first non-option argument, after any used
3849 for the input file name, as the output file name. If there is no
3850 non-option argument, then @command{windres} will write to standard output.
3851 @command{windres} can not write a COFF file to standard output. Note,
3852 for compatibility with @command{rc} the option @option{-fo} is also
3853 accepted, but its use is not recommended.
3855 @item -J @var{format}
3856 @itemx --input-format @var{format}
3857 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3858 @samp{coff}. If no input format is specified, @command{windres} will
3859 guess, as described above.
3861 @item -O @var{format}
3862 @itemx --output-format @var{format}
3863 The output format to generate. @var{format} may be @samp{res},
3864 @samp{rc}, or @samp{coff}. If no output format is specified,
3865 @command{windres} will guess, as described above.
3867 @item -F @var{target}
3868 @itemx --target @var{target}
3869 Specify the BFD format to use for a COFF file as input or output. This
3870 is a BFD target name; you can use the @option{--help} option to see a list
3871 of supported targets. Normally @command{windres} will use the default
3872 format, which is the first one listed by the @option{--help} option.
3874 @ref{Target Selection}.
3877 @item --preprocessor @var{program}
3878 When @command{windres} reads an @code{rc} file, it runs it through the C
3879 preprocessor first. This option may be used to specify the preprocessor
3880 to use, including any leading arguments. The default preprocessor
3881 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3883 @item --preprocessor-arg @var{option}
3884 When @command{windres} reads an @code{rc} file, it runs it through
3885 the C preprocessor first. This option may be used to specify additional
3886 text to be passed to preprocessor on its command line.
3887 This option can be used multiple times to add multiple options to the
3888 preprocessor command line.
3890 @item -I @var{directory}
3891 @itemx --include-dir @var{directory}
3892 Specify an include directory to use when reading an @code{rc} file.
3893 @command{windres} will pass this to the preprocessor as an @option{-I}
3894 option. @command{windres} will also search this directory when looking for
3895 files named in the @code{rc} file. If the argument passed to this command
3896 matches any of the supported @var{formats} (as described in the @option{-J}
3897 option), it will issue a deprecation warning, and behave just like the
3898 @option{-J} option. New programs should not use this behaviour. If a
3899 directory happens to match a @var{format}, simple prefix it with @samp{./}
3900 to disable the backward compatibility.
3902 @item -D @var{target}
3903 @itemx --define @var{sym}[=@var{val}]
3904 Specify a @option{-D} option to pass to the preprocessor when reading an
3907 @item -U @var{target}
3908 @itemx --undefine @var{sym}
3909 Specify a @option{-U} option to pass to the preprocessor when reading an
3913 Ignored for compatibility with rc.
3916 Enable verbose mode. This tells you what the preprocessor is if you
3920 @item --codepage @var{val}
3921 Specify the default codepage to use when reading an @code{rc} file.
3922 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3923 codepage code. The valid range is from zero up to 0xffff, but the
3924 validity of the codepage is host and configuration dependent.
3927 @item --language @var{val}
3928 Specify the default language to use when reading an @code{rc} file.
3929 @var{val} should be a hexadecimal language code. The low eight bits are
3930 the language, and the high eight bits are the sublanguage.
3932 @item --use-temp-file
3933 Use a temporary file to instead of using popen to read the output of
3934 the preprocessor. Use this option if the popen implementation is buggy
3935 on the host (eg., certain non-English language versions of Windows 95 and
3936 Windows 98 are known to have buggy popen where the output will instead
3939 @item --no-use-temp-file
3940 Use popen, not a temporary file, to read the output of the preprocessor.
3941 This is the default behaviour.
3945 Prints a usage summary.
3949 Prints the version number for @command{windres}.
3952 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3953 this will turn on parser debugging.
3959 @c man begin SEEALSO windres
3960 the Info entries for @file{binutils}.
3969 @command{dlltool} is used to create the files needed to create dynamic
3970 link libraries (DLLs) on systems which understand PE format image
3971 files such as Windows. A DLL contains an export table which contains
3972 information that the runtime loader needs to resolve references from a
3973 referencing program.
3975 The export table is generated by this program by reading in a
3976 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3977 will be in the DLL. A @file{.o} file can contain information in
3978 special @samp{.drectve} sections with export information.
3981 @emph{Note:} @command{dlltool} is not always built as part of the
3982 binary utilities, since it is only useful for those targets which
3986 @c man title dlltool Create files needed to build and use DLLs.
3989 @c man begin SYNOPSIS dlltool
3990 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3991 [@option{-b}|@option{--base-file} @var{base-file-name}]
3992 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3993 [@option{-z}|@option{--output-def} @var{def-file-name}]
3994 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3995 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
3996 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3997 [@option{--exclude-symbols} @var{list}]
3998 [@option{--no-default-excludes}]
3999 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
4000 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
4001 [@option{-a}|@option{--add-indirect}]
4002 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
4003 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
4004 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
4005 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
4006 [@option{--use-nul-prefixed-import-tables}]
4007 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
4008 [@option{-i}|@option{--interwork}]
4009 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
4010 [@option{-v}|@option{--verbose}]
4011 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
4012 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
4013 [object-file @dots{}]
4017 @c man begin DESCRIPTION dlltool
4019 @command{dlltool} reads its inputs, which can come from the @option{-d} and
4020 @option{-b} options as well as object files specified on the command
4021 line. It then processes these inputs and if the @option{-e} option has
4022 been specified it creates a exports file. If the @option{-l} option
4023 has been specified it creates a library file and if the @option{-z} option
4024 has been specified it creates a def file. Any or all of the @option{-e},
4025 @option{-l} and @option{-z} options can be present in one invocation of
4028 When creating a DLL, along with the source for the DLL, it is necessary
4029 to have three other files. @command{dlltool} can help with the creation of
4032 The first file is a @file{.def} file which specifies which functions are
4033 exported from the DLL, which functions the DLL imports, and so on. This
4034 is a text file and can be created by hand, or @command{dlltool} can be used
4035 to create it using the @option{-z} option. In this case @command{dlltool}
4036 will scan the object files specified on its command line looking for
4037 those functions which have been specially marked as being exported and
4038 put entries for them in the @file{.def} file it creates.
4040 In order to mark a function as being exported from a DLL, it needs to
4041 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
4042 section of the object file. This can be done in C by using the
4046 asm (".section .drectve");
4047 asm (".ascii \"-export:my_func\"");
4049 int my_func (void) @{ @dots{} @}
4052 The second file needed for DLL creation is an exports file. This file
4053 is linked with the object files that make up the body of the DLL and it
4054 handles the interface between the DLL and the outside world. This is a
4055 binary file and it can be created by giving the @option{-e} option to
4056 @command{dlltool} when it is creating or reading in a @file{.def} file.
4058 The third file needed for DLL creation is the library file that programs
4059 will link with in order to access the functions in the DLL (an `import
4060 library'). This file can be created by giving the @option{-l} option to
4061 dlltool when it is creating or reading in a @file{.def} file.
4063 If the @option{-y} option is specified, dlltool generates a delay-import
4064 library that can be used instead of the normal import library to allow
4065 a program to link to the dll only as soon as an imported function is
4066 called for the first time. The resulting executable will need to be
4067 linked to the static delayimp library containing __delayLoadHelper2(),
4068 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4070 @command{dlltool} builds the library file by hand, but it builds the
4071 exports file by creating temporary files containing assembler statements
4072 and then assembling these. The @option{-S} command line option can be
4073 used to specify the path to the assembler that dlltool will use,
4074 and the @option{-f} option can be used to pass specific flags to that
4075 assembler. The @option{-n} can be used to prevent dlltool from deleting
4076 these temporary assembler files when it is done, and if @option{-n} is
4077 specified twice then this will prevent dlltool from deleting the
4078 temporary object files it used to build the library.
4080 Here is an example of creating a DLL from a source file @samp{dll.c} and
4081 also creating a program (from an object file called @samp{program.o})
4086 dlltool -e exports.o -l dll.lib dll.o
4087 gcc dll.o exports.o -o dll.dll
4088 gcc program.o dll.lib -o program
4092 @command{dlltool} may also be used to query an existing import library
4093 to determine the name of the DLL to which it is associated. See the
4094 description of the @option{-I} or @option{--identify} option.
4098 @c man begin OPTIONS dlltool
4100 The command line options have the following meanings:
4104 @item -d @var{filename}
4105 @itemx --input-def @var{filename}
4106 @cindex input .def file
4107 Specifies the name of a @file{.def} file to be read in and processed.
4109 @item -b @var{filename}
4110 @itemx --base-file @var{filename}
4112 Specifies the name of a base file to be read in and processed. The
4113 contents of this file will be added to the relocation section in the
4114 exports file generated by dlltool.
4116 @item -e @var{filename}
4117 @itemx --output-exp @var{filename}
4118 Specifies the name of the export file to be created by dlltool.
4120 @item -z @var{filename}
4121 @itemx --output-def @var{filename}
4122 Specifies the name of the @file{.def} file to be created by dlltool.
4124 @item -l @var{filename}
4125 @itemx --output-lib @var{filename}
4126 Specifies the name of the library file to be created by dlltool.
4128 @item -y @var{filename}
4129 @itemx --output-delaylib @var{filename}
4130 Specifies the name of the delay-import library file to be created by dlltool.
4132 @item --export-all-symbols
4133 Treat all global and weak defined symbols found in the input object
4134 files as symbols to be exported. There is a small list of symbols which
4135 are not exported by default; see the @option{--no-default-excludes}
4136 option. You may add to the list of symbols to not export by using the
4137 @option{--exclude-symbols} option.
4139 @item --no-export-all-symbols
4140 Only export symbols explicitly listed in an input @file{.def} file or in
4141 @samp{.drectve} sections in the input object files. This is the default
4142 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
4143 attributes in the source code.
4145 @item --exclude-symbols @var{list}
4146 Do not export the symbols in @var{list}. This is a list of symbol names
4147 separated by comma or colon characters. The symbol names should not
4148 contain a leading underscore. This is only meaningful when
4149 @option{--export-all-symbols} is used.
4151 @item --no-default-excludes
4152 When @option{--export-all-symbols} is used, it will by default avoid
4153 exporting certain special symbols. The current list of symbols to avoid
4154 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
4155 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
4156 to go ahead and export these special symbols. This is only meaningful
4157 when @option{--export-all-symbols} is used.
4160 @itemx --as @var{path}
4161 Specifies the path, including the filename, of the assembler to be used
4162 to create the exports file.
4164 @item -f @var{options}
4165 @itemx --as-flags @var{options}
4166 Specifies any specific command line options to be passed to the
4167 assembler when building the exports file. This option will work even if
4168 the @option{-S} option is not used. This option only takes one argument,
4169 and if it occurs more than once on the command line, then later
4170 occurrences will override earlier occurrences. So if it is necessary to
4171 pass multiple options to the assembler they should be enclosed in
4175 @itemx --dll-name @var{name}
4176 Specifies the name to be stored in the @file{.def} file as the name of
4177 the DLL when the @option{-e} option is used. If this option is not
4178 present, then the filename given to the @option{-e} option will be
4179 used as the name of the DLL.
4181 @item -m @var{machine}
4182 @itemx -machine @var{machine}
4183 Specifies the type of machine for which the library file should be
4184 built. @command{dlltool} has a built in default type, depending upon how
4185 it was created, but this option can be used to override that. This is
4186 normally only useful when creating DLLs for an ARM processor, when the
4187 contents of the DLL are actually encode using Thumb instructions.
4190 @itemx --add-indirect
4191 Specifies that when @command{dlltool} is creating the exports file it
4192 should add a section which allows the exported functions to be
4193 referenced without using the import library. Whatever the hell that
4197 @itemx --add-underscore
4198 Specifies that when @command{dlltool} is creating the exports file it
4199 should prepend an underscore to the names of @emph{all} exported symbols.
4201 @item --no-leading-underscore
4202 @item --leading-underscore
4203 Specifies whether standard symbol should be forced to be prefixed, or
4206 @item --add-stdcall-underscore
4207 Specifies that when @command{dlltool} is creating the exports file it
4208 should prepend an underscore to the names of exported @emph{stdcall}
4209 functions. Variable names and non-stdcall function names are not modified.
4210 This option is useful when creating GNU-compatible import libs for third
4211 party DLLs that were built with MS-Windows tools.
4215 Specifies that @samp{@@<number>} suffixes should be omitted from the names
4216 of stdcall functions that will be imported from the DLL. This is
4217 useful when creating an import library for a DLL which exports stdcall
4218 functions but without the usual @samp{@@<number>} symbol name suffix.
4220 This does not change the naming of symbols provided by the import library
4221 to programs linked against it, but only the entries in the import table
4222 (ie the .idata section).
4225 @itemx --add-stdcall-alias
4226 Specifies that when @command{dlltool} is creating the exports file it
4227 should add aliases for stdcall symbols without @samp{@@ <number>}
4228 in addition to the symbols with @samp{@@ <number>}.
4231 @itemx --ext-prefix-alias @var{prefix}
4232 Causes @command{dlltool} to create external aliases for all DLL
4233 imports with the specified prefix. The aliases are created for both
4234 external and import symbols with no leading underscore.
4238 Specifies that when @command{dlltool} is creating the exports and library
4239 files it should omit the @code{.idata4} section. This is for compatibility
4240 with certain operating systems.
4242 @item --use-nul-prefixed-import-tables
4243 Specifies that when @command{dlltool} is creating the exports and library
4244 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4245 element. This emulates old gnu import library generation of
4246 @code{dlltool}. By default this option is turned off.
4250 Specifies that when @command{dlltool} is creating the exports and library
4251 files it should omit the @code{.idata5} section. This is for compatibility
4252 with certain operating systems.
4254 @item -I @var{filename}
4255 @itemx --identify @var{filename}
4256 Specifies that @command{dlltool} should inspect the import library
4257 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4258 of the associated DLL(s). This can be performed in addition to any
4259 other operations indicated by the other options and arguments.
4260 @command{dlltool} fails if the import library does not exist or is not
4261 actually an import library. See also @option{--identify-strict}.
4263 @item --identify-strict
4264 Modifies the behavior of the @option{--identify} option, such
4265 that an error is reported if @var{filename} is associated with
4270 Specifies that @command{dlltool} should mark the objects in the library
4271 file and exports file that it produces as supporting interworking
4272 between ARM and Thumb code.
4276 Makes @command{dlltool} preserve the temporary assembler files it used to
4277 create the exports file. If this option is repeated then dlltool will
4278 also preserve the temporary object files it uses to create the library
4281 @item -t @var{prefix}
4282 @itemx --temp-prefix @var{prefix}
4283 Makes @command{dlltool} use @var{prefix} when constructing the names of
4284 temporary assembler and object files. By default, the temp file prefix
4285 is generated from the pid.
4289 Make dlltool describe what it is doing.
4293 Displays a list of command line options and then exits.
4297 Displays dlltool's version number and then exits.
4304 * def file format:: The format of the dlltool @file{.def} file
4307 @node def file format
4308 @section The format of the @command{dlltool} @file{.def} file
4310 A @file{.def} file contains any number of the following commands:
4314 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4315 The result is going to be named @var{name}@code{.exe}.
4317 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4318 The result is going to be named @var{name}@code{.dll}.
4319 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4320 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4323 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4324 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4325 Declares @var{name1} as an exported symbol from the DLL, with optional
4326 ordinal number @var{integer}, or declares @var{name1} as an alias
4327 (forward) of the function @var{external-name} in the DLL.
4328 If @var{its_name} is specified, this name is used as string in export table.
4330 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4331 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4332 If you want to use LIBRARY as name then you need to quote it.
4334 @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{]} *}
4335 Declares that @var{external-name} or the exported function whose
4336 ordinal number is @var{integer} is to be imported from the file
4337 @var{module-name}. If @var{internal-name} is specified then this is
4338 the name that the imported function will be referred to in the body of
4340 If @var{its_name} is specified, this name is used as string in import table.
4341 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4342 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4343 If you want to use LIBRARY as name then you need to quote it.
4345 @item @code{DESCRIPTION} @var{string}
4346 Puts @var{string} into the output @file{.exp} file in the
4347 @code{.rdata} section.
4349 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4350 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4351 Generates @code{--stack} or @code{--heap}
4352 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4353 section. The linker will see this and act upon it.
4355 @item @code{CODE} @var{attr} @code{+}
4356 @item @code{DATA} @var{attr} @code{+}
4357 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4358 Generates @code{--attr} @var{section-name} @var{attr} in the output
4359 @code{.drectve} section, where @var{attr} is one of @code{READ},
4360 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4361 this and act upon it.
4366 @c man begin SEEALSO dlltool
4367 The Info pages for @file{binutils}.
4374 @cindex ELF file information
4377 @c man title readelf Displays information about ELF files.
4380 @c man begin SYNOPSIS readelf
4381 readelf [@option{-a}|@option{--all}]
4382 [@option{-h}|@option{--file-header}]
4383 [@option{-l}|@option{--program-headers}|@option{--segments}]
4384 [@option{-S}|@option{--section-headers}|@option{--sections}]
4385 [@option{-g}|@option{--section-groups}]
4386 [@option{-t}|@option{--section-details}]
4387 [@option{-e}|@option{--headers}]
4388 [@option{-s}|@option{--syms}|@option{--symbols}]
4389 [@option{--dyn-syms}]
4390 [@option{-n}|@option{--notes}]
4391 [@option{-r}|@option{--relocs}]
4392 [@option{-u}|@option{--unwind}]
4393 [@option{-d}|@option{--dynamic}]
4394 [@option{-V}|@option{--version-info}]
4395 [@option{-A}|@option{--arch-specific}]
4396 [@option{-D}|@option{--use-dynamic}]
4397 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4398 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4399 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4400 [@option{-z}|@option{--decompress}]
4401 [@option{-c}|@option{--archive-index}]
4402 [@option{-w[lLiaprmfFsoRt]}|
4403 @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]]
4404 [@option{--dwarf-depth=@var{n}}]
4405 [@option{--dwarf-start=@var{n}}]
4406 [@option{-I}|@option{--histogram}]
4407 [@option{-v}|@option{--version}]
4408 [@option{-W}|@option{--wide}]
4409 [@option{-H}|@option{--help}]
4410 @var{elffile}@dots{}
4414 @c man begin DESCRIPTION readelf
4416 @command{readelf} displays information about one or more ELF format object
4417 files. The options control what particular information to display.
4419 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4420 64-bit ELF files are supported, as are archives containing ELF files.
4422 This program performs a similar function to @command{objdump} but it
4423 goes into more detail and it exists independently of the @sc{bfd}
4424 library, so if there is a bug in @sc{bfd} then readelf will not be
4429 @c man begin OPTIONS readelf
4431 The long and short forms of options, shown here as alternatives, are
4432 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4438 Equivalent to specifying @option{--file-header},
4439 @option{--program-headers}, @option{--sections}, @option{--symbols},
4440 @option{--relocs}, @option{--dynamic}, @option{--notes} and
4441 @option{--version-info}.
4444 @itemx --file-header
4445 @cindex ELF file header information
4446 Displays the information contained in the ELF header at the start of the
4450 @itemx --program-headers
4452 @cindex ELF program header information
4453 @cindex ELF segment information
4454 Displays the information contained in the file's segment headers, if it
4459 @itemx --section-headers
4460 @cindex ELF section information
4461 Displays the information contained in the file's section headers, if it
4465 @itemx --section-groups
4466 @cindex ELF section group information
4467 Displays the information contained in the file's section groups, if it
4471 @itemx --section-details
4472 @cindex ELF section information
4473 Displays the detailed section information. Implies @option{-S}.
4478 @cindex ELF symbol table information
4479 Displays the entries in symbol table section of the file, if it has one.
4482 @cindex ELF dynamic symbol table information
4483 Displays the entries in dynamic symbol table section of the file, if it
4488 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4493 Displays the contents of the NOTE segments and/or sections, if any.
4497 @cindex ELF reloc information
4498 Displays the contents of the file's relocation section, if it has one.
4502 @cindex unwind information
4503 Displays the contents of the file's unwind section, if it has one. Only
4504 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4505 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported.
4509 @cindex ELF dynamic section information
4510 Displays the contents of the file's dynamic section, if it has one.
4513 @itemx --version-info
4514 @cindex ELF version sections information
4515 Displays the contents of the version sections in the file, it they
4519 @itemx --arch-specific
4520 Displays architecture-specific information in the file, if there
4524 @itemx --use-dynamic
4525 When displaying symbols, this option makes @command{readelf} use the
4526 symbol hash tables in the file's dynamic section, rather than the
4527 symbol table sections.
4529 @item -x <number or name>
4530 @itemx --hex-dump=<number or name>
4531 Displays the contents of the indicated section as a hexadecimal bytes.
4532 A number identifies a particular section by index in the section table;
4533 any other string identifies all sections with that name in the object file.
4535 @item -R <number or name>
4536 @itemx --relocated-dump=<number or name>
4537 Displays the contents of the indicated section as a hexadecimal
4538 bytes. A number identifies a particular section by index in the
4539 section table; any other string identifies all sections with that name
4540 in the object file. The contents of the section will be relocated
4541 before they are displayed.
4543 @item -p <number or name>
4544 @itemx --string-dump=<number or name>
4545 Displays the contents of the indicated section as printable strings.
4546 A number identifies a particular section by index in the section table;
4547 any other string identifies all sections with that name in the object file.
4551 Requests that the section(s) being dumped by @option{x}, @option{R} or
4552 @option{p} options are decompressed before being displayed. If the
4553 section(s) are not compressed then they are displayed as is.
4556 @itemx --archive-index
4557 @cindex Archive file symbol index information
4558 Displays the file symbol index information contained in the header part
4559 of binary archives. Performs the same function as the @option{t}
4560 command to @command{ar}, but without using the BFD library. @xref{ar}.
4562 @item -w[lLiaprmfFsoRt]
4563 @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]
4564 Displays the contents of the debug sections in the file, if any are
4565 present. If one of the optional letters or words follows the switch
4566 then only data found in those specific sections will be dumped.
4568 Note that there is no single letter option to display the content of
4569 trace sections or .gdb_index.
4571 Note: the @option{=decodedline} option will display the interpreted
4572 contents of a .debug_line section whereas the @option{=rawline} option
4573 dumps the contents in a raw format.
4575 Note: the @option{=frames-interp} option will display the interpreted
4576 contents of a .debug_frame section whereas the @option{=frames} option
4577 dumps the contents in a raw format.
4579 Note: the output from the @option{=info} option can also be affected
4580 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
4582 @item --dwarf-depth=@var{n}
4583 Limit the dump of the @code{.debug_info} section to @var{n} children.
4584 This is only useful with @option{--debug-dump=info}. The default is
4585 to print all DIEs; the special value 0 for @var{n} will also have this
4588 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
4589 levels will not be printed. The range for @var{n} is zero-based.
4591 @item --dwarf-start=@var{n}
4592 Print only DIEs beginning with the DIE numbered @var{n}. This is only
4593 useful with @option{--debug-dump=info}.
4595 If specified, this option will suppress printing of any header
4596 information and all DIEs before the DIE numbered @var{n}. Only
4597 siblings and children of the specified DIE will be printed.
4599 This can be used in conjunction with @option{--dwarf-depth}.
4603 Display a histogram of bucket list lengths when displaying the contents
4604 of the symbol tables.
4608 Display the version number of readelf.
4612 Don't break output lines to fit into 80 columns. By default
4613 @command{readelf} breaks section header and segment listing lines for
4614 64-bit ELF files, so that they fit into 80 columns. This option causes
4615 @command{readelf} to print each section header resp. each segment one a
4616 single line, which is far more readable on terminals wider than 80 columns.
4620 Display the command line options understood by @command{readelf}.
4627 @c man begin SEEALSO readelf
4628 objdump(1), and the Info entries for @file{binutils}.
4635 @cindex Update ELF header
4638 @c man title elfedit Update the ELF header of ELF files.
4641 @c man begin SYNOPSIS elfedit
4642 elfedit [@option{--input-mach=}@var{machine}]
4643 [@option{--input-type=}@var{type}]
4644 [@option{--input-osabi=}@var{osabi}]
4645 @option{--output-mach=}@var{machine}
4646 @option{--output-type=}@var{type}
4647 @option{--output-osabi=}@var{osabi}
4648 [@option{-v}|@option{--version}]
4649 [@option{-h}|@option{--help}]
4650 @var{elffile}@dots{}
4654 @c man begin DESCRIPTION elfedit
4656 @command{elfedit} updates the ELF header of ELF files which have
4657 the matching ELF machine and file types. The options control how and
4658 which fields in the ELF header should be updated.
4660 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4661 64-bit ELF files are supported, as are archives containing ELF files.
4664 @c man begin OPTIONS elfedit
4666 The long and short forms of options, shown here as alternatives, are
4667 equivalent. At least one of the @option{--output-mach},
4668 @option{--output-type} and @option{--output-osabi} options must be given.
4672 @item --input-mach=@var{machine}
4673 Set the matching input ELF machine type to @var{machine}. If
4674 @option{--input-mach} isn't specified, it will match any ELF
4677 The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
4678 @var{K1OM} and @var{x86-64}.
4680 @item --output-mach=@var{machine}
4681 Change the ELF machine type in the ELF header to @var{machine}. The
4682 supported ELF machine types are the same as @option{--input-mach}.
4684 @item --input-type=@var{type}
4685 Set the matching input ELF file type to @var{type}. If
4686 @option{--input-type} isn't specified, it will match any ELF file types.
4688 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4690 @item --output-type=@var{type}
4691 Change the ELF file type in the ELF header to @var{type}. The
4692 supported ELF types are the same as @option{--input-type}.
4694 @item --input-osabi=@var{osabi}
4695 Set the matching input ELF file OSABI to @var{osabi}. If
4696 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4698 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4699 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4700 @var{Solaris}, @var{AIX}, @var{Irix},
4701 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4702 @var{NSK}, @var{AROS} and @var{FenixOS}.
4704 @item --output-osabi=@var{osabi}
4705 Change the ELF OSABI in the ELF header to @var{osabi}. The
4706 supported ELF OSABI are the same as @option{--input-osabi}.
4710 Display the version number of @command{elfedit}.
4714 Display the command line options understood by @command{elfedit}.
4721 @c man begin SEEALSO elfedit
4722 readelf(1), and the Info entries for @file{binutils}.
4726 @node Common Options
4727 @chapter Common Options
4729 The following command-line options are supported by all of the
4730 programs described in this manual.
4732 @c man begin OPTIONS
4734 @include at-file.texi
4738 Display the command-line options supported by the program.
4741 Display the version number of the program.
4743 @c man begin OPTIONS
4747 @node Selecting the Target System
4748 @chapter Selecting the Target System
4750 You can specify two aspects of the target system to the @sc{gnu}
4751 binary file utilities, each in several ways:
4761 In the following summaries, the lists of ways to specify values are in
4762 order of decreasing precedence. The ways listed first override those
4765 The commands to list valid values only list the values for which the
4766 programs you are running were configured. If they were configured with
4767 @option{--enable-targets=all}, the commands list most of the available
4768 values, but a few are left out; not all targets can be configured in at
4769 once because some of them can only be configured @dfn{native} (on hosts
4770 with the same type as the target system).
4773 * Target Selection::
4774 * Architecture Selection::
4777 @node Target Selection
4778 @section Target Selection
4780 A @dfn{target} is an object file format. A given target may be
4781 supported for multiple architectures (@pxref{Architecture Selection}).
4782 A target selection may also have variations for different operating
4783 systems or architectures.
4785 The command to list valid target values is @samp{objdump -i}
4786 (the first column of output contains the relevant information).
4788 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4789 @samp{a.out-sunos-big}.
4791 You can also specify a target using a configuration triplet. This is
4792 the same sort of name that is passed to @file{configure} to specify a
4793 target. When you use a configuration triplet as an argument, it must be
4794 fully canonicalized. You can see the canonical version of a triplet by
4795 running the shell script @file{config.sub} which is included with the
4798 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4799 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4801 @subheading @command{objdump} Target
4807 command line option: @option{-b} or @option{--target}
4810 environment variable @code{GNUTARGET}
4813 deduced from the input file
4816 @subheading @command{objcopy} and @command{strip} Input Target
4822 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4825 environment variable @code{GNUTARGET}
4828 deduced from the input file
4831 @subheading @command{objcopy} and @command{strip} Output Target
4837 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4840 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4843 environment variable @code{GNUTARGET}
4846 deduced from the input file
4849 @subheading @command{nm}, @command{size}, and @command{strings} Target
4855 command line option: @option{--target}
4858 environment variable @code{GNUTARGET}
4861 deduced from the input file
4864 @node Architecture Selection
4865 @section Architecture Selection
4867 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4868 to run. Its name may contain a colon, separating the name of the
4869 processor family from the name of the particular @sc{cpu}.
4871 The command to list valid architecture values is @samp{objdump -i} (the
4872 second column contains the relevant information).
4874 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4876 @subheading @command{objdump} Architecture
4882 command line option: @option{-m} or @option{--architecture}
4885 deduced from the input file
4888 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4894 deduced from the input file
4897 @node Reporting Bugs
4898 @chapter Reporting Bugs
4900 @cindex reporting bugs
4902 Your bug reports play an essential role in making the binary utilities
4905 Reporting a bug may help you by bringing a solution to your problem, or
4906 it may not. But in any case the principal function of a bug report is
4907 to help the entire community by making the next version of the binary
4908 utilities work better. Bug reports are your contribution to their
4911 In order for a bug report to serve its purpose, you must include the
4912 information that enables us to fix the bug.
4915 * Bug Criteria:: Have you found a bug?
4916 * Bug Reporting:: How to report bugs
4920 @section Have You Found a Bug?
4921 @cindex bug criteria
4923 If you are not sure whether you have found a bug, here are some guidelines:
4926 @cindex fatal signal
4929 If a binary utility gets a fatal signal, for any input whatever, that is
4930 a bug. Reliable utilities never crash.
4932 @cindex error on valid input
4934 If a binary utility produces an error message for valid input, that is a
4938 If you are an experienced user of binary utilities, your suggestions for
4939 improvement are welcome in any case.
4943 @section How to Report Bugs
4945 @cindex bugs, reporting
4947 A number of companies and individuals offer support for @sc{gnu}
4948 products. If you obtained the binary utilities from a support
4949 organization, we recommend you contact that organization first.
4951 You can find contact information for many support companies and
4952 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4956 In any event, we also recommend that you send bug reports for the binary
4957 utilities to @value{BUGURL}.
4960 The fundamental principle of reporting bugs usefully is this:
4961 @strong{report all the facts}. If you are not sure whether to state a
4962 fact or leave it out, state it!
4964 Often people omit facts because they think they know what causes the
4965 problem and assume that some details do not matter. Thus, you might
4966 assume that the name of a file you use in an example does not matter.
4967 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4968 a stray memory reference which happens to fetch from the location where
4969 that pathname is stored in memory; perhaps, if the pathname were
4970 different, the contents of that location would fool the utility into
4971 doing the right thing despite the bug. Play it safe and give a
4972 specific, complete example. That is the easiest thing for you to do,
4973 and the most helpful.
4975 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4976 it is new to us. Therefore, always write your bug reports on the assumption
4977 that the bug has not been reported previously.
4979 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4980 bell?'' This cannot help us fix a bug, so it is basically useless. We
4981 respond by asking for enough details to enable us to investigate.
4982 You might as well expedite matters by sending them to begin with.
4984 To enable us to fix the bug, you should include all these things:
4988 The version of the utility. Each utility announces it if you start it
4989 with the @option{--version} argument.
4991 Without this, we will not know whether there is any point in looking for
4992 the bug in the current version of the binary utilities.
4995 Any patches you may have applied to the source, including any patches
4996 made to the @code{BFD} library.
4999 The type of machine you are using, and the operating system name and
5003 What compiler (and its version) was used to compile the utilities---e.g.
5007 The command arguments you gave the utility to observe the bug. To
5008 guarantee you will not omit something important, list them all. A copy
5009 of the Makefile (or the output from make) is sufficient.
5011 If we were to try to guess the arguments, we would probably guess wrong
5012 and then we might not encounter the bug.
5015 A complete input file, or set of input files, that will reproduce the
5016 bug. If the utility is reading an object file or files, then it is
5017 generally most helpful to send the actual object files.
5019 If the source files were produced exclusively using @sc{gnu} programs
5020 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
5021 may be OK to send the source files rather than the object files. In
5022 this case, be sure to say exactly what version of @command{gcc}, or
5023 whatever, was used to produce the object files. Also say how
5024 @command{gcc}, or whatever, was configured.
5027 A description of what behavior you observe that you believe is
5028 incorrect. For example, ``It gets a fatal signal.''
5030 Of course, if the bug is that the utility gets a fatal signal, then we
5031 will certainly notice it. But if the bug is incorrect output, we might
5032 not notice unless it is glaringly wrong. You might as well not give us
5033 a chance to make a mistake.
5035 Even if the problem you experience is a fatal signal, you should still
5036 say so explicitly. Suppose something strange is going on, such as your
5037 copy of the utility is out of sync, or you have encountered a bug in
5038 the C library on your system. (This has happened!) Your copy might
5039 crash and ours would not. If you told us to expect a crash, then when
5040 ours fails to crash, we would know that the bug was not happening for
5041 us. If you had not told us to expect a crash, then we would not be able
5042 to draw any conclusion from our observations.
5045 If you wish to suggest changes to the source, send us context diffs, as
5046 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
5047 option. Always send diffs from the old file to the new file. If you
5048 wish to discuss something in the @command{ld} source, refer to it by
5049 context, not by line number.
5051 The line numbers in our development sources will not match those in your
5052 sources. Your line numbers would convey no useful information to us.
5055 Here are some things that are not necessary:
5059 A description of the envelope of the bug.
5061 Often people who encounter a bug spend a lot of time investigating
5062 which changes to the input file will make the bug go away and which
5063 changes will not affect it.
5065 This is often time consuming and not very useful, because the way we
5066 will find the bug is by running a single example under the debugger
5067 with breakpoints, not by pure deduction from a series of examples.
5068 We recommend that you save your time for something else.
5070 Of course, if you can find a simpler example to report @emph{instead}
5071 of the original one, that is a convenience for us. Errors in the
5072 output will be easier to spot, running under the debugger will take
5073 less time, and so on.
5075 However, simplification is not vital; if you do not want to do this,
5076 report the bug anyway and send us the entire test case you used.
5079 A patch for the bug.
5081 A patch for the bug does help us if it is a good one. But do not omit
5082 the necessary information, such as the test case, on the assumption that
5083 a patch is all we need. We might see problems with your patch and decide
5084 to fix the problem another way, or we might not understand it at all.
5086 Sometimes with programs as complicated as the binary utilities it is
5087 very hard to construct an example that will make the program follow a
5088 certain path through the code. If you do not send us the example, we
5089 will not be able to construct one, so we will not be able to verify that
5092 And if we cannot understand what bug you are trying to fix, or why your
5093 patch should be an improvement, we will not install it. A test case will
5094 help us to understand.
5097 A guess about what the bug is or what it depends on.
5099 Such guesses are usually wrong. Even we cannot guess right about such
5100 things without first using the debugger to find the facts.
5103 @node GNU Free Documentation License
5104 @appendix GNU Free Documentation License
5108 @node Binutils Index
5109 @unnumbered Binutils Index