1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991-2019 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 * nm: (binutils)nm. List symbols from object files.
38 * objcopy: (binutils)objcopy. Copy and translate object files.
39 * objdump: (binutils)objdump. Display information from object files.
40 * ranlib: (binutils)ranlib. Generate index to archive contents.
41 * readelf: (binutils)readelf. Display the contents of ELF format files.
42 * size: (binutils)size. List section sizes and total size.
43 * strings: (binutils)strings. List printable strings from files.
44 * strip: (binutils)strip. Discard symbols.
45 * elfedit: (binutils)elfedit. Update ELF header and property of ELF files.
46 * windmc: (binutils)windmc. Generator for Windows message resources.
47 * windres: (binutils)windres. Manipulate Windows resources.
51 @title The @sc{gnu} Binary Utilities
52 @ifset VERSION_PACKAGE
53 @subtitle @value{VERSION_PACKAGE}
55 @subtitle Version @value{VERSION}
57 @subtitle @value{UPDATED}
58 @author Roland H. Pesch
59 @author Jeffrey M. Osier
60 @author Cygnus Support
64 {\parskip=0pt \hfill Cygnus Support\par \hfill
65 Texinfo \texinfoversion\par }
68 @vskip 0pt plus 1filll
77 This brief manual contains documentation for the @sc{gnu} binary
79 @ifset VERSION_PACKAGE
80 @value{VERSION_PACKAGE}
82 version @value{VERSION}:
87 Create, modify, and extract from archives
90 List symbols from object files
93 Copy and translate object files
96 Display information from object files
99 Generate index to archive contents
102 Display the contents of ELF format files.
105 List file section sizes and total size
108 List printable strings from files
114 Update the ELF header and program property of ELF files.
117 Demangle encoded C++ symbols (on MS-DOS, this program is named
121 Convert addresses into file names and line numbers
124 Manipulate Windows resources
127 Generator for Windows message resources
130 Create the files needed to build and use Dynamic Link Libraries
134 This document is distributed under the terms of the GNU Free
135 Documentation License version 1.3. A copy of the license is included
136 in the section entitled ``GNU Free Documentation License''.
139 * ar:: Create, modify, and extract from archives
140 * nm:: List symbols from object files
141 * objcopy:: Copy and translate object files
142 * objdump:: Display information from object files
143 * ranlib:: Generate index to archive contents
144 * size:: List section sizes and total size
145 * strings:: List printable strings from files
146 * strip:: Discard symbols
147 * c++filt:: Filter to demangle encoded C++ symbols
148 * cxxfilt: c++filt. MS-DOS name for c++filt
149 * addr2line:: Convert addresses to file and line
150 * windmc:: Generator for Windows message resources
151 * windres:: Manipulate Windows resources
152 * dlltool:: Create files needed to build and use DLLs
153 * readelf:: Display the contents of ELF format files
154 * elfedit:: Update ELF header and property of ELF files
155 * Common Options:: Command-line options for all utilities
156 * Selecting the Target System:: How these utilities determine the target
157 * Reporting Bugs:: Reporting Bugs
158 * GNU Free Documentation License:: GNU Free Documentation License
159 * Binutils Index:: Binutils Index
167 @cindex collections of files
169 @c man title ar create, modify, and extract from archives
172 ar [-]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@option{--output} @var{dirname}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
173 ar -M [ <mri-script ]
176 @c man begin DESCRIPTION ar
178 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
179 archives. An @dfn{archive} is a single file holding a collection of
180 other files in a structure that makes it possible to retrieve
181 the original individual files (called @dfn{members} of the archive).
183 The original files' contents, mode (permissions), timestamp, owner, and
184 group are preserved in the archive, and can be restored on
188 @sc{gnu} @command{ar} can maintain archives whose members have names of any
189 length; however, depending on how @command{ar} is configured on your
190 system, a limit on member-name length may be imposed for compatibility
191 with archive formats maintained with other tools. If it exists, the
192 limit is often 15 characters (typical of formats related to a.out) or 16
193 characters (typical of formats related to coff).
196 @command{ar} is considered a binary utility because archives of this sort
197 are most often used as @dfn{libraries} holding commonly needed
201 @command{ar} creates an index to the symbols defined in relocatable
202 object modules in the archive when you specify the modifier @samp{s}.
203 Once created, this index is updated in the archive whenever @command{ar}
204 makes a change to its contents (save for the @samp{q} update operation).
205 An archive with such an index speeds up linking to the library, and
206 allows routines in the library to call each other without regard to
207 their placement in the archive.
209 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
210 table. If an archive lacks the table, another form of @command{ar} called
211 @command{ranlib} can be used to add just the table.
213 @cindex thin archives
214 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
215 which contains a symbol index and references to the original copies
216 of the member files of the archive. This is useful for building
217 libraries for use within a local build tree, where the relocatable
218 objects are expected to remain available, and copying the contents of
219 each object would only waste time and space.
221 An archive can either be @emph{thin} or it can be normal. It cannot
222 be both at the same time. Once an archive is created its format
223 cannot be changed without first deleting it and then creating a new
224 archive in its place.
226 Thin archives are also @emph{flattened}, so that adding one thin
227 archive to another thin archive does not nest it, as would happen with
228 a normal archive. Instead the elements of the first archive are added
229 individually to the second archive.
231 The paths to the elements of the archive are stored relative to the
234 @cindex compatibility, @command{ar}
235 @cindex @command{ar} compatibility
236 @sc{gnu} @command{ar} is designed to be compatible with two different
237 facilities. You can control its activity using command-line options,
238 like the different varieties of @command{ar} on Unix systems; or, if you
239 specify the single command-line option @option{-M}, you can control it
240 with a script supplied via standard input, like the MRI ``librarian''
246 * ar cmdline:: Controlling @command{ar} on the command line
247 * ar scripts:: Controlling @command{ar} with a script
252 @section Controlling @command{ar} on the Command Line
255 @c man begin SYNOPSIS ar
256 ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@option{--output} @var{dirname}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
260 @cindex Unix compatibility, @command{ar}
261 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
262 arguments to execute: one keyletter specifying the @emph{operation}
263 (optionally accompanied by other keyletters specifying
264 @emph{modifiers}), and the archive name to act on.
266 Most operations can also accept further @var{member} arguments,
267 specifying particular files to operate on.
269 @c man begin OPTIONS ar
271 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
272 flags @var{mod} in any order, within the first command-line argument.
274 If you wish, you may begin the first command-line argument with a
277 @cindex operations on archive
278 The @var{p} keyletter specifies what operation to execute; it may be
279 any of the following, but you must specify only one of them:
283 @cindex deleting from archive
284 @emph{Delete} modules from the archive. Specify the names of modules to
285 be deleted as @var{member}@dots{}; the archive is untouched if you
286 specify no files to delete.
288 If you specify the @samp{v} modifier, @command{ar} lists each module
292 @cindex moving in archive
293 Use this operation to @emph{move} members in an archive.
295 The ordering of members in an archive can make a difference in how
296 programs are linked using the library, if a symbol is defined in more
299 If no modifiers are used with @code{m}, any members you name in the
300 @var{member} arguments are moved to the @emph{end} of the archive;
301 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
302 specified place instead.
305 @cindex printing from archive
306 @emph{Print} the specified members of the archive, to the standard
307 output file. If the @samp{v} modifier is specified, show the member
308 name before copying its contents to standard output.
310 If you specify no @var{member} arguments, all the files in the archive are
314 @cindex quick append to archive
315 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
316 @var{archive}, without checking for replacement.
318 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
319 operation; new members are always placed at the end of the archive.
321 The modifier @samp{v} makes @command{ar} list each file as it is appended.
323 Since the point of this operation is speed, implementations of
324 @command{ar} have the option of not updating the archive's symbol
325 table if one exists. Too many different systems however assume that
326 symbol tables are always up-to-date, so @sc{gnu} @command{ar} will
327 rebuild the table even with a quick append.
329 Note - @sc{gnu} @command{ar} treats the command @samp{qs} as a
330 synonym for @samp{r} - replacing already existing files in the
331 archive and appending new ones at the end.
334 @cindex replacement in archive
335 Insert the files @var{member}@dots{} into @var{archive} (with
336 @emph{replacement}). This operation differs from @samp{q} in that any
337 previously existing members are deleted if their names match those being
340 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
341 displays an error message, and leaves undisturbed any existing members
342 of the archive matching that name.
344 By default, new members are added at the end of the file; but you may
345 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
346 placement relative to some existing member.
348 The modifier @samp{v} used with this operation elicits a line of
349 output for each file inserted, along with one of the letters @samp{a} or
350 @samp{r} to indicate whether the file was appended (no old member
351 deleted) or replaced.
355 Add an index to the archive, or update it if it already exists. Note
356 this command is an exception to the rule that there can only be one
357 command letter, as it is possible to use it as either a command or a
358 modifier. In either case it does the same thing.
361 @cindex contents of archive
362 Display a @emph{table} listing the contents of @var{archive}, or those
363 of the files listed in @var{member}@dots{} that are present in the
364 archive. Normally only the member name is shown, but if the modifier
365 @samp{O} is specified, then the corresponding offset of the member is also
366 displayed. Finally, in order to see the modes (permissions), timestamp,
367 owner, group, and size the @samp{v} modifier should be included.
369 If you do not specify a @var{member}, all files in the archive
372 @cindex repeated names in archive
373 @cindex name duplication in archive
374 If there is more than one file with the same name (say, @samp{fie}) in
375 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
376 first instance; to see them all, you must ask for a complete
377 listing---in our example, @samp{ar t b.a}.
378 @c WRS only; per Gumby, this is implementation-dependent, and in a more
379 @c recent case in fact works the other way.
382 @cindex extract from archive
383 @emph{Extract} members (named @var{member}) from the archive. You can
384 use the @samp{v} modifier with this operation, to request that
385 @command{ar} list each name as it extracts it.
387 If you do not specify a @var{member}, all files in the archive
390 Files cannot be extracted from a thin archive, and there are
391 restrictions on extracting from archives created with @option{P}: The
392 paths must not be absolute, may not contain @code{..}, and any
393 subdirectories in the paths must exist.
396 A number of modifiers (@var{mod}) may immediately follow the @var{p}
397 keyletter, to specify variations on an operation's behavior:
401 @cindex relative placement in archive
402 Add new files @emph{after} an existing member of the
403 archive. If you use the modifier @samp{a}, the name of an existing archive
404 member must be present as the @var{relpos} argument, before the
405 @var{archive} specification.
408 Add new files @emph{before} an existing member of the
409 archive. If you use the modifier @samp{b}, the name of an existing archive
410 member must be present as the @var{relpos} argument, before the
411 @var{archive} specification. (same as @samp{i}).
414 @cindex creating archives
415 @emph{Create} the archive. The specified @var{archive} is always
416 created if it did not exist, when you request an update. But a warning is
417 issued unless you specify in advance that you expect to create it, by
421 @cindex deterministic archives
422 @kindex --enable-deterministic-archives
423 Operate in @emph{deterministic} mode. When adding files and the archive
424 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
425 for all files. When this option is used, if @command{ar} is used with
426 identical options and identical input files, multiple runs will create
427 identical output files regardless of the input files' owners, groups,
428 file modes, or modification times.
430 If @file{binutils} was configured with
431 @option{--enable-deterministic-archives}, then this mode is on by default.
432 It can be disabled with the @samp{U} modifier, below.
435 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
436 names of any length. This will cause it to create archives which are
437 not compatible with the native @command{ar} program on some systems. If
438 this is a concern, the @samp{f} modifier may be used to truncate file
439 names when putting them in the archive.
442 Insert new files @emph{before} an existing member of the
443 archive. If you use the modifier @samp{i}, the name of an existing archive
444 member must be present as the @var{relpos} argument, before the
445 @var{archive} specification. (same as @samp{b}).
448 This modifier is accepted but not used.
449 @c whaffor ar l modifier??? presumably compat; with
450 @c what???---doc@@cygnus.com, 25jan91
453 Uses the @var{count} parameter. This is used if there are multiple
454 entries in the archive with the same name. Extract or delete instance
455 @var{count} of the given name from the archive.
458 @cindex dates in archive
459 Preserve the @emph{original} dates of members when extracting them. If
460 you do not specify this modifier, files extracted from the archive
461 are stamped with the time of extraction.
464 @cindex offsets of files
465 Display member offsets inside the archive. Use together with the @samp{t}
469 Use the full path name when matching or storing names in the archive.
470 Archives created with full path names are not POSIX compliant, and
471 thus may not work with tools other than up to date @sc{gnu} tools.
472 Modifying such archives with @sc{gnu} @command{ar} without using
473 @option{P} will remove the full path names unless the archive is a
474 thin archive. Note that @option{P} may be useful when adding files to
475 a thin archive since @option{r} without @option{P} ignores the path
476 when choosing which element to replace. Thus
478 ar rcST archive.a subdir/file1 subdir/file2 file1
480 will result in the first @code{subdir/file1} being replaced with
481 @code{file1} from the current directory. Adding @option{P} will
482 prevent this replacement.
485 @cindex writing archive index
486 Write an object-file index into the archive, or update an existing one,
487 even if no other change is made to the archive. You may use this modifier
488 flag either with any operation, or alone. Running @samp{ar s} on an
489 archive is equivalent to running @samp{ranlib} on it.
492 @cindex not writing archive index
493 Do not generate an archive symbol table. This can speed up building a
494 large library in several steps. The resulting archive can not be used
495 with the linker. In order to build a symbol table, you must omit the
496 @samp{S} modifier on the last execution of @samp{ar}, or you must run
497 @samp{ranlib} on the archive.
500 @cindex creating thin archive
501 Make the specified @var{archive} a @emph{thin} archive. If it already
502 exists and is a regular archive, the existing members must be present
503 in the same directory as @var{archive}.
506 @cindex updating an archive
507 Normally, @samp{ar r}@dots{} inserts all files
508 listed into the archive. If you would like to insert @emph{only} those
509 of the files you list that are newer than existing members of the same
510 names, use this modifier. The @samp{u} modifier is allowed only for the
511 operation @samp{r} (replace). In particular, the combination @samp{qu} is
512 not allowed, since checking the timestamps would lose any speed
513 advantage from the operation @samp{q}.
516 @cindex deterministic archives
517 @kindex --enable-deterministic-archives
518 Do @emph{not} operate in @emph{deterministic} mode. This is the inverse
519 of the @samp{D} modifier, above: added files and the archive index will
520 get their actual UID, GID, timestamp, and file mode values.
522 This is the default unless @file{binutils} was configured with
523 @option{--enable-deterministic-archives}.
526 This modifier requests the @emph{verbose} version of an operation. Many
527 operations display additional information, such as filenames processed,
528 when the modifier @samp{v} is appended.
531 This modifier shows the version number of @command{ar}.
534 The @command{ar} program also supports some command-line options which
535 are neither modifiers nor actions, but which do change its behaviour
540 Displays the list of command-line options supported by @command{ar}
544 Displays the version information of @command{ar} and then exits.
547 @command{ar} ignores an initial option spelled @samp{-X32_64}, for
548 compatibility with AIX. The behaviour produced by this option is the
549 default for @sc{gnu} @command{ar}. @command{ar} does not support any
550 of the other @samp{-X} options; in particular, it does not support
551 @option{-X32} which is the default for AIX @command{ar}.
553 @item --plugin @var{name}
555 The optional command-line switch @option{--plugin @var{name}} causes
556 @command{ar} to load the plugin called @var{name} which adds support
557 for more file formats, including object files with link-time
558 optimization information.
560 This option is only available if the toolchain has been built with
561 plugin support enabled.
563 If @option{--plugin} is not provided, but plugin support has been
564 enabled then @command{ar} iterates over the files in
565 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
566 plugin that claims the object in question is used.
568 Please note that this plugin search directory is @emph{not} the one
569 used by @command{ld}'s @option{-plugin} option. In order to make
570 @command{ar} use the linker plugin it must be copied into the
571 @file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
572 the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
573 based compilations it is called @file{LLVMgold.so}. The GCC plugin
574 is always backwards compatible with earlier versions, so it is
575 sufficient to just copy the newest one.
577 @item --target @var{target}
578 The optional command-line switch @option{--target @var{bfdname}}
579 specifies that the archive members are in an object code format
580 different from your system's default format. See
581 @xref{Target Selection}, for more information.
583 @item --output @var{dirname}
584 The @option{--output} option can be used to specify a path to a
585 directory into which archive members should be extracted. If this
586 option is not specified then the current directory will be used.
588 Note - although the presence of this option does imply a @option{x}
589 extraction operation that option must still be included on the command
592 Note - using this option does not allow archive members to be
593 extracted to locations outside of the current directory, or one of its
594 sub-directories. This is a security feature to prevent archives
595 created with the @option{P} option from maliciously overwriting user
601 @c man begin SEEALSO ar
602 nm(1), ranlib(1), and the Info entries for @file{binutils}.
607 @section Controlling @command{ar} with a Script
610 ar -M [ <@var{script} ]
613 @cindex MRI compatibility, @command{ar}
614 @cindex scripts, @command{ar}
615 If you use the single command-line option @samp{-M} with @command{ar}, you
616 can control its operation with a rudimentary command language. This
617 form of @command{ar} operates interactively if standard input is coming
618 directly from a terminal. During interactive use, @command{ar} prompts for
619 input (the prompt is @samp{AR >}), and continues executing even after
620 errors. If you redirect standard input to a script file, no prompts are
621 issued, and @command{ar} abandons execution (with a nonzero exit code)
624 The @command{ar} command language is @emph{not} designed to be equivalent
625 to the command-line options; in fact, it provides somewhat less control
626 over archives. The only purpose of the command language is to ease the
627 transition to @sc{gnu} @command{ar} for developers who already have scripts
628 written for the MRI ``librarian'' program.
630 The syntax for the @command{ar} command language is straightforward:
633 commands are recognized in upper or lower case; for example, @code{LIST}
634 is the same as @code{list}. In the following descriptions, commands are
635 shown in upper case for clarity.
638 a single command may appear on each line; it is the first word on the
642 empty lines are allowed, and have no effect.
645 comments are allowed; text after either of the characters @samp{*}
646 or @samp{;} is ignored.
649 Whenever you use a list of names as part of the argument to an @command{ar}
650 command, you can separate the individual names with either commas or
651 blanks. Commas are shown in the explanations below, for clarity.
654 @samp{+} is used as a line continuation character; if @samp{+} appears
655 at the end of a line, the text on the following line is considered part
656 of the current command.
659 Here are the commands you can use in @command{ar} scripts, or when using
660 @command{ar} interactively. Three of them have special significance:
662 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
663 a temporary file required for most of the other commands.
665 @code{SAVE} commits the changes so far specified by the script. Prior
666 to @code{SAVE}, commands affect only the temporary copy of the current
670 @item ADDLIB @var{archive}
671 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
672 Add all the contents of @var{archive} (or, if specified, each named
673 @var{module} from @var{archive}) to the current archive.
675 Requires prior use of @code{OPEN} or @code{CREATE}.
677 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
678 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
679 @c else like "ar q..."
680 Add each named @var{member} as a module in the current archive.
682 Requires prior use of @code{OPEN} or @code{CREATE}.
685 Discard the contents of the current archive, canceling the effect of
686 any operations since the last @code{SAVE}. May be executed (with no
687 effect) even if no current archive is specified.
689 @item CREATE @var{archive}
690 Creates an archive, and makes it the current archive (required for many
691 other commands). The new archive is created with a temporary name; it
692 is not actually saved as @var{archive} until you use @code{SAVE}.
693 You can overwrite existing archives; similarly, the contents of any
694 existing file named @var{archive} will not be destroyed until @code{SAVE}.
696 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
697 Delete each listed @var{module} from the current archive; equivalent to
698 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
700 Requires prior use of @code{OPEN} or @code{CREATE}.
702 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
703 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
704 List each named @var{module} present in @var{archive}. The separate
705 command @code{VERBOSE} specifies the form of the output: when verbose
706 output is off, output is like that of @samp{ar -t @var{archive}
707 @var{module}@dots{}}. When verbose output is on, the listing is like
708 @samp{ar -tv @var{archive} @var{module}@dots{}}.
710 Output normally goes to the standard output stream; however, if you
711 specify @var{outputfile} as a final argument, @command{ar} directs the
715 Exit from @command{ar}, with a @code{0} exit code to indicate successful
716 completion. This command does not save the output file; if you have
717 changed the current archive since the last @code{SAVE} command, those
720 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
721 Extract each named @var{module} from the current archive, writing them
722 into the current directory as separate files. Equivalent to @samp{ar -x
723 @var{archive} @var{module}@dots{}}.
725 Requires prior use of @code{OPEN} or @code{CREATE}.
728 @c FIXME Tokens but no commands???
735 Display full contents of the current archive, in ``verbose'' style
736 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
737 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
738 enhancement, rather than present for MRI compatibility.)
740 Requires prior use of @code{OPEN} or @code{CREATE}.
742 @item OPEN @var{archive}
743 Opens an existing archive for use as the current archive (required for
744 many other commands). Any changes as the result of subsequent commands
745 will not actually affect @var{archive} until you next use @code{SAVE}.
747 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
748 In the current archive, replace each existing @var{module} (named in
749 the @code{REPLACE} arguments) from files in the current working directory.
750 To execute this command without errors, both the file, and the module in
751 the current archive, must exist.
753 Requires prior use of @code{OPEN} or @code{CREATE}.
756 Toggle an internal flag governing the output from @code{DIRECTORY}.
757 When the flag is on, @code{DIRECTORY} output matches output from
758 @samp{ar -tv }@dots{}.
761 Commit your changes to the current archive, and actually save it as a
762 file with the name specified in the last @code{CREATE} or @code{OPEN}
765 Requires prior use of @code{OPEN} or @code{CREATE}.
774 The @sc{gnu} linker @command{ld} is now described in a separate manual.
775 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
783 @c man title nm list symbols from object files
786 @c man begin SYNOPSIS nm
787 nm [@option{-A}|@option{-o}|@option{--print-file-name}] [@option{-a}|@option{--debug-syms}]
788 [@option{-B}|@option{--format=bsd}] [@option{-C}|@option{--demangle}[=@var{style}]]
789 [@option{-D}|@option{--dynamic}] [@option{-f}@var{format}|@option{--format=}@var{format}]
790 [@option{-g}|@option{--extern-only}] [@option{-h}|@option{--help}]
791 [@option{-l}|@option{--line-numbers}] [@option{--inlines}]
792 [@option{-n}|@option{-v}|@option{--numeric-sort}]
793 [@option{-P}|@option{--portability}] [@option{-p}|@option{--no-sort}]
794 [@option{-r}|@option{--reverse-sort}] [@option{-S}|@option{--print-size}]
795 [@option{-s}|@option{--print-armap}] [@option{-t} @var{radix}|@option{--radix=}@var{radix}]
796 [@option{-u}|@option{--undefined-only}] [@option{-V}|@option{--version}]
797 [@option{-X 32_64}] [@option{--defined-only}] [@option{--no-demangle}]
798 [@option{--plugin} @var{name}]
799 [@option{--no-recurse-limit}|@option{--recurse-limit}]]
800 [@option{--size-sort}] [@option{--special-syms}]
801 [@option{--synthetic}] [@option{--with-symbol-versions}] [@option{--target=}@var{bfdname}]
802 [@var{objfile}@dots{}]
806 @c man begin DESCRIPTION nm
807 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
808 If no object files are listed as arguments, @command{nm} assumes the file
811 For each symbol, @command{nm} shows:
815 The symbol value, in the radix selected by options (see below), or
816 hexadecimal by default.
819 The symbol type. At least the following types are used; others are, as
820 well, depending on the object file format. If lowercase, the symbol is
821 usually local; if uppercase, the symbol is global (external). There
822 are however a few lowercase symbols that are shown for special global
823 symbols (@code{u}, @code{v} and @code{w}).
825 @c Some more detail on exactly what these symbol types are used for
829 The symbol's value is absolute, and will not be changed by further
834 The symbol is in the BSS data section. This section typically
835 contains zero-initialized or uninitialized data, although the exact
836 behavior is system dependent.
839 The symbol is common. Common symbols are uninitialized data. When
840 linking, multiple common symbols may appear with the same name. If the
841 symbol is defined anywhere, the common symbols are treated as undefined
844 For more details on common symbols, see the discussion of
845 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
850 The symbol is in the initialized data section.
854 The symbol is in an initialized data section for small objects. Some
855 object file formats permit more efficient access to small data objects,
856 such as a global int variable as opposed to a large global array.
859 For PE format files this indicates that the symbol is in a section
860 specific to the implementation of DLLs. For ELF format files this
861 indicates that the symbol is an indirect function. This is a GNU
862 extension to the standard set of ELF symbol types. It indicates a
863 symbol which if referenced by a relocation does not evaluate to its
864 address, but instead must be invoked at runtime. The runtime
865 execution will then return the value to be used in the relocation.
868 The symbol is an indirect reference to another symbol.
871 The symbol is a debugging symbol.
874 The symbol is in the read-only data section.
877 The symbol is in a stack unwind section.
881 The symbol is in a read only data section.
885 The symbol is in an uninitialized or zero-initialized data section
890 The symbol is in the text (code) section.
893 The symbol is undefined.
896 The symbol is a unique global symbol. This is a GNU extension to the
897 standard set of ELF symbol bindings. For such a symbol the dynamic linker
898 will make sure that in the entire process there is just one symbol with
899 this name and type in use.
903 The symbol is a weak object. When a weak defined symbol is linked with
904 a normal defined symbol, the normal defined symbol is used with no error.
905 When a weak undefined symbol is linked and the symbol is not defined,
906 the value of the weak symbol becomes zero with no error. On some
907 systems, uppercase indicates that a default value has been specified.
911 The symbol is a weak symbol that has not been specifically tagged as a
912 weak object symbol. When a weak defined symbol is linked with a normal
913 defined symbol, the normal defined symbol is used with no error.
914 When a weak undefined symbol is linked and the symbol is not defined,
915 the value of the symbol is determined in a system-specific manner without
916 error. On some systems, uppercase indicates that a default value has been
920 The symbol is a stabs symbol in an a.out object file. In this case, the
921 next values printed are the stabs other field, the stabs desc field, and
922 the stab type. Stabs symbols are used to hold debugging information.
925 The symbol type is unknown, or object file format specific.
934 @c man begin OPTIONS nm
935 The long and short forms of options, shown here as alternatives, are
941 @itemx --print-file-name
942 @cindex input file name
944 @cindex source file name
945 Precede each symbol by the name of the input file (or archive member)
946 in which it was found, rather than identifying the input file once only,
947 before all of its symbols.
951 @cindex debugging symbols
952 Display all symbols, even debugger-only symbols; normally these are not
956 @cindex @command{nm} format
957 @cindex @command{nm} compatibility
958 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
961 @itemx --demangle[=@var{style}]
962 @cindex demangling in nm
963 Decode (@dfn{demangle}) low-level symbol names into user-level names.
964 Besides removing any initial underscore prepended by the system, this
965 makes C++ function names readable. Different compilers have different
966 mangling styles. The optional demangling style argument can be used to
967 choose an appropriate demangling style for your compiler. @xref{c++filt},
968 for more information on demangling.
971 Do not demangle low-level symbol names. This is the default.
973 @item --recurse-limit
974 @itemx --no-recurse-limit
975 @itemx --recursion-limit
976 @itemx --no-recursion-limit
977 Enables or disables a limit on the amount of recursion performed
978 whilst demangling strings. Since the name mangling formats allow for
979 an inifinite level of recursion it is possible to create strings whose
980 decoding will exhaust the amount of stack space available on the host
981 machine, triggering a memory fault. The limit tries to prevent this
982 from happening by restricting recursion to 2048 levels of nesting.
984 The default is for this limit to be enabled, but disabling it may be
985 necessary in order to demangle truly complicated names. Note however
986 that if the recursion limit is disabled then stack exhaustion is
987 possible and any bug reports about such an event will be rejected.
991 @cindex dynamic symbols
992 Display the dynamic symbols rather than the normal symbols. This is
993 only meaningful for dynamic objects, such as certain types of shared
996 @item -f @var{format}
997 @itemx --format=@var{format}
998 @cindex @command{nm} format
999 @cindex @command{nm} compatibility
1000 Use the output format @var{format}, which can be @code{bsd},
1001 @code{sysv}, or @code{posix}. The default is @code{bsd}.
1002 Only the first character of @var{format} is significant; it can be
1003 either upper or lower case.
1006 @itemx --extern-only
1007 @cindex external symbols
1008 Display only external symbols.
1012 Show a summary of the options to @command{nm} and exit.
1015 @itemx --line-numbers
1016 @cindex symbol line numbers
1017 For each symbol, use debugging information to try to find a filename and
1018 line number. For a defined symbol, look for the line number of the
1019 address of the symbol. For an undefined symbol, look for the line
1020 number of a relocation entry which refers to the symbol. If line number
1021 information can be found, print it after the other symbol information.
1024 @cindex objdump inlines
1025 When option @option{-l} is active, if the address belongs to a
1026 function that was inlined, then this option causes the source
1027 information for all enclosing scopes back to the first non-inlined
1028 function to be printed as well. For example, if @code{main} inlines
1029 @code{callee1} which inlines @code{callee2}, and address is from
1030 @code{callee2}, the source information for @code{callee1} and @code{main}
1031 will also be printed.
1035 @itemx --numeric-sort
1036 Sort symbols numerically by their addresses, rather than alphabetically
1041 @cindex sorting symbols
1042 Do not bother to sort the symbols in any order; print them in the order
1046 @itemx --portability
1047 Use the POSIX.2 standard output format instead of the default format.
1048 Equivalent to @samp{-f posix}.
1051 @itemx --reverse-sort
1052 Reverse the order of the sort (whether numeric or alphabetic); let the
1057 Print both value and size of defined symbols for the @code{bsd} output style.
1058 This option has no effect for object formats that do not record symbol
1059 sizes, unless @samp{--size-sort} is also used in which case a
1060 calculated size is displayed.
1063 @itemx --print-armap
1064 @cindex symbol index, listing
1065 When listing symbols from archive members, include the index: a mapping
1066 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
1067 contain definitions for which names.
1069 @item -t @var{radix}
1070 @itemx --radix=@var{radix}
1071 Use @var{radix} as the radix for printing the symbol values. It must be
1072 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
1075 @itemx --undefined-only
1076 @cindex external symbols
1077 @cindex undefined symbols
1078 Display only undefined symbols (those external to each object file).
1082 Show the version number of @command{nm} and exit.
1085 This option is ignored for compatibility with the AIX version of
1086 @command{nm}. It takes one parameter which must be the string
1087 @option{32_64}. The default mode of AIX @command{nm} corresponds
1088 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1090 @item --defined-only
1091 @cindex external symbols
1092 @cindex undefined symbols
1093 Display only defined symbols for each object file.
1095 @item --plugin @var{name}
1097 Load the plugin called @var{name} to add support for extra target
1098 types. This option is only available if the toolchain has been built
1099 with plugin support enabled.
1101 If @option{--plugin} is not provided, but plugin support has been
1102 enabled then @command{nm} iterates over the files in
1103 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
1104 plugin that claims the object in question is used.
1106 Please note that this plugin search directory is @emph{not} the one
1107 used by @command{ld}'s @option{-plugin} option. In order to make
1108 @command{nm} use the linker plugin it must be copied into the
1109 @file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
1110 the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
1111 based compilations it is called @file{LLVMgold.so}. The GCC plugin
1112 is always backwards compatible with earlier versions, so it is
1113 sufficient to just copy the newest one.
1116 Sort symbols by size. For ELF objects symbol sizes are read from the
1117 ELF, for other object types the symbol sizes are computed as the
1118 difference between the value of the symbol and the value of the symbol
1119 with the next higher value. If the @code{bsd} output format is used
1120 the size of the symbol is printed, rather than the value, and
1121 @samp{-S} must be used in order both size and value to be printed.
1123 @item --special-syms
1124 Display symbols which have a target-specific special meaning. These
1125 symbols are usually used by the target for some special processing and
1126 are not normally helpful when included in the normal symbol lists.
1127 For example for ARM targets this option would skip the mapping symbols
1128 used to mark transitions between ARM code, THUMB code and data.
1131 Include synthetic symbols in the output. These are special symbols
1132 created by the linker for various purposes. They are not shown by
1133 default since they are not part of the binary's original source code.
1135 @item --with-symbol-versions
1136 Enables the display of symbol version information if any exists. The
1137 version string is displayed as a suffix to the symbol name, preceeded by
1138 an @@ character. For example @samp{foo@@VER_1}. If the version is
1139 the default version to be used when resolving unversioned references
1140 to the symbol then it is displayed as a suffix preceeded by two @@
1141 characters. For example @samp{foo@@@@VER_2}.
1143 @item --target=@var{bfdname}
1144 @cindex object code format
1145 Specify an object code format other than your system's default format.
1146 @xref{Target Selection}, for more information.
1153 @c man begin SEEALSO nm
1154 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1161 @c man title objcopy copy and translate object files
1164 @c man begin SYNOPSIS objcopy
1165 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1166 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1167 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1168 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1169 [@option{-S}|@option{--strip-all}]
1170 [@option{-g}|@option{--strip-debug}]
1171 [@option{--strip-unneeded}]
1172 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1173 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1174 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1175 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1176 [@option{--localize-hidden}]
1177 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1178 [@option{--globalize-symbol=}@var{symbolname}]
1179 [@option{--globalize-symbols=}@var{filename}]
1180 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1181 [@option{-w}|@option{--wildcard}]
1182 [@option{-x}|@option{--discard-all}]
1183 [@option{-X}|@option{--discard-locals}]
1184 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1185 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1186 [@option{--interleave-width=}@var{width}]
1187 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1188 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1189 [@option{--keep-section=}@var{sectionpattern}]
1190 [@option{--remove-relocations=}@var{sectionpattern}]
1191 [@option{-p}|@option{--preserve-dates}]
1192 [@option{-D}|@option{--enable-deterministic-archives}]
1193 [@option{-U}|@option{--disable-deterministic-archives}]
1194 [@option{--debugging}]
1195 [@option{--gap-fill=}@var{val}]
1196 [@option{--pad-to=}@var{address}]
1197 [@option{--set-start=}@var{val}]
1198 [@option{--adjust-start=}@var{incr}]
1199 [@option{--change-addresses=}@var{incr}]
1200 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1201 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1202 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1203 [@option{--change-warnings}] [@option{--no-change-warnings}]
1204 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1205 [@option{--set-section-alignment} @var{sectionpattern}=@var{align}]
1206 [@option{--add-section} @var{sectionname}=@var{filename}]
1207 [@option{--dump-section} @var{sectionname}=@var{filename}]
1208 [@option{--update-section} @var{sectionname}=@var{filename}]
1209 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1210 [@option{--long-section-names} @{enable,disable,keep@}]
1211 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1212 [@option{--reverse-bytes=}@var{num}]
1213 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1214 [@option{--redefine-sym} @var{old}=@var{new}]
1215 [@option{--redefine-syms=}@var{filename}]
1217 [@option{--keep-symbols=}@var{filename}]
1218 [@option{--strip-symbols=}@var{filename}]
1219 [@option{--strip-unneeded-symbols=}@var{filename}]
1220 [@option{--keep-global-symbols=}@var{filename}]
1221 [@option{--localize-symbols=}@var{filename}]
1222 [@option{--weaken-symbols=}@var{filename}]
1223 [@option{--add-symbol} @var{name}=[@var{section}:]@var{value}[,@var{flags}]]
1224 [@option{--alt-machine-code=}@var{index}]
1225 [@option{--prefix-symbols=}@var{string}]
1226 [@option{--prefix-sections=}@var{string}]
1227 [@option{--prefix-alloc-sections=}@var{string}]
1228 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1229 [@option{--keep-file-symbols}]
1230 [@option{--only-keep-debug}]
1231 [@option{--strip-dwo}]
1232 [@option{--extract-dwo}]
1233 [@option{--extract-symbol}]
1234 [@option{--writable-text}]
1235 [@option{--readonly-text}]
1238 [@option{--file-alignment=}@var{num}]
1239 [@option{--heap=}@var{size}]
1240 [@option{--image-base=}@var{address}]
1241 [@option{--section-alignment=}@var{num}]
1242 [@option{--stack=}@var{size}]
1243 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1244 [@option{--compress-debug-sections}]
1245 [@option{--decompress-debug-sections}]
1246 [@option{--elf-stt-common=@var{val}}]
1247 [@option{--merge-notes}]
1248 [@option{--no-merge-notes}]
1249 [@option{--verilog-data-width=@var{val}}]
1250 [@option{-v}|@option{--verbose}]
1251 [@option{-V}|@option{--version}]
1252 [@option{--help}] [@option{--info}]
1253 @var{infile} [@var{outfile}]
1257 @c man begin DESCRIPTION objcopy
1258 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1259 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1260 read and write the object files. It can write the destination object
1261 file in a format different from that of the source object file. The
1262 exact behavior of @command{objcopy} is controlled by command-line options.
1263 Note that @command{objcopy} should be able to copy a fully linked file
1264 between any two formats. However, copying a relocatable object file
1265 between any two formats may not work as expected.
1267 @command{objcopy} creates temporary files to do its translations and
1268 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1269 translation work; it has access to all the formats described in @sc{bfd}
1270 and thus is able to recognize most formats without being told
1271 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1273 @command{objcopy} can be used to generate S-records by using an output
1274 target of @samp{srec} (e.g., use @samp{-O srec}).
1276 @command{objcopy} can be used to generate a raw binary file by using an
1277 output target of @samp{binary} (e.g., use @option{-O binary}). When
1278 @command{objcopy} generates a raw binary file, it will essentially produce
1279 a memory dump of the contents of the input object file. All symbols and
1280 relocation information will be discarded. The memory dump will start at
1281 the load address of the lowest section copied into the output file.
1283 When generating an S-record or a raw binary file, it may be helpful to
1284 use @option{-S} to remove sections containing debugging information. In
1285 some cases @option{-R} will be useful to remove sections which contain
1286 information that is not needed by the binary file.
1288 Note---@command{objcopy} is not able to change the endianness of its input
1289 files. If the input format has an endianness (some formats do not),
1290 @command{objcopy} can only copy the inputs into file formats that have the
1291 same endianness or which have no endianness (e.g., @samp{srec}).
1292 (However, see the @option{--reverse-bytes} option.)
1296 @c man begin OPTIONS objcopy
1300 @itemx @var{outfile}
1301 The input and output files, respectively.
1302 If you do not specify @var{outfile}, @command{objcopy} creates a
1303 temporary file and destructively renames the result with
1304 the name of @var{infile}.
1306 @item -I @var{bfdname}
1307 @itemx --input-target=@var{bfdname}
1308 Consider the source file's object format to be @var{bfdname}, rather than
1309 attempting to deduce it. @xref{Target Selection}, for more information.
1311 @item -O @var{bfdname}
1312 @itemx --output-target=@var{bfdname}
1313 Write the output file using the object format @var{bfdname}.
1314 @xref{Target Selection}, for more information.
1316 @item -F @var{bfdname}
1317 @itemx --target=@var{bfdname}
1318 Use @var{bfdname} as the object format for both the input and the output
1319 file; i.e., simply transfer data from source to destination with no
1320 translation. @xref{Target Selection}, for more information.
1322 @item -B @var{bfdarch}
1323 @itemx --binary-architecture=@var{bfdarch}
1324 Useful when transforming a architecture-less input file into an object file.
1325 In this case the output architecture can be set to @var{bfdarch}. This
1326 option will be ignored if the input file has a known @var{bfdarch}. You
1327 can access this binary data inside a program by referencing the special
1328 symbols that are created by the conversion process. These symbols are
1329 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1330 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1331 an object file and then access it in your code using these symbols.
1333 @item -j @var{sectionpattern}
1334 @itemx --only-section=@var{sectionpattern}
1335 Copy only the indicated sections from the input file to the output file.
1336 This option may be given more than once. Note that using this option
1337 inappropriately may make the output file unusable. Wildcard
1338 characters are accepted in @var{sectionpattern}.
1340 If the first character of @var{sectionpattern} is the exclamation
1341 point (!) then matching sections will not be copied, even if earlier
1342 use of @option{--only-section} on the same command line would
1343 otherwise copy it. For example:
1346 --only-section=.text.* --only-section=!.text.foo
1349 will copy all sectinos maching '.text.*' but not the section
1352 @item -R @var{sectionpattern}
1353 @itemx --remove-section=@var{sectionpattern}
1354 Remove any section matching @var{sectionpattern} from the output file.
1355 This option may be given more than once. Note that using this option
1356 inappropriately may make the output file unusable. Wildcard
1357 characters are accepted in @var{sectionpattern}. Using both the
1358 @option{-j} and @option{-R} options together results in undefined
1361 If the first character of @var{sectionpattern} is the exclamation
1362 point (!) then matching sections will not be removed even if an
1363 earlier use of @option{--remove-section} on the same command line
1364 would otherwise remove it. For example:
1367 --remove-section=.text.* --remove-section=!.text.foo
1370 will remove all sections matching the pattern '.text.*', but will not
1371 remove the section '.text.foo'.
1373 @item --keep-section=@var{sectionpattern}
1374 When removing sections from the output file, keep sections that match
1375 @var{sectionpattern}.
1377 @item --remove-relocations=@var{sectionpattern}
1378 Remove non-dynamic relocations from the output file for any section
1379 matching @var{sectionpattern}. This option may be given more than
1380 once. Note that using this option inappropriately may make the output
1381 file unusable, and attempting to remove a dynamic relocation section
1382 such as @samp{.rela.plt} from an executable or shared library with
1383 @option{--remove-relocations=.plt} will not work. Wildcard characters
1384 are accepted in @var{sectionpattern}.
1388 --remove-relocations=.text.*
1391 will remove the relocations for all sections matching the pattern
1394 If the first character of @var{sectionpattern} is the exclamation
1395 point (!) then matching sections will not have their relocation
1396 removed even if an earlier use of @option{--remove-relocations} on the
1397 same command line would otherwise cause the relocations to be removed.
1401 --remove-relocations=.text.* --remove-relocations=!.text.foo
1404 will remove all relocations for sections matching the pattern
1405 '.text.*', but will not remove relocations for the section
1410 Do not copy relocation and symbol information from the source file.
1413 @itemx --strip-debug
1414 Do not copy debugging symbols or sections from the source file.
1416 @item --strip-unneeded
1417 Strip all symbols that are not needed for relocation processing.
1419 @item -K @var{symbolname}
1420 @itemx --keep-symbol=@var{symbolname}
1421 When stripping symbols, keep symbol @var{symbolname} even if it would
1422 normally be stripped. This option may be given more than once.
1424 @item -N @var{symbolname}
1425 @itemx --strip-symbol=@var{symbolname}
1426 Do not copy symbol @var{symbolname} from the source file. This option
1427 may be given more than once.
1429 @item --strip-unneeded-symbol=@var{symbolname}
1430 Do not copy symbol @var{symbolname} from the source file unless it is needed
1431 by a relocation. This option may be given more than once.
1433 @item -G @var{symbolname}
1434 @itemx --keep-global-symbol=@var{symbolname}
1435 Keep only symbol @var{symbolname} global. Make all other symbols local
1436 to the file, so that they are not visible externally. This option may
1437 be given more than once. Note: this option cannot be used in
1438 conjunction with the @option{--globalize-symbol} or
1439 @option{--globalize-symbols} options.
1441 @item --localize-hidden
1442 In an ELF object, mark all symbols that have hidden or internal visibility
1443 as local. This option applies on top of symbol-specific localization options
1444 such as @option{-L}.
1446 @item -L @var{symbolname}
1447 @itemx --localize-symbol=@var{symbolname}
1448 Convert a global or weak symbol called @var{symbolname} into a local
1449 symbol, so that it is not visible externally. This option may be
1450 given more than once. Note - unique symbols are not converted.
1452 @item -W @var{symbolname}
1453 @itemx --weaken-symbol=@var{symbolname}
1454 Make symbol @var{symbolname} weak. This option may be given more than once.
1456 @item --globalize-symbol=@var{symbolname}
1457 Give symbol @var{symbolname} global scoping so that it is visible
1458 outside of the file in which it is defined. This option may be given
1459 more than once. Note: this option cannot be used in conjunction with
1460 the @option{-G} or @option{--keep-global-symbol} options.
1464 Permit regular expressions in @var{symbolname}s used in other command
1465 line options. The question mark (?), asterisk (*), backslash (\) and
1466 square brackets ([]) operators can be used anywhere in the symbol
1467 name. If the first character of the symbol name is the exclamation
1468 point (!) then the sense of the switch is reversed for that symbol.
1475 would cause objcopy to weaken all symbols that start with ``fo''
1476 except for the symbol ``foo''.
1479 @itemx --discard-all
1480 Do not copy non-global symbols from the source file.
1481 @c FIXME any reason to prefer "non-global" to "local" here?
1484 @itemx --discard-locals
1485 Do not copy compiler-generated local symbols.
1486 (These usually start with @samp{L} or @samp{.}.)
1489 @itemx --byte=@var{byte}
1490 If interleaving has been enabled via the @option{--interleave} option
1491 then start the range of bytes to keep at the @var{byte}th byte.
1492 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1493 @var{breadth} is the value given by the @option{--interleave} option.
1495 @item -i [@var{breadth}]
1496 @itemx --interleave[=@var{breadth}]
1497 Only copy a range out of every @var{breadth} bytes. (Header data is
1498 not affected). Select which byte in the range begins the copy with
1499 the @option{--byte} option. Select the width of the range with the
1500 @option{--interleave-width} option.
1502 This option is useful for creating files to program @sc{rom}. It is
1503 typically used with an @code{srec} output target. Note that
1504 @command{objcopy} will complain if you do not specify the
1505 @option{--byte} option as well.
1507 The default interleave breadth is 4, so with @option{--byte} set to 0,
1508 @command{objcopy} would copy the first byte out of every four bytes
1509 from the input to the output.
1511 @item --interleave-width=@var{width}
1512 When used with the @option{--interleave} option, copy @var{width}
1513 bytes at a time. The start of the range of bytes to be copied is set
1514 by the @option{--byte} option, and the extent of the range is set with
1515 the @option{--interleave} option.
1517 The default value for this option is 1. The value of @var{width} plus
1518 the @var{byte} value set by the @option{--byte} option must not exceed
1519 the interleave breadth set by the @option{--interleave} option.
1521 This option can be used to create images for two 16-bit flashes interleaved
1522 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1523 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1524 commands. If the input was '12345678' then the outputs would be
1525 '1256' and '3478' respectively.
1528 @itemx --preserve-dates
1529 Set the access and modification dates of the output file to be the same
1530 as those of the input file.
1533 @itemx --enable-deterministic-archives
1534 @cindex deterministic archives
1535 @kindex --enable-deterministic-archives
1536 Operate in @emph{deterministic} mode. When copying archive members
1537 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1538 and use consistent file modes for all files.
1540 If @file{binutils} was configured with
1541 @option{--enable-deterministic-archives}, then this mode is on by default.
1542 It can be disabled with the @samp{-U} option, below.
1545 @itemx --disable-deterministic-archives
1546 @cindex deterministic archives
1547 @kindex --enable-deterministic-archives
1548 Do @emph{not} operate in @emph{deterministic} mode. This is the
1549 inverse of the @option{-D} option, above: when copying archive members
1550 and writing the archive index, use their actual UID, GID, timestamp,
1551 and file mode values.
1553 This is the default unless @file{binutils} was configured with
1554 @option{--enable-deterministic-archives}.
1557 Convert debugging information, if possible. This is not the default
1558 because only certain debugging formats are supported, and the
1559 conversion process can be time consuming.
1561 @item --gap-fill @var{val}
1562 Fill gaps between sections with @var{val}. This operation applies to
1563 the @emph{load address} (LMA) of the sections. It is done by increasing
1564 the size of the section with the lower address, and filling in the extra
1565 space created with @var{val}.
1567 @item --pad-to @var{address}
1568 Pad the output file up to the load address @var{address}. This is
1569 done by increasing the size of the last section. The extra space is
1570 filled in with the value specified by @option{--gap-fill} (default zero).
1572 @item --set-start @var{val}
1573 Set the start address of the new file to @var{val}. Not all object file
1574 formats support setting the start address.
1576 @item --change-start @var{incr}
1577 @itemx --adjust-start @var{incr}
1578 @cindex changing start address
1579 Change the start address by adding @var{incr}. Not all object file
1580 formats support setting the start address.
1582 @item --change-addresses @var{incr}
1583 @itemx --adjust-vma @var{incr}
1584 @cindex changing object addresses
1585 Change the VMA and LMA addresses of all sections, as well as the start
1586 address, by adding @var{incr}. Some object file formats do not permit
1587 section addresses to be changed arbitrarily. Note that this does not
1588 relocate the sections; if the program expects sections to be loaded at a
1589 certain address, and this option is used to change the sections such
1590 that they are loaded at a different address, the program may fail.
1592 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1593 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1594 @cindex changing section address
1595 Set or change both the VMA address and the LMA address of any section
1596 matching @var{sectionpattern}. If @samp{=} is used, the section
1597 address is set to @var{val}. Otherwise, @var{val} is added to or
1598 subtracted from the section address. See the comments under
1599 @option{--change-addresses}, above. If @var{sectionpattern} does not
1600 match any sections in the input file, a warning will be issued, unless
1601 @option{--no-change-warnings} is used.
1603 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1604 @cindex changing section LMA
1605 Set or change the LMA address of any sections matching
1606 @var{sectionpattern}. The LMA address is the address where the
1607 section will be loaded into memory at program load time. Normally
1608 this is the same as the VMA address, which is the address of the
1609 section at program run time, but on some systems, especially those
1610 where a program is held in ROM, the two can be different. If @samp{=}
1611 is used, the section address is set to @var{val}. Otherwise,
1612 @var{val} is added to or subtracted from the section address. See the
1613 comments under @option{--change-addresses}, above. If
1614 @var{sectionpattern} does not match any sections in the input file, a
1615 warning will be issued, unless @option{--no-change-warnings} is used.
1617 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1618 @cindex changing section VMA
1619 Set or change the VMA address of any section matching
1620 @var{sectionpattern}. The VMA address is the address where the
1621 section will be located once the program has started executing.
1622 Normally this is the same as the LMA address, which is the address
1623 where the section will be loaded into memory, but on some systems,
1624 especially those where a program is held in ROM, the two can be
1625 different. If @samp{=} is used, the section address is set to
1626 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1627 section address. See the comments under @option{--change-addresses},
1628 above. If @var{sectionpattern} does not match any sections in the
1629 input file, a warning will be issued, unless
1630 @option{--no-change-warnings} is used.
1632 @item --change-warnings
1633 @itemx --adjust-warnings
1634 If @option{--change-section-address} or @option{--change-section-lma} or
1635 @option{--change-section-vma} is used, and the section pattern does not
1636 match any sections, issue a warning. This is the default.
1638 @item --no-change-warnings
1639 @itemx --no-adjust-warnings
1640 Do not issue a warning if @option{--change-section-address} or
1641 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1642 if the section pattern does not match any sections.
1644 @item --set-section-flags @var{sectionpattern}=@var{flags}
1645 Set the flags for any sections matching @var{sectionpattern}. The
1646 @var{flags} argument is a comma separated string of flag names. The
1647 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1648 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1649 @samp{share}, and @samp{debug}. You can set the @samp{contents} flag
1650 for a section which does not have contents, but it is not meaningful
1651 to clear the @samp{contents} flag of a section which does have
1652 contents--just remove the section instead. Not all flags are
1653 meaningful for all object file formats.
1655 @item --set-section-alignment @var{sectionpattern}=@var{align}
1656 Set the alignment for any sections matching @var{sectionpattern}.
1657 @var{align} specifies the alignment in bytes and must be a power of
1658 two, i.e. 1, 2, 4, 8@dots{}.
1660 @item --add-section @var{sectionname}=@var{filename}
1661 Add a new section named @var{sectionname} while copying the file. The
1662 contents of the new section are taken from the file @var{filename}. The
1663 size of the section will be the size of the file. This option only
1664 works on file formats which can support sections with arbitrary names.
1665 Note - it may be necessary to use the @option{--set-section-flags}
1666 option to set the attributes of the newly created section.
1668 @item --dump-section @var{sectionname}=@var{filename}
1669 Place the contents of section named @var{sectionname} into the file
1670 @var{filename}, overwriting any contents that may have been there
1671 previously. This option is the inverse of @option{--add-section}.
1672 This option is similar to the @option{--only-section} option except
1673 that it does not create a formatted file, it just dumps the contents
1674 as raw binary data, without applying any relocations. The option can
1675 be specified more than once.
1677 @item --update-section @var{sectionname}=@var{filename}
1678 Replace the existing contents of a section named @var{sectionname}
1679 with the contents of file @var{filename}. The size of the section
1680 will be adjusted to the size of the file. The section flags for
1681 @var{sectionname} will be unchanged. For ELF format files the section
1682 to segment mapping will also remain unchanged, something which is not
1683 possible using @option{--remove-section} followed by
1684 @option{--add-section}. The option can be specified more than once.
1686 Note - it is possible to use @option{--rename-section} and
1687 @option{--update-section} to both update and rename a section from one
1688 command line. In this case, pass the original section name to
1689 @option{--update-section}, and the original and new section names to
1690 @option{--rename-section}.
1692 @item --add-symbol @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1693 Add a new symbol named @var{name} while copying the file. This option may be
1694 specified multiple times. If the @var{section} is given, the symbol will be
1695 associated with and relative to that section, otherwise it will be an ABS
1696 symbol. Specifying an undefined section will result in a fatal error. There
1697 is no check for the value, it will be taken as specified. Symbol flags can
1698 be specified and not all flags will be meaningful for all object file
1699 formats. By default, the symbol will be global. The special flag
1700 'before=@var{othersym}' will insert the new symbol in front of the specified
1701 @var{othersym}, otherwise the symbol(s) will be added at the end of the
1702 symbol table in the order they appear.
1704 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1705 Rename a section from @var{oldname} to @var{newname}, optionally
1706 changing the section's flags to @var{flags} in the process. This has
1707 the advantage over using a linker script to perform the rename in that
1708 the output stays as an object file and does not become a linked
1711 This option is particularly helpful when the input format is binary,
1712 since this will always create a section called .data. If for example,
1713 you wanted instead to create a section called .rodata containing binary
1714 data you could use the following command line to achieve it:
1717 objcopy -I binary -O <output_format> -B <architecture> \
1718 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1719 <input_binary_file> <output_object_file>
1722 @item --long-section-names @{enable,disable,keep@}
1723 Controls the handling of long section names when processing @code{COFF}
1724 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1725 is to preserve long section names if any are present in the input file.
1726 The @samp{enable} and @samp{disable} options forcibly enable or disable
1727 the use of long section names in the output object; when @samp{disable}
1728 is in effect, any long section names in the input object will be truncated.
1729 The @samp{enable} option will only emit long section names if any are
1730 present in the inputs; this is mostly the same as @samp{keep}, but it
1731 is left undefined whether the @samp{enable} option might force the
1732 creation of an empty string table in the output file.
1734 @item --change-leading-char
1735 Some object file formats use special characters at the start of
1736 symbols. The most common such character is underscore, which compilers
1737 often add before every symbol. This option tells @command{objcopy} to
1738 change the leading character of every symbol when it converts between
1739 object file formats. If the object file formats use the same leading
1740 character, this option has no effect. Otherwise, it will add a
1741 character, or remove a character, or change a character, as
1744 @item --remove-leading-char
1745 If the first character of a global symbol is a special symbol leading
1746 character used by the object file format, remove the character. The
1747 most common symbol leading character is underscore. This option will
1748 remove a leading underscore from all global symbols. This can be useful
1749 if you want to link together objects of different file formats with
1750 different conventions for symbol names. This is different from
1751 @option{--change-leading-char} because it always changes the symbol name
1752 when appropriate, regardless of the object file format of the output
1755 @item --reverse-bytes=@var{num}
1756 Reverse the bytes in a section with output contents. A section length must
1757 be evenly divisible by the value given in order for the swap to be able to
1758 take place. Reversing takes place before the interleaving is performed.
1760 This option is used typically in generating ROM images for problematic
1761 target systems. For example, on some target boards, the 32-bit words
1762 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1763 regardless of the CPU byte order. Depending on the programming model, the
1764 endianness of the ROM may need to be modified.
1766 Consider a simple file with a section containing the following eight
1767 bytes: @code{12345678}.
1769 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1770 output file would be ordered @code{21436587}.
1772 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1773 output file would be ordered @code{43218765}.
1775 By using @samp{--reverse-bytes=2} for the above example, followed by
1776 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1777 output file would be ordered @code{34127856}.
1779 @item --srec-len=@var{ival}
1780 Meaningful only for srec output. Set the maximum length of the Srecords
1781 being produced to @var{ival}. This length covers both address, data and
1784 @item --srec-forceS3
1785 Meaningful only for srec output. Avoid generation of S1/S2 records,
1786 creating S3-only record format.
1788 @item --redefine-sym @var{old}=@var{new}
1789 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1790 when one is trying link two things together for which you have no
1791 source, and there are name collisions.
1793 @item --redefine-syms=@var{filename}
1794 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1795 listed in the file @var{filename}. @var{filename} is simply a flat file,
1796 with one symbol pair per line. Line comments may be introduced by the hash
1797 character. This option may be given more than once.
1800 Change all global symbols in the file to be weak. This can be useful
1801 when building an object which will be linked against other objects using
1802 the @option{-R} option to the linker. This option is only effective when
1803 using an object file format which supports weak symbols.
1805 @item --keep-symbols=@var{filename}
1806 Apply @option{--keep-symbol} option to each symbol listed in the file
1807 @var{filename}. @var{filename} is simply a flat file, with one symbol
1808 name per line. Line comments may be introduced by the hash character.
1809 This option may be given more than once.
1811 @item --strip-symbols=@var{filename}
1812 Apply @option{--strip-symbol} option to each symbol listed in the file
1813 @var{filename}. @var{filename} is simply a flat file, with one symbol
1814 name per line. Line comments may be introduced by the hash character.
1815 This option may be given more than once.
1817 @item --strip-unneeded-symbols=@var{filename}
1818 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1819 the file @var{filename}. @var{filename} is simply a flat file, with one
1820 symbol name per line. Line comments may be introduced by the hash
1821 character. This option may be given more than once.
1823 @item --keep-global-symbols=@var{filename}
1824 Apply @option{--keep-global-symbol} option to each symbol listed in the
1825 file @var{filename}. @var{filename} is simply a flat file, with one
1826 symbol name per line. Line comments may be introduced by the hash
1827 character. This option may be given more than once.
1829 @item --localize-symbols=@var{filename}
1830 Apply @option{--localize-symbol} option to each symbol listed in the file
1831 @var{filename}. @var{filename} is simply a flat file, with one symbol
1832 name per line. Line comments may be introduced by the hash character.
1833 This option may be given more than once.
1835 @item --globalize-symbols=@var{filename}
1836 Apply @option{--globalize-symbol} option to each symbol listed in the file
1837 @var{filename}. @var{filename} is simply a flat file, with one symbol
1838 name per line. Line comments may be introduced by the hash character.
1839 This option may be given more than once. Note: this option cannot be
1840 used in conjunction with the @option{-G} or @option{--keep-global-symbol}
1843 @item --weaken-symbols=@var{filename}
1844 Apply @option{--weaken-symbol} option to each symbol listed in the file
1845 @var{filename}. @var{filename} is simply a flat file, with one symbol
1846 name per line. Line comments may be introduced by the hash character.
1847 This option may be given more than once.
1849 @item --alt-machine-code=@var{index}
1850 If the output architecture has alternate machine codes, use the
1851 @var{index}th code instead of the default one. This is useful in case
1852 a machine is assigned an official code and the tool-chain adopts the
1853 new code, but other applications still depend on the original code
1854 being used. For ELF based architectures if the @var{index}
1855 alternative does not exist then the value is treated as an absolute
1856 number to be stored in the e_machine field of the ELF header.
1858 @item --writable-text
1859 Mark the output text as writable. This option isn't meaningful for all
1860 object file formats.
1862 @item --readonly-text
1863 Make the output text write protected. This option isn't meaningful for all
1864 object file formats.
1867 Mark the output file as demand paged. This option isn't meaningful for all
1868 object file formats.
1871 Mark the output file as impure. This option isn't meaningful for all
1872 object file formats.
1874 @item --prefix-symbols=@var{string}
1875 Prefix all symbols in the output file with @var{string}.
1877 @item --prefix-sections=@var{string}
1878 Prefix all section names in the output file with @var{string}.
1880 @item --prefix-alloc-sections=@var{string}
1881 Prefix all the names of all allocated sections in the output file with
1884 @item --add-gnu-debuglink=@var{path-to-file}
1885 Creates a .gnu_debuglink section which contains a reference to
1886 @var{path-to-file} and adds it to the output file. Note: the file at
1887 @var{path-to-file} must exist. Part of the process of adding the
1888 .gnu_debuglink section involves embedding a checksum of the contents
1889 of the debug info file into the section.
1891 If the debug info file is built in one location but it is going to be
1892 installed at a later time into a different location then do not use
1893 the path to the installed location. The @option{--add-gnu-debuglink}
1894 option will fail because the installed file does not exist yet.
1895 Instead put the debug info file in the current directory and use the
1896 @option{--add-gnu-debuglink} option without any directory components,
1900 objcopy --add-gnu-debuglink=foo.debug
1903 At debug time the debugger will attempt to look for the separate debug
1904 info file in a set of known locations. The exact set of these
1905 locations varies depending upon the distribution being used, but it
1910 @item * The same directory as the executable.
1912 @item * A sub-directory of the directory containing the executable
1915 @item * A global debug directory such as /usr/lib/debug.
1918 As long as the debug info file has been installed into one of these
1919 locations before the debugger is run everything should work
1922 @item --keep-file-symbols
1923 When stripping a file, perhaps with @option{--strip-debug} or
1924 @option{--strip-unneeded}, retain any symbols specifying source file names,
1925 which would otherwise get stripped.
1927 @item --only-keep-debug
1928 Strip a file, removing contents of any sections that would not be
1929 stripped by @option{--strip-debug} and leaving the debugging sections
1930 intact. In ELF files, this preserves all note sections in the output.
1932 Note - the section headers of the stripped sections are preserved,
1933 including their sizes, but the contents of the section are discarded.
1934 The section headers are preserved so that other tools can match up the
1935 debuginfo file with the real executable, even if that executable has
1936 been relocated to a different address space.
1938 The intention is that this option will be used in conjunction with
1939 @option{--add-gnu-debuglink} to create a two part executable. One a
1940 stripped binary which will occupy less space in RAM and in a
1941 distribution and the second a debugging information file which is only
1942 needed if debugging abilities are required. The suggested procedure
1943 to create these files is as follows:
1946 @item Link the executable as normal. Assuming that it is called
1948 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1949 create a file containing the debugging info.
1950 @item Run @code{objcopy --strip-debug foo} to create a
1951 stripped executable.
1952 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1953 to add a link to the debugging info into the stripped executable.
1956 Note---the choice of @code{.dbg} as an extension for the debug info
1957 file is arbitrary. Also the @code{--only-keep-debug} step is
1958 optional. You could instead do this:
1961 @item Link the executable as normal.
1962 @item Copy @code{foo} to @code{foo.full}
1963 @item Run @code{objcopy --strip-debug foo}
1964 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1967 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1968 full executable. It does not have to be a file created by the
1969 @option{--only-keep-debug} switch.
1971 Note---this switch is only intended for use on fully linked files. It
1972 does not make sense to use it on object files where the debugging
1973 information may be incomplete. Besides the gnu_debuglink feature
1974 currently only supports the presence of one filename containing
1975 debugging information, not multiple filenames on a one-per-object-file
1979 Remove the contents of all DWARF .dwo sections, leaving the
1980 remaining debugging sections and all symbols intact.
1981 This option is intended for use by the compiler as part of
1982 the @option{-gsplit-dwarf} option, which splits debug information
1983 between the .o file and a separate .dwo file. The compiler
1984 generates all debug information in the same file, then uses
1985 the @option{--extract-dwo} option to copy the .dwo sections to
1986 the .dwo file, then the @option{--strip-dwo} option to remove
1987 those sections from the original .o file.
1990 Extract the contents of all DWARF .dwo sections. See the
1991 @option{--strip-dwo} option for more information.
1993 @item --file-alignment @var{num}
1994 Specify the file alignment. Sections in the file will always begin at
1995 file offsets which are multiples of this number. This defaults to
1997 [This option is specific to PE targets.]
1999 @item --heap @var{reserve}
2000 @itemx --heap @var{reserve},@var{commit}
2001 Specify the number of bytes of memory to reserve (and optionally commit)
2002 to be used as heap for this program.
2003 [This option is specific to PE targets.]
2005 @item --image-base @var{value}
2006 Use @var{value} as the base address of your program or dll. This is
2007 the lowest memory location that will be used when your program or dll
2008 is loaded. To reduce the need to relocate and improve performance of
2009 your dlls, each should have a unique base address and not overlap any
2010 other dlls. The default is 0x400000 for executables, and 0x10000000
2012 [This option is specific to PE targets.]
2014 @item --section-alignment @var{num}
2015 Sets the section alignment field in the PE header. Sections in memory
2016 will always begin at addresses which are a multiple of this number.
2018 [This option is specific to PE targets.]
2020 @item --stack @var{reserve}
2021 @itemx --stack @var{reserve},@var{commit}
2022 Specify the number of bytes of memory to reserve (and optionally commit)
2023 to be used as stack for this program.
2024 [This option is specific to PE targets.]
2026 @item --subsystem @var{which}
2027 @itemx --subsystem @var{which}:@var{major}
2028 @itemx --subsystem @var{which}:@var{major}.@var{minor}
2029 Specifies the subsystem under which your program will execute. The
2030 legal values for @var{which} are @code{native}, @code{windows},
2031 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
2032 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
2033 the subsystem version also. Numeric values are also accepted for
2035 [This option is specific to PE targets.]
2037 @item --extract-symbol
2038 Keep the file's section flags and symbols but remove all section data.
2039 Specifically, the option:
2042 @item removes the contents of all sections;
2043 @item sets the size of every section to zero; and
2044 @item sets the file's start address to zero.
2047 This option is used to build a @file{.sym} file for a VxWorks kernel.
2048 It can also be a useful way of reducing the size of a @option{--just-symbols}
2051 @item --compress-debug-sections
2052 Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
2053 ELF ABI. Note - if compression would actually make a section
2054 @emph{larger}, then it is not compressed.
2056 @item --compress-debug-sections=none
2057 @itemx --compress-debug-sections=zlib
2058 @itemx --compress-debug-sections=zlib-gnu
2059 @itemx --compress-debug-sections=zlib-gabi
2060 For ELF files, these options control how DWARF debug sections are
2061 compressed. @option{--compress-debug-sections=none} is equivalent
2062 to @option{--decompress-debug-sections}.
2063 @option{--compress-debug-sections=zlib} and
2064 @option{--compress-debug-sections=zlib-gabi} are equivalent to
2065 @option{--compress-debug-sections}.
2066 @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug
2067 sections using zlib. The debug sections are renamed to begin with
2068 @samp{.zdebug} instead of @samp{.debug}. Note - if compression would
2069 actually make a section @emph{larger}, then it is not compressed nor
2072 @item --decompress-debug-sections
2073 Decompress DWARF debug sections using zlib. The original section
2074 names of the compressed sections are restored.
2076 @item --elf-stt-common=yes
2077 @itemx --elf-stt-common=no
2078 For ELF files, these options control whether common symbols should be
2079 converted to the @code{STT_COMMON} or @code{STT_OBJECT} type.
2080 @option{--elf-stt-common=yes} converts common symbol type to
2081 @code{STT_COMMON}. @option{--elf-stt-common=no} converts common symbol
2082 type to @code{STT_OBJECT}.
2085 @itemx --no-merge-notes
2086 For ELF files, attempt (or do not attempt) to reduce the size of any
2087 SHT_NOTE type sections by removing duplicate notes.
2091 Show the version number of @command{objcopy}.
2093 @item --verilog-data-width=@var{bytes}
2094 For Verilog output, this options controls the number of bytes
2095 converted for each output data element. The input target controls the
2096 endianness of the conversion.
2100 Verbose output: list all object files modified. In the case of
2101 archives, @samp{objcopy -V} lists all members of the archive.
2104 Show a summary of the options to @command{objcopy}.
2107 Display a list showing all architectures and object formats available.
2113 @c man begin SEEALSO objcopy
2114 ld(1), objdump(1), and the Info entries for @file{binutils}.
2121 @cindex object file information
2124 @c man title objdump display information from object files
2127 @c man begin SYNOPSIS objdump
2128 objdump [@option{-a}|@option{--archive-headers}]
2129 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
2130 [@option{-C}|@option{--demangle}[=@var{style}] ]
2131 [@option{-d}|@option{--disassemble}[=@var{symbol}]]
2132 [@option{-D}|@option{--disassemble-all}]
2133 [@option{-z}|@option{--disassemble-zeroes}]
2134 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
2135 [@option{-f}|@option{--file-headers}]
2136 [@option{-F}|@option{--file-offsets}]
2137 [@option{--file-start-context}]
2138 [@option{-g}|@option{--debugging}]
2139 [@option{-e}|@option{--debugging-tags}]
2140 [@option{-h}|@option{--section-headers}|@option{--headers}]
2141 [@option{-i}|@option{--info}]
2142 [@option{-j} @var{section}|@option{--section=}@var{section}]
2143 [@option{-l}|@option{--line-numbers}]
2144 [@option{-S}|@option{--source}]
2145 [@option{--source-comment}[=@var{text}]]
2146 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
2147 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
2148 [@option{-p}|@option{--private-headers}]
2149 [@option{-P} @var{options}|@option{--private=}@var{options}]
2150 [@option{-r}|@option{--reloc}]
2151 [@option{-R}|@option{--dynamic-reloc}]
2152 [@option{-s}|@option{--full-contents}]
2153 [@option{-W[lLiaprmfFsoRtUuTgAckK]}|
2154 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]]
2155 [@option{--ctf=}@var{section}]
2156 [@option{-G}|@option{--stabs}]
2157 [@option{-t}|@option{--syms}]
2158 [@option{-T}|@option{--dynamic-syms}]
2159 [@option{-x}|@option{--all-headers}]
2160 [@option{-w}|@option{--wide}]
2161 [@option{--start-address=}@var{address}]
2162 [@option{--stop-address=}@var{address}]
2163 [@option{--prefix-addresses}]
2164 [@option{--[no-]show-raw-insn}]
2165 [@option{--adjust-vma=}@var{offset}]
2166 [@option{--dwarf-depth=@var{n}}]
2167 [@option{--dwarf-start=@var{n}}]
2168 [@option{--ctf-parent=}@var{section}]
2169 [@option{--no-recurse-limit}|@option{--recurse-limit}]
2170 [@option{--special-syms}]
2171 [@option{--prefix=}@var{prefix}]
2172 [@option{--prefix-strip=}@var{level}]
2173 [@option{--insn-width=}@var{width}]
2174 [@option{-V}|@option{--version}]
2175 [@option{-H}|@option{--help}]
2176 @var{objfile}@dots{}
2180 @c man begin DESCRIPTION objdump
2182 @command{objdump} displays information about one or more object files.
2183 The options control what particular information to display. This
2184 information is mostly useful to programmers who are working on the
2185 compilation tools, as opposed to programmers who just want their
2186 program to compile and work.
2188 @var{objfile}@dots{} are the object files to be examined. When you
2189 specify archives, @command{objdump} shows information on each of the member
2194 @c man begin OPTIONS objdump
2196 The long and short forms of options, shown here as alternatives, are
2197 equivalent. At least one option from the list
2198 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
2202 @itemx --archive-header
2203 @cindex archive headers
2204 If any of the @var{objfile} files are archives, display the archive
2205 header information (in a format similar to @samp{ls -l}). Besides the
2206 information you could list with @samp{ar tv}, @samp{objdump -a} shows
2207 the object file format of each archive member.
2209 @item --adjust-vma=@var{offset}
2210 @cindex section addresses in objdump
2211 @cindex VMA in objdump
2212 When dumping information, first add @var{offset} to all the section
2213 addresses. This is useful if the section addresses do not correspond to
2214 the symbol table, which can happen when putting sections at particular
2215 addresses when using a format which can not represent section addresses,
2218 @item -b @var{bfdname}
2219 @itemx --target=@var{bfdname}
2220 @cindex object code format
2221 Specify that the object-code format for the object files is
2222 @var{bfdname}. This option may not be necessary; @var{objdump} can
2223 automatically recognize many formats.
2227 objdump -b oasys -m vax -h fu.o
2230 displays summary information from the section headers (@option{-h}) of
2231 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
2232 file in the format produced by Oasys compilers. You can list the
2233 formats available with the @option{-i} option.
2234 @xref{Target Selection}, for more information.
2237 @itemx --demangle[=@var{style}]
2238 @cindex demangling in objdump
2239 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2240 Besides removing any initial underscore prepended by the system, this
2241 makes C++ function names readable. Different compilers have different
2242 mangling styles. The optional demangling style argument can be used to
2243 choose an appropriate demangling style for your compiler. @xref{c++filt},
2244 for more information on demangling.
2246 @item --recurse-limit
2247 @itemx --no-recurse-limit
2248 @itemx --recursion-limit
2249 @itemx --no-recursion-limit
2250 Enables or disables a limit on the amount of recursion performed
2251 whilst demangling strings. Since the name mangling formats allow for
2252 an inifinite level of recursion it is possible to create strings whose
2253 decoding will exhaust the amount of stack space available on the host
2254 machine, triggering a memory fault. The limit tries to prevent this
2255 from happening by restricting recursion to 2048 levels of nesting.
2257 The default is for this limit to be enabled, but disabling it may be
2258 necessary in order to demangle truly complicated names. Note however
2259 that if the recursion limit is disabled then stack exhaustion is
2260 possible and any bug reports about such an event will be rejected.
2264 Display debugging information. This attempts to parse STABS
2265 debugging format information stored in the file and print it out using
2266 a C like syntax. If no STABS debuging was found this option
2267 falls back on the @option{-W} option to print any DWARF information in
2271 @itemx --debugging-tags
2272 Like @option{-g}, but the information is generated in a format compatible
2276 @itemx --disassemble
2277 @itemx --disassemble=@var{symbol}
2278 @cindex disassembling object code
2279 @cindex machine instructions
2280 Display the assembler mnemonics for the machine instructions from the
2281 input file. This option only disassembles those sections which are
2282 expected to contain instructions. If the optional @var{symbol}
2283 argument is given, then display the assembler mnemonics starting at
2284 @var{symbol}. If @var{symbol} is a function name then disassembly
2285 will stop at the end of the function, otherwise it will stop when the
2286 next symbol is encountered. If there are no matches for @var{symbol}
2287 then nothing will be displayed.
2289 Note if the @option{--dwarf=follow-links} option has also been enabled
2290 then any symbol tables in linked debug info files will be read in and
2291 used when disassembling.
2294 @itemx --disassemble-all
2295 Like @option{-d}, but disassemble the contents of all sections, not just
2296 those expected to contain instructions.
2298 This option also has a subtle effect on the disassembly of
2299 instructions in code sections. When option @option{-d} is in effect
2300 objdump will assume that any symbols present in a code section occur
2301 on the boundary between instructions and it will refuse to disassemble
2302 across such a boundary. When option @option{-D} is in effect however
2303 this assumption is supressed. This means that it is possible for the
2304 output of @option{-d} and @option{-D} to differ if, for example, data
2305 is stored in code sections.
2307 If the target is an ARM architecture this switch also has the effect
2308 of forcing the disassembler to decode pieces of data found in code
2309 sections as if they were instructions.
2311 Note if the @option{--dwarf=follow-links} option has also been enabled
2312 then any symbol tables in linked debug info files will be read in and
2313 used when disassembling.
2315 @item --prefix-addresses
2316 When disassembling, print the complete address on each line. This is
2317 the older disassembly format.
2321 @itemx --endian=@{big|little@}
2323 @cindex disassembly endianness
2324 Specify the endianness of the object files. This only affects
2325 disassembly. This can be useful when disassembling a file format which
2326 does not describe endianness information, such as S-records.
2329 @itemx --file-headers
2330 @cindex object file header
2331 Display summary information from the overall header of
2332 each of the @var{objfile} files.
2335 @itemx --file-offsets
2336 @cindex object file offsets
2337 When disassembling sections, whenever a symbol is displayed, also
2338 display the file offset of the region of data that is about to be
2339 dumped. If zeroes are being skipped, then when disassembly resumes,
2340 tell the user how many zeroes were skipped and the file offset of the
2341 location from where the disassembly resumes. When dumping sections,
2342 display the file offset of the location from where the dump starts.
2344 @item --file-start-context
2345 @cindex source code context
2346 Specify that when displaying interlisted source code/disassembly
2347 (assumes @option{-S}) from a file that has not yet been displayed, extend the
2348 context to the start of the file.
2351 @itemx --section-headers
2353 @cindex section headers
2354 Display summary information from the section headers of the
2357 File segments may be relocated to nonstandard addresses, for example by
2358 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2359 @command{ld}. However, some object file formats, such as a.out, do not
2360 store the starting address of the file segments. In those situations,
2361 although @command{ld} relocates the sections correctly, using @samp{objdump
2362 -h} to list the file section headers cannot show the correct addresses.
2363 Instead, it shows the usual addresses, which are implicit for the
2366 Note, in some cases it is possible for a section to have both the
2367 READONLY and the NOREAD attributes set. In such cases the NOREAD
2368 attribute takes precedence, but @command{objdump} will report both
2369 since the exact setting of the flag bits might be important.
2373 Print a summary of the options to @command{objdump} and exit.
2377 @cindex architectures available
2378 @cindex object formats available
2379 Display a list showing all architectures and object formats available
2380 for specification with @option{-b} or @option{-m}.
2383 @itemx --section=@var{name}
2384 @cindex section information
2385 Display information only for section @var{name}.
2388 @itemx --line-numbers
2389 @cindex source filenames for object files
2390 Label the display (using debugging information) with the filename and
2391 source line numbers corresponding to the object code or relocs shown.
2392 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2394 @item -m @var{machine}
2395 @itemx --architecture=@var{machine}
2396 @cindex architecture
2397 @cindex disassembly architecture
2398 Specify the architecture to use when disassembling object files. This
2399 can be useful when disassembling object files which do not describe
2400 architecture information, such as S-records. You can list the available
2401 architectures with the @option{-i} option.
2403 If the target is an ARM architecture then this switch has an
2404 additional effect. It restricts the disassembly to only those
2405 instructions supported by the architecture specified by @var{machine}.
2406 If it is necessary to use this switch because the input file does not
2407 contain any architecture information, but it is also desired to
2408 disassemble all the instructions use @option{-marm}.
2410 @item -M @var{options}
2411 @itemx --disassembler-options=@var{options}
2412 Pass target specific information to the disassembler. Only supported on
2413 some targets. If it is necessary to specify more than one
2414 disassembler option then multiple @option{-M} options can be used or
2415 can be placed together into a comma separated list.
2417 For ARC, @option{dsp} controls the printing of DSP instructions,
2418 @option{spfp} selects the printing of FPX single precision FP
2419 instructions, @option{dpfp} selects the printing of FPX double
2420 precision FP instructions, @option{quarkse_em} selects the printing of
2421 special QuarkSE-EM instructions, @option{fpuda} selects the printing
2422 of double precision assist instructions, @option{fpus} selects the
2423 printing of FPU single precision FP instructions, while @option{fpud}
2424 selects the printing of FPU double precision FP instructions.
2425 Additionally, one can choose to have all the immediates printed in
2426 hexadecimal using @option{hex}. By default, the short immediates are
2427 printed using the decimal representation, while the long immediate
2428 values are printed as hexadecimal.
2430 @option{cpu=...} allows to enforce a particular ISA when disassembling
2431 instructions, overriding the @option{-m} value or whatever is in the ELF file.
2432 This might be useful to select ARC EM or HS ISA, because architecture is same
2433 for those and disassembler relies on private ELF header data to decide if code
2434 is for EM or HS. This option might be specified multiple times - only the
2435 latest value will be used. Valid values are same as for the assembler
2436 @option{-mcpu=...} option.
2438 If the target is an ARM architecture then this switch can be used to
2439 select which register name set is used during disassembler. Specifying
2440 @option{-M reg-names-std} (the default) will select the register names as
2441 used in ARM's instruction set documentation, but with register 13 called
2442 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2443 @option{-M reg-names-apcs} will select the name set used by the ARM
2444 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2445 just use @samp{r} followed by the register number.
2447 There are also two variants on the APCS register naming scheme enabled
2448 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2449 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2450 with the normal register names or the special register names).
2452 This option can also be used for ARM architectures to force the
2453 disassembler to interpret all instructions as Thumb instructions by
2454 using the switch @option{--disassembler-options=force-thumb}. This can be
2455 useful when attempting to disassemble thumb code produced by other
2458 For AArch64 targets this switch can be used to set whether instructions are
2459 disassembled as the most general instruction using the @option{-M no-aliases}
2460 option or whether instruction notes should be generated as comments in the
2461 disasssembly using @option{-M notes}.
2463 For the x86, some of the options duplicate functions of the @option{-m}
2464 switch, but allow finer grained control. Multiple selections from the
2465 following may be specified as a comma separated string.
2470 Select disassembly for the given architecture.
2474 Select between intel syntax mode and AT&T syntax mode.
2478 Select between AMD64 ISA and Intel64 ISA.
2480 @item intel-mnemonic
2482 Select between intel mnemonic mode and AT&T mnemonic mode.
2483 Note: @code{intel-mnemonic} implies @code{intel} and
2484 @code{att-mnemonic} implies @code{att}.
2491 Specify the default address size and operand size. These five options
2492 will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2493 appear later in the option string.
2496 When in AT&T mode, instructs the disassembler to print a mnemonic
2497 suffix even when the suffix could be inferred by the operands.
2500 For PowerPC, the @option{-M} argument @option{raw} selects
2501 disasssembly of hardware insns rather than aliases. For example, you
2502 will see @code{rlwinm} rather than @code{clrlwi}, and @code{addi}
2503 rather than @code{li}. All of the @option{-m} arguments for
2504 @command{gas} that select a CPU are supported. These are:
2505 @option{403}, @option{405}, @option{440}, @option{464}, @option{476},
2506 @option{601}, @option{603}, @option{604}, @option{620}, @option{7400},
2507 @option{7410}, @option{7450}, @option{7455}, @option{750cl},
2508 @option{821}, @option{850}, @option{860}, @option{a2}, @option{booke},
2509 @option{booke32}, @option{cell}, @option{com}, @option{e200z4},
2510 @option{e300}, @option{e500}, @option{e500mc}, @option{e500mc64},
2511 @option{e500x2}, @option{e5500}, @option{e6500}, @option{efs},
2512 @option{power4}, @option{power5}, @option{power6}, @option{power7},
2513 @option{power8}, @option{power9}, @option{ppc}, @option{ppc32},
2514 @option{ppc64}, @option{ppc64bridge}, @option{ppcps}, @option{pwr},
2515 @option{pwr2}, @option{pwr4}, @option{pwr5}, @option{pwr5x},
2516 @option{pwr6}, @option{pwr7}, @option{pwr8}, @option{pwr9},
2517 @option{pwrx}, @option{titan}, and @option{vle}.
2518 @option{32} and @option{64} modify the default or a prior CPU
2519 selection, disabling and enabling 64-bit insns respectively. In
2520 addition, @option{altivec}, @option{any}, @option{htm}, @option{vsx},
2521 and @option{spe} add capabilities to a previous @emph{or later} CPU
2522 selection. @option{any} will disassemble any opcode known to
2523 binutils, but in cases where an opcode has two different meanings or
2524 different arguments, you may not see the disassembly you expect.
2525 If you disassemble without giving a CPU selection, a default will be
2526 chosen from information gleaned by BFD from the object files headers,
2527 but the result again may not be as you expect.
2529 For MIPS, this option controls the printing of instruction mnemonic
2530 names and register names in disassembled instructions. Multiple
2531 selections from the following may be specified as a comma separated
2532 string, and invalid options are ignored:
2536 Print the 'raw' instruction mnemonic instead of some pseudo
2537 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2538 'sll' instead of 'nop', etc.
2541 Disassemble MSA instructions.
2544 Disassemble the virtualization ASE instructions.
2547 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2549 @item gpr-names=@var{ABI}
2550 Print GPR (general-purpose register) names as appropriate
2551 for the specified ABI. By default, GPR names are selected according to
2552 the ABI of the binary being disassembled.
2554 @item fpr-names=@var{ABI}
2555 Print FPR (floating-point register) names as
2556 appropriate for the specified ABI. By default, FPR numbers are printed
2559 @item cp0-names=@var{ARCH}
2560 Print CP0 (system control coprocessor; coprocessor 0) register names
2561 as appropriate for the CPU or architecture specified by
2562 @var{ARCH}. By default, CP0 register names are selected according to
2563 the architecture and CPU of the binary being disassembled.
2565 @item hwr-names=@var{ARCH}
2566 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2567 as appropriate for the CPU or architecture specified by
2568 @var{ARCH}. By default, HWR names are selected according to
2569 the architecture and CPU of the binary being disassembled.
2571 @item reg-names=@var{ABI}
2572 Print GPR and FPR names as appropriate for the selected ABI.
2574 @item reg-names=@var{ARCH}
2575 Print CPU-specific register names (CP0 register and HWR names)
2576 as appropriate for the selected CPU or architecture.
2579 For any of the options listed above, @var{ABI} or
2580 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2581 rather than names, for the selected types of registers.
2582 You can list the available values of @var{ABI} and @var{ARCH} using
2583 the @option{--help} option.
2585 For VAX, you can specify function entry addresses with @option{-M
2586 entry:0xf00ba}. You can use this multiple times to properly
2587 disassemble VAX binary files that don't contain symbol tables (like
2588 ROM dumps). In these cases, the function entry mask would otherwise
2589 be decoded as VAX instructions, which would probably lead the rest
2590 of the function being wrongly disassembled.
2593 @itemx --private-headers
2594 Print information that is specific to the object file format. The exact
2595 information printed depends upon the object file format. For some
2596 object file formats, no additional information is printed.
2598 @item -P @var{options}
2599 @itemx --private=@var{options}
2600 Print information that is specific to the object file format. The
2601 argument @var{options} is a comma separated list that depends on the
2602 format (the lists of options is displayed with the help).
2604 For XCOFF, the available options are:
2620 Not all object formats support this option. In particular the ELF
2621 format does not use it.
2625 @cindex relocation entries, in object file
2626 Print the relocation entries of the file. If used with @option{-d} or
2627 @option{-D}, the relocations are printed interspersed with the
2631 @itemx --dynamic-reloc
2632 @cindex dynamic relocation entries, in object file
2633 Print the dynamic relocation entries of the file. This is only
2634 meaningful for dynamic objects, such as certain types of shared
2635 libraries. As for @option{-r}, if used with @option{-d} or
2636 @option{-D}, the relocations are printed interspersed with the
2640 @itemx --full-contents
2641 @cindex sections, full contents
2642 @cindex object file sections
2643 Display the full contents of any sections requested. By default all
2644 non-empty sections are displayed.
2648 @cindex source disassembly
2649 @cindex disassembly, with source
2650 Display source code intermixed with disassembly, if possible. Implies
2653 @item --source-comment[=@var{txt}]
2654 @cindex source disassembly
2655 @cindex disassembly, with source
2656 Like the @option{-S} option, but all source code lines are displayed
2657 with a prefix of @var{txt}. Typically @var{txt} will be a comment
2658 string which can be used to distinguish the assembler code from the
2659 source code. If @var{txt} is not provided then a default string of
2660 @var{``# ``} (hash followed by a space), will be used.
2662 @item --prefix=@var{prefix}
2663 @cindex Add prefix to absolute paths
2664 Specify @var{prefix} to add to the absolute paths when used with
2667 @item --prefix-strip=@var{level}
2668 @cindex Strip absolute paths
2669 Indicate how many initial directory names to strip off the hardwired
2670 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2672 @item --show-raw-insn
2673 When disassembling instructions, print the instruction in hex as well as
2674 in symbolic form. This is the default except when
2675 @option{--prefix-addresses} is used.
2677 @item --no-show-raw-insn
2678 When disassembling instructions, do not print the instruction bytes.
2679 This is the default when @option{--prefix-addresses} is used.
2681 @item --insn-width=@var{width}
2682 @cindex Instruction width
2683 Display @var{width} bytes on a single line when disassembling
2686 @item -W[lLiaprmfFsoRtUuTgAckK]
2687 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
2688 @include debug.options.texi
2691 Enable additional checks for consistency of Dwarf information.
2693 @include ctf.options.texi
2699 @cindex debug symbols
2700 @cindex ELF object file format
2701 Display the full contents of any sections requested. Display the
2702 contents of the .stab and .stab.index and .stab.excl sections from an
2703 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2704 @code{.stab} debugging symbol-table entries are carried in an ELF
2705 section. In most other file formats, debugging symbol-table entries are
2706 interleaved with linkage symbols, and are visible in the @option{--syms}
2709 @item --start-address=@var{address}
2710 @cindex start-address
2711 Start displaying data at the specified address. This affects the output
2712 of the @option{-d}, @option{-r} and @option{-s} options.
2714 @item --stop-address=@var{address}
2715 @cindex stop-address
2716 Stop displaying data at the specified address. This affects the output
2717 of the @option{-d}, @option{-r} and @option{-s} options.
2721 @cindex symbol table entries, printing
2722 Print the symbol table entries of the file.
2723 This is similar to the information provided by the @samp{nm} program,
2724 although the display format is different. The format of the output
2725 depends upon the format of the file being dumped, but there are two main
2726 types. One looks like this:
2729 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2730 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2733 where the number inside the square brackets is the number of the entry
2734 in the symbol table, the @var{sec} number is the section number, the
2735 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2736 symbol's type, the @var{scl} number is the symbol's storage class and
2737 the @var{nx} value is the number of auxilary entries associated with
2738 the symbol. The last two fields are the symbol's value and its name.
2740 The other common output format, usually seen with ELF based files,
2744 00000000 l d .bss 00000000 .bss
2745 00000000 g .text 00000000 fred
2748 Here the first number is the symbol's value (sometimes refered to as
2749 its address). The next field is actually a set of characters and
2750 spaces indicating the flag bits that are set on the symbol. These
2751 characters are described below. Next is the section with which the
2752 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2753 not connected with any section), or @emph{*UND*} if the section is
2754 referenced in the file being dumped, but not defined there.
2756 After the section name comes another field, a number, which for common
2757 symbols is the alignment and for other symbol is the size. Finally
2758 the symbol's name is displayed.
2760 The flag characters are divided into 7 groups as follows:
2766 The symbol is a local (l), global (g), unique global (u), neither
2767 global nor local (a space) or both global and local (!). A
2768 symbol can be neither local or global for a variety of reasons, e.g.,
2769 because it is used for debugging, but it is probably an indication of
2770 a bug if it is ever both local and global. Unique global symbols are
2771 a GNU extension to the standard set of ELF symbol bindings. For such
2772 a symbol the dynamic linker will make sure that in the entire process
2773 there is just one symbol with this name and type in use.
2776 The symbol is weak (w) or strong (a space).
2779 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2782 The symbol is a warning (W) or a normal symbol (a space). A warning
2783 symbol's name is a message to be displayed if the symbol following the
2784 warning symbol is ever referenced.
2788 The symbol is an indirect reference to another symbol (I), a function
2789 to be evaluated during reloc processing (i) or a normal symbol (a
2794 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2795 normal symbol (a space).
2800 The symbol is the name of a function (F) or a file (f) or an object
2801 (O) or just a normal symbol (a space).
2805 @itemx --dynamic-syms
2806 @cindex dynamic symbol table entries, printing
2807 Print the dynamic symbol table entries of the file. This is only
2808 meaningful for dynamic objects, such as certain types of shared
2809 libraries. This is similar to the information provided by the @samp{nm}
2810 program when given the @option{-D} (@option{--dynamic}) option.
2812 The output format is similar to that produced by the @option{--syms}
2813 option, except that an extra field is inserted before the symbol's
2814 name, giving the version information associated with the symbol.
2815 If the version is the default version to be used when resolving
2816 unversioned references to the symbol then it's displayed as is,
2817 otherwise it's put into parentheses.
2819 @item --special-syms
2820 When displaying symbols include those which the target considers to be
2821 special in some way and which would not normally be of interest to the
2826 Print the version number of @command{objdump} and exit.
2829 @itemx --all-headers
2830 @cindex all header information, object file
2831 @cindex header information, all
2832 Display all available header information, including the symbol table and
2833 relocation entries. Using @option{-x} is equivalent to specifying all of
2834 @option{-a -f -h -p -r -t}.
2838 @cindex wide output, printing
2839 Format some lines for output devices that have more than 80 columns.
2840 Also do not truncate symbol names when they are displayed.
2843 @itemx --disassemble-zeroes
2844 Normally the disassembly output will skip blocks of zeroes. This
2845 option directs the disassembler to disassemble those blocks, just like
2852 @c man begin SEEALSO objdump
2853 nm(1), readelf(1), and the Info entries for @file{binutils}.
2861 @cindex archive contents
2862 @cindex symbol index
2864 @c man title ranlib generate an index to an archive
2867 @c man begin SYNOPSIS ranlib
2868 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2872 @c man begin DESCRIPTION ranlib
2874 @command{ranlib} generates an index to the contents of an archive and
2875 stores it in the archive. The index lists each symbol defined by a
2876 member of an archive that is a relocatable object file.
2878 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2880 An archive with such an index speeds up linking to the library and
2881 allows routines in the library to call each other without regard to
2882 their placement in the archive.
2884 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2885 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2890 @c man begin OPTIONS ranlib
2896 Show usage information for @command{ranlib}.
2901 Show the version number of @command{ranlib}.
2904 @cindex deterministic archives
2905 @kindex --enable-deterministic-archives
2906 Operate in @emph{deterministic} mode. The symbol map archive member's
2907 header will show zero for the UID, GID, and timestamp. When this
2908 option is used, multiple runs will produce identical output files.
2910 If @file{binutils} was configured with
2911 @option{--enable-deterministic-archives}, then this mode is on by
2912 default. It can be disabled with the @samp{-U} option, described
2916 Update the timestamp of the symbol map of an archive.
2919 @cindex deterministic archives
2920 @kindex --enable-deterministic-archives
2921 Do @emph{not} operate in @emph{deterministic} mode. This is the
2922 inverse of the @samp{-D} option, above: the archive index will get
2923 actual UID, GID, timestamp, and file mode values.
2925 If @file{binutils} was configured @emph{without}
2926 @option{--enable-deterministic-archives}, then this mode is on by
2934 @c man begin SEEALSO ranlib
2935 ar(1), nm(1), and the Info entries for @file{binutils}.
2943 @cindex section sizes
2945 @c man title size list section sizes and total size of binary files
2948 @c man begin SYNOPSIS size
2949 size [@option{-A}|@option{-B}|@option{-G}|@option{--format=}@var{compatibility}]
2951 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2953 [@option{-t}|@option{--totals}]
2954 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2955 [@var{objfile}@dots{}]
2959 @c man begin DESCRIPTION size
2961 The @sc{gnu} @command{size} utility lists the section sizes and the total
2962 size for each of the binary files @var{objfile} on its argument list.
2963 By default, one line of output is generated for each file or each
2964 module if the file is an archive.
2966 @var{objfile}@dots{} are the files to be examined. If none are
2967 specified, the file @code{a.out} will be used instead.
2971 @c man begin OPTIONS size
2973 The command-line options have the following meanings:
2979 @itemx --format=@var{compatibility}
2980 @cindex @command{size} display format
2981 Using one of these options, you can choose whether the output from @sc{gnu}
2982 @command{size} resembles output from System V @command{size} (using @option{-A},
2983 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2984 @option{--format=berkeley}). The default is the one-line format similar to
2985 Berkeley's. Alternatively, you can choose the GNU format output
2986 (using @option{-G}, or @option{--format=gnu}), this is similar to
2987 Berkeley's output format, but sizes are counted differently.
2988 @c Bonus for doc-source readers: you can also say --format=strange (or
2989 @c anything else that starts with 's') for sysv, and --format=boring (or
2990 @c anything else that starts with 'b') for Berkeley.
2992 Here is an example of the Berkeley (default) format of output from
2995 $ size --format=Berkeley ranlib size
2996 text data bss dec hex filename
2997 294880 81920 11592 388392 5ed28 ranlib
2998 294880 81920 11888 388688 5ee50 size
3001 The Berkeley style output counts read only data in the @code{text}
3002 column, not in the @code{data} column, the @code{dec} and @code{hex}
3003 columns both display the sum of the @code{text}, @code{data}, and
3004 @code{bss} columns in decimal and hexadecimal respectively.
3006 The GNU format counts read only data in the @code{data} column, not
3007 the @code{text} column, and only displays the sum of the @code{text},
3008 @code{data}, and @code{bss} columns once, in the @code{total} column.
3009 The @option{--radix} option can be used to change the number base for
3010 all columns. Here is the same data displayed with GNU conventions:
3013 $ size --format=GNU ranlib size
3014 text data bss total filename
3015 279880 96920 11592 388392 ranlib
3016 279880 96920 11888 388688 size
3020 This is the same data, but displayed closer to System V conventions:
3023 $ size --format=SysV ranlib size
3041 Show a summary of acceptable arguments and options.
3046 @itemx --radix=@var{number}
3047 @cindex @command{size} number format
3048 @cindex radix for section sizes
3049 Using one of these options, you can control whether the size of each
3050 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
3051 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
3052 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
3053 values (8, 10, 16) are supported. The total size is always given in two
3054 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
3055 octal and hexadecimal if you're using @option{-o}.
3058 Print total size of common symbols in each file. When using Berkeley
3059 or GNU format these are included in the bss size.
3063 Show totals of all objects listed (Berkeley or GNU format mode only).
3065 @item --target=@var{bfdname}
3066 @cindex object code format
3067 Specify that the object-code format for @var{objfile} is
3068 @var{bfdname}. This option may not be necessary; @command{size} can
3069 automatically recognize many formats.
3070 @xref{Target Selection}, for more information.
3074 Display the version number of @command{size}.
3080 @c man begin SEEALSO size
3081 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
3088 @cindex listings strings
3089 @cindex printing strings
3090 @cindex strings, printing
3092 @c man title strings print the sequences of printable characters in files
3095 @c man begin SYNOPSIS strings
3096 strings [@option{-afovV}] [@option{-}@var{min-len}]
3097 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
3098 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
3099 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
3100 [@option{-}] [@option{--all}] [@option{--print-file-name}]
3101 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
3102 [@option{-w}] [@option{--include-all-whitespace}]
3103 [@option{-s}] [@option{--output-separator}@var{sep_string}]
3104 [@option{--help}] [@option{--version}] @var{file}@dots{}
3108 @c man begin DESCRIPTION strings
3110 For each @var{file} given, @sc{gnu} @command{strings} prints the
3111 printable character sequences that are at least 4 characters long (or
3112 the number given with the options below) and are followed by an
3113 unprintable character.
3115 Depending upon how the strings program was configured it will default
3116 to either displaying all the printable sequences that it can find in
3117 each file, or only those sequences that are in loadable, initialized
3118 data sections. If the file type in unrecognizable, or if strings is
3119 reading from stdin then it will always display all of the printable
3120 sequences that it can find.
3122 For backwards compatibility any file that occurs after a command-line
3123 option of just @option{-} will also be scanned in full, regardless of
3124 the presence of any @option{-d} option.
3126 @command{strings} is mainly useful for determining the contents of
3131 @c man begin OPTIONS strings
3137 Scan the whole file, regardless of what sections it contains or
3138 whether those sections are loaded or initialized. Normally this is
3139 the default behaviour, but strings can be configured so that the
3140 @option{-d} is the default instead.
3142 The @option{-} option is position dependent and forces strings to
3143 perform full scans of any file that is mentioned after the @option{-}
3144 on the command line, even if the @option{-d} option has been
3149 Only print strings from initialized, loaded data sections in the
3150 file. This may reduce the amount of garbage in the output, but it
3151 also exposes the strings program to any security flaws that may be
3152 present in the BFD library used to scan and load sections. Strings
3153 can be configured so that this option is the default behaviour. In
3154 such cases the @option{-a} option can be used to avoid using the BFD
3155 library and instead just print all of the strings found in the file.
3158 @itemx --print-file-name
3159 Print the name of the file before each string.
3162 Print a summary of the program usage on the standard output and exit.
3164 @item -@var{min-len}
3165 @itemx -n @var{min-len}
3166 @itemx --bytes=@var{min-len}
3167 Print sequences of characters that are at least @var{min-len} characters
3168 long, instead of the default 4.
3171 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
3172 act like @samp{-t d} instead. Since we can not be compatible with both
3173 ways, we simply chose one.
3175 @item -t @var{radix}
3176 @itemx --radix=@var{radix}
3177 Print the offset within the file before each string. The single
3178 character argument specifies the radix of the offset---@samp{o} for
3179 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
3181 @item -e @var{encoding}
3182 @itemx --encoding=@var{encoding}
3183 Select the character encoding of the strings that are to be found.
3184 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
3185 characters (ASCII, ISO 8859, etc., default), @samp{S} =
3186 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
3187 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
3188 littleendian. Useful for finding wide character strings. (@samp{l}
3189 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
3191 @item -T @var{bfdname}
3192 @itemx --target=@var{bfdname}
3193 @cindex object code format
3194 Specify an object code format other than your system's default format.
3195 @xref{Target Selection}, for more information.
3200 Print the program version number on the standard output and exit.
3203 @itemx --include-all-whitespace
3204 By default tab and space characters are included in the strings that
3205 are displayed, but other whitespace characters, such a newlines and
3206 carriage returns, are not. The @option{-w} option changes this so
3207 that all whitespace characters are considered to be part of a string.
3210 @itemx --output-separator
3211 By default, output strings are delimited by a new-line. This option
3212 allows you to supply any string to be used as the output record
3213 separator. Useful with --include-all-whitespace where strings
3214 may contain new-lines internally.
3220 @c man begin SEEALSO strings
3221 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
3222 and the Info entries for @file{binutils}.
3230 @cindex removing symbols
3231 @cindex discarding symbols
3232 @cindex symbols, discarding
3234 @c man title strip discard symbols and other data from object files
3237 @c man begin SYNOPSIS strip
3238 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
3239 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
3240 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
3241 [@option{-s}|@option{--strip-all}]
3242 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
3243 [@option{--strip-dwo}]
3244 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
3245 [@option{-M}|@option{--merge-notes}][@option{--no-merge-notes}]
3246 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
3247 [@option{-w}|@option{--wildcard}]
3248 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
3249 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
3250 [@option{--keep-section=}@var{sectionpattern}]
3251 [@option{--remove-relocations=}@var{sectionpattern}]
3252 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
3253 [@option{-D}|@option{--enable-deterministic-archives}]
3254 [@option{-U}|@option{--disable-deterministic-archives}]
3255 [@option{--keep-file-symbols}]
3256 [@option{--only-keep-debug}]
3257 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
3258 [@option{--help}] [@option{--info}]
3259 @var{objfile}@dots{}
3263 @c man begin DESCRIPTION strip
3265 @sc{gnu} @command{strip} discards all symbols from object files
3266 @var{objfile}. The list of object files may include archives.
3267 At least one object file must be given.
3269 @command{strip} modifies the files named in its argument,
3270 rather than writing modified copies under different names.
3274 @c man begin OPTIONS strip
3277 @item -F @var{bfdname}
3278 @itemx --target=@var{bfdname}
3279 Treat the original @var{objfile} as a file with the object
3280 code format @var{bfdname}, and rewrite it in the same format.
3281 @xref{Target Selection}, for more information.
3284 Show a summary of the options to @command{strip} and exit.
3287 Display a list showing all architectures and object formats available.
3289 @item -I @var{bfdname}
3290 @itemx --input-target=@var{bfdname}
3291 Treat the original @var{objfile} as a file with the object
3292 code format @var{bfdname}.
3293 @xref{Target Selection}, for more information.
3295 @item -O @var{bfdname}
3296 @itemx --output-target=@var{bfdname}
3297 Replace @var{objfile} with a file in the output format @var{bfdname}.
3298 @xref{Target Selection}, for more information.
3300 @item -R @var{sectionname}
3301 @itemx --remove-section=@var{sectionname}
3302 Remove any section named @var{sectionname} from the output file, in
3303 addition to whatever sections would otherwise be removed. This
3304 option may be given more than once. Note that using this option
3305 inappropriately may make the output file unusable. The wildcard
3306 character @samp{*} may be given at the end of @var{sectionname}. If
3307 so, then any section starting with @var{sectionname} will be removed.
3309 If the first character of @var{sectionpattern} is the exclamation
3310 point (!) then matching sections will not be removed even if an
3311 earlier use of @option{--remove-section} on the same command line
3312 would otherwise remove it. For example:
3315 --remove-section=.text.* --remove-section=!.text.foo
3318 will remove all sections matching the pattern '.text.*', but will not
3319 remove the section '.text.foo'.
3321 @item --keep-section=@var{sectionpattern}
3322 When removing sections from the output file, keep sections that match
3323 @var{sectionpattern}.
3325 @item --remove-relocations=@var{sectionpattern}
3326 Remove relocations from the output file for any section matching
3327 @var{sectionpattern}. This option may be given more than once. Note
3328 that using this option inappropriately may make the output file
3329 unusable. Wildcard characters are accepted in @var{sectionpattern}.
3333 --remove-relocations=.text.*
3336 will remove the relocations for all sections matching the patter
3339 If the first character of @var{sectionpattern} is the exclamation
3340 point (!) then matching sections will not have their relocation
3341 removed even if an earlier use of @option{--remove-relocations} on the
3342 same command line would otherwise cause the relocations to be removed.
3346 --remove-relocations=.text.* --remove-relocations=!.text.foo
3349 will remove all relocations for sections matching the pattern
3350 '.text.*', but will not remove relocations for the section
3360 @itemx --strip-debug
3361 Remove debugging symbols only.
3364 Remove the contents of all DWARF .dwo sections, leaving the
3365 remaining debugging sections and all symbols intact.
3366 See the description of this option in the @command{objcopy} section
3367 for more information.
3369 @item --strip-unneeded
3370 Remove all symbols that are not needed for relocation processing.
3372 @item -K @var{symbolname}
3373 @itemx --keep-symbol=@var{symbolname}
3374 When stripping symbols, keep symbol @var{symbolname} even if it would
3375 normally be stripped. This option may be given more than once.
3378 @itemx --merge-notes
3379 @itemx --no-merge-notes
3380 For ELF files, attempt (or do not attempt) to reduce the size of any
3381 SHT_NOTE type sections by removing duplicate notes. The default is to
3382 attempt this reduction unless stripping debug or DWO information.
3384 @item -N @var{symbolname}
3385 @itemx --strip-symbol=@var{symbolname}
3386 Remove symbol @var{symbolname} from the source file. This option may be
3387 given more than once, and may be combined with strip options other than
3391 Put the stripped output in @var{file}, rather than replacing the
3392 existing file. When this argument is used, only one @var{objfile}
3393 argument may be specified.
3396 @itemx --preserve-dates
3397 Preserve the access and modification dates of the file.
3400 @itemx --enable-deterministic-archives
3401 @cindex deterministic archives
3402 @kindex --enable-deterministic-archives
3403 Operate in @emph{deterministic} mode. When copying archive members
3404 and writing the archive index, use zero for UIDs, GIDs, timestamps,
3405 and use consistent file modes for all files.
3407 If @file{binutils} was configured with
3408 @option{--enable-deterministic-archives}, then this mode is on by default.
3409 It can be disabled with the @samp{-U} option, below.
3412 @itemx --disable-deterministic-archives
3413 @cindex deterministic archives
3414 @kindex --enable-deterministic-archives
3415 Do @emph{not} operate in @emph{deterministic} mode. This is the
3416 inverse of the @option{-D} option, above: when copying archive members
3417 and writing the archive index, use their actual UID, GID, timestamp,
3418 and file mode values.
3420 This is the default unless @file{binutils} was configured with
3421 @option{--enable-deterministic-archives}.
3425 Permit regular expressions in @var{symbolname}s used in other command
3426 line options. The question mark (?), asterisk (*), backslash (\) and
3427 square brackets ([]) operators can be used anywhere in the symbol
3428 name. If the first character of the symbol name is the exclamation
3429 point (!) then the sense of the switch is reversed for that symbol.
3436 would cause strip to only keep symbols that start with the letters
3437 ``fo'', but to discard the symbol ``foo''.
3440 @itemx --discard-all
3441 Remove non-global symbols.
3444 @itemx --discard-locals
3445 Remove compiler-generated local symbols.
3446 (These usually start with @samp{L} or @samp{.}.)
3448 @item --keep-file-symbols
3449 When stripping a file, perhaps with @option{--strip-debug} or
3450 @option{--strip-unneeded}, retain any symbols specifying source file names,
3451 which would otherwise get stripped.
3453 @item --only-keep-debug
3454 Strip a file, emptying the contents of any sections that would not be
3455 stripped by @option{--strip-debug} and leaving the debugging sections
3456 intact. In ELF files, this preserves all the note sections in the
3459 Note - the section headers of the stripped sections are preserved,
3460 including their sizes, but the contents of the section are discarded.
3461 The section headers are preserved so that other tools can match up the
3462 debuginfo file with the real executable, even if that executable has
3463 been relocated to a different address space.
3465 The intention is that this option will be used in conjunction with
3466 @option{--add-gnu-debuglink} to create a two part executable. One a
3467 stripped binary which will occupy less space in RAM and in a
3468 distribution and the second a debugging information file which is only
3469 needed if debugging abilities are required. The suggested procedure
3470 to create these files is as follows:
3473 @item Link the executable as normal. Assuming that it is called
3475 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3476 create a file containing the debugging info.
3477 @item Run @code{objcopy --strip-debug foo} to create a
3478 stripped executable.
3479 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3480 to add a link to the debugging info into the stripped executable.
3483 Note---the choice of @code{.dbg} as an extension for the debug info
3484 file is arbitrary. Also the @code{--only-keep-debug} step is
3485 optional. You could instead do this:
3488 @item Link the executable as normal.
3489 @item Copy @code{foo} to @code{foo.full}
3490 @item Run @code{strip --strip-debug foo}
3491 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3494 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
3495 full executable. It does not have to be a file created by the
3496 @option{--only-keep-debug} switch.
3498 Note---this switch is only intended for use on fully linked files. It
3499 does not make sense to use it on object files where the debugging
3500 information may be incomplete. Besides the gnu_debuglink feature
3501 currently only supports the presence of one filename containing
3502 debugging information, not multiple filenames on a one-per-object-file
3507 Show the version number for @command{strip}.
3511 Verbose output: list all object files modified. In the case of
3512 archives, @samp{strip -v} lists all members of the archive.
3518 @c man begin SEEALSO strip
3519 the Info entries for @file{binutils}.
3523 @node c++filt, addr2line, strip, Top
3527 @cindex demangling C++ symbols
3529 @c man title cxxfilt demangle C++ and Java symbols
3532 @c man begin SYNOPSIS cxxfilt
3533 c++filt [@option{-_}|@option{--strip-underscore}]
3534 [@option{-n}|@option{--no-strip-underscore}]
3535 [@option{-p}|@option{--no-params}]
3536 [@option{-t}|@option{--types}]
3537 [@option{-i}|@option{--no-verbose}]
3538 [@option{-r}|@option{--no-recurse-limit}]
3539 [@option{-R}|@option{--recurse-limit}]
3540 [@option{-s} @var{format}|@option{--format=}@var{format}]
3541 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
3545 @c man begin DESCRIPTION cxxfilt
3548 The C++ and Java languages provide function overloading, which means
3549 that you can write many functions with the same name, providing that
3550 each function takes parameters of different types. In order to be
3551 able to distinguish these similarly named functions C++ and Java
3552 encode them into a low-level assembler name which uniquely identifies
3553 each different version. This process is known as @dfn{mangling}. The
3555 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3556 MS-DOS this program is named @command{CXXFILT}.}
3557 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3558 names into user-level names so that they can be read.
3560 Every alphanumeric word (consisting of letters, digits, underscores,
3561 dollars, or periods) seen in the input is a potential mangled name.
3562 If the name decodes into a C++ name, the C++ name replaces the
3563 low-level name in the output, otherwise the original word is output.
3564 In this way you can pass an entire assembler source file, containing
3565 mangled names, through @command{c++filt} and see the same source file
3566 containing demangled names.
3568 You can also use @command{c++filt} to decipher individual symbols by
3569 passing them on the command line:
3572 c++filt @var{symbol}
3575 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3576 names from the standard input instead. All the results are printed on
3577 the standard output. The difference between reading names from the
3578 command line versus reading names from the standard input is that
3579 command-line arguments are expected to be just mangled names and no
3580 checking is performed to separate them from surrounding text. Thus
3587 will work and demangle the name to ``f()'' whereas:
3593 will not work. (Note the extra comma at the end of the mangled
3594 name which makes it invalid). This command however will work:
3597 echo _Z1fv, | c++filt -n
3600 and will display ``f(),'', i.e., the demangled name followed by a
3601 trailing comma. This behaviour is because when the names are read
3602 from the standard input it is expected that they might be part of an
3603 assembler source file where there might be extra, extraneous
3604 characters trailing after a mangled name. For example:
3607 .type _Z1fv, @@function
3612 @c man begin OPTIONS cxxfilt
3616 @itemx --strip-underscore
3617 On some systems, both the C and C++ compilers put an underscore in front
3618 of every name. For example, the C name @code{foo} gets the low-level
3619 name @code{_foo}. This option removes the initial underscore. Whether
3620 @command{c++filt} removes the underscore by default is target dependent.
3623 @itemx --no-strip-underscore
3624 Do not remove the initial underscore.
3628 When demangling the name of a function, do not display the types of
3629 the function's parameters.
3633 Attempt to demangle types as well as function names. This is disabled
3634 by default since mangled types are normally only used internally in
3635 the compiler, and they can be confused with non-mangled names. For example,
3636 a function called ``a'' treated as a mangled type name would be
3637 demangled to ``signed char''.
3641 Do not include implementation details (if any) in the demangled
3646 @itemx --recurse-limit
3647 @itemx --no-recurse-limit
3648 @itemx --recursion-limit
3649 @itemx --no-recursion-limit
3650 Enables or disables a limit on the amount of recursion performed
3651 whilst demangling strings. Since the name mangling formats allow for
3652 an inifinite level of recursion it is possible to create strings whose
3653 decoding will exhaust the amount of stack space available on the host
3654 machine, triggering a memory fault. The limit tries to prevent this
3655 from happening by restricting recursion to 2048 levels of nesting.
3657 The default is for this limit to be enabled, but disabling it may be
3658 necessary in order to demangle truly complicated names. Note however
3659 that if the recursion limit is disabled then stack exhaustion is
3660 possible and any bug reports about such an event will be rejected.
3662 The @option{-r} option is a synonym for the
3663 @option{--no-recurse-limit} option. The @option{-R} option is a
3664 synonym for the @option{--recurse-limit} option.
3666 @item -s @var{format}
3667 @itemx --format=@var{format}
3668 @command{c++filt} can decode various methods of mangling, used by
3669 different compilers. The argument to this option selects which
3674 Automatic selection based on executable (the default method)
3676 the one used by the @sc{gnu} C++ compiler (g++)
3678 the one used by the Lucid compiler (lcc)
3680 the one specified by the C++ Annotated Reference Manual
3682 the one used by the HP compiler (aCC)
3684 the one used by the EDG compiler
3686 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3688 the one used by the @sc{gnu} Java compiler (gcj)
3690 the one used by the @sc{gnu} Ada compiler (GNAT).
3694 Print a summary of the options to @command{c++filt} and exit.
3697 Print the version number of @command{c++filt} and exit.
3703 @c man begin SEEALSO cxxfilt
3704 the Info entries for @file{binutils}.
3709 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3710 user interface are subject to change in future releases. In particular,
3711 a command-line option may be required in the future to decode a name
3712 passed as an argument on the command line; in other words,
3715 c++filt @var{symbol}
3719 may in a future release become
3722 c++filt @var{option} @var{symbol}
3730 @cindex address to file name and line number
3732 @c man title addr2line convert addresses into file names and line numbers
3735 @c man begin SYNOPSIS addr2line
3736 addr2line [@option{-a}|@option{--addresses}]
3737 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3738 [@option{-C}|@option{--demangle}[=@var{style}]]
3739 [@option{-r}|@option{--no-recurse-limit}]
3740 [@option{-R}|@option{--recurse-limit}]
3741 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3742 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3743 [@option{-i}|@option{--inlines}]
3744 [@option{-p}|@option{--pretty-print}]
3745 [@option{-j}|@option{--section=}@var{name}]
3746 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3751 @c man begin DESCRIPTION addr2line
3753 @command{addr2line} translates addresses into file names and line numbers.
3754 Given an address in an executable or an offset in a section of a relocatable
3755 object, it uses the debugging information to figure out which file name and
3756 line number are associated with it.
3758 The executable or relocatable object to use is specified with the @option{-e}
3759 option. The default is the file @file{a.out}. The section in the relocatable
3760 object to use is specified with the @option{-j} option.
3762 @command{addr2line} has two modes of operation.
3764 In the first, hexadecimal addresses are specified on the command line,
3765 and @command{addr2line} displays the file name and line number for each
3768 In the second, @command{addr2line} reads hexadecimal addresses from
3769 standard input, and prints the file name and line number for each
3770 address on standard output. In this mode, @command{addr2line} may be used
3771 in a pipe to convert dynamically chosen addresses.
3773 The format of the output is @samp{FILENAME:LINENO}. By default
3774 each input address generates one line of output.
3776 Two options can generate additional lines before each
3777 @samp{FILENAME:LINENO} line (in that order).
3779 If the @option{-a} option is used then a line with the input address
3782 If the @option{-f} option is used, then a line with the
3783 @samp{FUNCTIONNAME} is displayed. This is the name of the function
3784 containing the address.
3786 One option can generate additional lines after the
3787 @samp{FILENAME:LINENO} line.
3789 If the @option{-i} option is used and the code at the given address is
3790 present there because of inlining by the compiler then additional
3791 lines are displayed afterwards. One or two extra lines (if the
3792 @option{-f} option is used) are displayed for each inlined function.
3794 Alternatively if the @option{-p} option is used then each input
3795 address generates a single, long, output line containing the address,
3796 the function name, the file name and the line number. If the
3797 @option{-i} option has also been used then any inlined functions will
3798 be displayed in the same manner, but on separate lines, and prefixed
3799 by the text @samp{(inlined by)}.
3801 If the file name or function name can not be determined,
3802 @command{addr2line} will print two question marks in their place. If the
3803 line number can not be determined, @command{addr2line} will print 0.
3807 @c man begin OPTIONS addr2line
3809 The long and short forms of options, shown here as alternatives, are
3815 Display the address before the function name, file and line number
3816 information. The address is printed with a @samp{0x} prefix to easily
3819 @item -b @var{bfdname}
3820 @itemx --target=@var{bfdname}
3821 @cindex object code format
3822 Specify that the object-code format for the object files is
3826 @itemx --demangle[=@var{style}]
3827 @cindex demangling in objdump
3828 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3829 Besides removing any initial underscore prepended by the system, this
3830 makes C++ function names readable. Different compilers have different
3831 mangling styles. The optional demangling style argument can be used to
3832 choose an appropriate demangling style for your compiler. @xref{c++filt},
3833 for more information on demangling.
3835 @item -e @var{filename}
3836 @itemx --exe=@var{filename}
3837 Specify the name of the executable for which addresses should be
3838 translated. The default file is @file{a.out}.
3842 Display function names as well as file and line number information.
3846 Display only the base of each file name.
3850 If the address belongs to a function that was inlined, the source
3851 information for all enclosing scopes back to the first non-inlined
3852 function will also be printed. For example, if @code{main} inlines
3853 @code{callee1} which inlines @code{callee2}, and address is from
3854 @code{callee2}, the source information for @code{callee1} and @code{main}
3855 will also be printed.
3859 Read offsets relative to the specified section instead of absolute addresses.
3862 @itemx --pretty-print
3863 Make the output more human friendly: each location are printed on one line.
3864 If option @option{-i} is specified, lines for all enclosing scopes are
3865 prefixed with @samp{(inlined by)}.
3869 @itemx --recurse-limit
3870 @itemx --no-recurse-limit
3871 @itemx --recursion-limit
3872 @itemx --no-recursion-limit
3873 Enables or disables a limit on the amount of recursion performed
3874 whilst demangling strings. Since the name mangling formats allow for
3875 an inifinite level of recursion it is possible to create strings whose
3876 decoding will exhaust the amount of stack space available on the host
3877 machine, triggering a memory fault. The limit tries to prevent this
3878 from happening by restricting recursion to 2048 levels of nesting.
3880 The default is for this limit to be enabled, but disabling it may be
3881 necessary in order to demangle truly complicated names. Note however
3882 that if the recursion limit is disabled then stack exhaustion is
3883 possible and any bug reports about such an event will be rejected.
3885 The @option{-r} option is a synonym for the
3886 @option{--no-recurse-limit} option. The @option{-R} option is a
3887 synonym for the @option{--recurse-limit} option.
3889 Note this option is only effective if the @option{-C} or
3890 @option{--demangle} option has been enabled.
3897 @c man begin SEEALSO addr2line
3898 Info entries for @file{binutils}.
3905 @command{windmc} may be used to generator Windows message resources.
3908 @emph{Warning:} @command{windmc} is not always built as part of the binary
3909 utilities, since it is only useful for Windows targets.
3912 @c man title windmc generates Windows message resources
3915 @c man begin SYNOPSIS windmc
3916 windmc [options] input-file
3920 @c man begin DESCRIPTION windmc
3922 @command{windmc} reads message definitions from an input file (.mc) and
3923 translate them into a set of output files. The output files may be of
3928 A C header file containing the message definitions.
3931 A resource file compilable by the @command{windres} tool.
3934 One or more binary files containing the resource data for a specific
3938 A C include file that maps message id's to their symbolic name.
3941 The exact description of these different formats is available in
3942 documentation from Microsoft.
3944 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3945 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3946 Windows Message Compiler.
3950 @c man begin OPTIONS windmc
3955 Specifies that the input file specified is ASCII. This is the default
3960 Specifies that messages in the output @code{bin} files should be in ASCII
3965 Specifies that @code{bin} filenames should have to be prefixed by the
3966 basename of the source file.
3970 Sets the customer bit in all message id's.
3972 @item -C @var{codepage}
3973 @itemx --codepage_in @var{codepage}
3974 Sets the default codepage to be used to convert input file to UTF16. The
3975 default is ocdepage 1252.
3978 @itemx --decimal_values
3979 Outputs the constants in the header file in decimal. Default is using
3983 @itemx --extension @var{ext}
3984 The extension for the header file. The default is .h extension.
3986 @item -F @var{target}
3987 @itemx --target @var{target}
3988 Specify the BFD format to use for a bin file as output. This
3989 is a BFD target name; you can use the @option{--help} option to see a list
3990 of supported targets. Normally @command{windmc} will use the default
3991 format, which is the first one listed by the @option{--help} option.
3993 @ref{Target Selection}.
3997 @itemx --headerdir @var{path}
3998 The target directory of the generated header file. The default is the
4003 Displays a list of command-line options and then exits.
4005 @item -m @var{characters}
4006 @itemx --maxlength @var{characters}
4007 Instructs @command{windmc} to generate a warning if the length
4008 of any message exceeds the number specified.
4011 @itemx --nullterminate
4012 Terminate message text in @code{bin} files by zero. By default they are
4013 terminated by CR/LF.
4016 @itemx --hresult_use
4017 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
4018 file, using HRESULT definitions. Status codes are used if the flag is not
4021 @item -O @var{codepage}
4022 @itemx --codepage_out @var{codepage}
4023 Sets the default codepage to be used to output text files. The default
4027 @itemx --rcdir @var{path}
4028 The target directory for the generated @code{rc} script and the generated
4029 @code{bin} files that the resource compiler script includes. The default
4030 is the current directory.
4034 Specifies that the input file is UTF16.
4037 @itemx --unicode_out
4038 Specifies that messages in the output @code{bin} file should be in UTF16
4039 format. This is the default behaviour.
4043 Enable verbose mode.
4047 Prints the version number for @command{windmc}.
4050 @itemx --xdgb @var{path}
4051 The path of the @code{dbg} C include file that maps message id's to the
4052 symbolic name. No such file is generated without specifying the switch.
4058 @c man begin SEEALSO windmc
4059 the Info entries for @file{binutils}.
4066 @command{windres} may be used to manipulate Windows resources.
4069 @emph{Warning:} @command{windres} is not always built as part of the binary
4070 utilities, since it is only useful for Windows targets.
4073 @c man title windres manipulate Windows resources
4076 @c man begin SYNOPSIS windres
4077 windres [options] [input-file] [output-file]
4081 @c man begin DESCRIPTION windres
4083 @command{windres} reads resources from an input file and copies them into
4084 an output file. Either file may be in one of three formats:
4088 A text format read by the Resource Compiler.
4091 A binary format generated by the Resource Compiler.
4094 A COFF object or executable.
4097 The exact description of these different formats is available in
4098 documentation from Microsoft.
4100 When @command{windres} converts from the @code{rc} format to the @code{res}
4101 format, it is acting like the Windows Resource Compiler. When
4102 @command{windres} converts from the @code{res} format to the @code{coff}
4103 format, it is acting like the Windows @code{CVTRES} program.
4105 When @command{windres} generates an @code{rc} file, the output is similar
4106 but not identical to the format expected for the input. When an input
4107 @code{rc} file refers to an external filename, an output @code{rc} file
4108 will instead include the file contents.
4110 If the input or output format is not specified, @command{windres} will
4111 guess based on the file name, or, for the input file, the file contents.
4112 A file with an extension of @file{.rc} will be treated as an @code{rc}
4113 file, a file with an extension of @file{.res} will be treated as a
4114 @code{res} file, and a file with an extension of @file{.o} or
4115 @file{.exe} will be treated as a @code{coff} file.
4117 If no output file is specified, @command{windres} will print the resources
4118 in @code{rc} format to standard output.
4120 The normal use is for you to write an @code{rc} file, use @command{windres}
4121 to convert it to a COFF object file, and then link the COFF file into
4122 your application. This will make the resources described in the
4123 @code{rc} file available to Windows.
4127 @c man begin OPTIONS windres
4130 @item -i @var{filename}
4131 @itemx --input @var{filename}
4132 The name of the input file. If this option is not used, then
4133 @command{windres} will use the first non-option argument as the input file
4134 name. If there are no non-option arguments, then @command{windres} will
4135 read from standard input. @command{windres} can not read a COFF file from
4138 @item -o @var{filename}
4139 @itemx --output @var{filename}
4140 The name of the output file. If this option is not used, then
4141 @command{windres} will use the first non-option argument, after any used
4142 for the input file name, as the output file name. If there is no
4143 non-option argument, then @command{windres} will write to standard output.
4144 @command{windres} can not write a COFF file to standard output. Note,
4145 for compatibility with @command{rc} the option @option{-fo} is also
4146 accepted, but its use is not recommended.
4148 @item -J @var{format}
4149 @itemx --input-format @var{format}
4150 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
4151 @samp{coff}. If no input format is specified, @command{windres} will
4152 guess, as described above.
4154 @item -O @var{format}
4155 @itemx --output-format @var{format}
4156 The output format to generate. @var{format} may be @samp{res},
4157 @samp{rc}, or @samp{coff}. If no output format is specified,
4158 @command{windres} will guess, as described above.
4160 @item -F @var{target}
4161 @itemx --target @var{target}
4162 Specify the BFD format to use for a COFF file as input or output. This
4163 is a BFD target name; you can use the @option{--help} option to see a list
4164 of supported targets. Normally @command{windres} will use the default
4165 format, which is the first one listed by the @option{--help} option.
4167 @ref{Target Selection}.
4170 @item --preprocessor @var{program}
4171 When @command{windres} reads an @code{rc} file, it runs it through the C
4172 preprocessor first. This option may be used to specify the preprocessor
4173 to use, including any leading arguments. The default preprocessor
4174 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
4176 @item --preprocessor-arg @var{option}
4177 When @command{windres} reads an @code{rc} file, it runs it through
4178 the C preprocessor first. This option may be used to specify additional
4179 text to be passed to preprocessor on its command line.
4180 This option can be used multiple times to add multiple options to the
4181 preprocessor command line.
4183 @item -I @var{directory}
4184 @itemx --include-dir @var{directory}
4185 Specify an include directory to use when reading an @code{rc} file.
4186 @command{windres} will pass this to the preprocessor as an @option{-I}
4187 option. @command{windres} will also search this directory when looking for
4188 files named in the @code{rc} file. If the argument passed to this command
4189 matches any of the supported @var{formats} (as described in the @option{-J}
4190 option), it will issue a deprecation warning, and behave just like the
4191 @option{-J} option. New programs should not use this behaviour. If a
4192 directory happens to match a @var{format}, simple prefix it with @samp{./}
4193 to disable the backward compatibility.
4195 @item -D @var{target}
4196 @itemx --define @var{sym}[=@var{val}]
4197 Specify a @option{-D} option to pass to the preprocessor when reading an
4200 @item -U @var{target}
4201 @itemx --undefine @var{sym}
4202 Specify a @option{-U} option to pass to the preprocessor when reading an
4206 Ignored for compatibility with rc.
4209 Enable verbose mode. This tells you what the preprocessor is if you
4213 @item --codepage @var{val}
4214 Specify the default codepage to use when reading an @code{rc} file.
4215 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
4216 codepage code. The valid range is from zero up to 0xffff, but the
4217 validity of the codepage is host and configuration dependent.
4220 @item --language @var{val}
4221 Specify the default language to use when reading an @code{rc} file.
4222 @var{val} should be a hexadecimal language code. The low eight bits are
4223 the language, and the high eight bits are the sublanguage.
4225 @item --use-temp-file
4226 Use a temporary file to instead of using popen to read the output of
4227 the preprocessor. Use this option if the popen implementation is buggy
4228 on the host (eg., certain non-English language versions of Windows 95 and
4229 Windows 98 are known to have buggy popen where the output will instead
4232 @item --no-use-temp-file
4233 Use popen, not a temporary file, to read the output of the preprocessor.
4234 This is the default behaviour.
4238 Prints a usage summary.
4242 Prints the version number for @command{windres}.
4245 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
4246 this will turn on parser debugging.
4252 @c man begin SEEALSO windres
4253 the Info entries for @file{binutils}.
4262 @command{dlltool} is used to create the files needed to create dynamic
4263 link libraries (DLLs) on systems which understand PE format image
4264 files such as Windows. A DLL contains an export table which contains
4265 information that the runtime loader needs to resolve references from a
4266 referencing program.
4268 The export table is generated by this program by reading in a
4269 @file{.def} file or scanning the @file{.a} and @file{.o} files which
4270 will be in the DLL. A @file{.o} file can contain information in
4271 special @samp{.drectve} sections with export information.
4274 @emph{Note:} @command{dlltool} is not always built as part of the
4275 binary utilities, since it is only useful for those targets which
4279 @c man title dlltool create files needed to build and use DLLs
4282 @c man begin SYNOPSIS dlltool
4283 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
4284 [@option{-b}|@option{--base-file} @var{base-file-name}]
4285 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
4286 [@option{-z}|@option{--output-def} @var{def-file-name}]
4287 [@option{-l}|@option{--output-lib} @var{library-file-name}]
4288 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
4289 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
4290 [@option{--exclude-symbols} @var{list}]
4291 [@option{--no-default-excludes}]
4292 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
4293 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
4294 [@option{-a}|@option{--add-indirect}]
4295 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
4296 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
4297 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
4298 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
4299 [@option{--use-nul-prefixed-import-tables}]
4300 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
4301 [@option{-i}|@option{--interwork}]
4302 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
4303 [@option{-v}|@option{--verbose}]
4304 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
4305 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
4306 [object-file @dots{}]
4310 @c man begin DESCRIPTION dlltool
4312 @command{dlltool} reads its inputs, which can come from the @option{-d} and
4313 @option{-b} options as well as object files specified on the command
4314 line. It then processes these inputs and if the @option{-e} option has
4315 been specified it creates a exports file. If the @option{-l} option
4316 has been specified it creates a library file and if the @option{-z} option
4317 has been specified it creates a def file. Any or all of the @option{-e},
4318 @option{-l} and @option{-z} options can be present in one invocation of
4321 When creating a DLL, along with the source for the DLL, it is necessary
4322 to have three other files. @command{dlltool} can help with the creation of
4325 The first file is a @file{.def} file which specifies which functions are
4326 exported from the DLL, which functions the DLL imports, and so on. This
4327 is a text file and can be created by hand, or @command{dlltool} can be used
4328 to create it using the @option{-z} option. In this case @command{dlltool}
4329 will scan the object files specified on its command line looking for
4330 those functions which have been specially marked as being exported and
4331 put entries for them in the @file{.def} file it creates.
4333 In order to mark a function as being exported from a DLL, it needs to
4334 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
4335 section of the object file. This can be done in C by using the
4339 asm (".section .drectve");
4340 asm (".ascii \"-export:my_func\"");
4342 int my_func (void) @{ @dots{} @}
4345 The second file needed for DLL creation is an exports file. This file
4346 is linked with the object files that make up the body of the DLL and it
4347 handles the interface between the DLL and the outside world. This is a
4348 binary file and it can be created by giving the @option{-e} option to
4349 @command{dlltool} when it is creating or reading in a @file{.def} file.
4351 The third file needed for DLL creation is the library file that programs
4352 will link with in order to access the functions in the DLL (an `import
4353 library'). This file can be created by giving the @option{-l} option to
4354 dlltool when it is creating or reading in a @file{.def} file.
4356 If the @option{-y} option is specified, dlltool generates a delay-import
4357 library that can be used instead of the normal import library to allow
4358 a program to link to the dll only as soon as an imported function is
4359 called for the first time. The resulting executable will need to be
4360 linked to the static delayimp library containing __delayLoadHelper2(),
4361 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4363 @command{dlltool} builds the library file by hand, but it builds the
4364 exports file by creating temporary files containing assembler statements
4365 and then assembling these. The @option{-S} command-line option can be
4366 used to specify the path to the assembler that dlltool will use,
4367 and the @option{-f} option can be used to pass specific flags to that
4368 assembler. The @option{-n} can be used to prevent dlltool from deleting
4369 these temporary assembler files when it is done, and if @option{-n} is
4370 specified twice then this will prevent dlltool from deleting the
4371 temporary object files it used to build the library.
4373 Here is an example of creating a DLL from a source file @samp{dll.c} and
4374 also creating a program (from an object file called @samp{program.o})
4379 dlltool -e exports.o -l dll.lib dll.o
4380 gcc dll.o exports.o -o dll.dll
4381 gcc program.o dll.lib -o program
4385 @command{dlltool} may also be used to query an existing import library
4386 to determine the name of the DLL to which it is associated. See the
4387 description of the @option{-I} or @option{--identify} option.
4391 @c man begin OPTIONS dlltool
4393 The command-line options have the following meanings:
4397 @item -d @var{filename}
4398 @itemx --input-def @var{filename}
4399 @cindex input .def file
4400 Specifies the name of a @file{.def} file to be read in and processed.
4402 @item -b @var{filename}
4403 @itemx --base-file @var{filename}
4405 Specifies the name of a base file to be read in and processed. The
4406 contents of this file will be added to the relocation section in the
4407 exports file generated by dlltool.
4409 @item -e @var{filename}
4410 @itemx --output-exp @var{filename}
4411 Specifies the name of the export file to be created by dlltool.
4413 @item -z @var{filename}
4414 @itemx --output-def @var{filename}
4415 Specifies the name of the @file{.def} file to be created by dlltool.
4417 @item -l @var{filename}
4418 @itemx --output-lib @var{filename}
4419 Specifies the name of the library file to be created by dlltool.
4421 @item -y @var{filename}
4422 @itemx --output-delaylib @var{filename}
4423 Specifies the name of the delay-import library file to be created by dlltool.
4425 @item --export-all-symbols
4426 Treat all global and weak defined symbols found in the input object
4427 files as symbols to be exported. There is a small list of symbols which
4428 are not exported by default; see the @option{--no-default-excludes}
4429 option. You may add to the list of symbols to not export by using the
4430 @option{--exclude-symbols} option.
4432 @item --no-export-all-symbols
4433 Only export symbols explicitly listed in an input @file{.def} file or in
4434 @samp{.drectve} sections in the input object files. This is the default
4435 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
4436 attributes in the source code.
4438 @item --exclude-symbols @var{list}
4439 Do not export the symbols in @var{list}. This is a list of symbol names
4440 separated by comma or colon characters. The symbol names should not
4441 contain a leading underscore. This is only meaningful when
4442 @option{--export-all-symbols} is used.
4444 @item --no-default-excludes
4445 When @option{--export-all-symbols} is used, it will by default avoid
4446 exporting certain special symbols. The current list of symbols to avoid
4447 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
4448 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
4449 to go ahead and export these special symbols. This is only meaningful
4450 when @option{--export-all-symbols} is used.
4453 @itemx --as @var{path}
4454 Specifies the path, including the filename, of the assembler to be used
4455 to create the exports file.
4457 @item -f @var{options}
4458 @itemx --as-flags @var{options}
4459 Specifies any specific command-line options to be passed to the
4460 assembler when building the exports file. This option will work even if
4461 the @option{-S} option is not used. This option only takes one argument,
4462 and if it occurs more than once on the command line, then later
4463 occurrences will override earlier occurrences. So if it is necessary to
4464 pass multiple options to the assembler they should be enclosed in
4468 @itemx --dll-name @var{name}
4469 Specifies the name to be stored in the @file{.def} file as the name of
4470 the DLL when the @option{-e} option is used. If this option is not
4471 present, then the filename given to the @option{-e} option will be
4472 used as the name of the DLL.
4474 @item -m @var{machine}
4475 @itemx -machine @var{machine}
4476 Specifies the type of machine for which the library file should be
4477 built. @command{dlltool} has a built in default type, depending upon how
4478 it was created, but this option can be used to override that. This is
4479 normally only useful when creating DLLs for an ARM processor, when the
4480 contents of the DLL are actually encode using Thumb instructions.
4483 @itemx --add-indirect
4484 Specifies that when @command{dlltool} is creating the exports file it
4485 should add a section which allows the exported functions to be
4486 referenced without using the import library. Whatever the hell that
4490 @itemx --add-underscore
4491 Specifies that when @command{dlltool} is creating the exports file it
4492 should prepend an underscore to the names of @emph{all} exported symbols.
4494 @item --no-leading-underscore
4495 @item --leading-underscore
4496 Specifies whether standard symbol should be forced to be prefixed, or
4499 @item --add-stdcall-underscore
4500 Specifies that when @command{dlltool} is creating the exports file it
4501 should prepend an underscore to the names of exported @emph{stdcall}
4502 functions. Variable names and non-stdcall function names are not modified.
4503 This option is useful when creating GNU-compatible import libs for third
4504 party DLLs that were built with MS-Windows tools.
4508 Specifies that @samp{@@<number>} suffixes should be omitted from the names
4509 of stdcall functions that will be imported from the DLL. This is
4510 useful when creating an import library for a DLL which exports stdcall
4511 functions but without the usual @samp{@@<number>} symbol name suffix.
4513 This does not change the naming of symbols provided by the import library
4514 to programs linked against it, but only the entries in the import table
4515 (ie the .idata section).
4518 @itemx --add-stdcall-alias
4519 Specifies that when @command{dlltool} is creating the exports file it
4520 should add aliases for stdcall symbols without @samp{@@ <number>}
4521 in addition to the symbols with @samp{@@ <number>}.
4524 @itemx --ext-prefix-alias @var{prefix}
4525 Causes @command{dlltool} to create external aliases for all DLL
4526 imports with the specified prefix. The aliases are created for both
4527 external and import symbols with no leading underscore.
4531 Specifies that when @command{dlltool} is creating the exports and library
4532 files it should omit the @code{.idata4} section. This is for compatibility
4533 with certain operating systems.
4535 @item --use-nul-prefixed-import-tables
4536 Specifies that when @command{dlltool} is creating the exports and library
4537 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4538 element. This emulates old gnu import library generation of
4539 @code{dlltool}. By default this option is turned off.
4543 Specifies that when @command{dlltool} is creating the exports and library
4544 files it should omit the @code{.idata5} section. This is for compatibility
4545 with certain operating systems.
4547 @item -I @var{filename}
4548 @itemx --identify @var{filename}
4549 Specifies that @command{dlltool} should inspect the import library
4550 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4551 of the associated DLL(s). This can be performed in addition to any
4552 other operations indicated by the other options and arguments.
4553 @command{dlltool} fails if the import library does not exist or is not
4554 actually an import library. See also @option{--identify-strict}.
4556 @item --identify-strict
4557 Modifies the behavior of the @option{--identify} option, such
4558 that an error is reported if @var{filename} is associated with
4563 Specifies that @command{dlltool} should mark the objects in the library
4564 file and exports file that it produces as supporting interworking
4565 between ARM and Thumb code.
4569 Makes @command{dlltool} preserve the temporary assembler files it used to
4570 create the exports file. If this option is repeated then dlltool will
4571 also preserve the temporary object files it uses to create the library
4574 @item -t @var{prefix}
4575 @itemx --temp-prefix @var{prefix}
4576 Makes @command{dlltool} use @var{prefix} when constructing the names of
4577 temporary assembler and object files. By default, the temp file prefix
4578 is generated from the pid.
4582 Make dlltool describe what it is doing.
4586 Displays a list of command-line options and then exits.
4590 Displays dlltool's version number and then exits.
4597 * def file format:: The format of the dlltool @file{.def} file
4600 @node def file format
4601 @section The format of the @command{dlltool} @file{.def} file
4603 A @file{.def} file contains any number of the following commands:
4607 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4608 The result is going to be named @var{name}@code{.exe}.
4610 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4611 The result is going to be named @var{name}@code{.dll}.
4612 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4613 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4616 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4617 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4618 Declares @var{name1} as an exported symbol from the DLL, with optional
4619 ordinal number @var{integer}, or declares @var{name1} as an alias
4620 (forward) of the function @var{external-name} in the DLL.
4621 If @var{its_name} is specified, this name is used as string in export table.
4623 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4624 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4625 If you want to use LIBRARY as name then you need to quote it.
4627 @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{]} *}
4628 Declares that @var{external-name} or the exported function whose
4629 ordinal number is @var{integer} is to be imported from the file
4630 @var{module-name}. If @var{internal-name} is specified then this is
4631 the name that the imported function will be referred to in the body of
4633 If @var{its_name} is specified, this name is used as string in import table.
4634 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4635 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4636 If you want to use LIBRARY as name then you need to quote it.
4638 @item @code{DESCRIPTION} @var{string}
4639 Puts @var{string} into the output @file{.exp} file in the
4640 @code{.rdata} section.
4642 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4643 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4644 Generates @code{--stack} or @code{--heap}
4645 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4646 section. The linker will see this and act upon it.
4648 @item @code{CODE} @var{attr} @code{+}
4649 @item @code{DATA} @var{attr} @code{+}
4650 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4651 Generates @code{--attr} @var{section-name} @var{attr} in the output
4652 @code{.drectve} section, where @var{attr} is one of @code{READ},
4653 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4654 this and act upon it.
4659 @c man begin SEEALSO dlltool
4660 The Info pages for @file{binutils}.
4667 @cindex ELF file information
4670 @c man title readelf display information about ELF files
4673 @c man begin SYNOPSIS readelf
4674 readelf [@option{-a}|@option{--all}]
4675 [@option{-h}|@option{--file-header}]
4676 [@option{-l}|@option{--program-headers}|@option{--segments}]
4677 [@option{-S}|@option{--section-headers}|@option{--sections}]
4678 [@option{-g}|@option{--section-groups}]
4679 [@option{-t}|@option{--section-details}]
4680 [@option{-e}|@option{--headers}]
4681 [@option{-s}|@option{--syms}|@option{--symbols}]
4682 [@option{--dyn-syms}]
4683 [@option{-n}|@option{--notes}]
4684 [@option{-r}|@option{--relocs}]
4685 [@option{-u}|@option{--unwind}]
4686 [@option{-d}|@option{--dynamic}]
4687 [@option{-V}|@option{--version-info}]
4688 [@option{-A}|@option{--arch-specific}]
4689 [@option{-D}|@option{--use-dynamic}]
4690 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4691 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4692 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4693 [@option{-z}|@option{--decompress}]
4694 [@option{-c}|@option{--archive-index}]
4695 [@option{-w[lLiaprmfFsoRtUuTgAckK]}|
4696 @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,=addr,=cu_index,=links,=follow-links]]
4697 [@option{--dwarf-depth=@var{n}}]
4698 [@option{--dwarf-start=@var{n}}]
4699 [@option{--ctf=}@var{section}]
4700 [@option{--ctf-parent=}@var{section}]
4701 [@option{--ctf-symbols=}@var{section}]
4702 [@option{--ctf-strings=}@var{section}]
4703 [@option{-I}|@option{--histogram}]
4704 [@option{-v}|@option{--version}]
4705 [@option{-W}|@option{--wide}]
4706 [@option{-H}|@option{--help}]
4707 @var{elffile}@dots{}
4711 @c man begin DESCRIPTION readelf
4713 @command{readelf} displays information about one or more ELF format object
4714 files. The options control what particular information to display.
4716 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4717 64-bit ELF files are supported, as are archives containing ELF files.
4719 This program performs a similar function to @command{objdump} but it
4720 goes into more detail and it exists independently of the @sc{bfd}
4721 library, so if there is a bug in @sc{bfd} then readelf will not be
4726 @c man begin OPTIONS readelf
4728 The long and short forms of options, shown here as alternatives, are
4729 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4735 Equivalent to specifying @option{--file-header},
4736 @option{--program-headers}, @option{--sections}, @option{--symbols},
4737 @option{--relocs}, @option{--dynamic}, @option{--notes},
4738 @option{--version-info}, @option{--arch-specific}, @option{--unwind},
4739 @option{--section-groups} and @option{--histogram}.
4741 Note - this option does not enable @option{--use-dynamic} itself, so
4742 if that option is not present on the command line then dynamic symbols
4743 and dynamic relocs will not be displayed.
4746 @itemx --file-header
4747 @cindex ELF file header information
4748 Displays the information contained in the ELF header at the start of the
4752 @itemx --program-headers
4754 @cindex ELF program header information
4755 @cindex ELF segment information
4756 Displays the information contained in the file's segment headers, if it
4761 @itemx --section-headers
4762 @cindex ELF section information
4763 Displays the information contained in the file's section headers, if it
4767 @itemx --section-groups
4768 @cindex ELF section group information
4769 Displays the information contained in the file's section groups, if it
4773 @itemx --section-details
4774 @cindex ELF section information
4775 Displays the detailed section information. Implies @option{-S}.
4780 @cindex ELF symbol table information
4781 Displays the entries in symbol table section of the file, if it has one.
4782 If a symbol has version information associated with it then this is
4783 displayed as well. The version string is displayed as a suffix to the
4784 symbol name, preceeded by an @@ character. For example
4785 @samp{foo@@VER_1}. If the version is the default version to be used
4786 when resolving unversioned references to the symbol then it is
4787 displayed as a suffix preceeded by two @@ characters. For example
4788 @samp{foo@@@@VER_2}.
4791 @cindex ELF dynamic symbol table information
4792 Displays the entries in dynamic symbol table section of the file, if it
4793 has one. The output format is the same as the format used by the
4794 @option{--syms} option.
4798 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4803 Displays the contents of the NOTE segments and/or sections, if any.
4807 @cindex ELF reloc information
4808 Displays the contents of the file's relocation section, if it has one.
4812 @cindex unwind information
4813 Displays the contents of the file's unwind section, if it has one. Only
4814 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4815 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported. If
4816 support is not yet implemented for your architecture you could try
4817 dumping the contents of the @var{.eh_frames} section using the
4818 @option{--debug-dump=frames} or @option{--debug-dump=frames-interp}
4823 @cindex ELF dynamic section information
4824 Displays the contents of the file's dynamic section, if it has one.
4827 @itemx --version-info
4828 @cindex ELF version sections information
4829 Displays the contents of the version sections in the file, it they
4833 @itemx --arch-specific
4834 Displays architecture-specific information in the file, if there
4838 @itemx --use-dynamic
4839 When displaying symbols, this option makes @command{readelf} use the
4840 symbol hash tables in the file's dynamic section, rather than the
4841 symbol table sections.
4843 When displaying relocations, this option makes @command{readelf}
4844 display the dynamic relocations rather than the static relocations.
4846 @item -x <number or name>
4847 @itemx --hex-dump=<number or name>
4848 Displays the contents of the indicated section as a hexadecimal bytes.
4849 A number identifies a particular section by index in the section table;
4850 any other string identifies all sections with that name in the object file.
4852 @item -R <number or name>
4853 @itemx --relocated-dump=<number or name>
4854 Displays the contents of the indicated section as a hexadecimal
4855 bytes. A number identifies a particular section by index in the
4856 section table; any other string identifies all sections with that name
4857 in the object file. The contents of the section will be relocated
4858 before they are displayed.
4860 @item -p <number or name>
4861 @itemx --string-dump=<number or name>
4862 Displays the contents of the indicated section as printable strings.
4863 A number identifies a particular section by index in the section table;
4864 any other string identifies all sections with that name in the object file.
4868 Requests that the section(s) being dumped by @option{x}, @option{R} or
4869 @option{p} options are decompressed before being displayed. If the
4870 section(s) are not compressed then they are displayed as is.
4873 @itemx --archive-index
4874 @cindex Archive file symbol index information
4875 Displays the file symbol index information contained in the header part
4876 of binary archives. Performs the same function as the @option{t}
4877 command to @command{ar}, but without using the BFD library. @xref{ar}.
4879 @item -w[lLiaprmfFsoRtUuTgAckK]
4880 @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,=addr,=cu_index,=links,=follow-links]
4881 @include debug.options.texi
4883 @include ctf.options.texi
4884 @item --ctf-symbols=@var{section}
4885 @item --ctf-strings=@var{section}
4886 Specify the name of another section from which the CTF file can inherit
4887 strings and symbols. By default, the @code{.symtab} and its linked
4888 string table are used.
4890 If either of @option{--ctf-symbols} or @option{--ctf-strings} is specified, the
4891 other must be specified as well.
4895 Display a histogram of bucket list lengths when displaying the contents
4896 of the symbol tables.
4900 Display the version number of readelf.
4904 Don't break output lines to fit into 80 columns. By default
4905 @command{readelf} breaks section header and segment listing lines for
4906 64-bit ELF files, so that they fit into 80 columns. This option causes
4907 @command{readelf} to print each section header resp. each segment one a
4908 single line, which is far more readable on terminals wider than 80 columns.
4912 Display the command-line options understood by @command{readelf}.
4919 @c man begin SEEALSO readelf
4920 objdump(1), and the Info entries for @file{binutils}.
4927 @cindex Update ELF header
4930 @c man title elfedit update ELF header and program property of ELF files
4933 @c man begin SYNOPSIS elfedit
4934 elfedit [@option{--input-mach=}@var{machine}]
4935 [@option{--input-type=}@var{type}]
4936 [@option{--input-osabi=}@var{osabi}]
4937 @option{--output-mach=}@var{machine}
4938 @option{--output-type=}@var{type}
4939 @option{--output-osabi=}@var{osabi}
4940 @option{--enable-x86-feature=}@var{feature}
4941 @option{--disable-x86-feature=}@var{feature}
4942 [@option{-v}|@option{--version}]
4943 [@option{-h}|@option{--help}]
4944 @var{elffile}@dots{}
4948 @c man begin DESCRIPTION elfedit
4950 @command{elfedit} updates the ELF header and program property of ELF
4951 files which have the matching ELF machine and file types. The options
4952 control how and which fields in the ELF header and program property
4955 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4956 64-bit ELF files are supported, as are archives containing ELF files.
4959 @c man begin OPTIONS elfedit
4961 The long and short forms of options, shown here as alternatives, are
4962 equivalent. At least one of the @option{--output-mach},
4963 @option{--output-type}, @option{--output-osabi},
4964 @option{--enable-x86-feature} and @option{--disable-x86-feature}
4965 options must be given.
4969 @item --input-mach=@var{machine}
4970 Set the matching input ELF machine type to @var{machine}. If
4971 @option{--input-mach} isn't specified, it will match any ELF
4974 The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
4975 @var{K1OM} and @var{x86-64}.
4977 @item --output-mach=@var{machine}
4978 Change the ELF machine type in the ELF header to @var{machine}. The
4979 supported ELF machine types are the same as @option{--input-mach}.
4981 @item --input-type=@var{type}
4982 Set the matching input ELF file type to @var{type}. If
4983 @option{--input-type} isn't specified, it will match any ELF file types.
4985 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4987 @item --output-type=@var{type}
4988 Change the ELF file type in the ELF header to @var{type}. The
4989 supported ELF types are the same as @option{--input-type}.
4991 @item --input-osabi=@var{osabi}
4992 Set the matching input ELF file OSABI to @var{osabi}. If
4993 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4995 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4996 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4997 @var{Solaris}, @var{AIX}, @var{Irix},
4998 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4999 @var{NSK}, @var{AROS} and @var{FenixOS}.
5001 @item --output-osabi=@var{osabi}
5002 Change the ELF OSABI in the ELF header to @var{osabi}. The
5003 supported ELF OSABI are the same as @option{--input-osabi}.
5005 @item --enable-x86-feature=@var{feature}
5006 Set the @var{feature} bit in program property in @var{exec} or @var{dyn}
5007 ELF files with machine types of @var{i386} or @var{x86-64}. The
5008 supported features are, @var{ibt} and @var{shstk}.
5010 @item --disable-x86-feature=@var{feature}
5011 Clear the @var{feature} bit in program property in @var{exec} or
5012 @var{dyn} ELF files with machine types of @var{i386} or @var{x86-64}.
5013 The supported features are the same as @option{--enable-x86-feature}.
5015 Note: @option{--enable-x86-feature} and @option{--disable-x86-feature}
5016 are available only on hosts with @samp{mmap} support.
5020 Display the version number of @command{elfedit}.
5024 Display the command-line options understood by @command{elfedit}.
5031 @c man begin SEEALSO elfedit
5032 readelf(1), and the Info entries for @file{binutils}.
5036 @node Common Options
5037 @chapter Common Options
5039 The following command-line options are supported by all of the
5040 programs described in this manual.
5042 @c man begin OPTIONS
5044 @include at-file.texi
5048 Display the command-line options supported by the program.
5051 Display the version number of the program.
5053 @c man begin OPTIONS
5057 @node Selecting the Target System
5058 @chapter Selecting the Target System
5060 You can specify two aspects of the target system to the @sc{gnu}
5061 binary file utilities, each in several ways:
5071 In the following summaries, the lists of ways to specify values are in
5072 order of decreasing precedence. The ways listed first override those
5075 The commands to list valid values only list the values for which the
5076 programs you are running were configured. If they were configured with
5077 @option{--enable-targets=all}, the commands list most of the available
5078 values, but a few are left out; not all targets can be configured in at
5079 once because some of them can only be configured @dfn{native} (on hosts
5080 with the same type as the target system).
5083 * Target Selection::
5084 * Architecture Selection::
5087 @node Target Selection
5088 @section Target Selection
5090 A @dfn{target} is an object file format. A given target may be
5091 supported for multiple architectures (@pxref{Architecture Selection}).
5092 A target selection may also have variations for different operating
5093 systems or architectures.
5095 The command to list valid target values is @samp{objdump -i}
5096 (the first column of output contains the relevant information).
5098 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
5099 @samp{a.out-sunos-big}.
5101 You can also specify a target using a configuration triplet. This is
5102 the same sort of name that is passed to @file{configure} to specify a
5103 target. When you use a configuration triplet as an argument, it must be
5104 fully canonicalized. You can see the canonical version of a triplet by
5105 running the shell script @file{config.sub} which is included with the
5108 Some sample configuration triplets are: @samp{m68k-hp-bsd},
5109 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
5111 @subheading @command{objdump} Target
5117 command-line option: @option{-b} or @option{--target}
5120 environment variable @code{GNUTARGET}
5123 deduced from the input file
5126 @subheading @command{objcopy} and @command{strip} Input Target
5132 command-line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
5135 environment variable @code{GNUTARGET}
5138 deduced from the input file
5141 @subheading @command{objcopy} and @command{strip} Output Target
5147 command-line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
5150 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
5153 environment variable @code{GNUTARGET}
5156 deduced from the input file
5159 @subheading @command{nm}, @command{size}, and @command{strings} Target
5165 command-line option: @option{--target}
5168 environment variable @code{GNUTARGET}
5171 deduced from the input file
5174 @node Architecture Selection
5175 @section Architecture Selection
5177 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
5178 to run. Its name may contain a colon, separating the name of the
5179 processor family from the name of the particular @sc{cpu}.
5181 The command to list valid architecture values is @samp{objdump -i} (the
5182 second column contains the relevant information).
5184 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
5186 @subheading @command{objdump} Architecture
5192 command-line option: @option{-m} or @option{--architecture}
5195 deduced from the input file
5198 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
5204 deduced from the input file
5207 @node Reporting Bugs
5208 @chapter Reporting Bugs
5210 @cindex reporting bugs
5212 Your bug reports play an essential role in making the binary utilities
5215 Reporting a bug may help you by bringing a solution to your problem, or
5216 it may not. But in any case the principal function of a bug report is
5217 to help the entire community by making the next version of the binary
5218 utilities work better. Bug reports are your contribution to their
5221 In order for a bug report to serve its purpose, you must include the
5222 information that enables us to fix the bug.
5225 * Bug Criteria:: Have you found a bug?
5226 * Bug Reporting:: How to report bugs
5230 @section Have You Found a Bug?
5231 @cindex bug criteria
5233 If you are not sure whether you have found a bug, here are some guidelines:
5236 @cindex fatal signal
5239 If a binary utility gets a fatal signal, for any input whatever, that is
5240 a bug. Reliable utilities never crash.
5242 @cindex error on valid input
5244 If a binary utility produces an error message for valid input, that is a
5248 If you are an experienced user of binary utilities, your suggestions for
5249 improvement are welcome in any case.
5253 @section How to Report Bugs
5255 @cindex bugs, reporting
5257 A number of companies and individuals offer support for @sc{gnu}
5258 products. If you obtained the binary utilities from a support
5259 organization, we recommend you contact that organization first.
5261 You can find contact information for many support companies and
5262 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5266 In any event, we also recommend that you send bug reports for the binary
5267 utilities to @value{BUGURL}.
5270 The fundamental principle of reporting bugs usefully is this:
5271 @strong{report all the facts}. If you are not sure whether to state a
5272 fact or leave it out, state it!
5274 Often people omit facts because they think they know what causes the
5275 problem and assume that some details do not matter. Thus, you might
5276 assume that the name of a file you use in an example does not matter.
5277 Well, probably it does not, but one cannot be sure. Perhaps the bug is
5278 a stray memory reference which happens to fetch from the location where
5279 that pathname is stored in memory; perhaps, if the pathname were
5280 different, the contents of that location would fool the utility into
5281 doing the right thing despite the bug. Play it safe and give a
5282 specific, complete example. That is the easiest thing for you to do,
5283 and the most helpful.
5285 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5286 it is new to us. Therefore, always write your bug reports on the assumption
5287 that the bug has not been reported previously.
5289 Sometimes people give a few sketchy facts and ask, ``Does this ring a
5290 bell?'' This cannot help us fix a bug, so it is basically useless. We
5291 respond by asking for enough details to enable us to investigate.
5292 You might as well expedite matters by sending them to begin with.
5294 To enable us to fix the bug, you should include all these things:
5298 The version of the utility. Each utility announces it if you start it
5299 with the @option{--version} argument.
5301 Without this, we will not know whether there is any point in looking for
5302 the bug in the current version of the binary utilities.
5305 Any patches you may have applied to the source, including any patches
5306 made to the @code{BFD} library.
5309 The type of machine you are using, and the operating system name and
5313 What compiler (and its version) was used to compile the utilities---e.g.
5317 The command arguments you gave the utility to observe the bug. To
5318 guarantee you will not omit something important, list them all. A copy
5319 of the Makefile (or the output from make) is sufficient.
5321 If we were to try to guess the arguments, we would probably guess wrong
5322 and then we might not encounter the bug.
5325 A complete input file, or set of input files, that will reproduce the
5326 bug. If the utility is reading an object file or files, then it is
5327 generally most helpful to send the actual object files.
5329 If the source files were produced exclusively using @sc{gnu} programs
5330 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
5331 may be OK to send the source files rather than the object files. In
5332 this case, be sure to say exactly what version of @command{gcc}, or
5333 whatever, was used to produce the object files. Also say how
5334 @command{gcc}, or whatever, was configured.
5337 A description of what behavior you observe that you believe is
5338 incorrect. For example, ``It gets a fatal signal.''
5340 Of course, if the bug is that the utility gets a fatal signal, then we
5341 will certainly notice it. But if the bug is incorrect output, we might
5342 not notice unless it is glaringly wrong. You might as well not give us
5343 a chance to make a mistake.
5345 Even if the problem you experience is a fatal signal, you should still
5346 say so explicitly. Suppose something strange is going on, such as your
5347 copy of the utility is out of sync, or you have encountered a bug in
5348 the C library on your system. (This has happened!) Your copy might
5349 crash and ours would not. If you told us to expect a crash, then when
5350 ours fails to crash, we would know that the bug was not happening for
5351 us. If you had not told us to expect a crash, then we would not be able
5352 to draw any conclusion from our observations.
5355 If you wish to suggest changes to the source, send us context diffs, as
5356 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
5357 option. Always send diffs from the old file to the new file. If you
5358 wish to discuss something in the @command{ld} source, refer to it by
5359 context, not by line number.
5361 The line numbers in our development sources will not match those in your
5362 sources. Your line numbers would convey no useful information to us.
5365 Here are some things that are not necessary:
5369 A description of the envelope of the bug.
5371 Often people who encounter a bug spend a lot of time investigating
5372 which changes to the input file will make the bug go away and which
5373 changes will not affect it.
5375 This is often time consuming and not very useful, because the way we
5376 will find the bug is by running a single example under the debugger
5377 with breakpoints, not by pure deduction from a series of examples.
5378 We recommend that you save your time for something else.
5380 Of course, if you can find a simpler example to report @emph{instead}
5381 of the original one, that is a convenience for us. Errors in the
5382 output will be easier to spot, running under the debugger will take
5383 less time, and so on.
5385 However, simplification is not vital; if you do not want to do this,
5386 report the bug anyway and send us the entire test case you used.
5389 A patch for the bug.
5391 A patch for the bug does help us if it is a good one. But do not omit
5392 the necessary information, such as the test case, on the assumption that
5393 a patch is all we need. We might see problems with your patch and decide
5394 to fix the problem another way, or we might not understand it at all.
5396 Sometimes with programs as complicated as the binary utilities it is
5397 very hard to construct an example that will make the program follow a
5398 certain path through the code. If you do not send us the example, we
5399 will not be able to construct one, so we will not be able to verify that
5402 And if we cannot understand what bug you are trying to fix, or why your
5403 patch should be an improvement, we will not install it. A test case will
5404 help us to understand.
5407 A guess about what the bug is or what it depends on.
5409 Such guesses are usually wrong. Even we cannot guess right about such
5410 things without first using the debugger to find the facts.
5413 @node GNU Free Documentation License
5414 @appendix GNU Free Documentation License
5418 @node Binutils Index
5419 @unnumbered Binutils Index