1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991-2023 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 or symbol+offset 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 or symbol+offset 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 * debuginfod:: Using binutils with debuginfod
158 * Reporting Bugs:: Reporting Bugs
159 * GNU Free Documentation License:: GNU Free Documentation License
160 * Binutils Index:: Binutils Index
168 @cindex collections of files
170 @c man title ar create, modify, and extract from archives
173 ar [-]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@option{--output} @var{dirname}] [@option{--record-libdeps} @var{libdeps}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
174 ar -M [ <mri-script ]
177 @c man begin DESCRIPTION ar
179 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
180 archives. An @dfn{archive} is a single file holding a collection of
181 other files in a structure that makes it possible to retrieve
182 the original individual files (called @dfn{members} of the archive).
184 The original files' contents, mode (permissions), timestamp, owner, and
185 group are preserved in the archive, and can be restored on
189 @sc{gnu} @command{ar} can maintain archives whose members have names of any
190 length; however, depending on how @command{ar} is configured on your
191 system, a limit on member-name length may be imposed for compatibility
192 with archive formats maintained with other tools. If it exists, the
193 limit is often 15 characters (typical of formats related to a.out) or 16
194 characters (typical of formats related to coff).
197 @command{ar} is considered a binary utility because archives of this sort
198 are most often used as @dfn{libraries} holding commonly needed
199 subroutines. Since libraries often will depend on other libraries,
200 @command{ar} can also record the dependencies of a library when the
201 @option{--record-libdeps} option is specified.
204 @command{ar} creates an index to the symbols defined in relocatable
205 object modules in the archive when you specify the modifier @samp{s}.
206 Once created, this index is updated in the archive whenever @command{ar}
207 makes a change to its contents (save for the @samp{q} update operation).
208 An archive with such an index speeds up linking to the library, and
209 allows routines in the library to call each other without regard to
210 their placement in the archive.
212 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
213 table. If an archive lacks the table, another form of @command{ar} called
214 @command{ranlib} can be used to add just the table.
216 @cindex thin archives
217 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
218 which contains a symbol index and references to the original copies
219 of the member files of the archive. This is useful for building
220 libraries for use within a local build tree, where the relocatable
221 objects are expected to remain available, and copying the contents of
222 each object would only waste time and space.
224 An archive can either be @emph{thin} or it can be normal. It cannot
225 be both at the same time. Once an archive is created its format
226 cannot be changed without first deleting it and then creating a new
227 archive in its place.
229 Thin archives are also @emph{flattened}, so that adding one thin
230 archive to another thin archive does not nest it, as would happen with
231 a normal archive. Instead the elements of the first archive are added
232 individually to the second archive.
234 The paths to the elements of the archive are stored relative to the
237 @cindex compatibility, @command{ar}
238 @cindex @command{ar} compatibility
239 @sc{gnu} @command{ar} is designed to be compatible with two different
240 facilities. You can control its activity using command-line options,
241 like the different varieties of @command{ar} on Unix systems; or, if you
242 specify the single command-line option @option{-M}, you can control it
243 with a script supplied via standard input, like the MRI ``librarian''
249 * ar cmdline:: Controlling @command{ar} on the command line
250 * ar scripts:: Controlling @command{ar} with a script
255 @section Controlling @command{ar} on the Command Line
258 @c man begin SYNOPSIS ar
259 ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@option{--output} @var{dirname}] [@option{--record-libdeps} @var{libdeps}] [@option{--thin}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
263 @cindex Unix compatibility, @command{ar}
264 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
265 arguments to execute: one keyletter specifying the @emph{operation}
266 (optionally accompanied by other keyletters specifying
267 @emph{modifiers}), and the archive name to act on.
269 Most operations can also accept further @var{member} arguments,
270 specifying particular files to operate on.
272 @c man begin OPTIONS ar
274 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
275 flags @var{mod} in any order, within the first command-line argument.
277 If you wish, you may begin the first command-line argument with a
280 @cindex operations on archive
281 The @var{p} keyletter specifies what operation to execute; it may be
282 any of the following, but you must specify only one of them:
286 @cindex deleting from archive
287 @emph{Delete} modules from the archive. Specify the names of modules to
288 be deleted as @var{member}@dots{}; the archive is untouched if you
289 specify no files to delete.
291 If you specify the @samp{v} modifier, @command{ar} lists each module
295 @cindex moving in archive
296 Use this operation to @emph{move} members in an archive.
298 The ordering of members in an archive can make a difference in how
299 programs are linked using the library, if a symbol is defined in more
302 If no modifiers are used with @code{m}, any members you name in the
303 @var{member} arguments are moved to the @emph{end} of the archive;
304 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
305 specified place instead.
308 @cindex printing from archive
309 @emph{Print} the specified members of the archive, to the standard
310 output file. If the @samp{v} modifier is specified, show the member
311 name before copying its contents to standard output.
313 If you specify no @var{member} arguments, all the files in the archive are
317 @cindex quick append to archive
318 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
319 @var{archive}, without checking for replacement.
321 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
322 operation; new members are always placed at the end of the archive.
324 The modifier @samp{v} makes @command{ar} list each file as it is appended.
326 Since the point of this operation is speed, implementations of
327 @command{ar} have the option of not updating the archive's symbol
328 table if one exists. Too many different systems however assume that
329 symbol tables are always up-to-date, so @sc{gnu} @command{ar} will
330 rebuild the table even with a quick append.
332 Note - @sc{gnu} @command{ar} treats the command @samp{qs} as a
333 synonym for @samp{r} - replacing already existing files in the
334 archive and appending new ones at the end.
337 @cindex replacement in archive
338 Insert the files @var{member}@dots{} into @var{archive} (with
339 @emph{replacement}). This operation differs from @samp{q} in that any
340 previously existing members are deleted if their names match those being
343 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
344 displays an error message, and leaves undisturbed any existing members
345 of the archive matching that name.
347 By default, new members are added at the end of the file; but you may
348 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
349 placement relative to some existing member.
351 The modifier @samp{v} used with this operation elicits a line of
352 output for each file inserted, along with one of the letters @samp{a} or
353 @samp{r} to indicate whether the file was appended (no old member
354 deleted) or replaced.
358 Add an index to the archive, or update it if it already exists. Note
359 this command is an exception to the rule that there can only be one
360 command letter, as it is possible to use it as either a command or a
361 modifier. In either case it does the same thing.
364 @cindex contents of archive
365 Display a @emph{table} listing the contents of @var{archive}, or those
366 of the files listed in @var{member}@dots{} that are present in the
367 archive. Normally only the member name is shown, but if the modifier
368 @samp{O} is specified, then the corresponding offset of the member is also
369 displayed. Finally, in order to see the modes (permissions), timestamp,
370 owner, group, and size the @samp{v} modifier should be included.
372 If you do not specify a @var{member}, all files in the archive
375 @cindex repeated names in archive
376 @cindex name duplication in archive
377 If there is more than one file with the same name (say, @samp{fie}) in
378 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
379 first instance; to see them all, you must ask for a complete
380 listing---in our example, @samp{ar t b.a}.
381 @c WRS only; per Gumby, this is implementation-dependent, and in a more
382 @c recent case in fact works the other way.
385 @cindex extract from archive
386 @emph{Extract} members (named @var{member}) from the archive. You can
387 use the @samp{v} modifier with this operation, to request that
388 @command{ar} list each name as it extracts it.
390 If you do not specify a @var{member}, all files in the archive
393 Files cannot be extracted from a thin archive, and there are
394 restrictions on extracting from archives created with @option{P}: The
395 paths must not be absolute, may not contain @code{..}, and any
396 subdirectories in the paths must exist. If it is desired to avoid
397 these restrictions then used the @option{--output} option to specify
401 A number of modifiers (@var{mod}) may immediately follow the @var{p}
402 keyletter, to specify variations on an operation's behavior:
406 @cindex relative placement in archive
407 Add new files @emph{after} an existing member of the
408 archive. If you use the modifier @samp{a}, the name of an existing archive
409 member must be present as the @var{relpos} argument, before the
410 @var{archive} specification.
413 Add new files @emph{before} an existing member of the
414 archive. If you use the modifier @samp{b}, the name of an existing archive
415 member must be present as the @var{relpos} argument, before the
416 @var{archive} specification. (same as @samp{i}).
419 @cindex creating archives
420 @emph{Create} the archive. The specified @var{archive} is always
421 created if it did not exist, when you request an update. But a warning is
422 issued unless you specify in advance that you expect to create it, by
426 @cindex deterministic archives
427 @kindex --enable-deterministic-archives
428 Operate in @emph{deterministic} mode. When adding files and the archive
429 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
430 for all files. When this option is used, if @command{ar} is used with
431 identical options and identical input files, multiple runs will create
432 identical output files regardless of the input files' owners, groups,
433 file modes, or modification times.
435 If @file{binutils} was configured with
436 @option{--enable-deterministic-archives}, then this mode is on by default.
437 It can be disabled with the @samp{U} modifier, below.
440 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
441 names of any length. This will cause it to create archives which are
442 not compatible with the native @command{ar} program on some systems. If
443 this is a concern, the @samp{f} modifier may be used to truncate file
444 names when putting them in the archive.
447 Insert new files @emph{before} an existing member of the
448 archive. If you use the modifier @samp{i}, the name of an existing archive
449 member must be present as the @var{relpos} argument, before the
450 @var{archive} specification. (same as @samp{b}).
453 @c This modifier was accepted but not used.
454 @c whaffor ar l modifier??? presumably compat; with
455 @c what???---doc@@cygnus.com, 25jan91
456 Specify dependencies of this library. The dependencies must immediately
457 follow this option character, must use the same syntax as the linker
458 command line, and must be specified within a single argument. I.e., if
459 multiple items are needed, they must be quoted to form a single command
460 line argument. For example @samp{L "-L/usr/local/lib -lmydep1 -lmydep2"}
463 Uses the @var{count} parameter. This is used if there are multiple
464 entries in the archive with the same name. Extract or delete instance
465 @var{count} of the given name from the archive.
468 @cindex dates in archive
469 Preserve the @emph{original} dates of members when extracting them. If
470 you do not specify this modifier, files extracted from the archive
471 are stamped with the time of extraction.
474 @cindex offsets of files
475 Display member offsets inside the archive. Use together with the @samp{t}
479 Use the full path name when matching or storing names in the archive.
480 Archives created with full path names are not POSIX compliant, and
481 thus may not work with tools other than up to date @sc{gnu} tools.
482 Modifying such archives with @sc{gnu} @command{ar} without using
483 @option{P} will remove the full path names unless the archive is a
484 thin archive. Note that @option{P} may be useful when adding files to
485 a thin archive since @option{r} without @option{P} ignores the path
486 when choosing which element to replace. Thus
488 ar rcST archive.a subdir/file1 subdir/file2 file1
490 will result in the first @code{subdir/file1} being replaced with
491 @code{file1} from the current directory. Adding @option{P} will
492 prevent this replacement.
495 @cindex writing archive index
496 Write an object-file index into the archive, or update an existing one,
497 even if no other change is made to the archive. You may use this modifier
498 flag either with any operation, or alone. Running @samp{ar s} on an
499 archive is equivalent to running @samp{ranlib} on it.
502 @cindex not writing archive index
503 Do not generate an archive symbol table. This can speed up building a
504 large library in several steps. The resulting archive can not be used
505 with the linker. In order to build a symbol table, you must omit the
506 @samp{S} modifier on the last execution of @samp{ar}, or you must run
507 @samp{ranlib} on the archive.
510 Deprecated alias for @option{--thin}. @option{T} is not recommended because in
511 many ar implementations @option{T} has a different meaning, as specified by
512 X/Open System Interface.
515 @cindex updating an archive
516 Normally, @samp{ar r}@dots{} inserts all files
517 listed into the archive. If you would like to insert @emph{only} those
518 of the files you list that are newer than existing members of the same
519 names, use this modifier. The @samp{u} modifier is allowed only for the
520 operation @samp{r} (replace). In particular, the combination @samp{qu} is
521 not allowed, since checking the timestamps would lose any speed
522 advantage from the operation @samp{q}.
525 @cindex deterministic archives
526 @kindex --enable-deterministic-archives
527 Do @emph{not} operate in @emph{deterministic} mode. This is the inverse
528 of the @samp{D} modifier, above: added files and the archive index will
529 get their actual UID, GID, timestamp, and file mode values.
531 This is the default unless @file{binutils} was configured with
532 @option{--enable-deterministic-archives}.
535 This modifier requests the @emph{verbose} version of an operation. Many
536 operations display additional information, such as filenames processed,
537 when the modifier @samp{v} is appended.
540 This modifier shows the version number of @command{ar}.
543 The @command{ar} program also supports some command-line options which
544 are neither modifiers nor actions, but which do change its behaviour
549 Displays the list of command-line options supported by @command{ar}
553 Displays the version information of @command{ar} and then exits.
556 @command{ar} ignores an initial option spelled @samp{-X32_64}, for
557 compatibility with AIX. The behaviour produced by this option is the
558 default for @sc{gnu} @command{ar}. @command{ar} does not support any
559 of the other @samp{-X} options; in particular, it does not support
560 @option{-X32} which is the default for AIX @command{ar}.
562 @item --plugin @var{name}
564 The optional command-line switch @option{--plugin @var{name}} causes
565 @command{ar} to load the plugin called @var{name} which adds support
566 for more file formats, including object files with link-time
567 optimization information.
569 This option is only available if the toolchain has been built with
570 plugin support enabled.
572 If @option{--plugin} is not provided, but plugin support has been
573 enabled then @command{ar} iterates over the files in
574 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
575 plugin that claims the object in question is used.
577 Please note that this plugin search directory is @emph{not} the one
578 used by @command{ld}'s @option{-plugin} option. In order to make
579 @command{ar} use the linker plugin it must be copied into the
580 @file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
581 the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
582 based compilations it is called @file{LLVMgold.so}. The GCC plugin
583 is always backwards compatible with earlier versions, so it is
584 sufficient to just copy the newest one.
586 @item --target @var{target}
587 The optional command-line switch @option{--target @var{bfdname}}
588 specifies that the archive members are in an object code format
589 different from your system's default format. See
590 @xref{Target Selection}, for more information.
592 @item --output @var{dirname}
593 The @option{--output} option can be used to specify a path to a
594 directory into which archive members should be extracted. If this
595 option is not specified then the current directory will be used.
597 Note - although the presence of this option does imply a @option{x}
598 extraction operation that option must still be included on the command
601 @item --record-libdeps @var{libdeps}
602 The @option{--record-libdeps} option is identical to the @option{l} modifier,
603 just handled in long form.
606 @cindex creating thin archive
607 Make the specified @var{archive} a @emph{thin} archive. If it already
608 exists and is a regular archive, the existing members must be present
609 in the same directory as @var{archive}.
615 @c man begin SEEALSO ar
616 nm(1), ranlib(1), and the Info entries for @file{binutils}.
621 @section Controlling @command{ar} with a Script
624 ar -M [ <@var{script} ]
627 @cindex MRI compatibility, @command{ar}
628 @cindex scripts, @command{ar}
629 If you use the single command-line option @samp{-M} with @command{ar}, you
630 can control its operation with a rudimentary command language. This
631 form of @command{ar} operates interactively if standard input is coming
632 directly from a terminal. During interactive use, @command{ar} prompts for
633 input (the prompt is @samp{AR >}), and continues executing even after
634 errors. If you redirect standard input to a script file, no prompts are
635 issued, and @command{ar} abandons execution (with a nonzero exit code)
638 The @command{ar} command language is @emph{not} designed to be equivalent
639 to the command-line options; in fact, it provides somewhat less control
640 over archives. The only purpose of the command language is to ease the
641 transition to @sc{gnu} @command{ar} for developers who already have scripts
642 written for the MRI ``librarian'' program.
644 The syntax for the @command{ar} command language is straightforward:
647 commands are recognized in upper or lower case; for example, @code{LIST}
648 is the same as @code{list}. In the following descriptions, commands are
649 shown in upper case for clarity.
652 a single command may appear on each line; it is the first word on the
656 empty lines are allowed, and have no effect.
659 comments are allowed; text after either of the characters @samp{*}
660 or @samp{;} is ignored.
663 Whenever you use a list of names as part of the argument to an @command{ar}
664 command, you can separate the individual names with either commas or
665 blanks. Commas are shown in the explanations below, for clarity.
668 @samp{+} is used as a line continuation character; if @samp{+} appears
669 at the end of a line, the text on the following line is considered part
670 of the current command.
673 Here are the commands you can use in @command{ar} scripts, or when using
674 @command{ar} interactively. Three of them have special significance:
676 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
677 a temporary file required for most of the other commands.
679 @code{SAVE} commits the changes so far specified by the script. Prior
680 to @code{SAVE}, commands affect only the temporary copy of the current
684 @item ADDLIB @var{archive}
685 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
686 Add all the contents of @var{archive} (or, if specified, each named
687 @var{module} from @var{archive}) to the current archive.
689 Requires prior use of @code{OPEN} or @code{CREATE}.
691 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
692 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
693 @c else like "ar q..."
694 Add each named @var{member} as a module in the current archive.
696 Requires prior use of @code{OPEN} or @code{CREATE}.
699 Discard the contents of the current archive, canceling the effect of
700 any operations since the last @code{SAVE}. May be executed (with no
701 effect) even if no current archive is specified.
703 @item CREATE @var{archive}
704 Creates an archive, and makes it the current archive (required for many
705 other commands). The new archive is created with a temporary name; it
706 is not actually saved as @var{archive} until you use @code{SAVE}.
707 You can overwrite existing archives; similarly, the contents of any
708 existing file named @var{archive} will not be destroyed until @code{SAVE}.
710 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
711 Delete each listed @var{module} from the current archive; equivalent to
712 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
714 Requires prior use of @code{OPEN} or @code{CREATE}.
716 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
717 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
718 List each named @var{module} present in @var{archive}. The separate
719 command @code{VERBOSE} specifies the form of the output: when verbose
720 output is off, output is like that of @samp{ar -t @var{archive}
721 @var{module}@dots{}}. When verbose output is on, the listing is like
722 @samp{ar -tv @var{archive} @var{module}@dots{}}.
724 Output normally goes to the standard output stream; however, if you
725 specify @var{outputfile} as a final argument, @command{ar} directs the
729 Exit from @command{ar}, with a @code{0} exit code to indicate successful
730 completion. This command does not save the output file; if you have
731 changed the current archive since the last @code{SAVE} command, those
734 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
735 Extract each named @var{module} from the current archive, writing them
736 into the current directory as separate files. Equivalent to @samp{ar -x
737 @var{archive} @var{module}@dots{}}.
739 Requires prior use of @code{OPEN} or @code{CREATE}.
742 @c FIXME Tokens but no commands???
749 Display full contents of the current archive, in ``verbose'' style
750 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
751 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
752 enhancement, rather than present for MRI compatibility.)
754 Requires prior use of @code{OPEN} or @code{CREATE}.
756 @item OPEN @var{archive}
757 Opens an existing archive for use as the current archive (required for
758 many other commands). Any changes as the result of subsequent commands
759 will not actually affect @var{archive} until you next use @code{SAVE}.
761 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
762 In the current archive, replace each existing @var{module} (named in
763 the @code{REPLACE} arguments) from files in the current working directory.
764 To execute this command without errors, both the file, and the module in
765 the current archive, must exist.
767 Requires prior use of @code{OPEN} or @code{CREATE}.
770 Toggle an internal flag governing the output from @code{DIRECTORY}.
771 When the flag is on, @code{DIRECTORY} output matches output from
772 @samp{ar -tv }@dots{}.
775 Commit your changes to the current archive, and actually save it as a
776 file with the name specified in the last @code{CREATE} or @code{OPEN}
779 Requires prior use of @code{OPEN} or @code{CREATE}.
788 The @sc{gnu} linker @command{ld} is now described in a separate manual.
789 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
797 @c man title nm list symbols from object files
800 @c man begin SYNOPSIS nm
801 nm [@option{-A}|@option{-o}|@option{--print-file-name}]
802 [@option{-a}|@option{--debug-syms}]
803 [@option{-B}|@option{--format=bsd}]
804 [@option{-C}|@option{--demangle}[=@var{style}]]
805 [@option{-D}|@option{--dynamic}]
806 [@option{-f}@var{format}|@option{--format=}@var{format}]
807 [@option{-g}|@option{--extern-only}]
808 [@option{-h}|@option{--help}]
809 [@option{--ifunc-chars=@var{CHARS}}]
810 [@option{-j}|@option{--format=just-symbols}]
811 [@option{-l}|@option{--line-numbers}] [@option{--inlines}]
812 [@option{-n}|@option{-v}|@option{--numeric-sort}]
813 [@option{-P}|@option{--portability}]
814 [@option{-p}|@option{--no-sort}]
815 [@option{-r}|@option{--reverse-sort}]
816 [@option{-S}|@option{--print-size}]
817 [@option{-s}|@option{--print-armap}]
818 [@option{-t} @var{radix}|@option{--radix=}@var{radix}]
819 [@option{-u}|@option{--undefined-only}]
820 [@option{-U}|@option{--defined-only}]
821 [@option{-V}|@option{--version}]
822 [@option{-W}|@option{--no-weak}]
824 [@option{--no-demangle}]
825 [@option{--no-recurse-limit}|@option{--recurse-limit}]]
826 [@option{--plugin} @var{name}]
827 [@option{--size-sort}]
828 [@option{--special-syms}]
829 [@option{--synthetic}]
830 [@option{--target=}@var{bfdname}]
831 [@option{--unicode=}@var{method}]
832 [@option{--with-symbol-versions}]
833 [@option{--without-symbol-versions}]
834 [@var{objfile}@dots{}]
838 @c man begin DESCRIPTION nm
839 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
840 If no object files are listed as arguments, @command{nm} assumes the file
843 For each symbol, @command{nm} shows:
847 The symbol value, in the radix selected by options (see below), or
848 hexadecimal by default.
851 The symbol type. At least the following types are used; others are, as
852 well, depending on the object file format. If lowercase, the symbol is
853 usually local; if uppercase, the symbol is global (external). There
854 are however a few lowercase symbols that are shown for special global
855 symbols (@code{u}, @code{v} and @code{w}).
857 @c Some more detail on exactly what these symbol types are used for
861 The symbol's value is absolute, and will not be changed by further
866 The symbol is in the BSS data section. This section typically
867 contains zero-initialized or uninitialized data, although the exact
868 behavior is system dependent.
872 The symbol is common. Common symbols are uninitialized data. When
873 linking, multiple common symbols may appear with the same name. If the
874 symbol is defined anywhere, the common symbols are treated as undefined
877 For more details on common symbols, see the discussion of
878 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
880 The lower case @var{c} character is used when the symbol is in a
881 special section for small commons.
885 The symbol is in the initialized data section.
889 The symbol is in an initialized data section for small objects. Some
890 object file formats permit more efficient access to small data objects,
891 such as a global int variable as opposed to a large global array.
894 For PE format files this indicates that the symbol is in a section
895 specific to the implementation of DLLs.
897 For ELF format files this indicates that the symbol is an indirect
898 function. This is a GNU extension to the standard set of ELF symbol
899 types. It indicates a symbol which if referenced by a relocation does
900 not evaluate to its address, but instead must be invoked at runtime.
901 The runtime execution will then return the value to be used in the
904 Note - the actual symbols display for GNU indirect symbols is
905 controlled by the @option{--ifunc-chars} command line option. If this
906 option has been provided then the first character in the string will
907 be used for global indirect function symbols. If the string contains
908 a second character then that will be used for local indirect function
912 The symbol is an indirect reference to another symbol.
915 The symbol is a debugging symbol.
918 The symbol is in a non-data, non-code, non-debug read-only section.
921 The symbol is in a stack unwind section.
925 The symbol is in a read only data section.
929 The symbol is in an uninitialized or zero-initialized data section
934 The symbol is in the text (code) section.
937 The symbol is undefined.
940 The symbol is a unique global symbol. This is a GNU extension to the
941 standard set of ELF symbol bindings. For such a symbol the dynamic linker
942 will make sure that in the entire process there is just one symbol with
943 this name and type in use.
947 The symbol is a weak object. When a weak defined symbol is linked with
948 a normal defined symbol, the normal defined symbol is used with no error.
949 When a weak undefined symbol is linked and the symbol is not defined,
950 the value of the weak symbol becomes zero with no error. On some
951 systems, uppercase indicates that a default value has been specified.
955 The symbol is a weak symbol that has not been specifically tagged as a
956 weak object symbol. When a weak defined symbol is linked with a normal
957 defined symbol, the normal defined symbol is used with no error.
958 When a weak undefined symbol is linked and the symbol is not defined,
959 the value of the symbol is determined in a system-specific manner without
960 error. On some systems, uppercase indicates that a default value has been
964 The symbol is a stabs symbol in an a.out object file. In this case, the
965 next values printed are the stabs other field, the stabs desc field, and
966 the stab type. Stabs symbols are used to hold debugging information.
969 The symbol type is unknown, or object file format specific.
973 The symbol name. If a symbol has version information associated with it,
974 then the version information is displayed as well. If the versioned
975 symbol is undefined or hidden from linker, the version string is displayed
976 as a suffix to the symbol name, preceded by an @@ character. For example
977 @samp{foo@@VER_1}. If the version is the default version to be used when
978 resolving unversioned references to the symbol, then it is displayed as a
979 suffix preceded by two @@ characters. For example @samp{foo@@@@VER_2}.
984 @c man begin OPTIONS nm
985 The long and short forms of options, shown here as alternatives, are
991 @itemx --print-file-name
992 @cindex input file name
994 @cindex source file name
995 Precede each symbol by the name of the input file (or archive member)
996 in which it was found, rather than identifying the input file once only,
997 before all of its symbols.
1001 @cindex debugging symbols
1002 Display all symbols, even debugger-only symbols; normally these are not
1006 @cindex @command{nm} format
1007 @cindex @command{nm} compatibility
1008 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
1011 @itemx --demangle[=@var{style}]
1012 @cindex demangling in nm
1013 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1014 Besides removing any initial underscore prepended by the system, this
1015 makes C++ function names readable. Different compilers have different
1016 mangling styles. The optional demangling style argument can be used to
1017 choose an appropriate demangling style for your compiler. @xref{c++filt},
1018 for more information on demangling.
1021 Do not demangle low-level symbol names. This is the default.
1023 @item --recurse-limit
1024 @itemx --no-recurse-limit
1025 @itemx --recursion-limit
1026 @itemx --no-recursion-limit
1027 Enables or disables a limit on the amount of recursion performed
1028 whilst demangling strings. Since the name mangling formats allow for
1029 an infinite level of recursion it is possible to create strings whose
1030 decoding will exhaust the amount of stack space available on the host
1031 machine, triggering a memory fault. The limit tries to prevent this
1032 from happening by restricting recursion to 2048 levels of nesting.
1034 The default is for this limit to be enabled, but disabling it may be
1035 necessary in order to demangle truly complicated names. Note however
1036 that if the recursion limit is disabled then stack exhaustion is
1037 possible and any bug reports about such an event will be rejected.
1041 @cindex dynamic symbols
1042 Display the dynamic symbols rather than the normal symbols. This is
1043 only meaningful for dynamic objects, such as certain types of shared
1046 @item -f @var{format}
1047 @itemx --format=@var{format}
1048 @cindex @command{nm} format
1049 @cindex @command{nm} compatibility
1050 Use the output format @var{format}, which can be @code{bsd},
1051 @code{sysv}, @code{posix} or @code{just-symbols}. The default is @code{bsd}.
1052 Only the first character of @var{format} is significant; it can be
1053 either upper or lower case.
1056 @itemx --extern-only
1057 @cindex external symbols
1058 Display only external symbols.
1062 Show a summary of the options to @command{nm} and exit.
1064 @item --ifunc-chars=@var{CHARS}
1065 When display GNU indirect function symbols @command{nm} will default
1066 to using the @code{i} character for both local indirect functions and
1067 global indirect functions. The @option{--ifunc-chars} option allows
1068 the user to specify a string containing one or two characters. The
1069 first character will be used for global indirect function symbols and
1070 the second character, if present, will be used for local indirect
1074 The same as @option{--format=just-symbols}.
1077 @itemx --line-numbers
1078 @cindex symbol line numbers
1079 For each symbol, use debugging information to try to find a filename and
1080 line number. For a defined symbol, look for the line number of the
1081 address of the symbol. For an undefined symbol, look for the line
1082 number of a relocation entry which refers to the symbol. If line number
1083 information can be found, print it after the other symbol information.
1086 @cindex objdump inlines
1087 When option @option{-l} is active, if the address belongs to a
1088 function that was inlined, then this option causes the source
1089 information for all enclosing scopes back to the first non-inlined
1090 function to be printed as well. For example, if @code{main} inlines
1091 @code{callee1} which inlines @code{callee2}, and address is from
1092 @code{callee2}, the source information for @code{callee1} and @code{main}
1093 will also be printed.
1097 @itemx --numeric-sort
1098 Sort symbols numerically by their addresses, rather than alphabetically
1103 @cindex sorting symbols
1104 Do not bother to sort the symbols in any order; print them in the order
1108 @itemx --portability
1109 Use the POSIX.2 standard output format instead of the default format.
1110 Equivalent to @samp{-f posix}.
1113 @itemx --reverse-sort
1114 Reverse the order of the sort (whether numeric or alphabetic); let the
1119 Print both value and size of defined symbols for the @code{bsd} output style.
1120 This option has no effect for object formats that do not record symbol
1121 sizes, unless @samp{--size-sort} is also used in which case a
1122 calculated size is displayed.
1125 @itemx --print-armap
1126 @cindex symbol index, listing
1127 When listing symbols from archive members, include the index: a mapping
1128 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
1129 contain definitions for which names.
1131 @item -t @var{radix}
1132 @itemx --radix=@var{radix}
1133 Use @var{radix} as the radix for printing the symbol values. It must be
1134 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
1137 @itemx --undefined-only
1138 @cindex external symbols
1139 @cindex undefined symbols
1140 Display only undefined symbols (those external to each object file).
1141 By default both defined and undefined symbols are displayed.
1144 @itemx --defined-only
1145 @cindex external symbols
1146 @cindex undefined symbols
1147 Display only defined symbols for each object file.
1148 By default both defined and undefined symbols are displayed.
1152 Show the version number of @command{nm} and exit.
1155 This option is ignored for compatibility with the AIX version of
1156 @command{nm}. It takes one parameter which must be the string
1157 @option{32_64}. The default mode of AIX @command{nm} corresponds
1158 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1160 @item --plugin @var{name}
1162 Load the plugin called @var{name} to add support for extra target
1163 types. This option is only available if the toolchain has been built
1164 with plugin support enabled.
1166 If @option{--plugin} is not provided, but plugin support has been
1167 enabled then @command{nm} iterates over the files in
1168 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
1169 plugin that claims the object in question is used.
1171 Please note that this plugin search directory is @emph{not} the one
1172 used by @command{ld}'s @option{-plugin} option. In order to make
1173 @command{nm} use the linker plugin it must be copied into the
1174 @file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
1175 the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
1176 based compilations it is called @file{LLVMgold.so}. The GCC plugin
1177 is always backwards compatible with earlier versions, so it is
1178 sufficient to just copy the newest one.
1181 Sort symbols by size. For ELF objects symbol sizes are read from the
1182 ELF, for other object types the symbol sizes are computed as the
1183 difference between the value of the symbol and the value of the symbol
1184 with the next higher value. If the @code{bsd} output format is used
1185 the size of the symbol is printed, rather than the value, and
1186 @samp{-S} must be used in order both size and value to be printed.
1188 Note - this option does not work if @option{--undefined-only} has been
1189 enabled as undefined symbols have no size.
1191 @item --special-syms
1192 Display symbols which have a target-specific special meaning. These
1193 symbols are usually used by the target for some special processing and
1194 are not normally helpful when included in the normal symbol lists.
1195 For example for ARM targets this option would skip the mapping symbols
1196 used to mark transitions between ARM code, THUMB code and data.
1199 Include synthetic symbols in the output. These are special symbols
1200 created by the linker for various purposes. They are not shown by
1201 default since they are not part of the binary's original source code.
1203 @item --unicode=@var{[default|invalid|locale|escape|hex|highlight]}
1204 Controls the display of UTF-8 encoded multibyte characters in strings.
1205 The default (@option{--unicode=default}) is to give them no special
1206 treatment. The @option{--unicode=locale} option displays the sequence
1207 in the current locale, which may or may not support them. The options
1208 @option{--unicode=hex} and @option{--unicode=invalid} display them as
1209 hex byte sequences enclosed by either angle brackets or curly braces.
1211 The @option{--unicode=escape} option displays them as escape sequences
1212 (@var{\uxxxx}) and the @option{--unicode=highlight} option displays
1213 them as escape sequences highlighted in red (if supported by the
1214 output device). The colouring is intended to draw attention to the
1215 presence of unicode sequences where they might not be expected.
1219 Do not display weak symbols.
1221 @item --with-symbol-versions
1222 @item --without-symbol-versions
1223 Enables or disables the display of symbol version information. The
1224 version string is displayed as a suffix to the symbol name, preceded
1225 by an @@ character. For example @samp{foo@@VER_1}. If the version is
1226 the default version to be used when resolving unversioned references
1227 to the symbol then it is displayed as a suffix preceded by two @@
1228 characters. For example @samp{foo@@@@VER_2}. By default, symbol
1229 version information is displayed.
1231 @item --target=@var{bfdname}
1232 @cindex object code format
1233 Specify an object code format other than your system's default format.
1234 @xref{Target Selection}, for more information.
1241 @c man begin SEEALSO nm
1242 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1249 @c man title objcopy copy and translate object files
1252 @c man begin SYNOPSIS objcopy
1253 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1254 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1255 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1256 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1257 [@option{-S}|@option{--strip-all}]
1258 [@option{-g}|@option{--strip-debug}]
1259 [@option{--strip-unneeded}]
1260 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1261 [@option{--keep-file-symbols}]
1262 [@option{--keep-section-symbols}]
1263 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1264 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1265 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1266 [@option{--localize-hidden}]
1267 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1268 [@option{--globalize-symbol=}@var{symbolname}]
1269 [@option{--globalize-symbols=}@var{filename}]
1270 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1271 [@option{-w}|@option{--wildcard}]
1272 [@option{-x}|@option{--discard-all}]
1273 [@option{-X}|@option{--discard-locals}]
1274 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1275 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1276 [@option{--interleave-width=}@var{width}]
1277 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1278 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1279 [@option{--keep-section=}@var{sectionpattern}]
1280 [@option{--remove-relocations=}@var{sectionpattern}]
1281 [@option{--strip-section-headers}]
1282 [@option{-p}|@option{--preserve-dates}]
1283 [@option{-D}|@option{--enable-deterministic-archives}]
1284 [@option{-U}|@option{--disable-deterministic-archives}]
1285 [@option{--debugging}]
1286 [@option{--gap-fill=}@var{val}]
1287 [@option{--pad-to=}@var{address}]
1288 [@option{--set-start=}@var{val}]
1289 [@option{--adjust-start=}@var{incr}]
1290 [@option{--change-addresses=}@var{incr}]
1291 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1292 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1293 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1294 [@option{--change-warnings}] [@option{--no-change-warnings}]
1295 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1296 [@option{--set-section-alignment} @var{sectionpattern}=@var{align}]
1297 [@option{--add-section} @var{sectionname}=@var{filename}]
1298 [@option{--dump-section} @var{sectionname}=@var{filename}]
1299 [@option{--update-section} @var{sectionname}=@var{filename}]
1300 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1301 [@option{--long-section-names} @{enable,disable,keep@}]
1302 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1303 [@option{--reverse-bytes=}@var{num}]
1304 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1305 [@option{--redefine-sym} @var{old}=@var{new}]
1306 [@option{--redefine-syms=}@var{filename}]
1308 [@option{--keep-symbols=}@var{filename}]
1309 [@option{--strip-symbols=}@var{filename}]
1310 [@option{--strip-unneeded-symbols=}@var{filename}]
1311 [@option{--keep-global-symbols=}@var{filename}]
1312 [@option{--localize-symbols=}@var{filename}]
1313 [@option{--weaken-symbols=}@var{filename}]
1314 [@option{--add-symbol} @var{name}=[@var{section}:]@var{value}[,@var{flags}]]
1315 [@option{--alt-machine-code=}@var{index}]
1316 [@option{--prefix-symbols=}@var{string}]
1317 [@option{--prefix-sections=}@var{string}]
1318 [@option{--prefix-alloc-sections=}@var{string}]
1319 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1320 [@option{--only-keep-debug}]
1321 [@option{--strip-dwo}]
1322 [@option{--extract-dwo}]
1323 [@option{--extract-symbol}]
1324 [@option{--writable-text}]
1325 [@option{--readonly-text}]
1328 [@option{--file-alignment=}@var{num}]
1329 [@option{--heap=}@var{size}]
1330 [@option{--image-base=}@var{address}]
1331 [@option{--section-alignment=}@var{num}]
1332 [@option{--stack=}@var{size}]
1333 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1334 [@option{--compress-debug-sections}]
1335 [@option{--decompress-debug-sections}]
1336 [@option{--elf-stt-common=@var{val}}]
1337 [@option{--merge-notes}]
1338 [@option{--no-merge-notes}]
1339 [@option{--verilog-data-width=@var{val}}]
1340 [@option{-v}|@option{--verbose}]
1341 [@option{-V}|@option{--version}]
1342 [@option{--help}] [@option{--info}]
1343 @var{infile} [@var{outfile}]
1347 @c man begin DESCRIPTION objcopy
1348 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1349 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1350 read and write the object files. It can write the destination object
1351 file in a format different from that of the source object file. The
1352 exact behavior of @command{objcopy} is controlled by command-line options.
1353 Note that @command{objcopy} should be able to copy a fully linked file
1354 between any two formats. However, copying a relocatable object file
1355 between any two formats may not work as expected.
1357 @command{objcopy} creates temporary files to do its translations and
1358 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1359 translation work; it has access to all the formats described in @sc{bfd}
1360 and thus is able to recognize most formats without being told
1361 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1363 @command{objcopy} can be used to generate S-records by using an output
1364 target of @samp{srec} (e.g., use @samp{-O srec}).
1366 @command{objcopy} can be used to generate a raw binary file by using an
1367 output target of @samp{binary} (e.g., use @option{-O binary}). When
1368 @command{objcopy} generates a raw binary file, it will essentially produce
1369 a memory dump of the contents of the input object file. All symbols and
1370 relocation information will be discarded. The memory dump will start at
1371 the load address of the lowest section copied into the output file.
1373 When generating an S-record or a raw binary file, it may be helpful to
1374 use @option{-S} to remove sections containing debugging information. In
1375 some cases @option{-R} will be useful to remove sections which contain
1376 information that is not needed by the binary file.
1378 Note---@command{objcopy} is not able to change the endianness of its input
1379 files. If the input format has an endianness (some formats do not),
1380 @command{objcopy} can only copy the inputs into file formats that have the
1381 same endianness or which have no endianness (e.g., @samp{srec}).
1382 (However, see the @option{--reverse-bytes} option.)
1386 @c man begin OPTIONS objcopy
1390 @itemx @var{outfile}
1391 The input and output files, respectively.
1392 If you do not specify @var{outfile}, @command{objcopy} creates a
1393 temporary file and destructively renames the result with
1394 the name of @var{infile}.
1396 @item -I @var{bfdname}
1397 @itemx --input-target=@var{bfdname}
1398 Consider the source file's object format to be @var{bfdname}, rather than
1399 attempting to deduce it. @xref{Target Selection}, for more information.
1401 @item -O @var{bfdname}
1402 @itemx --output-target=@var{bfdname}
1403 Write the output file using the object format @var{bfdname}.
1404 @xref{Target Selection}, for more information.
1406 @item -F @var{bfdname}
1407 @itemx --target=@var{bfdname}
1408 Use @var{bfdname} as the object format for both the input and the output
1409 file; i.e., simply transfer data from source to destination with no
1410 translation. @xref{Target Selection}, for more information.
1412 @item -B @var{bfdarch}
1413 @itemx --binary-architecture=@var{bfdarch}
1414 Useful when transforming a architecture-less input file into an object file.
1415 In this case the output architecture can be set to @var{bfdarch}. This
1416 option will be ignored if the input file has a known @var{bfdarch}. You
1417 can access this binary data inside a program by referencing the special
1418 symbols that are created by the conversion process. These symbols are
1419 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1420 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1421 an object file and then access it in your code using these symbols.
1423 @item -j @var{sectionpattern}
1424 @itemx --only-section=@var{sectionpattern}
1425 Copy only the indicated sections from the input file to the output file.
1426 This option may be given more than once. Note that using this option
1427 inappropriately may make the output file unusable. Wildcard
1428 characters are accepted in @var{sectionpattern}.
1430 If the first character of @var{sectionpattern} is the exclamation
1431 point (!) then matching sections will not be copied, even if earlier
1432 use of @option{--only-section} on the same command line would
1433 otherwise copy it. For example:
1436 --only-section=.text.* --only-section=!.text.foo
1439 will copy all sectinos matching '.text.*' but not the section
1442 @item -R @var{sectionpattern}
1443 @itemx --remove-section=@var{sectionpattern}
1444 Remove any section matching @var{sectionpattern} from the output file.
1445 This option may be given more than once. Note that using this option
1446 inappropriately may make the output file unusable. Wildcard
1447 characters are accepted in @var{sectionpattern}. Using both the
1448 @option{-j} and @option{-R} options together results in undefined
1451 If the first character of @var{sectionpattern} is the exclamation
1452 point (!) then matching sections will not be removed even if an
1453 earlier use of @option{--remove-section} on the same command line
1454 would otherwise remove it. For example:
1457 --remove-section=.text.* --remove-section=!.text.foo
1460 will remove all sections matching the pattern '.text.*', but will not
1461 remove the section '.text.foo'.
1463 @item --keep-section=@var{sectionpattern}
1464 When removing sections from the output file, keep sections that match
1465 @var{sectionpattern}.
1467 @item --remove-relocations=@var{sectionpattern}
1468 Remove non-dynamic relocations from the output file for any section
1469 matching @var{sectionpattern}. This option may be given more than
1470 once. Note that using this option inappropriately may make the output
1471 file unusable, and attempting to remove a dynamic relocation section
1472 such as @samp{.rela.plt} from an executable or shared library with
1473 @option{--remove-relocations=.plt} will not work. Wildcard characters
1474 are accepted in @var{sectionpattern}.
1478 --remove-relocations=.text.*
1481 will remove the relocations for all sections matching the pattern
1484 If the first character of @var{sectionpattern} is the exclamation
1485 point (!) then matching sections will not have their relocation
1486 removed even if an earlier use of @option{--remove-relocations} on the
1487 same command line would otherwise cause the relocations to be removed.
1491 --remove-relocations=.text.* --remove-relocations=!.text.foo
1494 will remove all relocations for sections matching the pattern
1495 '.text.*', but will not remove relocations for the section
1498 @item --strip-section-headers
1499 Strip section header This option is specific to ELF files.
1500 Implies @option{--strip-all} and @option{--merge-notes}.
1504 Do not copy relocation and symbol information from the source file.
1505 Also deletes debug sections.
1508 @itemx --strip-debug
1509 Do not copy debugging symbols or sections from the source file.
1511 @item --strip-unneeded
1512 Remove all symbols that are not needed for relocation processing in
1513 addition to debugging symbols and sections stripped by
1514 @option{--strip-debug}.
1516 @item -K @var{symbolname}
1517 @itemx --keep-symbol=@var{symbolname}
1518 When stripping symbols, keep symbol @var{symbolname} even if it would
1519 normally be stripped. This option may be given more than once.
1521 @item -N @var{symbolname}
1522 @itemx --strip-symbol=@var{symbolname}
1523 Do not copy symbol @var{symbolname} from the source file. This option
1524 may be given more than once.
1526 @item --strip-unneeded-symbol=@var{symbolname}
1527 Do not copy symbol @var{symbolname} from the source file unless it is needed
1528 by a relocation. This option may be given more than once.
1530 @item -G @var{symbolname}
1531 @itemx --keep-global-symbol=@var{symbolname}
1532 Keep only symbol @var{symbolname} global. Make all other symbols local
1533 to the file, so that they are not visible externally. This option may
1534 be given more than once. Note: this option cannot be used in
1535 conjunction with the @option{--globalize-symbol} or
1536 @option{--globalize-symbols} options.
1538 @item --localize-hidden
1539 In an ELF object, mark all symbols that have hidden or internal visibility
1540 as local. This option applies on top of symbol-specific localization options
1541 such as @option{-L}.
1543 @item -L @var{symbolname}
1544 @itemx --localize-symbol=@var{symbolname}
1545 Convert a global or weak symbol called @var{symbolname} into a local
1546 symbol, so that it is not visible externally. This option may be
1547 given more than once. Note - unique symbols are not converted.
1549 @item -W @var{symbolname}
1550 @itemx --weaken-symbol=@var{symbolname}
1551 Make symbol @var{symbolname} weak. This option may be given more than once.
1553 @item --globalize-symbol=@var{symbolname}
1554 Give symbol @var{symbolname} global scoping so that it is visible
1555 outside of the file in which it is defined. This option may be given
1556 more than once. Note: this option cannot be used in conjunction with
1557 the @option{-G} or @option{--keep-global-symbol} options.
1561 Permit regular expressions in @var{symbolname}s used in other command
1562 line options. The question mark (?), asterisk (*), backslash (\) and
1563 square brackets ([]) operators can be used anywhere in the symbol
1564 name. If the first character of the symbol name is the exclamation
1565 point (!) then the sense of the switch is reversed for that symbol.
1572 would cause objcopy to weaken all symbols that start with ``fo''
1573 except for the symbol ``foo''.
1576 @itemx --discard-all
1577 Do not copy non-global symbols from the source file.
1578 @c FIXME any reason to prefer "non-global" to "local" here?
1581 @itemx --discard-locals
1582 Do not copy compiler-generated local symbols.
1583 (These usually start with @samp{L} or @samp{.}.)
1586 @itemx --byte=@var{byte}
1587 If interleaving has been enabled via the @option{--interleave} option
1588 then start the range of bytes to keep at the @var{byte}th byte.
1589 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1590 @var{breadth} is the value given by the @option{--interleave} option.
1592 @item -i [@var{breadth}]
1593 @itemx --interleave[=@var{breadth}]
1594 Only copy a range out of every @var{breadth} bytes. (Header data is
1595 not affected). Select which byte in the range begins the copy with
1596 the @option{--byte} option. Select the width of the range with the
1597 @option{--interleave-width} option.
1599 This option is useful for creating files to program @sc{rom}. It is
1600 typically used with an @code{srec} output target. Note that
1601 @command{objcopy} will complain if you do not specify the
1602 @option{--byte} option as well.
1604 The default interleave breadth is 4, so with @option{--byte} set to 0,
1605 @command{objcopy} would copy the first byte out of every four bytes
1606 from the input to the output.
1608 @item --interleave-width=@var{width}
1609 When used with the @option{--interleave} option, copy @var{width}
1610 bytes at a time. The start of the range of bytes to be copied is set
1611 by the @option{--byte} option, and the extent of the range is set with
1612 the @option{--interleave} option.
1614 The default value for this option is 1. The value of @var{width} plus
1615 the @var{byte} value set by the @option{--byte} option must not exceed
1616 the interleave breadth set by the @option{--interleave} option.
1618 This option can be used to create images for two 16-bit flashes interleaved
1619 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1620 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1621 commands. If the input was '12345678' then the outputs would be
1622 '1256' and '3478' respectively.
1625 @itemx --preserve-dates
1626 Set the access and modification dates of the output file to be the same
1627 as those of the input file.
1629 This option also copies the date stored in a PE format file's header,
1630 unless the SOURCE_DATE_EPOCH environment variable is defined. If it
1631 is defined then this variable will be used as the date stored in the
1632 header, interpreted as the number of seconds since the Unix epoch.
1635 @itemx --enable-deterministic-archives
1636 @cindex deterministic archives
1637 @kindex --enable-deterministic-archives
1638 Operate in @emph{deterministic} mode. When copying archive members
1639 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1640 and use consistent file modes for all files.
1642 If @file{binutils} was configured with
1643 @option{--enable-deterministic-archives}, then this mode is on by default.
1644 It can be disabled with the @samp{-U} option, below.
1647 @itemx --disable-deterministic-archives
1648 @cindex deterministic archives
1649 @kindex --enable-deterministic-archives
1650 Do @emph{not} operate in @emph{deterministic} mode. This is the
1651 inverse of the @option{-D} option, above: when copying archive members
1652 and writing the archive index, use their actual UID, GID, timestamp,
1653 and file mode values.
1655 This is the default unless @file{binutils} was configured with
1656 @option{--enable-deterministic-archives}.
1659 Convert debugging information, if possible. This is not the default
1660 because only certain debugging formats are supported, and the
1661 conversion process can be time consuming.
1663 @item --gap-fill @var{val}
1664 Fill gaps between sections with @var{val}. This operation applies to
1665 the @emph{load address} (LMA) of the sections. It is done by increasing
1666 the size of the section with the lower address, and filling in the extra
1667 space created with @var{val}.
1669 @item --pad-to @var{address}
1670 Pad the output file up to the load address @var{address}. This is
1671 done by increasing the size of the last section. The extra space is
1672 filled in with the value specified by @option{--gap-fill} (default zero).
1674 @item --set-start @var{val}
1675 Set the start address (also known as the entry address) of the new
1676 file to @var{val}. Not all object file formats support setting the
1679 @item --change-start @var{incr}
1680 @itemx --adjust-start @var{incr}
1681 @cindex changing start address
1682 Change the start address (also known as the entry address) by adding
1683 @var{incr}. Not all object file formats support setting the start
1686 @item --change-addresses @var{incr}
1687 @itemx --adjust-vma @var{incr}
1688 @cindex changing object addresses
1689 Change the VMA and LMA addresses of all sections, as well as the start
1690 address, by adding @var{incr}. Some object file formats do not permit
1691 section addresses to be changed arbitrarily. Note that this does not
1692 relocate the sections; if the program expects sections to be loaded at a
1693 certain address, and this option is used to change the sections such
1694 that they are loaded at a different address, the program may fail.
1696 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1697 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1698 @cindex changing section address
1699 Set or change both the VMA address and the LMA address of any section
1700 matching @var{sectionpattern}. If @samp{=} is used, the section
1701 address is set to @var{val}. Otherwise, @var{val} is added to or
1702 subtracted from the section address. See the comments under
1703 @option{--change-addresses}, above. If @var{sectionpattern} does not
1704 match any sections in the input file, a warning will be issued, unless
1705 @option{--no-change-warnings} is used.
1707 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1708 @cindex changing section LMA
1709 Set or change the LMA address of any sections matching
1710 @var{sectionpattern}. The LMA address is the address where the
1711 section will be loaded into memory at program load time. Normally
1712 this is the same as the VMA address, which is the address of the
1713 section at program run time, but on some systems, especially those
1714 where a program is held in ROM, the two can be different. If @samp{=}
1715 is used, the section address is set to @var{val}. Otherwise,
1716 @var{val} is added to or subtracted from the section address. See the
1717 comments under @option{--change-addresses}, above. If
1718 @var{sectionpattern} does not match any sections in the input file, a
1719 warning will be issued, unless @option{--no-change-warnings} is used.
1721 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1722 @cindex changing section VMA
1723 Set or change the VMA address of any section matching
1724 @var{sectionpattern}. The VMA address is the address where the
1725 section will be located once the program has started executing.
1726 Normally this is the same as the LMA address, which is the address
1727 where the section will be loaded into memory, but on some systems,
1728 especially those where a program is held in ROM, the two can be
1729 different. If @samp{=} is used, the section address is set to
1730 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1731 section address. See the comments under @option{--change-addresses},
1732 above. If @var{sectionpattern} does not match any sections in the
1733 input file, a warning will be issued, unless
1734 @option{--no-change-warnings} is used.
1736 @item --change-warnings
1737 @itemx --adjust-warnings
1738 If @option{--change-section-address} or @option{--change-section-lma} or
1739 @option{--change-section-vma} is used, and the section pattern does not
1740 match any sections, issue a warning. This is the default.
1742 @item --no-change-warnings
1743 @itemx --no-adjust-warnings
1744 Do not issue a warning if @option{--change-section-address} or
1745 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1746 if the section pattern does not match any sections.
1748 @item --set-section-flags @var{sectionpattern}=@var{flags}
1749 Set the flags for any sections matching @var{sectionpattern}. The
1750 @var{flags} argument is a comma separated string of flag names. The
1751 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1752 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1753 @samp{exclude}, @samp{share}, @samp{debug}, and @samp{large}.
1754 You can set the @samp{contents} flag for a section which does not have
1755 contents, but it is not meaningful to clear the @samp{contents} flag of a
1756 section which does have contents--just remove the section instead. Not all
1757 flags are meaningful for all object file formats. In particular the
1758 @samp{share} flag is only meaningful for COFF format files and not for ELF
1759 format files. The ELF x86-64 specific flag @samp{large} corresponds to
1762 @item --set-section-alignment @var{sectionpattern}=@var{align}
1763 Set the alignment for any sections matching @var{sectionpattern}.
1764 @var{align} specifies the alignment in bytes and must be a power of
1765 two, i.e. 1, 2, 4, 8@dots{}.
1767 @item --add-section @var{sectionname}=@var{filename}
1768 Add a new section named @var{sectionname} while copying the file. The
1769 contents of the new section are taken from the file @var{filename}. The
1770 size of the section will be the size of the file. This option only
1771 works on file formats which can support sections with arbitrary names.
1772 Note - it may be necessary to use the @option{--set-section-flags}
1773 option to set the attributes of the newly created section.
1775 @item --dump-section @var{sectionname}=@var{filename}
1776 Place the contents of section named @var{sectionname} into the file
1777 @var{filename}, overwriting any contents that may have been there
1778 previously. This option is the inverse of @option{--add-section}.
1779 This option is similar to the @option{--only-section} option except
1780 that it does not create a formatted file, it just dumps the contents
1781 as raw binary data, without applying any relocations. The option can
1782 be specified more than once.
1784 @item --update-section @var{sectionname}=@var{filename}
1785 Replace the existing contents of a section named @var{sectionname}
1786 with the contents of file @var{filename}. The size of the section
1787 will be adjusted to the size of the file. The section flags for
1788 @var{sectionname} will be unchanged. For ELF format files the section
1789 to segment mapping will also remain unchanged, something which is not
1790 possible using @option{--remove-section} followed by
1791 @option{--add-section}. The option can be specified more than once.
1793 Note - it is possible to use @option{--rename-section} and
1794 @option{--update-section} to both update and rename a section from one
1795 command line. In this case, pass the original section name to
1796 @option{--update-section}, and the original and new section names to
1797 @option{--rename-section}.
1799 @item --add-symbol @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1800 Add a new symbol named @var{name} while copying the file. This option may be
1801 specified multiple times. If the @var{section} is given, the symbol will be
1802 associated with and relative to that section, otherwise it will be an ABS
1803 symbol. Specifying an undefined section will result in a fatal error. There
1804 is no check for the value, it will be taken as specified. Symbol flags can
1805 be specified and not all flags will be meaningful for all object file
1806 formats. By default, the symbol will be global. The special flag
1807 'before=@var{othersym}' will insert the new symbol in front of the specified
1808 @var{othersym}, otherwise the symbol(s) will be added at the end of the
1809 symbol table in the order they appear.
1811 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1812 Rename a section from @var{oldname} to @var{newname}, optionally
1813 changing the section's flags to @var{flags} in the process. This has
1814 the advantage over using a linker script to perform the rename in that
1815 the output stays as an object file and does not become a linked
1816 executable. This option accepts the same set of flags as the
1817 @option{--sect-section-flags} option.
1819 This option is particularly helpful when the input format is binary,
1820 since this will always create a section called .data. If for example,
1821 you wanted instead to create a section called .rodata containing binary
1822 data you could use the following command line to achieve it:
1825 objcopy -I binary -O <output_format> -B <architecture> \
1826 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1827 <input_binary_file> <output_object_file>
1830 @item --long-section-names @{enable,disable,keep@}
1831 Controls the handling of long section names when processing @code{COFF}
1832 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1833 is to preserve long section names if any are present in the input file.
1834 The @samp{enable} and @samp{disable} options forcibly enable or disable
1835 the use of long section names in the output object; when @samp{disable}
1836 is in effect, any long section names in the input object will be truncated.
1837 The @samp{enable} option will only emit long section names if any are
1838 present in the inputs; this is mostly the same as @samp{keep}, but it
1839 is left undefined whether the @samp{enable} option might force the
1840 creation of an empty string table in the output file.
1842 @item --change-leading-char
1843 Some object file formats use special characters at the start of
1844 symbols. The most common such character is underscore, which compilers
1845 often add before every symbol. This option tells @command{objcopy} to
1846 change the leading character of every symbol when it converts between
1847 object file formats. If the object file formats use the same leading
1848 character, this option has no effect. Otherwise, it will add a
1849 character, or remove a character, or change a character, as
1852 @item --remove-leading-char
1853 If the first character of a global symbol is a special symbol leading
1854 character used by the object file format, remove the character. The
1855 most common symbol leading character is underscore. This option will
1856 remove a leading underscore from all global symbols. This can be useful
1857 if you want to link together objects of different file formats with
1858 different conventions for symbol names. This is different from
1859 @option{--change-leading-char} because it always changes the symbol name
1860 when appropriate, regardless of the object file format of the output
1863 @item --reverse-bytes=@var{num}
1864 Reverse the bytes in a section with output contents. A section length must
1865 be evenly divisible by the value given in order for the swap to be able to
1866 take place. Reversing takes place before the interleaving is performed.
1868 This option is used typically in generating ROM images for problematic
1869 target systems. For example, on some target boards, the 32-bit words
1870 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1871 regardless of the CPU byte order. Depending on the programming model, the
1872 endianness of the ROM may need to be modified.
1874 Consider a simple file with a section containing the following eight
1875 bytes: @code{12345678}.
1877 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1878 output file would be ordered @code{21436587}.
1880 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1881 output file would be ordered @code{43218765}.
1883 By using @samp{--reverse-bytes=2} for the above example, followed by
1884 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1885 output file would be ordered @code{34127856}.
1887 @item --srec-len=@var{ival}
1888 Meaningful only for srec output. Set the maximum length of the Srecords
1889 being produced to @var{ival}. This length covers both address, data and
1892 @item --srec-forceS3
1893 Meaningful only for srec output. Avoid generation of S1/S2 records,
1894 creating S3-only record format.
1896 @item --redefine-sym @var{old}=@var{new}
1897 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1898 when one is trying link two things together for which you have no
1899 source, and there are name collisions.
1901 @item --redefine-syms=@var{filename}
1902 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1903 listed in the file @var{filename}. @var{filename} is simply a flat file,
1904 with one symbol pair per line. Line comments may be introduced by the hash
1905 character. This option may be given more than once.
1908 Change all global symbols in the file to be weak. This can be useful
1909 when building an object which will be linked against other objects using
1910 the @option{-R} option to the linker. This option is only effective when
1911 using an object file format which supports weak symbols.
1913 @item --keep-symbols=@var{filename}
1914 Apply @option{--keep-symbol} option to each symbol listed in the file
1915 @var{filename}. @var{filename} is simply a flat file, with one symbol
1916 name per line. Line comments may be introduced by the hash character.
1917 This option may be given more than once.
1919 @item --strip-symbols=@var{filename}
1920 Apply @option{--strip-symbol} option to each symbol listed in the file
1921 @var{filename}. @var{filename} is simply a flat file, with one symbol
1922 name per line. Line comments may be introduced by the hash character.
1923 This option may be given more than once.
1925 @item --strip-unneeded-symbols=@var{filename}
1926 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1927 the file @var{filename}. @var{filename} is simply a flat file, with one
1928 symbol name per line. Line comments may be introduced by the hash
1929 character. This option may be given more than once.
1931 @item --keep-global-symbols=@var{filename}
1932 Apply @option{--keep-global-symbol} option to each symbol listed in the
1933 file @var{filename}. @var{filename} is simply a flat file, with one
1934 symbol name per line. Line comments may be introduced by the hash
1935 character. This option may be given more than once.
1937 @item --localize-symbols=@var{filename}
1938 Apply @option{--localize-symbol} option to each symbol listed in the file
1939 @var{filename}. @var{filename} is simply a flat file, with one symbol
1940 name per line. Line comments may be introduced by the hash character.
1941 This option may be given more than once.
1943 @item --globalize-symbols=@var{filename}
1944 Apply @option{--globalize-symbol} option to each symbol listed in the file
1945 @var{filename}. @var{filename} is simply a flat file, with one symbol
1946 name per line. Line comments may be introduced by the hash character.
1947 This option may be given more than once. Note: this option cannot be
1948 used in conjunction with the @option{-G} or @option{--keep-global-symbol}
1951 @item --weaken-symbols=@var{filename}
1952 Apply @option{--weaken-symbol} option to each symbol listed in the file
1953 @var{filename}. @var{filename} is simply a flat file, with one symbol
1954 name per line. Line comments may be introduced by the hash character.
1955 This option may be given more than once.
1957 @item --alt-machine-code=@var{index}
1958 If the output architecture has alternate machine codes, use the
1959 @var{index}th code instead of the default one. This is useful in case
1960 a machine is assigned an official code and the tool-chain adopts the
1961 new code, but other applications still depend on the original code
1962 being used. For ELF based architectures if the @var{index}
1963 alternative does not exist then the value is treated as an absolute
1964 number to be stored in the e_machine field of the ELF header.
1966 @item --writable-text
1967 Mark the output text as writable. This option isn't meaningful for all
1968 object file formats.
1970 @item --readonly-text
1971 Make the output text write protected. This option isn't meaningful for all
1972 object file formats.
1975 Mark the output file as demand paged. This option isn't meaningful for all
1976 object file formats.
1979 Mark the output file as impure. This option isn't meaningful for all
1980 object file formats.
1982 @item --prefix-symbols=@var{string}
1983 Prefix all symbols in the output file with @var{string}.
1985 @item --prefix-sections=@var{string}
1986 Prefix all section names in the output file with @var{string}.
1988 @item --prefix-alloc-sections=@var{string}
1989 Prefix all the names of all allocated sections in the output file with
1992 @item --add-gnu-debuglink=@var{path-to-file}
1993 Creates a .gnu_debuglink section which contains a reference to
1994 @var{path-to-file} and adds it to the output file. Note: the file at
1995 @var{path-to-file} must exist. Part of the process of adding the
1996 .gnu_debuglink section involves embedding a checksum of the contents
1997 of the debug info file into the section.
1999 If the debug info file is built in one location but it is going to be
2000 installed at a later time into a different location then do not use
2001 the path to the installed location. The @option{--add-gnu-debuglink}
2002 option will fail because the installed file does not exist yet.
2003 Instead put the debug info file in the current directory and use the
2004 @option{--add-gnu-debuglink} option without any directory components,
2008 objcopy --add-gnu-debuglink=foo.debug
2011 At debug time the debugger will attempt to look for the separate debug
2012 info file in a set of known locations. The exact set of these
2013 locations varies depending upon the distribution being used, but it
2018 @item * The same directory as the executable.
2020 @item * A sub-directory of the directory containing the executable
2023 @item * A global debug directory such as /usr/lib/debug.
2026 As long as the debug info file has been installed into one of these
2027 locations before the debugger is run everything should work
2030 @item --keep-section-symbils
2031 When stripping a file, perhaps with @option{--strip-debug} or
2032 @option{--strip-unneeded}, retain any symbols specifying section names,
2033 which would otherwise get stripped.
2035 @item --keep-file-symbols
2036 When stripping a file, perhaps with @option{--strip-debug} or
2037 @option{--strip-unneeded}, retain any symbols specifying source file names,
2038 which would otherwise get stripped.
2040 @item --only-keep-debug
2041 Strip a file, removing contents of any sections that would not be
2042 stripped by @option{--strip-debug} and leaving the debugging sections
2043 intact. In ELF files, this preserves all note sections in the output.
2045 Note - the section headers of the stripped sections are preserved,
2046 including their sizes, but the contents of the section are discarded.
2047 The section headers are preserved so that other tools can match up the
2048 debuginfo file with the real executable, even if that executable has
2049 been relocated to a different address space.
2051 The intention is that this option will be used in conjunction with
2052 @option{--add-gnu-debuglink} to create a two part executable. One a
2053 stripped binary which will occupy less space in RAM and in a
2054 distribution and the second a debugging information file which is only
2055 needed if debugging abilities are required. The suggested procedure
2056 to create these files is as follows:
2059 @item Link the executable as normal. Assuming that it is called
2061 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2062 create a file containing the debugging info.
2063 @item Run @code{objcopy --strip-debug foo} to create a
2064 stripped executable.
2065 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2066 to add a link to the debugging info into the stripped executable.
2069 Note---the choice of @code{.dbg} as an extension for the debug info
2070 file is arbitrary. Also the @code{--only-keep-debug} step is
2071 optional. You could instead do this:
2074 @item Link the executable as normal.
2075 @item Copy @code{foo} to @code{foo.full}
2076 @item Run @code{objcopy --strip-debug foo}
2077 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2080 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2081 full executable. It does not have to be a file created by the
2082 @option{--only-keep-debug} switch.
2084 Note---this switch is only intended for use on fully linked files. It
2085 does not make sense to use it on object files where the debugging
2086 information may be incomplete. Besides the gnu_debuglink feature
2087 currently only supports the presence of one filename containing
2088 debugging information, not multiple filenames on a one-per-object-file
2092 Remove the contents of all DWARF .dwo sections, leaving the
2093 remaining debugging sections and all symbols intact.
2094 This option is intended for use by the compiler as part of
2095 the @option{-gsplit-dwarf} option, which splits debug information
2096 between the .o file and a separate .dwo file. The compiler
2097 generates all debug information in the same file, then uses
2098 the @option{--extract-dwo} option to copy the .dwo sections to
2099 the .dwo file, then the @option{--strip-dwo} option to remove
2100 those sections from the original .o file.
2103 Extract the contents of all DWARF .dwo sections. See the
2104 @option{--strip-dwo} option for more information.
2106 @item --file-alignment @var{num}
2107 Specify the file alignment. Sections in the file will always begin at
2108 file offsets which are multiples of this number. This defaults to
2110 [This option is specific to PE targets.]
2112 @item --heap @var{reserve}
2113 @itemx --heap @var{reserve},@var{commit}
2114 Specify the number of bytes of memory to reserve (and optionally commit)
2115 to be used as heap for this program.
2116 [This option is specific to PE targets.]
2118 @item --image-base @var{value}
2119 Use @var{value} as the base address of your program or dll. This is
2120 the lowest memory location that will be used when your program or dll
2121 is loaded. To reduce the need to relocate and improve performance of
2122 your dlls, each should have a unique base address and not overlap any
2123 other dlls. The default is 0x400000 for executables, and 0x10000000
2125 [This option is specific to PE targets.]
2127 @item --section-alignment @var{num}
2128 Sets the section alignment field in the PE header. Sections in memory
2129 will always begin at addresses which are a multiple of this number.
2131 [This option is specific to PE targets.]
2133 @item --stack @var{reserve}
2134 @itemx --stack @var{reserve},@var{commit}
2135 Specify the number of bytes of memory to reserve (and optionally commit)
2136 to be used as stack for this program.
2137 [This option is specific to PE targets.]
2139 @item --subsystem @var{which}
2140 @itemx --subsystem @var{which}:@var{major}
2141 @itemx --subsystem @var{which}:@var{major}.@var{minor}
2142 Specifies the subsystem under which your program will execute. The
2143 legal values for @var{which} are @code{native}, @code{windows},
2144 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
2145 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
2146 the subsystem version also. Numeric values are also accepted for
2148 [This option is specific to PE targets.]
2150 @item --extract-symbol
2151 Keep the file's section flags and symbols but remove all section data.
2152 Specifically, the option:
2155 @item removes the contents of all sections;
2156 @item sets the size of every section to zero; and
2157 @item sets the file's start address to zero.
2160 This option is used to build a @file{.sym} file for a VxWorks kernel.
2161 It can also be a useful way of reducing the size of a @option{--just-symbols}
2164 @item --compress-debug-sections
2165 Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
2166 ELF ABI. Note - if compression would actually make a section
2167 @emph{larger}, then it is not compressed.
2169 @item --compress-debug-sections=none
2170 @itemx --compress-debug-sections=zlib
2171 @itemx --compress-debug-sections=zlib-gnu
2172 @itemx --compress-debug-sections=zlib-gabi
2173 @itemx --compress-debug-sections=zstd
2174 For ELF files, these options control how DWARF debug sections are
2175 compressed. @option{--compress-debug-sections=none} is equivalent
2176 to @option{--decompress-debug-sections}.
2177 @option{--compress-debug-sections=zlib} and
2178 @option{--compress-debug-sections=zlib-gabi} are equivalent to
2179 @option{--compress-debug-sections}.
2180 @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug sections
2181 using the obsoleted zlib-gnu format. The debug sections are renamed to begin
2182 with @samp{.zdebug}.
2183 @option{--compress-debug-sections=zstd} compresses DWARF debug
2184 sections using zstd. Note - if compression would actually make a section
2185 @emph{larger}, then it is not compressed nor renamed.
2187 @item --decompress-debug-sections
2188 Decompress DWARF debug sections. For a @samp{.zdebug} section, the original
2191 @item --elf-stt-common=yes
2192 @itemx --elf-stt-common=no
2193 For ELF files, these options control whether common symbols should be
2194 converted to the @code{STT_COMMON} or @code{STT_OBJECT} type.
2195 @option{--elf-stt-common=yes} converts common symbol type to
2196 @code{STT_COMMON}. @option{--elf-stt-common=no} converts common symbol
2197 type to @code{STT_OBJECT}.
2200 @itemx --no-merge-notes
2201 For ELF files, attempt (or do not attempt) to reduce the size of any
2202 SHT_NOTE type sections by removing duplicate notes.
2206 Show the version number of @command{objcopy}.
2208 @item --verilog-data-width=@var{bytes}
2209 For Verilog output, this options controls the number of bytes
2210 converted for each output data element. The input target controls the
2211 endianness of the conversion.
2215 Verbose output: list all object files modified. In the case of
2216 archives, @samp{objcopy -V} lists all members of the archive.
2219 Show a summary of the options to @command{objcopy}.
2222 Display a list showing all architectures and object formats available.
2228 @c man begin SEEALSO objcopy
2229 ld(1), objdump(1), and the Info entries for @file{binutils}.
2236 @cindex object file information
2239 @c man title objdump display information from object files
2242 @c man begin SYNOPSIS objdump
2243 objdump [@option{-a}|@option{--archive-headers}]
2244 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
2245 [@option{-C}|@option{--demangle}[=@var{style}] ]
2246 [@option{-d}|@option{--disassemble}[=@var{symbol}]]
2247 [@option{-D}|@option{--disassemble-all}]
2248 [@option{-z}|@option{--disassemble-zeroes}]
2249 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
2250 [@option{-f}|@option{--file-headers}]
2251 [@option{-F}|@option{--file-offsets}]
2252 [@option{--file-start-context}]
2253 [@option{-g}|@option{--debugging}]
2254 [@option{-e}|@option{--debugging-tags}]
2255 [@option{-h}|@option{--section-headers}|@option{--headers}]
2256 [@option{-i}|@option{--info}]
2257 [@option{-j} @var{section}|@option{--section=}@var{section}]
2258 [@option{-l}|@option{--line-numbers}]
2259 [@option{-S}|@option{--source}]
2260 [@option{--source-comment}[=@var{text}]]
2261 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
2262 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
2263 [@option{-p}|@option{--private-headers}]
2264 [@option{-P} @var{options}|@option{--private=}@var{options}]
2265 [@option{-r}|@option{--reloc}]
2266 [@option{-R}|@option{--dynamic-reloc}]
2267 [@option{-s}|@option{--full-contents}]
2268 [@option{-W[lLiaprmfFsoORtUuTgAck]}|
2269 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links]]
2270 [@option{-WK}|@option{--dwarf=follow-links}]
2271 [@option{-WN}|@option{--dwarf=no-follow-links}]
2272 [@option{-wD}|@option{--dwarf=use-debuginfod}]
2273 [@option{-wE}|@option{--dwarf=do-not-use-debuginfod}]
2274 [@option{-L}|@option{--process-links}]
2275 [@option{--ctf=}@var{section}]
2276 [@option{--sframe=}@var{section}]
2277 [@option{-G}|@option{--stabs}]
2278 [@option{-t}|@option{--syms}]
2279 [@option{-T}|@option{--dynamic-syms}]
2280 [@option{-x}|@option{--all-headers}]
2281 [@option{-w}|@option{--wide}]
2282 [@option{--start-address=}@var{address}]
2283 [@option{--stop-address=}@var{address}]
2284 [@option{--no-addresses}]
2285 [@option{--prefix-addresses}]
2286 [@option{--[no-]show-raw-insn}]
2287 [@option{--adjust-vma=}@var{offset}]
2288 [@option{--show-all-symbols}]
2289 [@option{--dwarf-depth=@var{n}}]
2290 [@option{--dwarf-start=@var{n}}]
2291 [@option{--ctf-parent=}@var{section}]
2292 [@option{--no-recurse-limit}|@option{--recurse-limit}]
2293 [@option{--special-syms}]
2294 [@option{--prefix=}@var{prefix}]
2295 [@option{--prefix-strip=}@var{level}]
2296 [@option{--insn-width=}@var{width}]
2297 [@option{--visualize-jumps[=color|=extended-color|=off]}
2298 [@option{--disassembler-color=[off|terminal|on|extended]}
2299 [@option{-U} @var{method}] [@option{--unicode=}@var{method}]
2300 [@option{-V}|@option{--version}]
2301 [@option{-H}|@option{--help}]
2302 @var{objfile}@dots{}
2306 @c man begin DESCRIPTION objdump
2308 @command{objdump} displays information about one or more object files.
2309 The options control what particular information to display. This
2310 information is mostly useful to programmers who are working on the
2311 compilation tools, as opposed to programmers who just want their
2312 program to compile and work.
2314 @var{objfile}@dots{} are the object files to be examined. When you
2315 specify archives, @command{objdump} shows information on each of the member
2320 @c man begin OPTIONS objdump
2322 The long and short forms of options, shown here as alternatives, are
2323 equivalent. At least one option from the list
2324 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
2328 @itemx --archive-header
2329 @cindex archive headers
2330 If any of the @var{objfile} files are archives, display the archive
2331 header information (in a format similar to @samp{ls -l}). Besides the
2332 information you could list with @samp{ar tv}, @samp{objdump -a} shows
2333 the object file format of each archive member.
2335 @item --adjust-vma=@var{offset}
2336 @cindex section addresses in objdump
2337 @cindex VMA in objdump
2338 When dumping information, first add @var{offset} to all the section
2339 addresses. This is useful if the section addresses do not correspond to
2340 the symbol table, which can happen when putting sections at particular
2341 addresses when using a format which can not represent section addresses,
2344 @item -b @var{bfdname}
2345 @itemx --target=@var{bfdname}
2346 @cindex object code format
2347 Specify that the object-code format for the object files is
2348 @var{bfdname}. This option may not be necessary; @var{objdump} can
2349 automatically recognize many formats.
2353 objdump -b oasys -m vax -h fu.o
2356 displays summary information from the section headers (@option{-h}) of
2357 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
2358 file in the format produced by Oasys compilers. You can list the
2359 formats available with the @option{-i} option.
2360 @xref{Target Selection}, for more information.
2363 @itemx --demangle[=@var{style}]
2364 @cindex demangling in objdump
2365 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2366 Besides removing any initial underscore prepended by the system, this
2367 makes C++ function names readable. Different compilers have different
2368 mangling styles. The optional demangling style argument can be used to
2369 choose an appropriate demangling style for your compiler. @xref{c++filt},
2370 for more information on demangling.
2372 @item --recurse-limit
2373 @itemx --no-recurse-limit
2374 @itemx --recursion-limit
2375 @itemx --no-recursion-limit
2376 Enables or disables a limit on the amount of recursion performed
2377 whilst demangling strings. Since the name mangling formats allow for
2378 an infinite level of recursion it is possible to create strings whose
2379 decoding will exhaust the amount of stack space available on the host
2380 machine, triggering a memory fault. The limit tries to prevent this
2381 from happening by restricting recursion to 2048 levels of nesting.
2383 The default is for this limit to be enabled, but disabling it may be
2384 necessary in order to demangle truly complicated names. Note however
2385 that if the recursion limit is disabled then stack exhaustion is
2386 possible and any bug reports about such an event will be rejected.
2390 Display debugging information. This attempts to parse STABS
2391 debugging format information stored in the file and print it out using
2392 a C like syntax. If no STABS debugging was found this option
2393 falls back on the @option{-W} option to print any DWARF information in
2397 @itemx --debugging-tags
2398 Like @option{-g}, but the information is generated in a format compatible
2402 @itemx --disassemble
2403 @itemx --disassemble=@var{symbol}
2404 @cindex disassembling object code
2405 @cindex machine instructions
2406 Display the assembler mnemonics for the machine instructions from the
2407 input file. This option only disassembles those sections which are
2408 expected to contain instructions. If the optional @var{symbol}
2409 argument is given, then display the assembler mnemonics starting at
2410 @var{symbol}. If @var{symbol} is a function name then disassembly
2411 will stop at the end of the function, otherwise it will stop when the
2412 next symbol is encountered. If there are no matches for @var{symbol}
2413 then nothing will be displayed.
2415 Note if the @option{--dwarf=follow-links} option is enabled
2416 then any symbol tables in linked debug info files will be read in and
2417 used when disassembling.
2420 @itemx --disassemble-all
2421 Like @option{-d}, but disassemble the contents of all non-empty
2422 non-bss sections, not just those expected to contain instructions.
2423 @option{-j} may be used to select specific sections.
2425 This option also has a subtle effect on the disassembly of
2426 instructions in code sections. When option @option{-d} is in effect
2427 objdump will assume that any symbols present in a code section occur
2428 on the boundary between instructions and it will refuse to disassemble
2429 across such a boundary. When option @option{-D} is in effect however
2430 this assumption is supressed. This means that it is possible for the
2431 output of @option{-d} and @option{-D} to differ if, for example, data
2432 is stored in code sections.
2434 If the target is an ARM architecture this switch also has the effect
2435 of forcing the disassembler to decode pieces of data found in code
2436 sections as if they were instructions.
2438 Note if the @option{--dwarf=follow-links} option is enabled
2439 then any symbol tables in linked debug info files will be read in and
2440 used when disassembling.
2442 @item --no-addresses
2443 When disassembling, don't print addresses on each line or for symbols
2444 and relocation offsets. In combination with @option{--no-show-raw-insn}
2445 this may be useful for comparing compiler output.
2447 @item --prefix-addresses
2448 When disassembling, print the complete address on each line. This is
2449 the older disassembly format.
2453 @itemx --endian=@{big|little@}
2455 @cindex disassembly endianness
2456 Specify the endianness of the object files. This only affects
2457 disassembly. This can be useful when disassembling a file format which
2458 does not describe endianness information, such as S-records.
2461 @itemx --file-headers
2462 @cindex object file header
2463 Display summary information from the overall header of
2464 each of the @var{objfile} files.
2467 @itemx --file-offsets
2468 @cindex object file offsets
2469 When disassembling sections, whenever a symbol is displayed, also
2470 display the file offset of the region of data that is about to be
2471 dumped. If zeroes are being skipped, then when disassembly resumes,
2472 tell the user how many zeroes were skipped and the file offset of the
2473 location from where the disassembly resumes. When dumping sections,
2474 display the file offset of the location from where the dump starts.
2476 @item --file-start-context
2477 @cindex source code context
2478 Specify that when displaying interlisted source code/disassembly
2479 (assumes @option{-S}) from a file that has not yet been displayed, extend the
2480 context to the start of the file.
2483 @itemx --section-headers
2485 @cindex section headers
2486 Display summary information from the section headers of the
2489 File segments may be relocated to nonstandard addresses, for example by
2490 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2491 @command{ld}. However, some object file formats, such as a.out, do not
2492 store the starting address of the file segments. In those situations,
2493 although @command{ld} relocates the sections correctly, using @samp{objdump
2494 -h} to list the file section headers cannot show the correct addresses.
2495 Instead, it shows the usual addresses, which are implicit for the
2498 Note, in some cases it is possible for a section to have both the
2499 READONLY and the NOREAD attributes set. In such cases the NOREAD
2500 attribute takes precedence, but @command{objdump} will report both
2501 since the exact setting of the flag bits might be important.
2505 Print a summary of the options to @command{objdump} and exit.
2509 @cindex architectures available
2510 @cindex object formats available
2511 Display a list showing all architectures and object formats available
2512 for specification with @option{-b} or @option{-m}.
2515 @itemx --section=@var{name}
2516 @cindex section information
2517 Display information for section @var{name}. This option may be
2518 specified multiple times.
2521 @itemx --process-links
2522 Display the contents of non-debug sections found in separate debuginfo
2523 files that are linked to the main file. This option automatically
2524 implies the @option{-WK} option, and only sections requested by other
2525 command line options will be displayed.
2528 @itemx --line-numbers
2529 @cindex source filenames for object files
2530 Label the display (using debugging information) with the filename and
2531 source line numbers corresponding to the object code or relocs shown.
2532 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2534 @item -m @var{machine}
2535 @itemx --architecture=@var{machine}
2536 @cindex architecture
2537 @cindex disassembly architecture
2538 Specify the architecture to use when disassembling object files. This
2539 can be useful when disassembling object files which do not describe
2540 architecture information, such as S-records. You can list the available
2541 architectures with the @option{-i} option.
2543 For most architectures it is possible to supply an architecture
2544 name and a machine name, separated by a colon. For example
2545 @samp{foo:bar} would refer to the @samp{bar} machine type in the
2546 @samp{foo} architecture. This can be helpful if objdump has been
2547 configured to support multiple architectures.
2549 If the target is an ARM architecture then this switch has an
2550 additional effect. It restricts the disassembly to only those
2551 instructions supported by the architecture specified by @var{machine}.
2552 If it is necessary to use this switch because the input file does not
2553 contain any architecture information, but it is also desired to
2554 disassemble all the instructions use @option{-marm}.
2556 @item -M @var{options}
2557 @itemx --disassembler-options=@var{options}
2558 Pass target specific information to the disassembler. Only supported on
2559 some targets. If it is necessary to specify more than one
2560 disassembler option then multiple @option{-M} options can be used or
2561 can be placed together into a comma separated list.
2563 For ARC, @option{dsp} controls the printing of DSP instructions,
2564 @option{spfp} selects the printing of FPX single precision FP
2565 instructions, @option{dpfp} selects the printing of FPX double
2566 precision FP instructions, @option{quarkse_em} selects the printing of
2567 special QuarkSE-EM instructions, @option{fpuda} selects the printing
2568 of double precision assist instructions, @option{fpus} selects the
2569 printing of FPU single precision FP instructions, while @option{fpud}
2570 selects the printing of FPU double precision FP instructions.
2571 Additionally, one can choose to have all the immediates printed in
2572 hexadecimal using @option{hex}. By default, the short immediates are
2573 printed using the decimal representation, while the long immediate
2574 values are printed as hexadecimal.
2576 @option{cpu=...} allows one to enforce a particular ISA when disassembling
2577 instructions, overriding the @option{-m} value or whatever is in the ELF file.
2578 This might be useful to select ARC EM or HS ISA, because architecture is same
2579 for those and disassembler relies on private ELF header data to decide if code
2580 is for EM or HS. This option might be specified multiple times - only the
2581 latest value will be used. Valid values are same as for the assembler
2582 @option{-mcpu=...} option.
2584 If the target is an ARM architecture then this switch can be used to
2585 select which register name set is used during disassembler. Specifying
2586 @option{-M reg-names-std} (the default) will select the register names as
2587 used in ARM's instruction set documentation, but with register 13 called
2588 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2589 @option{-M reg-names-apcs} will select the name set used by the ARM
2590 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2591 just use @samp{r} followed by the register number.
2593 There are also two variants on the APCS register naming scheme enabled
2594 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2595 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2596 with the normal register names or the special register names).
2598 This option can also be used for ARM architectures to force the
2599 disassembler to interpret all instructions as Thumb instructions by
2600 using the switch @option{--disassembler-options=force-thumb}. This can be
2601 useful when attempting to disassemble thumb code produced by other
2604 For AArch64 targets this switch can be used to set whether instructions are
2605 disassembled as the most general instruction using the @option{-M no-aliases}
2606 option or whether instruction notes should be generated as comments in the
2607 disasssembly using @option{-M notes}.
2609 For the x86, some of the options duplicate functions of the @option{-m}
2610 switch, but allow finer grained control.
2615 Select disassembly for the given architecture.
2619 Select between intel syntax mode and AT&T syntax mode.
2623 Select between AMD64 ISA and Intel64 ISA.
2625 @item intel-mnemonic
2627 Select between intel mnemonic mode and AT&T mnemonic mode.
2628 Note: @code{intel-mnemonic} implies @code{intel} and
2629 @code{att-mnemonic} implies @code{att}.
2636 Specify the default address size and operand size. These five options
2637 will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2638 appear later in the option string.
2641 When in AT&T mode and also for a limited set of instructions when in Intel
2642 mode, instructs the disassembler to print a mnemonic suffix even when the
2643 suffix could be inferred by the operands or, for certain instructions, the
2644 execution mode's defaults.
2647 For PowerPC, the @option{-M} argument @option{raw} selects
2648 disasssembly of hardware insns rather than aliases. For example, you
2649 will see @code{rlwinm} rather than @code{clrlwi}, and @code{addi}
2650 rather than @code{li}. All of the @option{-m} arguments for
2651 @command{gas} that select a CPU are supported. These are:
2652 @option{403}, @option{405}, @option{440}, @option{464}, @option{476},
2653 @option{601}, @option{603}, @option{604}, @option{620}, @option{7400},
2654 @option{7410}, @option{7450}, @option{7455}, @option{750cl},
2655 @option{821}, @option{850}, @option{860}, @option{a2}, @option{booke},
2656 @option{booke32}, @option{cell}, @option{com}, @option{e200z2}, @option{e200z4},
2657 @option{e300}, @option{e500}, @option{e500mc}, @option{e500mc64},
2658 @option{e500x2}, @option{e5500}, @option{e6500}, @option{efs},
2659 @option{power4}, @option{power5}, @option{power6}, @option{power7},
2660 @option{power8}, @option{power9}, @option{power10}, @option{ppc},
2661 @option{ppc32}, @option{ppc64}, @option{ppc64bridge}, @option{ppcps},
2662 @option{pwr}, @option{pwr2}, @option{pwr4}, @option{pwr5}, @option{pwr5x},
2663 @option{pwr6}, @option{pwr7}, @option{pwr8}, @option{pwr9}, @option{pwr10},
2664 @option{pwrx}, @option{titan}, @option{vle}, and @option{future}.
2665 @option{32} and @option{64} modify the default or a prior CPU
2666 selection, disabling and enabling 64-bit insns respectively. In
2667 addition, @option{altivec}, @option{any}, @option{lsp}, @option{htm},
2668 @option{vsx}, @option{spe} and @option{spe2} add capabilities to a
2669 previous @emph{or later} CPU selection.
2670 @option{any} will disassemble any opcode known to
2671 binutils, but in cases where an opcode has two different meanings or
2672 different arguments, you may not see the disassembly you expect.
2673 If you disassemble without giving a CPU selection, a default will be
2674 chosen from information gleaned by BFD from the object files headers,
2675 but the result again may not be as you expect.
2677 For MIPS, this option controls the printing of instruction mnemonic
2678 names and register names in disassembled instructions. Multiple
2679 selections from the following may be specified as a comma separated
2680 string, and invalid options are ignored:
2684 Print the 'raw' instruction mnemonic instead of some pseudo
2685 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2686 'sll' instead of 'nop', etc.
2689 Disassemble MSA instructions.
2692 Disassemble the virtualization ASE instructions.
2695 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2697 @item gpr-names=@var{ABI}
2698 Print GPR (general-purpose register) names as appropriate
2699 for the specified ABI. By default, GPR names are selected according to
2700 the ABI of the binary being disassembled.
2702 @item fpr-names=@var{ABI}
2703 Print FPR (floating-point register) names as
2704 appropriate for the specified ABI. By default, FPR numbers are printed
2707 @item cp0-names=@var{ARCH}
2708 Print CP0 (system control coprocessor; coprocessor 0) register names
2709 as appropriate for the CPU or architecture specified by
2710 @var{ARCH}. By default, CP0 register names are selected according to
2711 the architecture and CPU of the binary being disassembled.
2713 @item hwr-names=@var{ARCH}
2714 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2715 as appropriate for the CPU or architecture specified by
2716 @var{ARCH}. By default, HWR names are selected according to
2717 the architecture and CPU of the binary being disassembled.
2719 @item reg-names=@var{ABI}
2720 Print GPR and FPR names as appropriate for the selected ABI.
2722 @item reg-names=@var{ARCH}
2723 Print CPU-specific register names (CP0 register and HWR names)
2724 as appropriate for the selected CPU or architecture.
2727 For any of the options listed above, @var{ABI} or
2728 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2729 rather than names, for the selected types of registers.
2730 You can list the available values of @var{ABI} and @var{ARCH} using
2731 the @option{--help} option.
2733 For VAX, you can specify function entry addresses with @option{-M
2734 entry:0xf00ba}. You can use this multiple times to properly
2735 disassemble VAX binary files that don't contain symbol tables (like
2736 ROM dumps). In these cases, the function entry mask would otherwise
2737 be decoded as VAX instructions, which would probably lead the rest
2738 of the function being wrongly disassembled.
2741 @itemx --private-headers
2742 Print information that is specific to the object file format. The exact
2743 information printed depends upon the object file format. For some
2744 object file formats, no additional information is printed.
2746 @item -P @var{options}
2747 @itemx --private=@var{options}
2748 Print information that is specific to the object file format. The
2749 argument @var{options} is a comma separated list that depends on the
2750 format (the lists of options is displayed with the help).
2752 For XCOFF, the available options are:
2768 For PE, the available options are:
2774 Not all object formats support this option. In particular the ELF
2775 format does not use it.
2779 @cindex relocation entries, in object file
2780 Print the relocation entries of the file. If used with @option{-d} or
2781 @option{-D}, the relocations are printed interspersed with the
2785 @itemx --dynamic-reloc
2786 @cindex dynamic relocation entries, in object file
2787 Print the dynamic relocation entries of the file. This is only
2788 meaningful for dynamic objects, such as certain types of shared
2789 libraries. As for @option{-r}, if used with @option{-d} or
2790 @option{-D}, the relocations are printed interspersed with the
2794 @itemx --full-contents
2795 @cindex sections, full contents
2796 @cindex object file sections
2797 Display the full contents of sections, often used in combination with
2798 @option{-j} to request specific sections. By default all non-empty
2799 non-bss sections are displayed.
2803 @cindex source disassembly
2804 @cindex disassembly, with source
2805 Display source code intermixed with disassembly, if possible. Implies
2808 @item --show-all-symbols
2809 When disassembling, show all the symbols that match a given address,
2810 not just the first one.
2812 @item --source-comment[=@var{txt}]
2813 @cindex source disassembly
2814 @cindex disassembly, with source
2815 Like the @option{-S} option, but all source code lines are displayed
2816 with a prefix of @var{txt}. Typically @var{txt} will be a comment
2817 string which can be used to distinguish the assembler code from the
2818 source code. If @var{txt} is not provided then a default string of
2819 @var{``# ``} (hash followed by a space), will be used.
2821 @item --prefix=@var{prefix}
2822 @cindex Add prefix to absolute paths
2823 Specify @var{prefix} to add to the absolute paths when used with
2826 @item --prefix-strip=@var{level}
2827 @cindex Strip absolute paths
2828 Indicate how many initial directory names to strip off the hardwired
2829 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2831 @item --show-raw-insn
2832 When disassembling instructions, print the instruction in hex as well as
2833 in symbolic form. This is the default except when
2834 @option{--prefix-addresses} is used.
2836 @item --no-show-raw-insn
2837 When disassembling instructions, do not print the instruction bytes.
2838 This is the default when @option{--prefix-addresses} is used.
2840 @item --insn-width=@var{width}
2841 @cindex Instruction width
2842 Display @var{width} bytes on a single line when disassembling
2845 @item --visualize-jumps[=color|=extended-color|=off]
2846 Visualize jumps that stay inside a function by drawing ASCII art between
2847 the start and target addresses. The optional @option{=color} argument
2848 adds color to the output using simple terminal colors. Alternatively
2849 the @option{=extended-color} argument will add color using 8bit
2850 colors, but these might not work on all terminals.
2852 If it is necessary to disable the @option{visualize-jumps} option
2853 after it has previously been enabled then use
2854 @option{visualize-jumps=off}.
2856 @item --disassembler-color=off
2857 @itemx --disassembler-color=terminal
2858 @itemx --disassembler-color=on|color|colour
2859 @itemx --disassembler-color=extened|extended-color|extened-colour
2860 Enables or disables the use of colored syntax highlighting in
2861 disassembly output. The default behaviour is determined via a
2862 configure time option. Note, not all architectures support colored
2863 syntax highlighting, and depending upon the terminal used, colored
2864 output may not actually be legible.
2866 The @option{on} argument adds colors using simple terminal colors.
2868 The @option{terminal} argument does the same, but only if the output
2869 device is a terminal.
2871 The @option{extended-color} argument is similar to the @option{on}
2872 argument, but it uses 8-bit colors. These may not work on all
2875 The @option{off} argument disables colored disassembly.
2877 @item -W[lLiaprmfFsoORtUuTgAckK]
2878 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
2879 @include debug.options.texi
2882 Enable additional checks for consistency of Dwarf information.
2884 @include ctf.options.texi
2886 @include sframe.options.texi
2892 @cindex debug symbols
2893 @cindex ELF object file format
2894 Display the full contents of any sections requested. Display the
2895 contents of the .stab and .stab.index and .stab.excl sections from an
2896 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2897 @code{.stab} debugging symbol-table entries are carried in an ELF
2898 section. In most other file formats, debugging symbol-table entries are
2899 interleaved with linkage symbols, and are visible in the @option{--syms}
2902 @item --start-address=@var{address}
2903 @cindex start-address
2904 Start displaying data at the specified address. This affects the output
2905 of the @option{-d}, @option{-r} and @option{-s} options.
2907 @item --stop-address=@var{address}
2908 @cindex stop-address
2909 Stop displaying data at the specified address. This affects the output
2910 of the @option{-d}, @option{-r} and @option{-s} options.
2914 @cindex symbol table entries, printing
2915 Print the symbol table entries of the file.
2916 This is similar to the information provided by the @samp{nm} program,
2917 although the display format is different. The format of the output
2918 depends upon the format of the file being dumped, but there are two main
2919 types. One looks like this:
2922 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2923 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2926 where the number inside the square brackets is the number of the entry
2927 in the symbol table, the @var{sec} number is the section number, the
2928 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2929 symbol's type, the @var{scl} number is the symbol's storage class and
2930 the @var{nx} value is the number of auxiliary entries associated with
2931 the symbol. The last two fields are the symbol's value and its name.
2933 The other common output format, usually seen with ELF based files,
2937 00000000 l d .bss 00000000 .bss
2938 00000000 g .text 00000000 fred
2941 Here the first number is the symbol's value (sometimes referred to as
2942 its address). The next field is actually a set of characters and
2943 spaces indicating the flag bits that are set on the symbol. These
2944 characters are described below. Next is the section with which the
2945 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2946 not connected with any section), or @emph{*UND*} if the section is
2947 referenced in the file being dumped, but not defined there.
2949 After the section name comes another field, a number, which for common
2950 symbols is the alignment and for other symbol is the size. Finally
2951 the symbol's name is displayed.
2953 The flag characters are divided into 7 groups as follows:
2959 The symbol is a local (l), global (g), unique global (u), neither
2960 global nor local (a space) or both global and local (!). A
2961 symbol can be neither local or global for a variety of reasons, e.g.,
2962 because it is used for debugging, but it is probably an indication of
2963 a bug if it is ever both local and global. Unique global symbols are
2964 a GNU extension to the standard set of ELF symbol bindings. For such
2965 a symbol the dynamic linker will make sure that in the entire process
2966 there is just one symbol with this name and type in use.
2969 The symbol is weak (w) or strong (a space).
2972 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2975 The symbol is a warning (W) or a normal symbol (a space). A warning
2976 symbol's name is a message to be displayed if the symbol following the
2977 warning symbol is ever referenced.
2981 The symbol is an indirect reference to another symbol (I), a function
2982 to be evaluated during reloc processing (i) or a normal symbol (a
2987 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2988 normal symbol (a space).
2993 The symbol is the name of a function (F) or a file (f) or an object
2994 (O) or just a normal symbol (a space).
2998 @itemx --dynamic-syms
2999 @cindex dynamic symbol table entries, printing
3000 Print the dynamic symbol table entries of the file. This is only
3001 meaningful for dynamic objects, such as certain types of shared
3002 libraries. This is similar to the information provided by the @samp{nm}
3003 program when given the @option{-D} (@option{--dynamic}) option.
3005 The output format is similar to that produced by the @option{--syms}
3006 option, except that an extra field is inserted before the symbol's
3007 name, giving the version information associated with the symbol.
3008 If the version is the default version to be used when resolving
3009 unversioned references to the symbol then it's displayed as is,
3010 otherwise it's put into parentheses.
3012 @item --special-syms
3013 When displaying symbols include those which the target considers to be
3014 special in some way and which would not normally be of interest to the
3017 @item -U @var{[d|i|l|e|x|h]}
3018 @itemx --unicode=@var{[default|invalid|locale|escape|hex|highlight]}
3019 Controls the display of UTF-8 encoded multibyte characters in strings.
3020 The default (@option{--unicode=default}) is to give them no special
3021 treatment. The @option{--unicode=locale} option displays the sequence
3022 in the current locale, which may or may not support them. The options
3023 @option{--unicode=hex} and @option{--unicode=invalid} display them as
3024 hex byte sequences enclosed by either angle brackets or curly braces.
3026 The @option{--unicode=escape} option displays them as escape sequences
3027 (@var{\uxxxx}) and the @option{--unicode=highlight} option displays
3028 them as escape sequences highlighted in red (if supported by the
3029 output device). The colouring is intended to draw attention to the
3030 presence of unicode sequences where they might not be expected.
3034 Print the version number of @command{objdump} and exit.
3037 @itemx --all-headers
3038 @cindex all header information, object file
3039 @cindex header information, all
3040 Display all available header information, including the symbol table and
3041 relocation entries. Using @option{-x} is equivalent to specifying all of
3042 @option{-a -f -h -p -r -t}.
3046 @cindex wide output, printing
3047 Format some lines for output devices that have more than 80 columns.
3048 Also do not truncate symbol names when they are displayed.
3051 @itemx --disassemble-zeroes
3052 Normally the disassembly output will skip blocks of zeroes. This
3053 option directs the disassembler to disassemble those blocks, just like
3060 @c man begin SEEALSO objdump
3061 nm(1), readelf(1), and the Info entries for @file{binutils}.
3069 @cindex archive contents
3070 @cindex symbol index
3072 @c man title ranlib generate an index to an archive
3075 @c man begin SYNOPSIS ranlib
3076 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
3080 @c man begin DESCRIPTION ranlib
3082 @command{ranlib} generates an index to the contents of an archive and
3083 stores it in the archive. The index lists each symbol defined by a
3084 member of an archive that is a relocatable object file.
3086 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
3088 An archive with such an index speeds up linking to the library and
3089 allows routines in the library to call each other without regard to
3090 their placement in the archive.
3092 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
3093 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
3098 @c man begin OPTIONS ranlib
3104 Show usage information for @command{ranlib}.
3109 Show the version number of @command{ranlib}.
3112 @cindex deterministic archives
3113 @kindex --enable-deterministic-archives
3114 Operate in @emph{deterministic} mode. The symbol map archive member's
3115 header will show zero for the UID, GID, and timestamp. When this
3116 option is used, multiple runs will produce identical output files.
3118 If @file{binutils} was configured with
3119 @option{--enable-deterministic-archives}, then this mode is on by
3120 default. It can be disabled with the @samp{-U} option, described
3124 Update the timestamp of the symbol map of an archive.
3127 @cindex deterministic archives
3128 @kindex --enable-deterministic-archives
3129 Do @emph{not} operate in @emph{deterministic} mode. This is the
3130 inverse of the @samp{-D} option, above: the archive index will get
3131 actual UID, GID, timestamp, and file mode values.
3133 If @file{binutils} was configured @emph{without}
3134 @option{--enable-deterministic-archives}, then this mode is on by
3142 @c man begin SEEALSO ranlib
3143 ar(1), nm(1), and the Info entries for @file{binutils}.
3151 @cindex section sizes
3153 @c man title size list section sizes and total size of binary files
3156 @c man begin SYNOPSIS size
3157 size [@option{-A}|@option{-B}|@option{-G}|@option{--format=}@var{compatibility}]
3159 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
3161 [@option{-t}|@option{--totals}]
3162 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
3164 [@var{objfile}@dots{}]
3168 @c man begin DESCRIPTION size
3170 The @sc{gnu} @command{size} utility lists the section sizes and the total
3171 size for each of the binary files @var{objfile} on its argument list.
3172 By default, one line of output is generated for each file or each
3173 module if the file is an archive.
3175 @var{objfile}@dots{} are the files to be examined. If none are
3176 specified, the file @code{a.out} will be used instead.
3180 @c man begin OPTIONS size
3182 The command-line options have the following meanings:
3188 @itemx --format=@var{compatibility}
3189 @cindex @command{size} display format
3190 Using one of these options, you can choose whether the output from @sc{gnu}
3191 @command{size} resembles output from System V @command{size} (using @option{-A},
3192 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
3193 @option{--format=berkeley}). The default is the one-line format similar to
3194 Berkeley's. Alternatively, you can choose the GNU format output
3195 (using @option{-G}, or @option{--format=gnu}), this is similar to
3196 Berkeley's output format, but sizes are counted differently.
3197 @c Bonus for doc-source readers: you can also say --format=strange (or
3198 @c anything else that starts with 's') for sysv, and --format=boring (or
3199 @c anything else that starts with 'b') for Berkeley.
3201 Here is an example of the Berkeley (default) format of output from
3204 $ size --format=Berkeley ranlib size
3205 text data bss dec hex filename
3206 294880 81920 11592 388392 5ed28 ranlib
3207 294880 81920 11888 388688 5ee50 size
3210 The Berkeley style output counts read only data in the @code{text}
3211 column, not in the @code{data} column, the @code{dec} and @code{hex}
3212 columns both display the sum of the @code{text}, @code{data}, and
3213 @code{bss} columns in decimal and hexadecimal respectively.
3215 The GNU format counts read only data in the @code{data} column, not
3216 the @code{text} column, and only displays the sum of the @code{text},
3217 @code{data}, and @code{bss} columns once, in the @code{total} column.
3218 The @option{--radix} option can be used to change the number base for
3219 all columns. Here is the same data displayed with GNU conventions:
3222 $ size --format=GNU ranlib size
3223 text data bss total filename
3224 279880 96920 11592 388392 ranlib
3225 279880 96920 11888 388688 size
3229 This is the same data, but displayed closer to System V conventions:
3232 $ size --format=SysV ranlib size
3253 Show a summary of acceptable arguments and options.
3258 @itemx --radix=@var{number}
3259 @cindex @command{size} number format
3260 @cindex radix for section sizes
3261 Using one of these options, you can control whether the size of each
3262 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
3263 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
3264 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
3265 values (8, 10, 16) are supported. The total size is always given in two
3266 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
3267 octal and hexadecimal if you're using @option{-o}.
3270 Print total size of common symbols in each file. When using Berkeley
3271 or GNU format these are included in the bss size.
3275 Show totals of all objects listed (Berkeley or GNU format mode only).
3277 @item --target=@var{bfdname}
3278 @cindex object code format
3279 Specify that the object-code format for @var{objfile} is
3280 @var{bfdname}. This option may not be necessary; @command{size} can
3281 automatically recognize many formats.
3282 @xref{Target Selection}, for more information.
3287 Display the version number of @command{size}.
3290 Ignored. This option is used by other versions of the @command{size}
3291 program, but it is not supported by the GNU Binutils version.
3298 @c man begin SEEALSO size
3299 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
3306 @cindex listings strings
3307 @cindex printing strings
3308 @cindex strings, printing
3310 @c man title strings print the sequences of printable characters in files
3313 @c man begin SYNOPSIS strings
3314 strings [@option{-afovV}] [@option{-}@var{min-len}]
3315 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
3316 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
3317 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
3318 [@option{-U} @var{method}] [@option{--unicode=}@var{method}]
3319 [@option{-}] [@option{--all}] [@option{--print-file-name}]
3320 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
3321 [@option{-w}] [@option{--include-all-whitespace}]
3322 [@option{-s}] [@option{--output-separator} @var{sep_string}]
3323 [@option{--help}] [@option{--version}] @var{file}@dots{}
3327 @c man begin DESCRIPTION strings
3329 For each @var{file} given, @sc{gnu} @command{strings} prints the
3330 printable character sequences that are at least 4 characters long (or
3331 the number given with the options below) and are followed by an
3332 unprintable character.
3334 Depending upon how the strings program was configured it will default
3335 to either displaying all the printable sequences that it can find in
3336 each file, or only those sequences that are in loadable, initialized
3337 data sections. If the file type is unrecognizable, or if strings is
3338 reading from stdin then it will always display all of the printable
3339 sequences that it can find.
3341 For backwards compatibility any file that occurs after a command-line
3342 option of just @option{-} will also be scanned in full, regardless of
3343 the presence of any @option{-d} option.
3345 @command{strings} is mainly useful for determining the contents of
3350 @c man begin OPTIONS strings
3356 Scan the whole file, regardless of what sections it contains or
3357 whether those sections are loaded or initialized. Normally this is
3358 the default behaviour, but strings can be configured so that the
3359 @option{-d} is the default instead.
3361 The @option{-} option is position dependent and forces strings to
3362 perform full scans of any file that is mentioned after the @option{-}
3363 on the command line, even if the @option{-d} option has been
3368 Only print strings from initialized, loaded data sections in the
3369 file. This may reduce the amount of garbage in the output, but it
3370 also exposes the strings program to any security flaws that may be
3371 present in the BFD library used to scan and load sections. Strings
3372 can be configured so that this option is the default behaviour. In
3373 such cases the @option{-a} option can be used to avoid using the BFD
3374 library and instead just print all of the strings found in the file.
3377 @itemx --print-file-name
3378 Print the name of the file before each string.
3381 Print a summary of the program usage on the standard output and exit.
3383 @item -@var{min-len}
3384 @itemx -n @var{min-len}
3385 @itemx --bytes=@var{min-len}
3386 Print sequences of displayable characters that are at least
3387 @var{min-len} characters long. If not specified a default minimum
3388 length of 4 is used. The distinction between displayable and
3389 non-displayable characters depends upon the setting of the
3390 @option{-e} and @option{-U} options. Sequences are always terminated
3391 at control characters such as new-line and carriage-return, but not
3395 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
3396 act like @samp{-t d} instead. Since we can not be compatible with both
3397 ways, we simply chose one.
3399 @item -t @var{radix}
3400 @itemx --radix=@var{radix}
3401 Print the offset within the file before each string. The single
3402 character argument specifies the radix of the offset---@samp{o} for
3403 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
3405 @item -e @var{encoding}
3406 @itemx --encoding=@var{encoding}
3407 Select the character encoding of the strings that are to be found.
3408 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
3409 characters (default), @samp{S} =
3410 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
3411 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
3412 littleendian. Useful for finding wide character strings. (@samp{l}
3413 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
3415 @item -U @var{[d|i|l|e|x|h]}
3416 @itemx --unicode=@var{[default|invalid|locale|escape|hex|highlight]}
3417 Controls the display of UTF-8 encoded multibyte characters in strings.
3418 The default (@option{--unicode=default}) is to give them no special
3419 treatment, and instead rely upon the setting of the
3420 @option{--encoding} option. The other values for this option
3421 automatically enable @option{--encoding=S}.
3423 The @option{--unicode=invalid} option treats them as non-graphic
3424 characters and hence not part of a valid string. All the remaining
3425 options treat them as valid string characters.
3427 The @option{--unicode=locale} option displays them in the current
3428 locale, which may or may not support UTF-8 encoding. The
3429 @option{--unicode=hex} option displays them as hex byte sequences
3430 enclosed between @var{<>} characters. The @option{--unicode=escape}
3431 option displays them as escape sequences (@var{\uxxxx}) and the
3432 @option{--unicode=highlight} option displays them as escape sequences
3433 highlighted in red (if supported by the output device). The colouring
3434 is intended to draw attention to the presence of unicode sequences
3435 where they might not be expected.
3437 @item -T @var{bfdname}
3438 @itemx --target=@var{bfdname}
3439 @cindex object code format
3440 Specify an object code format other than your system's default format.
3441 @xref{Target Selection}, for more information.
3446 Print the program version number on the standard output and exit.
3449 @itemx --include-all-whitespace
3450 By default tab and space characters are included in the strings that
3451 are displayed, but other whitespace characters, such a newlines and
3452 carriage returns, are not. The @option{-w} option changes this so
3453 that all whitespace characters are considered to be part of a string.
3456 @itemx --output-separator
3457 By default, output strings are delimited by a new-line. This option
3458 allows you to supply any string to be used as the output record
3459 separator. Useful with --include-all-whitespace where strings
3460 may contain new-lines internally.
3466 @c man begin SEEALSO strings
3467 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
3468 and the Info entries for @file{binutils}.
3476 @cindex removing symbols
3477 @cindex discarding symbols
3478 @cindex symbols, discarding
3480 @c man title strip discard symbols and other data from object files
3483 @c man begin SYNOPSIS strip
3484 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
3485 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
3486 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
3487 [@option{-s}|@option{--strip-all}]
3488 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
3489 [@option{--strip-dwo}]
3490 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
3491 [@option{-M}|@option{--merge-notes}][@option{--no-merge-notes}]
3492 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
3493 [@option{-w}|@option{--wildcard}]
3494 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
3495 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
3496 [@option{--keep-section=}@var{sectionpattern}]
3497 [@option{--remove-relocations=}@var{sectionpattern}]
3498 [@option{--strip-section-headers}]
3499 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
3500 [@option{-D}|@option{--enable-deterministic-archives}]
3501 [@option{-U}|@option{--disable-deterministic-archives}]
3502 [@option{--keep-section-symbols}]
3503 [@option{--keep-file-symbols}]
3504 [@option{--only-keep-debug}]
3505 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
3506 [@option{--help}] [@option{--info}]
3507 @var{objfile}@dots{}
3511 @c man begin DESCRIPTION strip
3513 @sc{gnu} @command{strip} discards all symbols from object files
3514 @var{objfile}. The list of object files may include archives.
3515 At least one object file must be given.
3517 @command{strip} modifies the files named in its argument,
3518 rather than writing modified copies under different names.
3522 @c man begin OPTIONS strip
3525 @item -F @var{bfdname}
3526 @itemx --target=@var{bfdname}
3527 Treat the original @var{objfile} as a file with the object
3528 code format @var{bfdname}, and rewrite it in the same format.
3529 @xref{Target Selection}, for more information.
3532 Show a summary of the options to @command{strip} and exit.
3535 Display a list showing all architectures and object formats available.
3537 @item -I @var{bfdname}
3538 @itemx --input-target=@var{bfdname}
3539 Treat the original @var{objfile} as a file with the object
3540 code format @var{bfdname}.
3541 @xref{Target Selection}, for more information.
3543 @item -O @var{bfdname}
3544 @itemx --output-target=@var{bfdname}
3545 Replace @var{objfile} with a file in the output format @var{bfdname}.
3546 @xref{Target Selection}, for more information.
3548 @item -R @var{sectionname}
3549 @itemx --remove-section=@var{sectionname}
3550 Remove any section named @var{sectionname} from the output file, in
3551 addition to whatever sections would otherwise be removed. This
3552 option may be given more than once. Note that using this option
3553 inappropriately may make the output file unusable. The wildcard
3554 character @samp{*} may be given at the end of @var{sectionname}. If
3555 so, then any section starting with @var{sectionname} will be removed.
3557 If the first character of @var{sectionpattern} is the exclamation
3558 point (!) then matching sections will not be removed even if an
3559 earlier use of @option{--remove-section} on the same command line
3560 would otherwise remove it. For example:
3563 --remove-section=.text.* --remove-section=!.text.foo
3566 will remove all sections matching the pattern '.text.*', but will not
3567 remove the section '.text.foo'.
3569 @item --keep-section=@var{sectionpattern}
3570 When removing sections from the output file, keep sections that match
3571 @var{sectionpattern}.
3573 @item --remove-relocations=@var{sectionpattern}
3574 Remove relocations from the output file for any section matching
3575 @var{sectionpattern}. This option may be given more than once. Note
3576 that using this option inappropriately may make the output file
3577 unusable. Wildcard characters are accepted in @var{sectionpattern}.
3581 --remove-relocations=.text.*
3584 will remove the relocations for all sections matching the patter
3587 If the first character of @var{sectionpattern} is the exclamation
3588 point (!) then matching sections will not have their relocation
3589 removed even if an earlier use of @option{--remove-relocations} on the
3590 same command line would otherwise cause the relocations to be removed.
3594 --remove-relocations=.text.* --remove-relocations=!.text.foo
3597 will remove all relocations for sections matching the pattern
3598 '.text.*', but will not remove relocations for the section
3601 @item --strip-section-headers
3602 Strip section headers. This option is specific to ELF files. Implies
3603 @option{--strip-all} and @option{--merge-notes}.
3612 @itemx --strip-debug
3613 Remove debugging symbols only.
3616 Remove the contents of all DWARF .dwo sections, leaving the
3617 remaining debugging sections and all symbols intact.
3618 See the description of this option in the @command{objcopy} section
3619 for more information.
3621 @item --strip-unneeded
3622 Remove all symbols that are not needed for relocation processing in
3623 addition to debugging symbols and sections stripped by
3624 @option{--strip-debug}.
3626 @item -K @var{symbolname}
3627 @itemx --keep-symbol=@var{symbolname}
3628 When stripping symbols, keep symbol @var{symbolname} even if it would
3629 normally be stripped. This option may be given more than once.
3632 @itemx --merge-notes
3633 @itemx --no-merge-notes
3634 For ELF files, attempt (or do not attempt) to reduce the size of any
3635 SHT_NOTE type sections by removing duplicate notes. The default is to
3636 attempt this reduction unless stripping debug or DWO information.
3638 @item -N @var{symbolname}
3639 @itemx --strip-symbol=@var{symbolname}
3640 Remove symbol @var{symbolname} from the source file. This option may be
3641 given more than once, and may be combined with strip options other than
3645 Put the stripped output in @var{file}, rather than replacing the
3646 existing file. When this argument is used, only one @var{objfile}
3647 argument may be specified.
3650 @itemx --preserve-dates
3651 Preserve the access and modification dates of the file.
3654 @itemx --enable-deterministic-archives
3655 @cindex deterministic archives
3656 @kindex --enable-deterministic-archives
3657 Operate in @emph{deterministic} mode. When copying archive members
3658 and writing the archive index, use zero for UIDs, GIDs, timestamps,
3659 and use consistent file modes for all files.
3661 If @file{binutils} was configured with
3662 @option{--enable-deterministic-archives}, then this mode is on by default.
3663 It can be disabled with the @samp{-U} option, below.
3666 @itemx --disable-deterministic-archives
3667 @cindex deterministic archives
3668 @kindex --enable-deterministic-archives
3669 Do @emph{not} operate in @emph{deterministic} mode. This is the
3670 inverse of the @option{-D} option, above: when copying archive members
3671 and writing the archive index, use their actual UID, GID, timestamp,
3672 and file mode values.
3674 This is the default unless @file{binutils} was configured with
3675 @option{--enable-deterministic-archives}.
3679 Permit regular expressions in @var{symbolname}s used in other command
3680 line options. The question mark (?), asterisk (*), backslash (\) and
3681 square brackets ([]) operators can be used anywhere in the symbol
3682 name. If the first character of the symbol name is the exclamation
3683 point (!) then the sense of the switch is reversed for that symbol.
3690 would cause strip to only keep symbols that start with the letters
3691 ``fo'', but to discard the symbol ``foo''.
3694 @itemx --discard-all
3695 Remove non-global symbols.
3698 @itemx --discard-locals
3699 Remove compiler-generated local symbols.
3700 (These usually start with @samp{L} or @samp{.}.)
3702 @item --keep-section-symbols
3703 When stripping a file, perhaps with @option{--strip-debug} or
3704 @option{--strip-unneeded}, retain any symbols specifying section names,
3705 which would otherwise get stripped.
3707 @item --keep-file-symbols
3708 When stripping a file, perhaps with @option{--strip-debug} or
3709 @option{--strip-unneeded}, retain any symbols specifying source file names,
3710 which would otherwise get stripped.
3712 @item --only-keep-debug
3713 Strip a file, emptying the contents of any sections that would not be
3714 stripped by @option{--strip-debug} and leaving the debugging sections
3715 intact. In ELF files, this preserves all the note sections in the
3718 Note - the section headers of the stripped sections are preserved,
3719 including their sizes, but the contents of the section are discarded.
3720 The section headers are preserved so that other tools can match up the
3721 debuginfo file with the real executable, even if that executable has
3722 been relocated to a different address space.
3724 The intention is that this option will be used in conjunction with
3725 @option{--add-gnu-debuglink} to create a two part executable. One a
3726 stripped binary which will occupy less space in RAM and in a
3727 distribution and the second a debugging information file which is only
3728 needed if debugging abilities are required. The suggested procedure
3729 to create these files is as follows:
3732 @item Link the executable as normal. Assuming that it is called
3734 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3735 create a file containing the debugging info.
3736 @item Run @code{objcopy --strip-debug foo} to create a
3737 stripped executable.
3738 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3739 to add a link to the debugging info into the stripped executable.
3742 Note---the choice of @code{.dbg} as an extension for the debug info
3743 file is arbitrary. Also the @code{--only-keep-debug} step is
3744 optional. You could instead do this:
3747 @item Link the executable as normal.
3748 @item Copy @code{foo} to @code{foo.full}
3749 @item Run @code{strip --strip-debug foo}
3750 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3753 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
3754 full executable. It does not have to be a file created by the
3755 @option{--only-keep-debug} switch.
3757 Note---this switch is only intended for use on fully linked files. It
3758 does not make sense to use it on object files where the debugging
3759 information may be incomplete. Besides the gnu_debuglink feature
3760 currently only supports the presence of one filename containing
3761 debugging information, not multiple filenames on a one-per-object-file
3766 Show the version number for @command{strip}.
3770 Verbose output: list all object files modified. In the case of
3771 archives, @samp{strip -v} lists all members of the archive.
3777 @c man begin SEEALSO strip
3778 the Info entries for @file{binutils}.
3782 @node c++filt, addr2line, strip, Top
3786 @cindex demangling C++ symbols
3788 @c man title cxxfilt demangle C++ and Java symbols
3791 @c man begin SYNOPSIS cxxfilt
3792 c++filt [@option{-_}|@option{--strip-underscore}]
3793 [@option{-n}|@option{--no-strip-underscore}]
3794 [@option{-p}|@option{--no-params}]
3795 [@option{-t}|@option{--types}]
3796 [@option{-i}|@option{--no-verbose}]
3797 [@option{-r}|@option{--no-recurse-limit}]
3798 [@option{-R}|@option{--recurse-limit}]
3799 [@option{-s} @var{format}|@option{--format=}@var{format}]
3800 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
3804 @c man begin DESCRIPTION cxxfilt
3807 The C++ and Java languages provide function overloading, which means
3808 that you can write many functions with the same name, providing that
3809 each function takes parameters of different types. In order to be
3810 able to distinguish these similarly named functions C++ and Java
3811 encode them into a low-level assembler name which uniquely identifies
3812 each different version. This process is known as @dfn{mangling}. The
3814 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3815 MS-DOS this program is named @command{CXXFILT}.}
3816 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3817 names into user-level names so that they can be read.
3819 Every alphanumeric word (consisting of letters, digits, underscores,
3820 dollars, or periods) seen in the input is a potential mangled name.
3821 If the name decodes into a C++ name, the C++ name replaces the
3822 low-level name in the output, otherwise the original word is output.
3823 In this way you can pass an entire assembler source file, containing
3824 mangled names, through @command{c++filt} and see the same source file
3825 containing demangled names.
3827 You can also use @command{c++filt} to decipher individual symbols by
3828 passing them on the command line:
3831 c++filt @var{symbol}
3834 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3835 names from the standard input instead. All the results are printed on
3836 the standard output. The difference between reading names from the
3837 command line versus reading names from the standard input is that
3838 command-line arguments are expected to be just mangled names and no
3839 checking is performed to separate them from surrounding text. Thus
3846 will work and demangle the name to ``f()'' whereas:
3852 will not work. (Note the extra comma at the end of the mangled
3853 name which makes it invalid). This command however will work:
3856 echo _Z1fv, | c++filt -n
3859 and will display ``f(),'', i.e., the demangled name followed by a
3860 trailing comma. This behaviour is because when the names are read
3861 from the standard input it is expected that they might be part of an
3862 assembler source file where there might be extra, extraneous
3863 characters trailing after a mangled name. For example:
3866 .type _Z1fv, @@function
3871 @c man begin OPTIONS cxxfilt
3875 @itemx --strip-underscore
3876 On some systems, both the C and C++ compilers put an underscore in front
3877 of every name. For example, the C name @code{foo} gets the low-level
3878 name @code{_foo}. This option removes the initial underscore. Whether
3879 @command{c++filt} removes the underscore by default is target dependent.
3882 @itemx --no-strip-underscore
3883 Do not remove the initial underscore.
3887 When demangling the name of a function, do not display the types of
3888 the function's parameters.
3892 Attempt to demangle types as well as function names. This is disabled
3893 by default since mangled types are normally only used internally in
3894 the compiler, and they can be confused with non-mangled names. For example,
3895 a function called ``a'' treated as a mangled type name would be
3896 demangled to ``signed char''.
3900 Do not include implementation details (if any) in the demangled
3905 @itemx --recurse-limit
3906 @itemx --no-recurse-limit
3907 @itemx --recursion-limit
3908 @itemx --no-recursion-limit
3909 Enables or disables a limit on the amount of recursion performed
3910 whilst demangling strings. Since the name mangling formats allow for
3911 an infinite level of recursion it is possible to create strings whose
3912 decoding will exhaust the amount of stack space available on the host
3913 machine, triggering a memory fault. The limit tries to prevent this
3914 from happening by restricting recursion to 2048 levels of nesting.
3916 The default is for this limit to be enabled, but disabling it may be
3917 necessary in order to demangle truly complicated names. Note however
3918 that if the recursion limit is disabled then stack exhaustion is
3919 possible and any bug reports about such an event will be rejected.
3921 The @option{-r} option is a synonym for the
3922 @option{--no-recurse-limit} option. The @option{-R} option is a
3923 synonym for the @option{--recurse-limit} option.
3925 @item -s @var{format}
3926 @itemx --format=@var{format}
3927 @command{c++filt} can decode various methods of mangling, used by
3928 different compilers. The argument to this option selects which
3933 Automatic selection based on executable (the default method)
3935 the one used by the @sc{gnu} C++ compiler (g++)
3937 the one used by the Lucid compiler (lcc)
3939 the one specified by the C++ Annotated Reference Manual
3941 the one used by the HP compiler (aCC)
3943 the one used by the EDG compiler
3945 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3947 the one used by the @sc{gnu} Java compiler (gcj)
3949 the one used by the @sc{gnu} Ada compiler (GNAT).
3953 Print a summary of the options to @command{c++filt} and exit.
3956 Print the version number of @command{c++filt} and exit.
3962 @c man begin SEEALSO cxxfilt
3963 the Info entries for @file{binutils}.
3968 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3969 user interface are subject to change in future releases. In particular,
3970 a command-line option may be required in the future to decode a name
3971 passed as an argument on the command line; in other words,
3974 c++filt @var{symbol}
3978 may in a future release become
3981 c++filt @var{option} @var{symbol}
3989 @cindex address to file name and line number
3991 @c man title addr2line convert addresses or symbol+offset into file names and line numbers
3994 @c man begin SYNOPSIS addr2line
3995 addr2line [@option{-a}|@option{--addresses}]
3996 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3997 [@option{-C}|@option{--demangle}[=@var{style}]]
3998 [@option{-r}|@option{--no-recurse-limit}]
3999 [@option{-R}|@option{--recurse-limit}]
4000 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
4001 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
4002 [@option{-i}|@option{--inlines}]
4003 [@option{-p}|@option{--pretty-print}]
4004 [@option{-j}|@option{--section=}@var{name}]
4005 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
4010 @c man begin DESCRIPTION addr2line
4012 @command{addr2line} translates addresses or symbol+offset into file names and line numbers.
4013 Given an address or symbol+offset in an executable or an offset in a section of a relocatable
4014 object, it uses the debugging information to figure out which file name and
4015 line number are associated with it.
4017 The executable or relocatable object to use is specified with the @option{-e}
4018 option. The default is the file @file{a.out}. The section in the relocatable
4019 object to use is specified with the @option{-j} option.
4021 @command{addr2line} has two modes of operation.
4023 In the first, hexadecimal addresses or symbol+offset are specified on the command line,
4024 and @command{addr2line} displays the file name and line number for each
4027 In the second, @command{addr2line} reads hexadecimal addresses or symbol+offset from
4028 standard input, and prints the file name and line number for each
4029 address on standard output. In this mode, @command{addr2line} may be used
4030 in a pipe to convert dynamically chosen addresses.
4032 The format of the output is @samp{FILENAME:LINENO}. By default
4033 each input address generates one line of output.
4035 Two options can generate additional lines before each
4036 @samp{FILENAME:LINENO} line (in that order).
4038 If the @option{-a} option is used then a line with the input address
4041 If the @option{-f} option is used, then a line with the
4042 @samp{FUNCTIONNAME} is displayed. This is the name of the function
4043 containing the address.
4045 One option can generate additional lines after the
4046 @samp{FILENAME:LINENO} line.
4048 If the @option{-i} option is used and the code at the given address is
4049 present there because of inlining by the compiler then additional
4050 lines are displayed afterwards. One or two extra lines (if the
4051 @option{-f} option is used) are displayed for each inlined function.
4053 Alternatively if the @option{-p} option is used then each input
4054 address generates a single, long, output line containing the address,
4055 the function name, the file name and the line number. If the
4056 @option{-i} option has also been used then any inlined functions will
4057 be displayed in the same manner, but on separate lines, and prefixed
4058 by the text @samp{(inlined by)}.
4060 If the file name or function name can not be determined,
4061 @command{addr2line} will print two question marks in their place. If the
4062 line number can not be determined, @command{addr2line} will print 0.
4064 When symbol+offset is used, +offset is optional, except when the symbol
4065 is ambigious with a hex number. The resolved symbols can be mangled
4066 or unmangled, except unmangled symbols with + are not allowed.
4070 @c man begin OPTIONS addr2line
4072 The long and short forms of options, shown here as alternatives, are
4078 Display the address before the function name, file and line number
4079 information. The address is printed with a @samp{0x} prefix to easily
4082 @item -b @var{bfdname}
4083 @itemx --target=@var{bfdname}
4084 @cindex object code format
4085 Specify that the object-code format for the object files is
4089 @itemx --demangle[=@var{style}]
4090 @cindex demangling in objdump
4091 Decode (@dfn{demangle}) low-level symbol names into user-level names.
4092 Besides removing any initial underscore prepended by the system, this
4093 makes C++ function names readable. Different compilers have different
4094 mangling styles. The optional demangling style argument can be used to
4095 choose an appropriate demangling style for your compiler. @xref{c++filt},
4096 for more information on demangling.
4098 @item -e @var{filename}
4099 @itemx --exe=@var{filename}
4100 Specify the name of the executable for which addresses should be
4101 translated. The default file is @file{a.out}.
4105 Display function names as well as file and line number information.
4109 Display only the base of each file name.
4113 If the address belongs to a function that was inlined, the source
4114 information for all enclosing scopes back to the first non-inlined
4115 function will also be printed. For example, if @code{main} inlines
4116 @code{callee1} which inlines @code{callee2}, and address is from
4117 @code{callee2}, the source information for @code{callee1} and @code{main}
4118 will also be printed.
4122 Read offsets relative to the specified section instead of absolute addresses.
4125 @itemx --pretty-print
4126 Make the output more human friendly: each location are printed on one line.
4127 If option @option{-i} is specified, lines for all enclosing scopes are
4128 prefixed with @samp{(inlined by)}.
4132 @itemx --recurse-limit
4133 @itemx --no-recurse-limit
4134 @itemx --recursion-limit
4135 @itemx --no-recursion-limit
4136 Enables or disables a limit on the amount of recursion performed
4137 whilst demangling strings. Since the name mangling formats allow for
4138 an infinite level of recursion it is possible to create strings whose
4139 decoding will exhaust the amount of stack space available on the host
4140 machine, triggering a memory fault. The limit tries to prevent this
4141 from happening by restricting recursion to 2048 levels of nesting.
4143 The default is for this limit to be enabled, but disabling it may be
4144 necessary in order to demangle truly complicated names. Note however
4145 that if the recursion limit is disabled then stack exhaustion is
4146 possible and any bug reports about such an event will be rejected.
4148 The @option{-r} option is a synonym for the
4149 @option{--no-recurse-limit} option. The @option{-R} option is a
4150 synonym for the @option{--recurse-limit} option.
4152 Note this option is only effective if the @option{-C} or
4153 @option{--demangle} option has been enabled.
4160 @c man begin SEEALSO addr2line
4161 Info entries for @file{binutils}.
4168 @command{windmc} may be used to generator Windows message resources.
4171 @emph{Warning:} @command{windmc} is not always built as part of the binary
4172 utilities, since it is only useful for Windows targets.
4175 @c man title windmc generates Windows message resources
4178 @c man begin SYNOPSIS windmc
4179 windmc [options] input-file
4183 @c man begin DESCRIPTION windmc
4185 @command{windmc} reads message definitions from an input file (.mc) and
4186 translate them into a set of output files. The output files may be of
4191 A C header file containing the message definitions.
4194 A resource file compilable by the @command{windres} tool.
4197 One or more binary files containing the resource data for a specific
4201 A C include file that maps message id's to their symbolic name.
4204 The exact description of these different formats is available in
4205 documentation from Microsoft.
4207 When @command{windmc} converts from the @code{mc} format to the @code{bin}
4208 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
4209 Windows Message Compiler.
4213 @c man begin OPTIONS windmc
4218 Specifies that the input file specified is ASCII. This is the default
4223 Specifies that messages in the output @code{bin} files should be in ASCII
4228 Specifies that @code{bin} filenames should have to be prefixed by the
4229 basename of the source file.
4233 Sets the customer bit in all message id's.
4235 @item -C @var{codepage}
4236 @itemx --codepage_in @var{codepage}
4237 Sets the default codepage to be used to convert input file to UTF16. The
4238 default is ocdepage 1252.
4241 @itemx --decimal_values
4242 Outputs the constants in the header file in decimal. Default is using
4246 @itemx --extension @var{ext}
4247 The extension for the header file. The default is .h extension.
4249 @item -F @var{target}
4250 @itemx --target @var{target}
4251 Specify the BFD format to use for a bin file as output. This
4252 is a BFD target name; you can use the @option{--help} option to see a list
4253 of supported targets. Normally @command{windmc} will use the default
4254 format, which is the first one listed by the @option{--help} option.
4256 @ref{Target Selection}.
4260 @itemx --headerdir @var{path}
4261 The target directory of the generated header file. The default is the
4266 Displays a list of command-line options and then exits.
4268 @item -m @var{characters}
4269 @itemx --maxlength @var{characters}
4270 Instructs @command{windmc} to generate a warning if the length
4271 of any message exceeds the number specified.
4274 @itemx --nullterminate
4275 Terminate message text in @code{bin} files by zero. By default they are
4276 terminated by CR/LF.
4279 @itemx --hresult_use
4280 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
4281 file, using HRESULT definitions. Status codes are used if the flag is not
4284 @item -O @var{codepage}
4285 @itemx --codepage_out @var{codepage}
4286 Sets the default codepage to be used to output text files. The default
4290 @itemx --rcdir @var{path}
4291 The target directory for the generated @code{rc} script and the generated
4292 @code{bin} files that the resource compiler script includes. The default
4293 is the current directory.
4297 Specifies that the input file is UTF16.
4300 @itemx --unicode_out
4301 Specifies that messages in the output @code{bin} file should be in UTF16
4302 format. This is the default behaviour.
4306 Enable verbose mode.
4310 Prints the version number for @command{windmc}.
4313 @itemx --xdgb @var{path}
4314 The path of the @code{dbg} C include file that maps message id's to the
4315 symbolic name. No such file is generated without specifying the switch.
4321 @c man begin SEEALSO windmc
4322 the Info entries for @file{binutils}.
4329 @command{windres} may be used to manipulate Windows resources.
4332 @emph{Warning:} @command{windres} is not always built as part of the binary
4333 utilities, since it is only useful for Windows targets.
4336 @c man title windres manipulate Windows resources
4339 @c man begin SYNOPSIS windres
4340 windres [options] [input-file] [output-file]
4344 @c man begin DESCRIPTION windres
4346 @command{windres} reads resources from an input file and copies them into
4347 an output file. Either file may be in one of three formats:
4351 A text format read by the Resource Compiler.
4354 A binary format generated by the Resource Compiler.
4357 A COFF object or executable.
4360 The exact description of these different formats is available in
4361 documentation from Microsoft.
4363 When @command{windres} converts from the @code{rc} format to the @code{res}
4364 format, it is acting like the Windows Resource Compiler. When
4365 @command{windres} converts from the @code{res} format to the @code{coff}
4366 format, it is acting like the Windows @code{CVTRES} program.
4368 When @command{windres} generates an @code{rc} file, the output is similar
4369 but not identical to the format expected for the input. When an input
4370 @code{rc} file refers to an external filename, an output @code{rc} file
4371 will instead include the file contents.
4373 If the input or output format is not specified, @command{windres} will
4374 guess based on the file name, or, for the input file, the file contents.
4375 A file with an extension of @file{.rc} will be treated as an @code{rc}
4376 file, a file with an extension of @file{.res} will be treated as a
4377 @code{res} file, and a file with an extension of @file{.o} or
4378 @file{.exe} will be treated as a @code{coff} file.
4380 If no output file is specified, @command{windres} will print the resources
4381 in @code{rc} format to standard output.
4383 The normal use is for you to write an @code{rc} file, use @command{windres}
4384 to convert it to a COFF object file, and then link the COFF file into
4385 your application. This will make the resources described in the
4386 @code{rc} file available to Windows.
4390 @c man begin OPTIONS windres
4393 @item -i @var{filename}
4394 @itemx --input @var{filename}
4395 The name of the input file. If this option is not used, then
4396 @command{windres} will use the first non-option argument as the input file
4397 name. If there are no non-option arguments, then @command{windres} will
4398 read from standard input. @command{windres} can not read a COFF file from
4401 @item -o @var{filename}
4402 @itemx --output @var{filename}
4403 The name of the output file. If this option is not used, then
4404 @command{windres} will use the first non-option argument, after any used
4405 for the input file name, as the output file name. If there is no
4406 non-option argument, then @command{windres} will write to standard output.
4407 @command{windres} can not write a COFF file to standard output. Note,
4408 for compatibility with @command{rc} the option @option{-fo} is also
4409 accepted, but its use is not recommended.
4411 @item -J @var{format}
4412 @itemx --input-format @var{format}
4413 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
4414 @samp{coff}. If no input format is specified, @command{windres} will
4415 guess, as described above.
4417 @item -O @var{format}
4418 @itemx --output-format @var{format}
4419 The output format to generate. @var{format} may be @samp{res},
4420 @samp{rc}, or @samp{coff}. If no output format is specified,
4421 @command{windres} will guess, as described above.
4423 @item -F @var{target}
4424 @itemx --target @var{target}
4425 Specify the BFD format to use for a COFF file as input or output. This
4426 is a BFD target name; you can use the @option{--help} option to see a list
4427 of supported targets. Normally @command{windres} will use the default
4428 format, which is the first one listed by the @option{--help} option.
4430 @ref{Target Selection}.
4433 @item --preprocessor @var{program}
4434 When @command{windres} reads an @code{rc} file, it runs it through the C
4435 preprocessor first. This option may be used to specify the preprocessor
4436 to use. The default preprocessor is @code{gcc}.
4438 @item --preprocessor-arg @var{option}
4439 When @command{windres} reads an @code{rc} file, it runs it through
4440 the C preprocessor first. This option may be used to specify additional
4441 text to be passed to preprocessor on its command line.
4442 This option can be used multiple times to add multiple options to the
4443 preprocessor command line.
4444 If the @option{--preprocessor} option has not been specified then a
4445 default set of preprocessor arguments will be used, with any
4446 @option{--preprocessor-arg} options being placed after them on the
4447 command line. These default arguments are @code{-E},
4448 @code{-xc-header} and @code{-DRC_INVOKED}.
4450 @item -I @var{directory}
4451 @itemx --include-dir @var{directory}
4452 Specify an include directory to use when reading an @code{rc} file.
4453 @command{windres} will pass this to the preprocessor as an @option{-I}
4454 option. @command{windres} will also search this directory when looking for
4455 files named in the @code{rc} file. If the argument passed to this command
4456 matches any of the supported @var{formats} (as described in the @option{-J}
4457 option), it will issue a deprecation warning, and behave just like the
4458 @option{-J} option. New programs should not use this behaviour. If a
4459 directory happens to match a @var{format}, simple prefix it with @samp{./}
4460 to disable the backward compatibility.
4462 @item -D @var{target}
4463 @itemx --define @var{sym}[=@var{val}]
4464 Specify a @option{-D} option to pass to the preprocessor when reading an
4467 @item -U @var{target}
4468 @itemx --undefine @var{sym}
4469 Specify a @option{-U} option to pass to the preprocessor when reading an
4473 Ignored for compatibility with rc.
4476 Enable verbose mode. This tells you what the preprocessor is if you
4480 @item --codepage @var{val}
4481 Specify the default codepage to use when reading an @code{rc} file.
4482 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
4483 codepage code. The valid range is from zero up to 0xffff, but the
4484 validity of the codepage is host and configuration dependent.
4487 @item --language @var{val}
4488 Specify the default language to use when reading an @code{rc} file.
4489 @var{val} should be a hexadecimal language code. The low eight bits are
4490 the language, and the high eight bits are the sublanguage.
4492 @item --use-temp-file
4493 Use a temporary file to instead of using popen to read the output of
4494 the preprocessor. Use this option if the popen implementation is buggy
4495 on the host (eg., certain non-English language versions of Windows 95 and
4496 Windows 98 are known to have buggy popen where the output will instead
4499 @item --no-use-temp-file
4500 Use popen, not a temporary file, to read the output of the preprocessor.
4501 This is the default behaviour.
4505 Prints a usage summary.
4509 Prints the version number for @command{windres}.
4512 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
4513 this will turn on parser debugging.
4519 @c man begin SEEALSO windres
4520 the Info entries for @file{binutils}.
4529 @command{dlltool} is used to create the files needed to create dynamic
4530 link libraries (DLLs) on systems which understand PE format image
4531 files such as Windows. A DLL contains an export table which contains
4532 information that the runtime loader needs to resolve references from a
4533 referencing program.
4535 The export table is generated by this program by reading in a
4536 @file{.def} file or scanning the @file{.a} and @file{.o} files which
4537 will be in the DLL. A @file{.o} file can contain information in
4538 special @samp{.drectve} sections with export information.
4541 @emph{Note:} @command{dlltool} is not always built as part of the
4542 binary utilities, since it is only useful for those targets which
4546 @c man title dlltool create files needed to build and use DLLs
4549 @c man begin SYNOPSIS dlltool
4550 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
4551 [@option{-b}|@option{--base-file} @var{base-file-name}]
4552 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
4553 [@option{-z}|@option{--output-def} @var{def-file-name}]
4554 [@option{-l}|@option{--output-lib} @var{library-file-name}]
4555 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
4556 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
4557 [@option{--exclude-symbols} @var{list}]
4558 [@option{--no-default-excludes}]
4559 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
4560 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
4561 [@option{-a}|@option{--add-indirect}]
4562 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
4563 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
4564 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
4565 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
4566 [@option{--use-nul-prefixed-import-tables}]
4567 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
4568 [@option{-i}|@option{--interwork}]
4569 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
4570 [@option{-v}|@option{--verbose}]
4571 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
4572 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
4573 [@option{--deterministic-libraries}] [@option{--non-deterministic-libraries}]
4574 [object-file @dots{}]
4578 @c man begin DESCRIPTION dlltool
4580 @command{dlltool} reads its inputs, which can come from the @option{-d} and
4581 @option{-b} options as well as object files specified on the command
4582 line. It then processes these inputs and if the @option{-e} option has
4583 been specified it creates a exports file. If the @option{-l} option
4584 has been specified it creates a library file and if the @option{-z} option
4585 has been specified it creates a def file. Any or all of the @option{-e},
4586 @option{-l} and @option{-z} options can be present in one invocation of
4589 When creating a DLL, along with the source for the DLL, it is necessary
4590 to have three other files. @command{dlltool} can help with the creation of
4593 The first file is a @file{.def} file which specifies which functions are
4594 exported from the DLL, which functions the DLL imports, and so on. This
4595 is a text file and can be created by hand, or @command{dlltool} can be used
4596 to create it using the @option{-z} option. In this case @command{dlltool}
4597 will scan the object files specified on its command line looking for
4598 those functions which have been specially marked as being exported and
4599 put entries for them in the @file{.def} file it creates.
4601 In order to mark a function as being exported from a DLL, it needs to
4602 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
4603 section of the object file. This can be done in C by using the
4607 asm (".section .drectve");
4608 asm (".ascii \"-export:my_func\"");
4610 int my_func (void) @{ @dots{} @}
4613 The second file needed for DLL creation is an exports file. This file
4614 is linked with the object files that make up the body of the DLL and it
4615 handles the interface between the DLL and the outside world. This is a
4616 binary file and it can be created by giving the @option{-e} option to
4617 @command{dlltool} when it is creating or reading in a @file{.def} file.
4619 The third file needed for DLL creation is the library file that programs
4620 will link with in order to access the functions in the DLL (an `import
4621 library'). This file can be created by giving the @option{-l} option to
4622 dlltool when it is creating or reading in a @file{.def} file.
4624 If the @option{-y} option is specified, dlltool generates a delay-import
4625 library that can be used instead of the normal import library to allow
4626 a program to link to the dll only as soon as an imported function is
4627 called for the first time. The resulting executable will need to be
4628 linked to the static delayimp library containing __delayLoadHelper2(),
4629 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4631 @command{dlltool} builds the library file by hand, but it builds the
4632 exports file by creating temporary files containing assembler statements
4633 and then assembling these. The @option{-S} command-line option can be
4634 used to specify the path to the assembler that dlltool will use,
4635 and the @option{-f} option can be used to pass specific flags to that
4636 assembler. The @option{-n} can be used to prevent dlltool from deleting
4637 these temporary assembler files when it is done, and if @option{-n} is
4638 specified twice then this will prevent dlltool from deleting the
4639 temporary object files it used to build the library.
4641 Here is an example of creating a DLL from a source file @samp{dll.c} and
4642 also creating a program (from an object file called @samp{program.o})
4647 dlltool -e exports.o -l dll.lib dll.o
4648 gcc dll.o exports.o -o dll.dll
4649 gcc program.o dll.lib -o program
4653 @command{dlltool} may also be used to query an existing import library
4654 to determine the name of the DLL to which it is associated. See the
4655 description of the @option{-I} or @option{--identify} option.
4659 @c man begin OPTIONS dlltool
4661 The command-line options have the following meanings:
4665 @item -d @var{filename}
4666 @itemx --input-def @var{filename}
4667 @cindex input .def file
4668 Specifies the name of a @file{.def} file to be read in and processed.
4670 @item -b @var{filename}
4671 @itemx --base-file @var{filename}
4673 Specifies the name of a base file to be read in and processed. The
4674 contents of this file will be added to the relocation section in the
4675 exports file generated by dlltool.
4677 @item -e @var{filename}
4678 @itemx --output-exp @var{filename}
4679 Specifies the name of the export file to be created by dlltool.
4681 @item -z @var{filename}
4682 @itemx --output-def @var{filename}
4683 Specifies the name of the @file{.def} file to be created by dlltool.
4685 @item -l @var{filename}
4686 @itemx --output-lib @var{filename}
4687 Specifies the name of the library file to be created by dlltool.
4689 @item -y @var{filename}
4690 @itemx --output-delaylib @var{filename}
4691 Specifies the name of the delay-import library file to be created by dlltool.
4693 @item --deterministic-libraries
4694 @itemx --non-deterministic-libraries
4695 When creating output libraries in response to either the
4696 @option{--output-lib} or @option{--output-delaylib} options either use
4697 the value of zero for any timestamps, user ids and group ids created
4698 (@option{--deterministic-libraries}) or the actual timestamps, user
4699 ids and group ids (@option{--non-deterministic-libraries}).
4701 @item --export-all-symbols
4702 Treat all global and weak defined symbols found in the input object
4703 files as symbols to be exported. There is a small list of symbols which
4704 are not exported by default; see the @option{--no-default-excludes}
4705 option. You may add to the list of symbols to not export by using the
4706 @option{--exclude-symbols} option.
4708 @item --no-export-all-symbols
4709 Only export symbols explicitly listed in an input @file{.def} file or in
4710 @samp{.drectve} sections in the input object files. This is the default
4711 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
4712 attributes in the source code.
4714 @item --exclude-symbols @var{list}
4715 Do not export the symbols in @var{list}. This is a list of symbol names
4716 separated by comma or colon characters. The symbol names should not
4717 contain a leading underscore. This is only meaningful when
4718 @option{--export-all-symbols} is used.
4720 @item --no-default-excludes
4721 When @option{--export-all-symbols} is used, it will by default avoid
4722 exporting certain special symbols. The current list of symbols to avoid
4723 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
4724 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
4725 to go ahead and export these special symbols. This is only meaningful
4726 when @option{--export-all-symbols} is used.
4729 @itemx --as @var{path}
4730 Specifies the path, including the filename, of the assembler to be used
4731 to create the exports file.
4733 @item -f @var{options}
4734 @itemx --as-flags @var{options}
4735 Specifies any specific command-line options to be passed to the
4736 assembler when building the exports file. This option will work even if
4737 the @option{-S} option is not used. This option only takes one argument,
4738 and if it occurs more than once on the command line, then later
4739 occurrences will override earlier occurrences. So if it is necessary to
4740 pass multiple options to the assembler they should be enclosed in
4744 @itemx --dll-name @var{name}
4745 Specifies the name to be stored in the @file{.def} file as the name of
4746 the DLL when the @option{-e} option is used. If this option is not
4747 present, then the filename given to the @option{-e} option will be
4748 used as the name of the DLL.
4750 @item -m @var{machine}
4751 @itemx -machine @var{machine}
4752 Specifies the type of machine for which the library file should be
4753 built. @command{dlltool} has a built in default type, depending upon how
4754 it was created, but this option can be used to override that. This is
4755 normally only useful when creating DLLs for an ARM processor, when the
4756 contents of the DLL are actually encode using Thumb instructions.
4759 @itemx --add-indirect
4760 Specifies that when @command{dlltool} is creating the exports file it
4761 should add a section which allows the exported functions to be
4762 referenced without using the import library. Whatever the hell that
4766 @itemx --add-underscore
4767 Specifies that when @command{dlltool} is creating the exports file it
4768 should prepend an underscore to the names of @emph{all} exported symbols.
4770 @item --no-leading-underscore
4771 @item --leading-underscore
4772 Specifies whether standard symbol should be forced to be prefixed, or
4775 @item --add-stdcall-underscore
4776 Specifies that when @command{dlltool} is creating the exports file it
4777 should prepend an underscore to the names of exported @emph{stdcall}
4778 functions. Variable names and non-stdcall function names are not modified.
4779 This option is useful when creating GNU-compatible import libs for third
4780 party DLLs that were built with MS-Windows tools.
4784 Specifies that @samp{@@<number>} suffixes should be omitted from the names
4785 of stdcall functions that will be imported from the DLL. This is
4786 useful when creating an import library for a DLL which exports stdcall
4787 functions but without the usual @samp{@@<number>} symbol name suffix.
4789 This does not change the naming of symbols provided by the import library
4790 to programs linked against it, but only the entries in the import table
4791 (ie the .idata section).
4794 @itemx --add-stdcall-alias
4795 Specifies that when @command{dlltool} is creating the exports file it
4796 should add aliases for stdcall symbols without @samp{@@ <number>}
4797 in addition to the symbols with @samp{@@ <number>}.
4800 @itemx --ext-prefix-alias @var{prefix}
4801 Causes @command{dlltool} to create external aliases for all DLL
4802 imports with the specified prefix. The aliases are created for both
4803 external and import symbols with no leading underscore.
4807 Specifies that when @command{dlltool} is creating the exports and library
4808 files it should omit the @code{.idata4} section. This is for compatibility
4809 with certain operating systems.
4811 @item --use-nul-prefixed-import-tables
4812 Specifies that when @command{dlltool} is creating the exports and library
4813 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4814 element. This emulates old gnu import library generation of
4815 @code{dlltool}. By default this option is turned off.
4819 Specifies that when @command{dlltool} is creating the exports and library
4820 files it should omit the @code{.idata5} section. This is for compatibility
4821 with certain operating systems.
4823 @item -I @var{filename}
4824 @itemx --identify @var{filename}
4825 Specifies that @command{dlltool} should inspect the import library
4826 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4827 of the associated DLL(s). This can be performed in addition to any
4828 other operations indicated by the other options and arguments.
4829 @command{dlltool} fails if the import library does not exist or is not
4830 actually an import library. See also @option{--identify-strict}.
4832 @item --identify-strict
4833 Modifies the behavior of the @option{--identify} option, such
4834 that an error is reported if @var{filename} is associated with
4839 Specifies that @command{dlltool} should mark the objects in the library
4840 file and exports file that it produces as supporting interworking
4841 between ARM and Thumb code.
4845 Makes @command{dlltool} preserve the temporary assembler files it used to
4846 create the exports file. If this option is repeated then dlltool will
4847 also preserve the temporary object files it uses to create the library
4850 @item -t @var{prefix}
4851 @itemx --temp-prefix @var{prefix}
4852 Makes @command{dlltool} use @var{prefix} when constructing the names of
4853 temporary assembler and object files. By default, the temp file prefix
4854 is generated from the pid.
4858 Make dlltool describe what it is doing.
4862 Displays a list of command-line options and then exits.
4866 Displays dlltool's version number and then exits.
4873 * def file format:: The format of the dlltool @file{.def} file
4876 @node def file format
4877 @section The format of the @command{dlltool} @file{.def} file
4879 A @file{.def} file contains any number of the following commands:
4883 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4884 The result is going to be named @var{name}@code{.exe}.
4886 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4887 The result is going to be named @var{name}@code{.dll}.
4888 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4889 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4892 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4893 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4894 Declares @var{name1} as an exported symbol from the DLL, with optional
4895 ordinal number @var{integer}, or declares @var{name1} as an alias
4896 (forward) of the function @var{external-name} in the DLL.
4897 If @var{its_name} is specified, this name is used as string in export table.
4899 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4900 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4901 If you want to use LIBRARY as name then you need to quote it.
4903 @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{]} *}
4904 Declares that @var{external-name} or the exported function whose
4905 ordinal number is @var{integer} is to be imported from the file
4906 @var{module-name}. If @var{internal-name} is specified then this is
4907 the name that the imported function will be referred to in the body of
4909 If @var{its_name} is specified, this name is used as string in import table.
4910 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4911 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4912 If you want to use LIBRARY as name then you need to quote it.
4914 @item @code{DESCRIPTION} @var{string}
4915 Puts @var{string} into the output @file{.exp} file in the
4916 @code{.rdata} section.
4918 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4919 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4920 Generates @code{--stack} or @code{--heap}
4921 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4922 section. The linker will see this and act upon it.
4924 @item @code{CODE} @var{attr} @code{+}
4925 @item @code{DATA} @var{attr} @code{+}
4926 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4927 Generates @code{--attr} @var{section-name} @var{attr} in the output
4928 @code{.drectve} section, where @var{attr} is one of @code{READ},
4929 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4930 this and act upon it.
4935 @c man begin SEEALSO dlltool
4936 The Info pages for @file{binutils}.
4943 @cindex ELF file information
4946 @c man title readelf display information about ELF files
4949 @c man begin SYNOPSIS readelf
4950 readelf [@option{-a}|@option{--all}]
4951 [@option{-h}|@option{--file-header}]
4952 [@option{-l}|@option{--program-headers}|@option{--segments}]
4953 [@option{-S}|@option{--section-headers}|@option{--sections}]
4954 [@option{-g}|@option{--section-groups}]
4955 [@option{-t}|@option{--section-details}]
4956 [@option{-e}|@option{--headers}]
4957 [@option{-s}|@option{--syms}|@option{--symbols}]
4958 [@option{--dyn-syms}|@option{--lto-syms}]
4959 [@option{--sym-base=[0|8|10|16]}]
4960 [@option{--demangle@var{=style}}|@option{--no-demangle}]
4962 [@option{--recurse-limit}|@option{--no-recurse-limit}]
4963 [@option{-U} @var{method}|@option{--unicode=}@var{method}]
4964 [@option{-n}|@option{--notes}]
4965 [@option{-r}|@option{--relocs}]
4966 [@option{-u}|@option{--unwind}]
4967 [@option{-d}|@option{--dynamic}]
4968 [@option{-V}|@option{--version-info}]
4969 [@option{-A}|@option{--arch-specific}]
4970 [@option{-D}|@option{--use-dynamic}]
4971 [@option{-L}|@option{--lint}|@option{--enable-checks}]
4972 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4973 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4974 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4975 [@option{-z}|@option{--decompress}]
4976 [@option{-c}|@option{--archive-index}]
4977 [@option{-w[lLiaprmfFsoORtUuTgAck]}|
4978 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links]]
4979 [@option{-wK}|@option{--debug-dump=follow-links}]
4980 [@option{-wN}|@option{--debug-dump=no-follow-links}]
4981 [@option{-wD}|@option{--debug-dump=use-debuginfod}]
4982 [@option{-wE}|@option{--debug-dump=do-not-use-debuginfod}]
4983 [@option{-P}|@option{--process-links}]
4984 [@option{--dwarf-depth=@var{n}}]
4985 [@option{--dwarf-start=@var{n}}]
4986 [@option{--ctf=}@var{section}]
4987 [@option{--ctf-parent=}@var{section}]
4988 [@option{--ctf-symbols=}@var{section}]
4989 [@option{--ctf-strings=}@var{section}]
4990 [@option{--sframe=}@var{section}]
4991 [@option{-I}|@option{--histogram}]
4992 [@option{-v}|@option{--version}]
4993 [@option{-W}|@option{--wide}]
4994 [@option{-T}|@option{--silent-truncation}]
4995 [@option{-H}|@option{--help}]
4996 @var{elffile}@dots{}
5000 @c man begin DESCRIPTION readelf
5002 @command{readelf} displays information about one or more ELF format object
5003 files. The options control what particular information to display.
5005 @var{elffile}@dots{} are the object files to be examined. 32-bit and
5006 64-bit ELF files are supported, as are archives containing ELF files.
5008 This program performs a similar function to @command{objdump} but it
5009 goes into more detail and it exists independently of the @sc{bfd}
5010 library, so if there is a bug in @sc{bfd} then readelf will not be
5015 @c man begin OPTIONS readelf
5017 The long and short forms of options, shown here as alternatives, are
5018 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
5024 Equivalent to specifying @option{--file-header},
5025 @option{--program-headers}, @option{--sections}, @option{--symbols},
5026 @option{--relocs}, @option{--dynamic}, @option{--notes},
5027 @option{--version-info}, @option{--arch-specific}, @option{--unwind},
5028 @option{--section-groups} and @option{--histogram}.
5030 Note - this option does not enable @option{--use-dynamic} itself, so
5031 if that option is not present on the command line then dynamic symbols
5032 and dynamic relocs will not be displayed.
5035 @itemx --file-header
5036 @cindex ELF file header information
5037 Displays the information contained in the ELF header at the start of the
5041 @itemx --program-headers
5043 @cindex ELF program header information
5044 @cindex ELF segment information
5045 Displays the information contained in the file's segment headers, if it
5050 Suppress "no symbols" diagnostic.
5054 @itemx --section-headers
5055 @cindex ELF section information
5056 Displays the information contained in the file's section headers, if it
5060 @itemx --section-groups
5061 @cindex ELF section group information
5062 Displays the information contained in the file's section groups, if it
5066 @itemx --section-details
5067 @cindex ELF section information
5068 Displays the detailed section information. Implies @option{-S}.
5073 @cindex ELF symbol table information
5074 Displays the entries in symbol table section of the file, if it has one.
5075 If a symbol has version information associated with it then this is
5076 displayed as well. The version string is displayed as a suffix to the
5077 symbol name, preceded by an @@ character. For example
5078 @samp{foo@@VER_1}. If the version is the default version to be used
5079 when resolving unversioned references to the symbol then it is
5080 displayed as a suffix preceded by two @@ characters. For example
5081 @samp{foo@@@@VER_2}.
5084 @cindex ELF dynamic symbol table information
5085 Displays the entries in dynamic symbol table section of the file, if it
5086 has one. The output format is the same as the format used by the
5087 @option{--syms} option.
5090 @cindex LTO symbol table
5091 Displays the contents of any LTO symbol tables in the file.
5093 @item --sym-base=[0|8|10|16]
5094 @cindex symbol table size base
5095 Forces the size field of the symbol table to use the given base. Any
5096 unrecognized options will be treated as @samp{0}. @option{--sym-base=0}
5097 represents the default and legacy behaviour. This will output sizes as decimal
5098 for numbers less than 100000. For sizes 100000 and greater hexadecimal notation
5099 will be used with a 0x prefix.
5100 @option{--sym-base=8} will give the symbol sizes in octal.
5101 @option{--sym-base=10} will always give the symbol sizes in decimal.
5102 @option{--sym-base=16} will always give the symbol sizes in hexadecimal with a
5106 @itemx --demangle[=@var{style}]
5107 @cindex demangling in nm
5108 Decode (@dfn{demangle}) low-level symbol names into user-level names.
5109 This makes C++ function names readable. Different compilers have
5110 different mangling styles. The optional demangling style argument can
5111 be used to choose an appropriate demangling style for your
5112 compiler. @xref{c++filt}, for more information on demangling.
5115 Do not demangle low-level symbol names. This is the default.
5117 @item --recurse-limit
5118 @itemx --no-recurse-limit
5119 @itemx --recursion-limit
5120 @itemx --no-recursion-limit
5121 Enables or disables a limit on the amount of recursion performed
5122 whilst demangling strings. Since the name mangling formats allow for
5123 an infinite level of recursion it is possible to create strings whose
5124 decoding will exhaust the amount of stack space available on the host
5125 machine, triggering a memory fault. The limit tries to prevent this
5126 from happening by restricting recursion to 2048 levels of nesting.
5128 The default is for this limit to be enabled, but disabling it may be
5129 necessary in order to demangle truly complicated names. Note however
5130 that if the recursion limit is disabled then stack exhaustion is
5131 possible and any bug reports about such an event will be rejected.
5133 @item -U @var{[d|i|l|e|x|h]}
5134 @itemx --unicode=[default|invalid|locale|escape|hex|highlight]
5135 Controls the display of non-ASCII characters in identifier names.
5136 The default (@option{--unicode=locale} or @option{--unicode=default}) is
5137 to treat them as multibyte characters and display them in the current
5138 locale. All other versions of this option treat the bytes as UTF-8
5139 encoded values and attempt to interpret them. If they cannot be
5140 interpreted or if the @option{--unicode=invalid} option is used then
5141 they are displayed as a sequence of hex bytes, encloses in curly
5142 parethesis characters.
5144 Using the @option{--unicode=escape} option will display the characters
5145 as as unicode escape sequences (@var{\uxxxx}). Using the
5146 @option{--unicode=hex} will display the characters as hex byte
5147 sequences enclosed between angle brackets.
5149 Using the @option{--unicode=highlight} will display the characters as
5150 unicode escape sequences but it will also highlighted them in red,
5151 assuming that colouring is supported by the output device. The
5152 colouring is intended to draw attention to the presence of unicode
5153 sequences when they might not be expected.
5157 Display all the headers in the file. Equivalent to @option{-h -l -S}.
5162 Displays the contents of the NOTE segments and/or sections, if any.
5166 @cindex ELF reloc information
5167 Displays the contents of the file's relocation section, if it has one.
5171 @cindex unwind information
5172 Displays the contents of the file's unwind section, if it has one. Only
5173 the unwind sections for IA64 ELF files, as well as ARM unwind tables
5174 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported. If
5175 support is not yet implemented for your architecture you could try
5176 dumping the contents of the @var{.eh_frames} section using the
5177 @option{--debug-dump=frames} or @option{--debug-dump=frames-interp}
5182 @cindex ELF dynamic section information
5183 Displays the contents of the file's dynamic section, if it has one.
5186 @itemx --version-info
5187 @cindex ELF version sections information
5188 Displays the contents of the version sections in the file, it they
5192 @itemx --arch-specific
5193 Displays architecture-specific information in the file, if there
5197 @itemx --use-dynamic
5198 When displaying symbols, this option makes @command{readelf} use the
5199 symbol hash tables in the file's dynamic section, rather than the
5200 symbol table sections.
5202 When displaying relocations, this option makes @command{readelf}
5203 display the dynamic relocations rather than the static relocations.
5207 @itemx --enable-checks
5208 Displays warning messages about possible problems with the file(s)
5209 being examined. If used on its own then all of the contents of the
5210 file(s) will be examined. If used with one of the dumping options
5211 then the warning messages will only be produced for the things being
5214 @item -x <number or name>
5215 @itemx --hex-dump=<number or name>
5216 Displays the contents of the indicated section as a hexadecimal bytes.
5217 A number identifies a particular section by index in the section table;
5218 any other string identifies all sections with that name in the object file.
5220 @item -R <number or name>
5221 @itemx --relocated-dump=<number or name>
5222 Displays the contents of the indicated section as a hexadecimal
5223 bytes. A number identifies a particular section by index in the
5224 section table; any other string identifies all sections with that name
5225 in the object file. The contents of the section will be relocated
5226 before they are displayed.
5228 @item -p <number or name>
5229 @itemx --string-dump=<number or name>
5230 Displays the contents of the indicated section as printable strings.
5231 A number identifies a particular section by index in the section table;
5232 any other string identifies all sections with that name in the object file.
5236 Requests that the section(s) being dumped by @option{x}, @option{R} or
5237 @option{p} options are decompressed before being displayed. If the
5238 section(s) are not compressed then they are displayed as is.
5241 @itemx --archive-index
5242 @cindex Archive file symbol index information
5243 Displays the file symbol index information contained in the header part
5244 of binary archives. Performs the same function as the @option{t}
5245 command to @command{ar}, but without using the BFD library. @xref{ar}.
5247 @item -w[lLiaprmfFsOoRtUuTgAckK]
5248 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
5249 @include debug.options.texi
5252 @itemx --process-links
5253 Display the contents of non-debug sections found in separate debuginfo
5254 files that are linked to the main file. This option automatically
5255 implies the @option{-wK} option, and only sections requested by other
5256 command line options will be displayed.
5258 @include ctf.options.texi
5259 @item --ctf-symbols=@var{section}
5260 @item --ctf-strings=@var{section}
5261 Specify the name of another section from which the CTF file can inherit
5262 strings and symbols. By default, the @code{.symtab} and its linked
5263 string table are used.
5265 If either of @option{--ctf-symbols} or @option{--ctf-strings} is specified, the
5266 other must be specified as well.
5270 Display a histogram of bucket list lengths when displaying the contents
5271 of the symbol tables.
5275 Display the version number of readelf.
5279 Don't break output lines to fit into 80 columns. By default
5280 @command{readelf} breaks section header and segment listing lines for
5281 64-bit ELF files, so that they fit into 80 columns. This option causes
5282 @command{readelf} to print each section header resp. each segment one a
5283 single line, which is far more readable on terminals wider than 80 columns.
5286 @itemx --silent-truncation
5287 Normally when readelf is displaying a symbol name, and it has to
5288 truncate the name to fit into an 80 column display, it will add a
5289 suffix of @code{[...]} to the name. This command line option
5290 disables this behaviour, allowing 5 more characters of the name to be
5291 displayed and restoring the old behaviour of readelf (prior to release
5296 Display the command-line options understood by @command{readelf}.
5303 @c man begin SEEALSO readelf
5304 objdump(1), and the Info entries for @file{binutils}.
5311 @cindex Update ELF header
5314 @c man title elfedit update ELF header and program property of ELF files
5317 @c man begin SYNOPSIS elfedit
5318 elfedit [@option{--input-mach=}@var{machine}]
5319 [@option{--input-type=}@var{type}]
5320 [@option{--input-osabi=}@var{osabi}]
5321 [@option{--input-abiversion=}@var{version}]
5322 @option{--output-mach=}@var{machine}
5323 @option{--output-type=}@var{type}
5324 @option{--output-osabi=}@var{osabi}
5325 @option{--output-abiversion=}@var{version}
5326 @option{--enable-x86-feature=}@var{feature}
5327 @option{--disable-x86-feature=}@var{feature}
5328 [@option{-v}|@option{--version}]
5329 [@option{-h}|@option{--help}]
5330 @var{elffile}@dots{}
5334 @c man begin DESCRIPTION elfedit
5336 @command{elfedit} updates the ELF header and program property of ELF
5337 files which have the matching ELF machine and file types. The options
5338 control how and which fields in the ELF header and program property
5341 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
5342 64-bit ELF files are supported, as are archives containing ELF files.
5345 @c man begin OPTIONS elfedit
5347 The long and short forms of options, shown here as alternatives, are
5348 equivalent. At least one of the @option{--output-mach},
5349 @option{--output-type}, @option{--output-osabi},
5350 @option{--output-abiversion},
5351 @option{--enable-x86-feature} and @option{--disable-x86-feature}
5352 options must be given.
5356 @item --input-mach=@var{machine}
5357 Set the matching input ELF machine type to @var{machine}. If
5358 @option{--input-mach} isn't specified, it will match any ELF
5361 The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
5362 @var{K1OM} and @var{x86-64}.
5364 @item --output-mach=@var{machine}
5365 Change the ELF machine type in the ELF header to @var{machine}. The
5366 supported ELF machine types are the same as @option{--input-mach}.
5368 @item --input-type=@var{type}
5369 Set the matching input ELF file type to @var{type}. If
5370 @option{--input-type} isn't specified, it will match any ELF file types.
5372 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
5374 @item --output-type=@var{type}
5375 Change the ELF file type in the ELF header to @var{type}. The
5376 supported ELF types are the same as @option{--input-type}.
5378 @item --input-osabi=@var{osabi}
5379 Set the matching input ELF file OSABI to @var{osabi}. If
5380 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
5382 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
5383 @var{GNU}, @var{Linux} (alias for @var{GNU}),
5384 @var{Solaris}, @var{AIX}, @var{Irix},
5385 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
5386 @var{NSK}, @var{AROS} and @var{FenixOS}.
5388 @item --output-osabi=@var{osabi}
5389 Change the ELF OSABI in the ELF header to @var{osabi}. The
5390 supported ELF OSABI are the same as @option{--input-osabi}.
5392 @item --input-abiversion=@var{version}
5393 Set the matching input ELF file ABIVERSION to @var{version}.
5394 @var{version} must be between 0 and 255. If @option{--input-abiversion}
5395 isn't specified, it will match any ELF ABIVERSIONs.
5397 @item --output-abiversion=@var{version}
5398 Change the ELF ABIVERSION in the ELF header to @var{version}.
5399 @var{version} must be between 0 and 255.
5401 @item --enable-x86-feature=@var{feature}
5402 Set the @var{feature} bit in program property in @var{exec} or @var{dyn}
5403 ELF files with machine types of @var{i386} or @var{x86-64}. The
5404 supported features are, @var{ibt}, @var{shstk}, @var{lam_u48} and
5407 @item --disable-x86-feature=@var{feature}
5408 Clear the @var{feature} bit in program property in @var{exec} or
5409 @var{dyn} ELF files with machine types of @var{i386} or @var{x86-64}.
5410 The supported features are the same as @option{--enable-x86-feature}.
5412 Note: @option{--enable-x86-feature} and @option{--disable-x86-feature}
5413 are available only on hosts with @samp{mmap} support.
5417 Display the version number of @command{elfedit}.
5421 Display the command-line options understood by @command{elfedit}.
5428 @c man begin SEEALSO elfedit
5429 readelf(1), and the Info entries for @file{binutils}.
5433 @node Common Options
5434 @chapter Common Options
5436 The following command-line options are supported by all of the
5437 programs described in this manual.
5439 @c man begin OPTIONS
5441 @include at-file.texi
5445 Display the command-line options supported by the program.
5448 Display the version number of the program.
5450 @c man begin OPTIONS
5454 @node Selecting the Target System
5455 @chapter Selecting the Target System
5457 You can specify two aspects of the target system to the @sc{gnu}
5458 binary file utilities, each in several ways:
5468 In the following summaries, the lists of ways to specify values are in
5469 order of decreasing precedence. The ways listed first override those
5472 The commands to list valid values only list the values for which the
5473 programs you are running were configured. If they were configured with
5474 @option{--enable-targets=all}, the commands list most of the available
5475 values, but a few are left out; not all targets can be configured in at
5476 once because some of them can only be configured @dfn{native} (on hosts
5477 with the same type as the target system).
5480 * Target Selection::
5481 * Architecture Selection::
5484 @node Target Selection
5485 @section Target Selection
5487 A @dfn{target} is an object file format. A given target may be
5488 supported for multiple architectures (@pxref{Architecture Selection}).
5489 A target selection may also have variations for different operating
5490 systems or architectures.
5492 The command to list valid target values is @samp{objdump -i}
5493 (the first column of output contains the relevant information).
5495 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
5496 @samp{a.out-sunos-big}.
5498 You can also specify a target using a configuration triplet. This is
5499 the same sort of name that is passed to @file{configure} to specify a
5500 target. When you use a configuration triplet as an argument, it must be
5501 fully canonicalized. You can see the canonical version of a triplet by
5502 running the shell script @file{config.sub} which is included with the
5505 Some sample configuration triplets are: @samp{m68k-hp-bsd},
5506 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
5508 @subheading @command{objdump} Target
5514 command-line option: @option{-b} or @option{--target}
5517 environment variable @code{GNUTARGET}
5520 deduced from the input file
5523 @subheading @command{objcopy} and @command{strip} Input Target
5529 command-line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
5532 environment variable @code{GNUTARGET}
5535 deduced from the input file
5538 @subheading @command{objcopy} and @command{strip} Output Target
5544 command-line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
5547 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
5550 environment variable @code{GNUTARGET}
5553 deduced from the input file
5556 @subheading @command{nm}, @command{size}, and @command{strings} Target
5562 command-line option: @option{--target}
5565 environment variable @code{GNUTARGET}
5568 deduced from the input file
5571 @node Architecture Selection
5572 @section Architecture Selection
5574 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
5575 to run. Its name may contain a colon, separating the name of the
5576 processor family from the name of the particular @sc{cpu}.
5578 The command to list valid architecture values is @samp{objdump -i} (the
5579 second column contains the relevant information).
5581 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
5583 @subheading @command{objdump} Architecture
5589 command-line option: @option{-m} or @option{--architecture}
5592 deduced from the input file
5595 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
5601 deduced from the input file
5606 @cindex separate debug files
5608 debuginfod is a web service that indexes ELF/DWARF debugging resources
5609 by build-id and serves them over HTTP. For more information see:
5610 @emph{https://sourceware.org/elfutils/Debuginfod.html}
5612 Binutils can be built with the debuginfod client library
5613 @code{libdebuginfod} using the @option{--with-debuginfod} configure option.
5614 This option is enabled by default if @code{libdebuginfod} is installed
5615 and found at configure time. This allows @command{objdump} and
5616 @command{readelf} to automatically query debuginfod servers for
5617 separate debug files when the files are otherwise not found.
5619 debuginfod is packaged with elfutils, starting with version 0.178.
5620 You can get the latest version from `https://sourceware.org/elfutils/'.
5622 The DWARF info dumping tools (@command{readelf} and @command{objdump})
5623 have options to control when they should access the debuginfod
5624 servers. By default this access is enabled.
5626 @node Reporting Bugs
5627 @chapter Reporting Bugs
5629 @cindex reporting bugs
5631 Your bug reports play an essential role in making the binary utilities
5634 Reporting a bug may help you by bringing a solution to your problem, or
5635 it may not. But in any case the principal function of a bug report is
5636 to help the entire community by making the next version of the binary
5637 utilities work better. Bug reports are your contribution to their
5640 In order for a bug report to serve its purpose, you must include the
5641 information that enables us to fix the bug.
5644 * Bug Criteria:: Have you found a bug?
5645 * Bug Reporting:: How to report bugs
5649 @section Have You Found a Bug?
5650 @cindex bug criteria
5652 If you are not sure whether you have found a bug, here are some guidelines:
5655 @cindex fatal signal
5658 If a binary utility gets a fatal signal, for any input whatever, that is
5659 a bug. Reliable utilities never crash.
5661 @cindex error on valid input
5663 If a binary utility produces an error message for valid input, that is a
5667 If you are an experienced user of binary utilities, your suggestions for
5668 improvement are welcome in any case.
5672 @section How to Report Bugs
5674 @cindex bugs, reporting
5676 A number of companies and individuals offer support for @sc{gnu}
5677 products. If you obtained the binary utilities from a support
5678 organization, we recommend you contact that organization first.
5680 You can find contact information for many support companies and
5681 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5685 In any event, we also recommend that you send bug reports for the binary
5686 utilities to @value{BUGURL}.
5689 The fundamental principle of reporting bugs usefully is this:
5690 @strong{report all the facts}. If you are not sure whether to state a
5691 fact or leave it out, state it!
5693 Often people omit facts because they think they know what causes the
5694 problem and assume that some details do not matter. Thus, you might
5695 assume that the name of a file you use in an example does not matter.
5696 Well, probably it does not, but one cannot be sure. Perhaps the bug is
5697 a stray memory reference which happens to fetch from the location where
5698 that pathname is stored in memory; perhaps, if the pathname were
5699 different, the contents of that location would fool the utility into
5700 doing the right thing despite the bug. Play it safe and give a
5701 specific, complete example. That is the easiest thing for you to do,
5702 and the most helpful.
5704 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5705 it is new to us. Therefore, always write your bug reports on the assumption
5706 that the bug has not been reported previously.
5708 Sometimes people give a few sketchy facts and ask, ``Does this ring a
5709 bell?'' This cannot help us fix a bug, so it is basically useless. We
5710 respond by asking for enough details to enable us to investigate.
5711 You might as well expedite matters by sending them to begin with.
5713 To enable us to fix the bug, you should include all these things:
5717 The version of the utility. Each utility announces it if you start it
5718 with the @option{--version} argument.
5720 Without this, we will not know whether there is any point in looking for
5721 the bug in the current version of the binary utilities.
5724 Any patches you may have applied to the source, including any patches
5725 made to the @code{BFD} library.
5728 The type of machine you are using, and the operating system name and
5732 What compiler (and its version) was used to compile the utilities---e.g.
5736 The command arguments you gave the utility to observe the bug. To
5737 guarantee you will not omit something important, list them all. A copy
5738 of the Makefile (or the output from make) is sufficient.
5740 If we were to try to guess the arguments, we would probably guess wrong
5741 and then we might not encounter the bug.
5744 A complete input file, or set of input files, that will reproduce the
5745 bug. If the utility is reading an object file or files, then it is
5746 generally most helpful to send the actual object files.
5748 If the source files were produced exclusively using @sc{gnu} programs
5749 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
5750 may be OK to send the source files rather than the object files. In
5751 this case, be sure to say exactly what version of @command{gcc}, or
5752 whatever, was used to produce the object files. Also say how
5753 @command{gcc}, or whatever, was configured.
5756 A description of what behavior you observe that you believe is
5757 incorrect. For example, ``It gets a fatal signal.''
5759 Of course, if the bug is that the utility gets a fatal signal, then we
5760 will certainly notice it. But if the bug is incorrect output, we might
5761 not notice unless it is glaringly wrong. You might as well not give us
5762 a chance to make a mistake.
5764 Even if the problem you experience is a fatal signal, you should still
5765 say so explicitly. Suppose something strange is going on, such as your
5766 copy of the utility is out of sync, or you have encountered a bug in
5767 the C library on your system. (This has happened!) Your copy might
5768 crash and ours would not. If you told us to expect a crash, then when
5769 ours fails to crash, we would know that the bug was not happening for
5770 us. If you had not told us to expect a crash, then we would not be able
5771 to draw any conclusion from our observations.
5774 If you wish to suggest changes to the source, send us context diffs, as
5775 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
5776 option. Always send diffs from the old file to the new file. If you
5777 wish to discuss something in the @command{ld} source, refer to it by
5778 context, not by line number.
5780 The line numbers in our development sources will not match those in your
5781 sources. Your line numbers would convey no useful information to us.
5784 Here are some things that are not necessary:
5788 A description of the envelope of the bug.
5790 Often people who encounter a bug spend a lot of time investigating
5791 which changes to the input file will make the bug go away and which
5792 changes will not affect it.
5794 This is often time consuming and not very useful, because the way we
5795 will find the bug is by running a single example under the debugger
5796 with breakpoints, not by pure deduction from a series of examples.
5797 We recommend that you save your time for something else.
5799 Of course, if you can find a simpler example to report @emph{instead}
5800 of the original one, that is a convenience for us. Errors in the
5801 output will be easier to spot, running under the debugger will take
5802 less time, and so on.
5804 However, simplification is not vital; if you do not want to do this,
5805 report the bug anyway and send us the entire test case you used.
5808 A patch for the bug.
5810 A patch for the bug does help us if it is a good one. But do not omit
5811 the necessary information, such as the test case, on the assumption that
5812 a patch is all we need. We might see problems with your patch and decide
5813 to fix the problem another way, or we might not understand it at all.
5815 Sometimes with programs as complicated as the binary utilities it is
5816 very hard to construct an example that will make the program follow a
5817 certain path through the code. If you do not send us the example, we
5818 will not be able to construct one, so we will not be able to verify that
5821 And if we cannot understand what bug you are trying to fix, or why your
5822 patch should be an improvement, we will not install it. A test case will
5823 help us to understand.
5826 A guess about what the bug is or what it depends on.
5828 Such guesses are usually wrong. Even we cannot guess right about such
5829 things without first using the debugger to find the facts.
5832 @node GNU Free Documentation License
5833 @appendix GNU Free Documentation License
5837 @node Binutils Index
5838 @unnumbered Binutils Index