1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
14 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.2
18 or any later version published by the Free Software Foundation;
19 with no Invariant Sections, with no Front-Cover Texts, and with no
20 Back-Cover Texts. A copy of the license is included in the
21 section entitled ``GNU Free Documentation License''.
26 @dircategory Software development
28 * Binutils: (binutils). The GNU binary utilities.
31 @dircategory Individual utilities
33 * addr2line: (binutils)addr2line. Convert addresses to file and line.
34 * ar: (binutils)ar. Create, modify, and extract from archives.
35 * c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols.
36 * cxxfilt: (binutils)c++filt. MS-DOS name for c++filt.
37 * dlltool: (binutils)dlltool. Create files needed to build and use DLLs.
38 * nlmconv: (binutils)nlmconv. Converts object code into an NLM.
39 * nm: (binutils)nm. List symbols from object files.
40 * objcopy: (binutils)objcopy. Copy and translate object files.
41 * objdump: (binutils)objdump. Display information from object files.
42 * ranlib: (binutils)ranlib. Generate index to archive contents.
43 * readelf: (binutils)readelf. Display the contents of ELF format files.
44 * size: (binutils)size. List section sizes and total size.
45 * strings: (binutils)strings. List printable strings from files.
46 * strip: (binutils)strip. Discard symbols.
47 * windmc: (binutils)windmc. Generator for Windows message resources.
48 * windres: (binutils)windres. Manipulate Windows resources.
52 @title The @sc{gnu} Binary Utilities
53 @ifset VERSION_PACKAGE
54 @subtitle @value{VERSION_PACKAGE}
56 @subtitle Version @value{VERSION}
58 @subtitle @value{UPDATED}
59 @author Roland H. Pesch
60 @author Jeffrey M. Osier
61 @author Cygnus Support
65 {\parskip=0pt \hfill Cygnus Support\par \hfill
66 Texinfo \texinfoversion\par }
69 @vskip 0pt plus 1filll
78 This brief manual contains documentation for the @sc{gnu} binary
80 @ifset VERSION_PACKAGE
81 @value{VERSION_PACKAGE}
83 version @value{VERSION}:
88 Create, modify, and extract from archives
91 List symbols from object files
94 Copy and translate object files
97 Display information from object files
100 Generate index to archive contents
103 Display the contents of ELF format files.
106 List file section sizes and total size
109 List printable strings from files
115 Demangle encoded C++ symbols (on MS-DOS, this program is named
119 Convert addresses into file names and line numbers
122 Convert object code into a Netware Loadable Module
125 Manipulate Windows resources
128 Genertor for Windows message resources
131 Create the files needed to build and use Dynamic Link Libraries
135 This document is distributed under the terms of the GNU Free
136 Documentation License. A copy of the license is included in the
137 section entitled ``GNU Free Documentation License''.
140 * ar:: Create, modify, and extract from archives
141 * nm:: List symbols from object files
142 * objcopy:: Copy and translate object files
143 * objdump:: Display information from object files
144 * ranlib:: Generate index to archive contents
145 * readelf:: Display the contents of ELF format files
146 * size:: List section sizes and total size
147 * strings:: List printable strings from files
148 * strip:: Discard symbols
149 * c++filt:: Filter to demangle encoded C++ symbols
150 * cxxfilt: c++filt. MS-DOS name for c++filt
151 * addr2line:: Convert addresses to file and line
152 * nlmconv:: Converts object code into an NLM
153 * windres:: Manipulate Windows resources
154 * windmc:: Generator for Windows message resources
155 * dlltool:: Create files needed to build and use DLLs
156 * Common Options:: Command-line options for all utilities
157 * Selecting the Target System:: How these utilities determine the target
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} [@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
202 @command{ar} creates an index to the symbols defined in relocatable
203 object modules in the archive when you specify the modifier @samp{s}.
204 Once created, this index is updated in the archive whenever @command{ar}
205 makes a change to its contents (save for the @samp{q} update operation).
206 An archive with such an index speeds up linking to the library, and
207 allows routines in the library to call each other without regard to
208 their placement in the archive.
210 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
211 table. If an archive lacks the table, another form of @command{ar} called
212 @command{ranlib} can be used to add just the table.
214 @cindex thin archives
215 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
216 which contains a symbol index and references to the original copies
217 of the member files of the archives. Such an archive is useful
218 for building libraries for use within a local build, where the
219 relocatable objects are expected to remain available, and copying the
220 contents of each object would only waste time and space. Thin archives
221 are also @emph{flattened}, so that adding one or more archives to a
222 thin archive will add the elements of the nested archive individually.
223 The paths to the elements of the archive are stored relative to the
226 @cindex compatibility, @command{ar}
227 @cindex @command{ar} compatibility
228 @sc{gnu} @command{ar} is designed to be compatible with two different
229 facilities. You can control its activity using command-line options,
230 like the different varieties of @command{ar} on Unix systems; or, if you
231 specify the single command-line option @option{-M}, you can control it
232 with a script supplied via standard input, like the MRI ``librarian''
238 * ar cmdline:: Controlling @command{ar} on the command line
239 * ar scripts:: Controlling @command{ar} with a script
244 @section Controlling @command{ar} on the Command Line
247 @c man begin SYNOPSIS ar
248 ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
252 @cindex Unix compatibility, @command{ar}
253 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
254 arguments to execute: one keyletter specifying the @emph{operation}
255 (optionally accompanied by other keyletters specifying
256 @emph{modifiers}), and the archive name to act on.
258 Most operations can also accept further @var{member} arguments,
259 specifying particular files to operate on.
261 @c man begin OPTIONS ar
263 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
264 flags @var{mod} in any order, within the first command-line argument.
266 If you wish, you may begin the first command-line argument with a
269 @cindex operations on archive
270 The @var{p} keyletter specifies what operation to execute; it may be
271 any of the following, but you must specify only one of them:
275 @cindex deleting from archive
276 @emph{Delete} modules from the archive. Specify the names of modules to
277 be deleted as @var{member}@dots{}; the archive is untouched if you
278 specify no files to delete.
280 If you specify the @samp{v} modifier, @command{ar} lists each module
284 @cindex moving in archive
285 Use this operation to @emph{move} members in an archive.
287 The ordering of members in an archive can make a difference in how
288 programs are linked using the library, if a symbol is defined in more
291 If no modifiers are used with @code{m}, any members you name in the
292 @var{member} arguments are moved to the @emph{end} of the archive;
293 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
294 specified place instead.
297 @cindex printing from archive
298 @emph{Print} the specified members of the archive, to the standard
299 output file. If the @samp{v} modifier is specified, show the member
300 name before copying its contents to standard output.
302 If you specify no @var{member} arguments, all the files in the archive are
306 @cindex quick append to archive
307 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
308 @var{archive}, without checking for replacement.
310 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
311 operation; new members are always placed at the end of the archive.
313 The modifier @samp{v} makes @command{ar} list each file as it is appended.
315 Since the point of this operation is speed, the archive's symbol table
316 index is not updated, even if it already existed; you can use @samp{ar s} or
317 @command{ranlib} explicitly to update the symbol table index.
319 However, too many different systems assume quick append rebuilds the
320 index, so @sc{gnu} @command{ar} implements @samp{q} as a synonym for @samp{r}.
323 @cindex replacement in archive
324 Insert the files @var{member}@dots{} into @var{archive} (with
325 @emph{replacement}). This operation differs from @samp{q} in that any
326 previously existing members are deleted if their names match those being
329 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
330 displays an error message, and leaves undisturbed any existing members
331 of the archive matching that name.
333 By default, new members are added at the end of the file; but you may
334 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
335 placement relative to some existing member.
337 The modifier @samp{v} used with this operation elicits a line of
338 output for each file inserted, along with one of the letters @samp{a} or
339 @samp{r} to indicate whether the file was appended (no old member
340 deleted) or replaced.
343 @cindex contents of archive
344 Display a @emph{table} listing the contents of @var{archive}, or those
345 of the files listed in @var{member}@dots{} that are present in the
346 archive. Normally only the member name is shown; if you also want to
347 see the modes (permissions), timestamp, owner, group, and size, you can
348 request that by also specifying the @samp{v} modifier.
350 If you do not specify a @var{member}, all files in the archive
353 @cindex repeated names in archive
354 @cindex name duplication in archive
355 If there is more than one file with the same name (say, @samp{fie}) in
356 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
357 first instance; to see them all, you must ask for a complete
358 listing---in our example, @samp{ar t b.a}.
359 @c WRS only; per Gumby, this is implementation-dependent, and in a more
360 @c recent case in fact works the other way.
363 @cindex extract from archive
364 @emph{Extract} members (named @var{member}) from the archive. You can
365 use the @samp{v} modifier with this operation, to request that
366 @command{ar} list each name as it extracts it.
368 If you do not specify a @var{member}, all files in the archive
371 Files cannot be extracted from a thin archive.
375 A number of modifiers (@var{mod}) may immediately follow the @var{p}
376 keyletter, to specify variations on an operation's behavior:
380 @cindex relative placement in archive
381 Add new files @emph{after} an existing member of the
382 archive. If you use the modifier @samp{a}, the name of an existing archive
383 member must be present as the @var{relpos} argument, before the
384 @var{archive} specification.
387 Add new files @emph{before} an existing member of the
388 archive. If you use the modifier @samp{b}, the name of an existing archive
389 member must be present as the @var{relpos} argument, before the
390 @var{archive} specification. (same as @samp{i}).
393 @cindex creating archives
394 @emph{Create} the archive. The specified @var{archive} is always
395 created if it did not exist, when you request an update. But a warning is
396 issued unless you specify in advance that you expect to create it, by
400 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
401 names of any length. This will cause it to create archives which are
402 not compatible with the native @command{ar} program on some systems. If
403 this is a concern, the @samp{f} modifier may be used to truncate file
404 names when putting them in the archive.
407 Insert new files @emph{before} an existing member of the
408 archive. If you use the modifier @samp{i}, the name of an existing archive
409 member must be present as the @var{relpos} argument, before the
410 @var{archive} specification. (same as @samp{b}).
413 This modifier is accepted but not used.
414 @c whaffor ar l modifier??? presumably compat; with
415 @c what???---doc@@cygnus.com, 25jan91
418 Uses the @var{count} parameter. This is used if there are multiple
419 entries in the archive with the same name. Extract or delete instance
420 @var{count} of the given name from the archive.
423 @cindex dates in archive
424 Preserve the @emph{original} dates of members when extracting them. If
425 you do not specify this modifier, files extracted from the archive
426 are stamped with the time of extraction.
429 Use the full path name when matching names in the archive. @sc{gnu}
430 @command{ar} can not create an archive with a full path name (such archives
431 are not POSIX complaint), but other archive creators can. This option
432 will cause @sc{gnu} @command{ar} to match file names using a complete path
433 name, which can be convenient when extracting a single file from an
434 archive created by another tool.
437 @cindex writing archive index
438 Write an object-file index into the archive, or update an existing one,
439 even if no other change is made to the archive. You may use this modifier
440 flag either with any operation, or alone. Running @samp{ar s} on an
441 archive is equivalent to running @samp{ranlib} on it.
444 @cindex not writing archive index
445 Do not generate an archive symbol table. This can speed up building a
446 large library in several steps. The resulting archive can not be used
447 with the linker. In order to build a symbol table, you must omit the
448 @samp{S} modifier on the last execution of @samp{ar}, or you must run
449 @samp{ranlib} on the archive.
452 @cindex creating thin archive
453 Make the specified @var{archive} a @emph{thin} archive. If it already
454 exists and is a regular archive, the existing members must be present
455 in the same directory as @var{archive}.
458 @cindex updating an archive
459 Normally, @samp{ar r}@dots{} inserts all files
460 listed into the archive. If you would like to insert @emph{only} those
461 of the files you list that are newer than existing members of the same
462 names, use this modifier. The @samp{u} modifier is allowed only for the
463 operation @samp{r} (replace). In particular, the combination @samp{qu} is
464 not allowed, since checking the timestamps would lose any speed
465 advantage from the operation @samp{q}.
468 This modifier requests the @emph{verbose} version of an operation. Many
469 operations display additional information, such as filenames processed,
470 when the modifier @samp{v} is appended.
473 This modifier shows the version number of @command{ar}.
476 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
477 compatibility with AIX. The behaviour produced by this option is the
478 default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other
479 @samp{-X} options; in particular, it does not support @option{-X32}
480 which is the default for AIX @command{ar}.
485 @c man begin SEEALSO ar
486 nm(1), ranlib(1), and the Info entries for @file{binutils}.
491 @section Controlling @command{ar} with a Script
494 ar -M [ <@var{script} ]
497 @cindex MRI compatibility, @command{ar}
498 @cindex scripts, @command{ar}
499 If you use the single command-line option @samp{-M} with @command{ar}, you
500 can control its operation with a rudimentary command language. This
501 form of @command{ar} operates interactively if standard input is coming
502 directly from a terminal. During interactive use, @command{ar} prompts for
503 input (the prompt is @samp{AR >}), and continues executing even after
504 errors. If you redirect standard input to a script file, no prompts are
505 issued, and @command{ar} abandons execution (with a nonzero exit code)
508 The @command{ar} command language is @emph{not} designed to be equivalent
509 to the command-line options; in fact, it provides somewhat less control
510 over archives. The only purpose of the command language is to ease the
511 transition to @sc{gnu} @command{ar} for developers who already have scripts
512 written for the MRI ``librarian'' program.
514 The syntax for the @command{ar} command language is straightforward:
517 commands are recognized in upper or lower case; for example, @code{LIST}
518 is the same as @code{list}. In the following descriptions, commands are
519 shown in upper case for clarity.
522 a single command may appear on each line; it is the first word on the
526 empty lines are allowed, and have no effect.
529 comments are allowed; text after either of the characters @samp{*}
530 or @samp{;} is ignored.
533 Whenever you use a list of names as part of the argument to an @command{ar}
534 command, you can separate the individual names with either commas or
535 blanks. Commas are shown in the explanations below, for clarity.
538 @samp{+} is used as a line continuation character; if @samp{+} appears
539 at the end of a line, the text on the following line is considered part
540 of the current command.
543 Here are the commands you can use in @command{ar} scripts, or when using
544 @command{ar} interactively. Three of them have special significance:
546 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
547 a temporary file required for most of the other commands.
549 @code{SAVE} commits the changes so far specified by the script. Prior
550 to @code{SAVE}, commands affect only the temporary copy of the current
554 @item ADDLIB @var{archive}
555 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
556 Add all the contents of @var{archive} (or, if specified, each named
557 @var{module} from @var{archive}) to the current archive.
559 Requires prior use of @code{OPEN} or @code{CREATE}.
561 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
562 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
563 @c else like "ar q..."
564 Add each named @var{member} as a module in the current archive.
566 Requires prior use of @code{OPEN} or @code{CREATE}.
569 Discard the contents of the current archive, canceling the effect of
570 any operations since the last @code{SAVE}. May be executed (with no
571 effect) even if no current archive is specified.
573 @item CREATE @var{archive}
574 Creates an archive, and makes it the current archive (required for many
575 other commands). The new archive is created with a temporary name; it
576 is not actually saved as @var{archive} until you use @code{SAVE}.
577 You can overwrite existing archives; similarly, the contents of any
578 existing file named @var{archive} will not be destroyed until @code{SAVE}.
580 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
581 Delete each listed @var{module} from the current archive; equivalent to
582 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
584 Requires prior use of @code{OPEN} or @code{CREATE}.
586 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
587 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
588 List each named @var{module} present in @var{archive}. The separate
589 command @code{VERBOSE} specifies the form of the output: when verbose
590 output is off, output is like that of @samp{ar -t @var{archive}
591 @var{module}@dots{}}. When verbose output is on, the listing is like
592 @samp{ar -tv @var{archive} @var{module}@dots{}}.
594 Output normally goes to the standard output stream; however, if you
595 specify @var{outputfile} as a final argument, @command{ar} directs the
599 Exit from @command{ar}, with a @code{0} exit code to indicate successful
600 completion. This command does not save the output file; if you have
601 changed the current archive since the last @code{SAVE} command, those
604 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
605 Extract each named @var{module} from the current archive, writing them
606 into the current directory as separate files. Equivalent to @samp{ar -x
607 @var{archive} @var{module}@dots{}}.
609 Requires prior use of @code{OPEN} or @code{CREATE}.
612 @c FIXME Tokens but no commands???
619 Display full contents of the current archive, in ``verbose'' style
620 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
621 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
622 enhancement, rather than present for MRI compatibility.)
624 Requires prior use of @code{OPEN} or @code{CREATE}.
626 @item OPEN @var{archive}
627 Opens an existing archive for use as the current archive (required for
628 many other commands). Any changes as the result of subsequent commands
629 will not actually affect @var{archive} until you next use @code{SAVE}.
631 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
632 In the current archive, replace each existing @var{module} (named in
633 the @code{REPLACE} arguments) from files in the current working directory.
634 To execute this command without errors, both the file, and the module in
635 the current archive, must exist.
637 Requires prior use of @code{OPEN} or @code{CREATE}.
640 Toggle an internal flag governing the output from @code{DIRECTORY}.
641 When the flag is on, @code{DIRECTORY} output matches output from
642 @samp{ar -tv }@dots{}.
645 Commit your changes to the current archive, and actually save it as a
646 file with the name specified in the last @code{CREATE} or @code{OPEN}
649 Requires prior use of @code{OPEN} or @code{CREATE}.
658 The @sc{gnu} linker @command{ld} is now described in a separate manual.
659 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
667 @c man title nm list symbols from object files
670 @c man begin SYNOPSIS nm
671 nm [@option{-a}|@option{--debug-syms}] [@option{-g}|@option{--extern-only}]
672 [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]
673 [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}]
674 [@option{-A}|@option{-o}|@option{--print-file-name}][@option{--special-syms}]
675 [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}]
676 [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}]
677 [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}]
678 [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]
679 [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]
680 [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}]
684 @c man begin DESCRIPTION nm
685 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
686 If no object files are listed as arguments, @command{nm} assumes the file
689 For each symbol, @command{nm} shows:
693 The symbol value, in the radix selected by options (see below), or
694 hexadecimal by default.
697 The symbol type. At least the following types are used; others are, as
698 well, depending on the object file format. If lowercase, the symbol is
699 local; if uppercase, the symbol is global (external).
701 @c Some more detail on exactly what these symbol types are used for
705 The symbol's value is absolute, and will not be changed by further
710 The symbol is in the uninitialized data section (known as BSS).
713 The symbol is common. Common symbols are uninitialized data. When
714 linking, multiple common symbols may appear with the same name. If the
715 symbol is defined anywhere, the common symbols are treated as undefined
718 For more details on common symbols, see the discussion of
719 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
724 The symbol is in the initialized data section.
728 The symbol is in an initialized data section for small objects. Some
729 object file formats permit more efficient access to small data objects,
730 such as a global int variable as opposed to a large global array.
733 The symbol is an indirect reference to another symbol. This is a @sc{gnu}
734 extension to the a.out object file format which is rarely used.
737 The symbol is in a section specific to the implementation of DLLs.
740 The symbol is a debugging symbol.
743 The symbols is in a stack unwind section.
747 The symbol is in a read only data section.
751 The symbol is in an uninitialized data section for small objects.
755 The symbol is in the text (code) section.
758 The symbol is undefined.
762 The symbol is a weak object. When a weak defined symbol is linked with
763 a normal defined symbol, the normal defined symbol is used with no error.
764 When a weak undefined symbol is linked and the symbol is not defined,
765 the value of the weak symbol becomes zero with no error. On some
766 systems, uppercase indicates that a default value has been specified.
770 The symbol is a weak symbol that has not been specifically tagged as a
771 weak object symbol. When a weak defined symbol is linked with a normal
772 defined symbol, the normal defined symbol is used with no error.
773 When a weak undefined symbol is linked and the symbol is not defined,
774 the value of the symbol is determined in a system-specific manner without
775 error. On some systems, uppercase indicates that a default value has been
779 The symbol is a stabs symbol in an a.out object file. In this case, the
780 next values printed are the stabs other field, the stabs desc field, and
781 the stab type. Stabs symbols are used to hold debugging information.
783 For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
784 ``stabs'' debug format}.
788 The symbol type is unknown, or object file format specific.
797 @c man begin OPTIONS nm
798 The long and short forms of options, shown here as alternatives, are
804 @itemx --print-file-name
805 @cindex input file name
807 @cindex source file name
808 Precede each symbol by the name of the input file (or archive member)
809 in which it was found, rather than identifying the input file once only,
810 before all of its symbols.
814 @cindex debugging symbols
815 Display all symbols, even debugger-only symbols; normally these are not
819 @cindex @command{nm} format
820 @cindex @command{nm} compatibility
821 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
824 @itemx --demangle[=@var{style}]
825 @cindex demangling in nm
826 Decode (@dfn{demangle}) low-level symbol names into user-level names.
827 Besides removing any initial underscore prepended by the system, this
828 makes C++ function names readable. Different compilers have different
829 mangling styles. The optional demangling style argument can be used to
830 choose an appropriate demangling style for your compiler. @xref{c++filt},
831 for more information on demangling.
834 Do not demangle low-level symbol names. This is the default.
838 @cindex dynamic symbols
839 Display the dynamic symbols rather than the normal symbols. This is
840 only meaningful for dynamic objects, such as certain types of shared
843 @item -f @var{format}
844 @itemx --format=@var{format}
845 @cindex @command{nm} format
846 @cindex @command{nm} compatibility
847 Use the output format @var{format}, which can be @code{bsd},
848 @code{sysv}, or @code{posix}. The default is @code{bsd}.
849 Only the first character of @var{format} is significant; it can be
850 either upper or lower case.
854 @cindex external symbols
855 Display only external symbols.
858 @itemx --line-numbers
859 @cindex symbol line numbers
860 For each symbol, use debugging information to try to find a filename and
861 line number. For a defined symbol, look for the line number of the
862 address of the symbol. For an undefined symbol, look for the line
863 number of a relocation entry which refers to the symbol. If line number
864 information can be found, print it after the other symbol information.
868 @itemx --numeric-sort
869 Sort symbols numerically by their addresses, rather than alphabetically
874 @cindex sorting symbols
875 Do not bother to sort the symbols in any order; print them in the order
880 Use the POSIX.2 standard output format instead of the default format.
881 Equivalent to @samp{-f posix}.
885 Print size, not the value, of defined symbols for the @code{bsd} output format.
889 @cindex symbol index, listing
890 When listing symbols from archive members, include the index: a mapping
891 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
892 contain definitions for which names.
895 @itemx --reverse-sort
896 Reverse the order of the sort (whether numeric or alphabetic); let the
900 Sort symbols by size. The size is computed as the difference between
901 the value of the symbol and the value of the symbol with the next higher
902 value. If the @code{bsd} output format is used the size of the symbol
903 is printed, rather than the value, and @samp{-S} must be used in order
904 both size and value to be printed.
907 Display symbols which have a target-specific special meaning. These
908 symbols are usually used by the target for some special processing and
909 are not normally helpful when included included in the normal symbol
910 lists. For example for ARM targets this option would skip the mapping
911 symbols used to mark transitions between ARM code, THUMB code and
915 @itemx --radix=@var{radix}
916 Use @var{radix} as the radix for printing the symbol values. It must be
917 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
919 @item --target=@var{bfdname}
920 @cindex object code format
921 Specify an object code format other than your system's default format.
922 @xref{Target Selection}, for more information.
925 @itemx --undefined-only
926 @cindex external symbols
927 @cindex undefined symbols
928 Display only undefined symbols (those external to each object file).
931 @cindex external symbols
932 @cindex undefined symbols
933 Display only defined symbols for each object file.
937 Show the version number of @command{nm} and exit.
940 This option is ignored for compatibility with the AIX version of
941 @command{nm}. It takes one parameter which must be the string
942 @option{32_64}. The default mode of AIX @command{nm} corresponds
943 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
946 Show a summary of the options to @command{nm} and exit.
952 @c man begin SEEALSO nm
953 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
960 @c man title objcopy copy and translate object files
963 @c man begin SYNOPSIS objcopy
964 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
965 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
966 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
967 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
968 [@option{-S}|@option{--strip-all}]
969 [@option{-g}|@option{--strip-debug}]
970 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
971 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
972 [@option{--strip-unneeded-symbol=}@var{symbolname}]
973 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
974 [@option{--localize-hidden}]
975 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
976 [@option{--globalize-symbol=}@var{symbolname}]
977 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
978 [@option{-w}|@option{--wildcard}]
979 [@option{-x}|@option{--discard-all}]
980 [@option{-X}|@option{--discard-locals}]
981 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
982 [@option{-i} @var{interleave}|@option{--interleave=}@var{interleave}]
983 [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
984 [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
985 [@option{-p}|@option{--preserve-dates}]
986 [@option{--debugging}]
987 [@option{--gap-fill=}@var{val}]
988 [@option{--pad-to=}@var{address}]
989 [@option{--set-start=}@var{val}]
990 [@option{--adjust-start=}@var{incr}]
991 [@option{--change-addresses=}@var{incr}]
992 [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
993 [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
994 [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
995 [@option{--change-warnings}] [@option{--no-change-warnings}]
996 [@option{--set-section-flags} @var{section}=@var{flags}]
997 [@option{--add-section} @var{sectionname}=@var{filename}]
998 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
999 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1000 [@option{--reverse-bytes=}@var{num}]
1001 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1002 [@option{--redefine-sym} @var{old}=@var{new}]
1003 [@option{--redefine-syms=}@var{filename}]
1005 [@option{--keep-symbols=}@var{filename}]
1006 [@option{--strip-symbols=}@var{filename}]
1007 [@option{--strip-unneeded-symbols=}@var{filename}]
1008 [@option{--keep-global-symbols=}@var{filename}]
1009 [@option{--localize-symbols=}@var{filename}]
1010 [@option{--globalize-symbols=}@var{filename}]
1011 [@option{--weaken-symbols=}@var{filename}]
1012 [@option{--alt-machine-code=}@var{index}]
1013 [@option{--prefix-symbols=}@var{string}]
1014 [@option{--prefix-sections=}@var{string}]
1015 [@option{--prefix-alloc-sections=}@var{string}]
1016 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1017 [@option{--keep-file-symbols}]
1018 [@option{--only-keep-debug}]
1019 [@option{--extract-symbol}]
1020 [@option{--writable-text}]
1021 [@option{--readonly-text}]
1024 [@option{-v}|@option{--verbose}]
1025 [@option{-V}|@option{--version}]
1026 [@option{--help}] [@option{--info}]
1027 @var{infile} [@var{outfile}]
1031 @c man begin DESCRIPTION objcopy
1032 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1033 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1034 read and write the object files. It can write the destination object
1035 file in a format different from that of the source object file. The
1036 exact behavior of @command{objcopy} is controlled by command-line options.
1037 Note that @command{objcopy} should be able to copy a fully linked file
1038 between any two formats. However, copying a relocatable object file
1039 between any two formats may not work as expected.
1041 @command{objcopy} creates temporary files to do its translations and
1042 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1043 translation work; it has access to all the formats described in @sc{bfd}
1044 and thus is able to recognize most formats without being told
1045 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1047 @command{objcopy} can be used to generate S-records by using an output
1048 target of @samp{srec} (e.g., use @samp{-O srec}).
1050 @command{objcopy} can be used to generate a raw binary file by using an
1051 output target of @samp{binary} (e.g., use @option{-O binary}). When
1052 @command{objcopy} generates a raw binary file, it will essentially produce
1053 a memory dump of the contents of the input object file. All symbols and
1054 relocation information will be discarded. The memory dump will start at
1055 the load address of the lowest section copied into the output file.
1057 When generating an S-record or a raw binary file, it may be helpful to
1058 use @option{-S} to remove sections containing debugging information. In
1059 some cases @option{-R} will be useful to remove sections which contain
1060 information that is not needed by the binary file.
1062 Note---@command{objcopy} is not able to change the endianness of its input
1063 files. If the input format has an endianness (some formats do not),
1064 @command{objcopy} can only copy the inputs into file formats that have the
1065 same endianness or which have no endianness (e.g., @samp{srec}).
1066 (However, see the @option{--reverse-bytes} option.)
1070 @c man begin OPTIONS objcopy
1074 @itemx @var{outfile}
1075 The input and output files, respectively.
1076 If you do not specify @var{outfile}, @command{objcopy} creates a
1077 temporary file and destructively renames the result with
1078 the name of @var{infile}.
1080 @item -I @var{bfdname}
1081 @itemx --input-target=@var{bfdname}
1082 Consider the source file's object format to be @var{bfdname}, rather than
1083 attempting to deduce it. @xref{Target Selection}, for more information.
1085 @item -O @var{bfdname}
1086 @itemx --output-target=@var{bfdname}
1087 Write the output file using the object format @var{bfdname}.
1088 @xref{Target Selection}, for more information.
1090 @item -F @var{bfdname}
1091 @itemx --target=@var{bfdname}
1092 Use @var{bfdname} as the object format for both the input and the output
1093 file; i.e., simply transfer data from source to destination with no
1094 translation. @xref{Target Selection}, for more information.
1096 @item -B @var{bfdarch}
1097 @itemx --binary-architecture=@var{bfdarch}
1098 Useful when transforming a raw binary input file into an object file.
1099 In this case the output architecture can be set to @var{bfdarch}. This
1100 option will be ignored if the input file has a known @var{bfdarch}. You
1101 can access this binary data inside a program by referencing the special
1102 symbols that are created by the conversion process. These symbols are
1103 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1104 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1105 an object file and then access it in your code using these symbols.
1107 @item -j @var{sectionname}
1108 @itemx --only-section=@var{sectionname}
1109 Copy only the named section from the input file to the output file.
1110 This option may be given more than once. Note that using this option
1111 inappropriately may make the output file unusable.
1113 @item -R @var{sectionname}
1114 @itemx --remove-section=@var{sectionname}
1115 Remove any section named @var{sectionname} from the output file. This
1116 option may be given more than once. Note that using this option
1117 inappropriately may make the output file unusable.
1121 Do not copy relocation and symbol information from the source file.
1124 @itemx --strip-debug
1125 Do not copy debugging symbols or sections from the source file.
1127 @item --strip-unneeded
1128 Strip all symbols that are not needed for relocation processing.
1130 @item -K @var{symbolname}
1131 @itemx --keep-symbol=@var{symbolname}
1132 When stripping symbols, keep symbol @var{symbolname} even if it would
1133 normally be stripped. This option may be given more than once.
1135 @item -N @var{symbolname}
1136 @itemx --strip-symbol=@var{symbolname}
1137 Do not copy symbol @var{symbolname} from the source file. This option
1138 may be given more than once.
1140 @item --strip-unneeded-symbol=@var{symbolname}
1141 Do not copy symbol @var{symbolname} from the source file unless it is needed
1142 by a relocation. This option may be given more than once.
1144 @item -G @var{symbolname}
1145 @itemx --keep-global-symbol=@var{symbolname}
1146 Keep only symbol @var{symbolname} global. Make all other symbols local
1147 to the file, so that they are not visible externally. This option may
1148 be given more than once.
1150 @item --localize-hidden
1151 In an ELF object, mark all symbols that have hidden or internal visibility
1152 as local. This option applies on top of symbol-specific localization options
1153 such as @option{-L}.
1155 @item -L @var{symbolname}
1156 @itemx --localize-symbol=@var{symbolname}
1157 Make symbol @var{symbolname} local to the file, so that it is not
1158 visible externally. This option may be given more than once.
1160 @item -W @var{symbolname}
1161 @itemx --weaken-symbol=@var{symbolname}
1162 Make symbol @var{symbolname} weak. This option may be given more than once.
1164 @item --globalize-symbol=@var{symbolname}
1165 Give symbol @var{symbolname} global scoping so that it is visible
1166 outside of the file in which it is defined. This option may be given
1171 Permit regular expressions in @var{symbolname}s used in other command
1172 line options. The question mark (?), asterisk (*), backslash (\) and
1173 square brackets ([]) operators can be used anywhere in the symbol
1174 name. If the first character of the symbol name is the exclamation
1175 point (!) then the sense of the switch is reversed for that symbol.
1182 would cause objcopy to weaken all symbols that start with ``fo''
1183 except for the symbol ``foo''.
1186 @itemx --discard-all
1187 Do not copy non-global symbols from the source file.
1188 @c FIXME any reason to prefer "non-global" to "local" here?
1191 @itemx --discard-locals
1192 Do not copy compiler-generated local symbols.
1193 (These usually start with @samp{L} or @samp{.}.)
1196 @itemx --byte=@var{byte}
1197 Keep only every @var{byte}th byte of the input file (header data is not
1198 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
1199 where @var{interleave} is given by the @option{-i} or @option{--interleave}
1200 option, or the default of 4. This option is useful for creating files
1201 to program @sc{rom}. It is typically used with an @code{srec} output
1204 @item -i @var{interleave}
1205 @itemx --interleave=@var{interleave}
1206 Only copy one out of every @var{interleave} bytes. Select which byte to
1207 copy with the @option{-b} or @option{--byte} option. The default is 4.
1208 @command{objcopy} ignores this option if you do not specify either @option{-b} or
1212 @itemx --preserve-dates
1213 Set the access and modification dates of the output file to be the same
1214 as those of the input file.
1217 Convert debugging information, if possible. This is not the default
1218 because only certain debugging formats are supported, and the
1219 conversion process can be time consuming.
1221 @item --gap-fill @var{val}
1222 Fill gaps between sections with @var{val}. This operation applies to
1223 the @emph{load address} (LMA) of the sections. It is done by increasing
1224 the size of the section with the lower address, and filling in the extra
1225 space created with @var{val}.
1227 @item --pad-to @var{address}
1228 Pad the output file up to the load address @var{address}. This is
1229 done by increasing the size of the last section. The extra space is
1230 filled in with the value specified by @option{--gap-fill} (default zero).
1232 @item --set-start @var{val}
1233 Set the start address of the new file to @var{val}. Not all object file
1234 formats support setting the start address.
1236 @item --change-start @var{incr}
1237 @itemx --adjust-start @var{incr}
1238 @cindex changing start address
1239 Change the start address by adding @var{incr}. Not all object file
1240 formats support setting the start address.
1242 @item --change-addresses @var{incr}
1243 @itemx --adjust-vma @var{incr}
1244 @cindex changing object addresses
1245 Change the VMA and LMA addresses of all sections, as well as the start
1246 address, by adding @var{incr}. Some object file formats do not permit
1247 section addresses to be changed arbitrarily. Note that this does not
1248 relocate the sections; if the program expects sections to be loaded at a
1249 certain address, and this option is used to change the sections such
1250 that they are loaded at a different address, the program may fail.
1252 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1253 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1254 @cindex changing section address
1255 Set or change both the VMA address and the LMA address of the named
1256 @var{section}. If @samp{=} is used, the section address is set to
1257 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1258 section address. See the comments under @option{--change-addresses},
1259 above. If @var{section} does not exist in the input file, a warning will
1260 be issued, unless @option{--no-change-warnings} is used.
1262 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1263 @cindex changing section LMA
1264 Set or change the LMA address of the named @var{section}. The LMA
1265 address is the address where the section will be loaded into memory at
1266 program load time. Normally this is the same as the VMA address, which
1267 is the address of the section at program run time, but on some systems,
1268 especially those where a program is held in ROM, the two can be
1269 different. If @samp{=} is used, the section address is set to
1270 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1271 section address. See the comments under @option{--change-addresses},
1272 above. If @var{section} does not exist in the input file, a warning
1273 will be issued, unless @option{--no-change-warnings} is used.
1275 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1276 @cindex changing section VMA
1277 Set or change the VMA address of the named @var{section}. The VMA
1278 address is the address where the section will be located once the
1279 program has started executing. Normally this is the same as the LMA
1280 address, which is the address where the section will be loaded into
1281 memory, but on some systems, especially those where a program is held in
1282 ROM, the two can be different. If @samp{=} is used, the section address
1283 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1284 from the section address. See the comments under
1285 @option{--change-addresses}, above. If @var{section} does not exist in
1286 the input file, a warning will be issued, unless
1287 @option{--no-change-warnings} is used.
1289 @item --change-warnings
1290 @itemx --adjust-warnings
1291 If @option{--change-section-address} or @option{--change-section-lma} or
1292 @option{--change-section-vma} is used, and the named section does not
1293 exist, issue a warning. This is the default.
1295 @item --no-change-warnings
1296 @itemx --no-adjust-warnings
1297 Do not issue a warning if @option{--change-section-address} or
1298 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1299 if the named section does not exist.
1301 @item --set-section-flags @var{section}=@var{flags}
1302 Set the flags for the named section. The @var{flags} argument is a
1303 comma separated string of flag names. The recognized names are
1304 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1305 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1306 @samp{debug}. You can set the @samp{contents} flag for a section which
1307 does not have contents, but it is not meaningful to clear the
1308 @samp{contents} flag of a section which does have contents--just remove
1309 the section instead. Not all flags are meaningful for all object file
1312 @item --add-section @var{sectionname}=@var{filename}
1313 Add a new section named @var{sectionname} while copying the file. The
1314 contents of the new section are taken from the file @var{filename}. The
1315 size of the section will be the size of the file. This option only
1316 works on file formats which can support sections with arbitrary names.
1318 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1319 Rename a section from @var{oldname} to @var{newname}, optionally
1320 changing the section's flags to @var{flags} in the process. This has
1321 the advantage over usng a linker script to perform the rename in that
1322 the output stays as an object file and does not become a linked
1325 This option is particularly helpful when the input format is binary,
1326 since this will always create a section called .data. If for example,
1327 you wanted instead to create a section called .rodata containing binary
1328 data you could use the following command line to achieve it:
1331 objcopy -I binary -O <output_format> -B <architecture> \
1332 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1333 <input_binary_file> <output_object_file>
1336 @item --change-leading-char
1337 Some object file formats use special characters at the start of
1338 symbols. The most common such character is underscore, which compilers
1339 often add before every symbol. This option tells @command{objcopy} to
1340 change the leading character of every symbol when it converts between
1341 object file formats. If the object file formats use the same leading
1342 character, this option has no effect. Otherwise, it will add a
1343 character, or remove a character, or change a character, as
1346 @item --remove-leading-char
1347 If the first character of a global symbol is a special symbol leading
1348 character used by the object file format, remove the character. The
1349 most common symbol leading character is underscore. This option will
1350 remove a leading underscore from all global symbols. This can be useful
1351 if you want to link together objects of different file formats with
1352 different conventions for symbol names. This is different from
1353 @option{--change-leading-char} because it always changes the symbol name
1354 when appropriate, regardless of the object file format of the output
1357 @item --reverse-bytes=@var{num}
1358 Reverse the bytes in a section with output contents. A section length must
1359 be evenly divisible by the value given in order for the swap to be able to
1360 take place. Reversing takes place before the interleaving is performed.
1362 This option is used typically in generating ROM images for problematic
1363 target systems. For example, on some target boards, the 32-bit words
1364 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1365 regardless of the CPU byte order. Depending on the programming model, the
1366 endianness of the ROM may need to be modified.
1368 Consider a simple file with a section containing the following eight
1369 bytes: @code{12345678}.
1371 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1372 output file would be ordered @code{21436587}.
1374 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1375 output file would be ordered @code{43218765}.
1377 By using @samp{--reverse-bytes=2} for the above example, followed by
1378 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1379 output file would be ordered @code{34127856}.
1381 @item --srec-len=@var{ival}
1382 Meaningful only for srec output. Set the maximum length of the Srecords
1383 being produced to @var{ival}. This length covers both address, data and
1386 @item --srec-forceS3
1387 Meaningful only for srec output. Avoid generation of S1/S2 records,
1388 creating S3-only record format.
1390 @item --redefine-sym @var{old}=@var{new}
1391 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1392 when one is trying link two things together for which you have no
1393 source, and there are name collisions.
1395 @item --redefine-syms=@var{filename}
1396 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1397 listed in the file @var{filename}. @var{filename} is simply a flat file,
1398 with one symbol pair per line. Line comments may be introduced by the hash
1399 character. This option may be given more than once.
1402 Change all global symbols in the file to be weak. This can be useful
1403 when building an object which will be linked against other objects using
1404 the @option{-R} option to the linker. This option is only effective when
1405 using an object file format which supports weak symbols.
1407 @item --keep-symbols=@var{filename}
1408 Apply @option{--keep-symbol} option to each symbol listed in the file
1409 @var{filename}. @var{filename} is simply a flat file, with one symbol
1410 name per line. Line comments may be introduced by the hash character.
1411 This option may be given more than once.
1413 @item --strip-symbols=@var{filename}
1414 Apply @option{--strip-symbol} option to each symbol listed in the file
1415 @var{filename}. @var{filename} is simply a flat file, with one symbol
1416 name per line. Line comments may be introduced by the hash character.
1417 This option may be given more than once.
1419 @item --strip-unneeded-symbols=@var{filename}
1420 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1421 the file @var{filename}. @var{filename} is simply a flat file, with one
1422 symbol name per line. Line comments may be introduced by the hash
1423 character. This option may be given more than once.
1425 @item --keep-global-symbols=@var{filename}
1426 Apply @option{--keep-global-symbol} option to each symbol listed in the
1427 file @var{filename}. @var{filename} is simply a flat file, with one
1428 symbol name per line. Line comments may be introduced by the hash
1429 character. This option may be given more than once.
1431 @item --localize-symbols=@var{filename}
1432 Apply @option{--localize-symbol} option to each symbol listed in the file
1433 @var{filename}. @var{filename} is simply a flat file, with one symbol
1434 name per line. Line comments may be introduced by the hash character.
1435 This option may be given more than once.
1437 @item --globalize-symbols=@var{filename}
1438 Apply @option{--globalize-symbol} option to each symbol listed in the file
1439 @var{filename}. @var{filename} is simply a flat file, with one symbol
1440 name per line. Line comments may be introduced by the hash character.
1441 This option may be given more than once.
1443 @item --weaken-symbols=@var{filename}
1444 Apply @option{--weaken-symbol} option to each symbol listed in the file
1445 @var{filename}. @var{filename} is simply a flat file, with one symbol
1446 name per line. Line comments may be introduced by the hash character.
1447 This option may be given more than once.
1449 @item --alt-machine-code=@var{index}
1450 If the output architecture has alternate machine codes, use the
1451 @var{index}th code instead of the default one. This is useful in case
1452 a machine is assigned an official code and the tool-chain adopts the
1453 new code, but other applications still depend on the original code
1454 being used. For ELF based architectures if the @var{index}
1455 alternative does not exist then the value is treated as an absolute
1456 number to be stored in the e_machine field of the ELF header.
1458 @item --writable-text
1459 Mark the output text as writable. This option isn't meaningful for all
1460 object file formats.
1462 @item --readonly-text
1463 Make the output text write protected. This option isn't meaningful for all
1464 object file formats.
1467 Mark the output file as demand paged. This option isn't meaningful for all
1468 object file formats.
1471 Mark the output file as impure. This option isn't meaningful for all
1472 object file formats.
1474 @item --prefix-symbols=@var{string}
1475 Prefix all symbols in the output file with @var{string}.
1477 @item --prefix-sections=@var{string}
1478 Prefix all section names in the output file with @var{string}.
1480 @item --prefix-alloc-sections=@var{string}
1481 Prefix all the names of all allocated sections in the output file with
1484 @item --add-gnu-debuglink=@var{path-to-file}
1485 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1486 and adds it to the output file.
1488 @item --keep-file-symbols
1489 When stripping a file, perhaps with @option{--strip-debug} or
1490 @option{--strip-unneeded}, retain any symbols specifying source file names,
1491 which would otherwise get stripped.
1493 @item --only-keep-debug
1494 Strip a file, removing contents of any sections that would not be
1495 stripped by @option{--strip-debug} and leaving the debugging sections
1496 intact. In ELF files, this preserves all note sections in the output.
1498 The intention is that this option will be used in conjunction with
1499 @option{--add-gnu-debuglink} to create a two part executable. One a
1500 stripped binary which will occupy less space in RAM and in a
1501 distribution and the second a debugging information file which is only
1502 needed if debugging abilities are required. The suggested procedure
1503 to create these files is as follows:
1506 @item Link the executable as normal. Assuming that is is called
1508 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1509 create a file containing the debugging info.
1510 @item Run @code{objcopy --strip-debug foo} to create a
1511 stripped executable.
1512 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1513 to add a link to the debugging info into the stripped executable.
1516 Note---the choice of @code{.dbg} as an extension for the debug info
1517 file is arbitrary. Also the @code{--only-keep-debug} step is
1518 optional. You could instead do this:
1521 @item Link the executable as normal.
1522 @item Copy @code{foo} to @code{foo.full}
1523 @item Run @code{objcopy --strip-debug foo}
1524 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1527 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1528 full executable. It does not have to be a file created by the
1529 @option{--only-keep-debug} switch.
1531 Note---this switch is only intended for use on fully linked files. It
1532 does not make sense to use it on object files where the debugging
1533 information may be incomplete. Besides the gnu_debuglink feature
1534 currently only supports the presence of one filename containing
1535 debugging information, not multiple filenames on a one-per-object-file
1538 @item --extract-symbol
1539 Keep the file's section flags and symbols but remove all section data.
1540 Specifically, the option:
1543 @item removes the contents of all sections;
1544 @item sets the size of every section to zero; and
1545 @item sets the file's start address to zero.
1548 This option is used to build a @file{.sym} file for a VxWorks kernel.
1549 It can also be a useful way of reducing the size of a @option{--just-symbols}
1554 Show the version number of @command{objcopy}.
1558 Verbose output: list all object files modified. In the case of
1559 archives, @samp{objcopy -V} lists all members of the archive.
1562 Show a summary of the options to @command{objcopy}.
1565 Display a list showing all architectures and object formats available.
1571 @c man begin SEEALSO objcopy
1572 ld(1), objdump(1), and the Info entries for @file{binutils}.
1579 @cindex object file information
1582 @c man title objdump display information from object files.
1585 @c man begin SYNOPSIS objdump
1586 objdump [@option{-a}|@option{--archive-headers}]
1587 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1588 [@option{-C}|@option{--demangle}[=@var{style}] ]
1589 [@option{-d}|@option{--disassemble}]
1590 [@option{-D}|@option{--disassemble-all}]
1591 [@option{-z}|@option{--disassemble-zeroes}]
1592 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1593 [@option{-f}|@option{--file-headers}]
1594 [@option{-F}|@option{--file-offsets}]
1595 [@option{--file-start-context}]
1596 [@option{-g}|@option{--debugging}]
1597 [@option{-e}|@option{--debugging-tags}]
1598 [@option{-h}|@option{--section-headers}|@option{--headers}]
1599 [@option{-i}|@option{--info}]
1600 [@option{-j} @var{section}|@option{--section=}@var{section}]
1601 [@option{-l}|@option{--line-numbers}]
1602 [@option{-S}|@option{--source}]
1603 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1604 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1605 [@option{-p}|@option{--private-headers}]
1606 [@option{-r}|@option{--reloc}]
1607 [@option{-R}|@option{--dynamic-reloc}]
1608 [@option{-s}|@option{--full-contents}]
1609 [@option{-W}|@option{--dwarf}]
1610 [@option{-G}|@option{--stabs}]
1611 [@option{-t}|@option{--syms}]
1612 [@option{-T}|@option{--dynamic-syms}]
1613 [@option{-x}|@option{--all-headers}]
1614 [@option{-w}|@option{--wide}]
1615 [@option{--start-address=}@var{address}]
1616 [@option{--stop-address=}@var{address}]
1617 [@option{--prefix-addresses}]
1618 [@option{--[no-]show-raw-insn}]
1619 [@option{--adjust-vma=}@var{offset}]
1620 [@option{--special-syms}]
1621 [@option{-V}|@option{--version}]
1622 [@option{-H}|@option{--help}]
1623 @var{objfile}@dots{}
1627 @c man begin DESCRIPTION objdump
1629 @command{objdump} displays information about one or more object files.
1630 The options control what particular information to display. This
1631 information is mostly useful to programmers who are working on the
1632 compilation tools, as opposed to programmers who just want their
1633 program to compile and work.
1635 @var{objfile}@dots{} are the object files to be examined. When you
1636 specify archives, @command{objdump} shows information on each of the member
1641 @c man begin OPTIONS objdump
1643 The long and short forms of options, shown here as alternatives, are
1644 equivalent. At least one option from the list
1645 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1649 @itemx --archive-header
1650 @cindex archive headers
1651 If any of the @var{objfile} files are archives, display the archive
1652 header information (in a format similar to @samp{ls -l}). Besides the
1653 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1654 the object file format of each archive member.
1656 @item --adjust-vma=@var{offset}
1657 @cindex section addresses in objdump
1658 @cindex VMA in objdump
1659 When dumping information, first add @var{offset} to all the section
1660 addresses. This is useful if the section addresses do not correspond to
1661 the symbol table, which can happen when putting sections at particular
1662 addresses when using a format which can not represent section addresses,
1665 @item -b @var{bfdname}
1666 @itemx --target=@var{bfdname}
1667 @cindex object code format
1668 Specify that the object-code format for the object files is
1669 @var{bfdname}. This option may not be necessary; @var{objdump} can
1670 automatically recognize many formats.
1674 objdump -b oasys -m vax -h fu.o
1677 displays summary information from the section headers (@option{-h}) of
1678 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1679 file in the format produced by Oasys compilers. You can list the
1680 formats available with the @option{-i} option.
1681 @xref{Target Selection}, for more information.
1684 @itemx --demangle[=@var{style}]
1685 @cindex demangling in objdump
1686 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1687 Besides removing any initial underscore prepended by the system, this
1688 makes C++ function names readable. Different compilers have different
1689 mangling styles. The optional demangling style argument can be used to
1690 choose an appropriate demangling style for your compiler. @xref{c++filt},
1691 for more information on demangling.
1695 Display debugging information. This attempts to parse STABS and IEEE
1696 debugging format information stored in the file and print it out using
1697 a C like syntax. If neither of these formats are found this option
1698 falls back on the @option{-W} option to print any DWARF information in
1702 @itemx --debugging-tags
1703 Like @option{-g}, but the information is generated in a format compatible
1707 @itemx --disassemble
1708 @cindex disassembling object code
1709 @cindex machine instructions
1710 Display the assembler mnemonics for the machine instructions from
1711 @var{objfile}. This option only disassembles those sections which are
1712 expected to contain instructions.
1715 @itemx --disassemble-all
1716 Like @option{-d}, but disassemble the contents of all sections, not just
1717 those expected to contain instructions.
1719 @item --prefix-addresses
1720 When disassembling, print the complete address on each line. This is
1721 the older disassembly format.
1725 @itemx --endian=@{big|little@}
1727 @cindex disassembly endianness
1728 Specify the endianness of the object files. This only affects
1729 disassembly. This can be useful when disassembling a file format which
1730 does not describe endianness information, such as S-records.
1733 @itemx --file-headers
1734 @cindex object file header
1735 Display summary information from the overall header of
1736 each of the @var{objfile} files.
1739 @itemx --file-offsets
1740 @cindex object file offsets
1741 When disassembling sections, whenever a symbol is displayed, also
1742 display the file offset of the region of data that is about to be
1743 dumped. If zeroes are being skipped, then when disassembly resumes,
1744 tell the user how many zeroes were skipped and the file offset of the
1745 location from where the disassembly resumes. When dumping sections,
1746 display the file offset of the location from where the dump starts.
1748 @item --file-start-context
1749 @cindex source code context
1750 Specify that when displaying interlisted source code/disassembly
1751 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1752 context to the start of the file.
1755 @itemx --section-headers
1757 @cindex section headers
1758 Display summary information from the section headers of the
1761 File segments may be relocated to nonstandard addresses, for example by
1762 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1763 @command{ld}. However, some object file formats, such as a.out, do not
1764 store the starting address of the file segments. In those situations,
1765 although @command{ld} relocates the sections correctly, using @samp{objdump
1766 -h} to list the file section headers cannot show the correct addresses.
1767 Instead, it shows the usual addresses, which are implicit for the
1772 Print a summary of the options to @command{objdump} and exit.
1776 @cindex architectures available
1777 @cindex object formats available
1778 Display a list showing all architectures and object formats available
1779 for specification with @option{-b} or @option{-m}.
1782 @itemx --section=@var{name}
1783 @cindex section information
1784 Display information only for section @var{name}.
1787 @itemx --line-numbers
1788 @cindex source filenames for object files
1789 Label the display (using debugging information) with the filename and
1790 source line numbers corresponding to the object code or relocs shown.
1791 Only useful with @option{-d}, @option{-D}, or @option{-r}.
1793 @item -m @var{machine}
1794 @itemx --architecture=@var{machine}
1795 @cindex architecture
1796 @cindex disassembly architecture
1797 Specify the architecture to use when disassembling object files. This
1798 can be useful when disassembling object files which do not describe
1799 architecture information, such as S-records. You can list the available
1800 architectures with the @option{-i} option.
1802 @item -M @var{options}
1803 @itemx --disassembler-options=@var{options}
1804 Pass target specific information to the disassembler. Only supported on
1805 some targets. If it is necessary to specify more than one
1806 disassembler option then multiple @option{-M} options can be used or
1807 can be placed together into a comma separated list.
1809 If the target is an ARM architecture then this switch can be used to
1810 select which register name set is used during disassembler. Specifying
1811 @option{-M reg-names-std} (the default) will select the register names as
1812 used in ARM's instruction set documentation, but with register 13 called
1813 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
1814 @option{-M reg-names-apcs} will select the name set used by the ARM
1815 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
1816 just use @samp{r} followed by the register number.
1818 There are also two variants on the APCS register naming scheme enabled
1819 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
1820 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
1821 with the normal register names or the special register names).
1823 This option can also be used for ARM architectures to force the
1824 disassembler to interpret all instructions as Thumb instructions by
1825 using the switch @option{--disassembler-options=force-thumb}. This can be
1826 useful when attempting to disassemble thumb code produced by other
1829 For the x86, some of the options duplicate functions of the @option{-m}
1830 switch, but allow finer grained control. Multiple selections from the
1831 following may be specified as a comma separated string.
1832 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
1833 the given architecture. @option{intel} and @option{att} select between
1834 intel syntax mode and AT&T syntax mode.
1835 @option{intel-mnemonic} and @option{att-mnemonic} select between
1836 intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic}
1837 implies @option{intel} and @option{att-mnemonic} implies @option{att}.
1838 @option{addr64}, @option{addr32},
1839 @option{addr16}, @option{data32} and @option{data16} specify the default
1840 address size and operand size. These four options will be overridden if
1841 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
1842 option string. Lastly, @option{suffix}, when in AT&T mode,
1843 instructs the disassembler to print a mnemonic suffix even when the
1844 suffix could be inferred by the operands.
1846 For PPC, @option{booke}, @option{booke32} and @option{booke64} select
1847 disassembly of BookE instructions. @option{32} and @option{64} select
1848 PowerPC and PowerPC64 disassembly, respectively. @option{e300}
1849 selects disassembly for the e300 family. @option{440} selects
1850 disassembly for the PowerPC 440. @option{ppcps} selects disassembly
1851 for the paired single instructions of the PPC750CL.
1853 For MIPS, this option controls the printing of instruction mnemonic
1854 names and register names in disassembled instructions. Multiple
1855 selections from the following may be specified as a comma separated
1856 string, and invalid options are ignored:
1860 Print the 'raw' instruction mnemonic instead of some pseudo
1861 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
1862 'sll' instead of 'nop', etc.
1864 @item gpr-names=@var{ABI}
1865 Print GPR (general-purpose register) names as appropriate
1866 for the specified ABI. By default, GPR names are selected according to
1867 the ABI of the binary being disassembled.
1869 @item fpr-names=@var{ABI}
1870 Print FPR (floating-point register) names as
1871 appropriate for the specified ABI. By default, FPR numbers are printed
1874 @item cp0-names=@var{ARCH}
1875 Print CP0 (system control coprocessor; coprocessor 0) register names
1876 as appropriate for the CPU or architecture specified by
1877 @var{ARCH}. By default, CP0 register names are selected according to
1878 the architecture and CPU of the binary being disassembled.
1880 @item hwr-names=@var{ARCH}
1881 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
1882 as appropriate for the CPU or architecture specified by
1883 @var{ARCH}. By default, HWR names are selected according to
1884 the architecture and CPU of the binary being disassembled.
1886 @item reg-names=@var{ABI}
1887 Print GPR and FPR names as appropriate for the selected ABI.
1889 @item reg-names=@var{ARCH}
1890 Print CPU-specific register names (CP0 register and HWR names)
1891 as appropriate for the selected CPU or architecture.
1894 For any of the options listed above, @var{ABI} or
1895 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
1896 rather than names, for the selected types of registers.
1897 You can list the available values of @var{ABI} and @var{ARCH} using
1898 the @option{--help} option.
1900 For VAX, you can specify function entry addresses with @option{-M
1901 entry:0xf00ba}. You can use this multiple times to properly
1902 disassemble VAX binary files that don't contain symbol tables (like
1903 ROM dumps). In these cases, the function entry mask would otherwise
1904 be decoded as VAX instructions, which would probably lead the rest
1905 of the function being wrongly disassembled.
1908 @itemx --private-headers
1909 Print information that is specific to the object file format. The exact
1910 information printed depends upon the object file format. For some
1911 object file formats, no additional information is printed.
1915 @cindex relocation entries, in object file
1916 Print the relocation entries of the file. If used with @option{-d} or
1917 @option{-D}, the relocations are printed interspersed with the
1921 @itemx --dynamic-reloc
1922 @cindex dynamic relocation entries, in object file
1923 Print the dynamic relocation entries of the file. This is only
1924 meaningful for dynamic objects, such as certain types of shared
1928 @itemx --full-contents
1929 @cindex sections, full contents
1930 @cindex object file sections
1931 Display the full contents of any sections requested. By default all
1932 non-empty sections are displayed.
1936 @cindex source disassembly
1937 @cindex disassembly, with source
1938 Display source code intermixed with disassembly, if possible. Implies
1941 @item --show-raw-insn
1942 When disassembling instructions, print the instruction in hex as well as
1943 in symbolic form. This is the default except when
1944 @option{--prefix-addresses} is used.
1946 @item --no-show-raw-insn
1947 When disassembling instructions, do not print the instruction bytes.
1948 This is the default when @option{--prefix-addresses} is used.
1953 @cindex debug symbols
1954 Displays the contents of the DWARF debug sections in the file, if any
1961 @cindex debug symbols
1962 @cindex ELF object file format
1963 Display the full contents of any sections requested. Display the
1964 contents of the .stab and .stab.index and .stab.excl sections from an
1965 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1966 @code{.stab} debugging symbol-table entries are carried in an ELF
1967 section. In most other file formats, debugging symbol-table entries are
1968 interleaved with linkage symbols, and are visible in the @option{--syms}
1971 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1972 Overview,stabs.info, The ``stabs'' debug format}.
1975 @item --start-address=@var{address}
1976 @cindex start-address
1977 Start displaying data at the specified address. This affects the output
1978 of the @option{-d}, @option{-r} and @option{-s} options.
1980 @item --stop-address=@var{address}
1981 @cindex stop-address
1982 Stop displaying data at the specified address. This affects the output
1983 of the @option{-d}, @option{-r} and @option{-s} options.
1987 @cindex symbol table entries, printing
1988 Print the symbol table entries of the file.
1989 This is similar to the information provided by the @samp{nm} program,
1990 although the display format is different. The format of the output
1991 depends upon the format of the file being dumped, but there are two main
1992 types. One looks like this:
1995 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
1996 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
1999 where the number inside the square brackets is the number of the entry
2000 in the symbol table, the @var{sec} number is the section number, the
2001 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2002 symbol's type, the @var{scl} number is the symbol's storage class and
2003 the @var{nx} value is the number of auxilary entries associated with
2004 the symbol. The last two fields are the symbol's value and its name.
2006 The other common output format, usually seen with ELF based files,
2010 00000000 l d .bss 00000000 .bss
2011 00000000 g .text 00000000 fred
2014 Here the first number is the symbol's value (sometimes refered to as
2015 its address). The next field is actually a set of characters and
2016 spaces indicating the flag bits that are set on the symbol. These
2017 characters are described below. Next is the section with which the
2018 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2019 not connected with any section), or @emph{*UND*} if the section is
2020 referenced in the file being dumped, but not defined there.
2022 After the section name comes another field, a number, which for common
2023 symbols is the alignment and for other symbol is the size. Finally
2024 the symbol's name is displayed.
2026 The flag characters are divided into 7 groups as follows:
2031 The symbol is local (l), global (g), neither (a space) or both (!). A
2032 symbol can be neither local or global for a variety of reasons, e.g.,
2033 because it is used for debugging, but it is probably an indication of
2034 a bug if it is ever both local and global.
2037 The symbol is weak (w) or strong (a space).
2040 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2043 The symbol is a warning (W) or a normal symbol (a space). A warning
2044 symbol's name is a message to be displayed if the symbol following the
2045 warning symbol is ever referenced.
2048 The symbol is an indirect reference to another symbol (I) or a normal
2053 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2054 normal symbol (a space).
2059 The symbol is the name of a function (F) or a file (f) or an object
2060 (O) or just a normal symbol (a space).
2064 @itemx --dynamic-syms
2065 @cindex dynamic symbol table entries, printing
2066 Print the dynamic symbol table entries of the file. This is only
2067 meaningful for dynamic objects, such as certain types of shared
2068 libraries. This is similar to the information provided by the @samp{nm}
2069 program when given the @option{-D} (@option{--dynamic}) option.
2071 @item --special-syms
2072 When displaying symbols include those which the target considers to be
2073 special in some way and which would not normally be of interest to the
2078 Print the version number of @command{objdump} and exit.
2081 @itemx --all-headers
2082 @cindex all header information, object file
2083 @cindex header information, all
2084 Display all available header information, including the symbol table and
2085 relocation entries. Using @option{-x} is equivalent to specifying all of
2086 @option{-a -f -h -p -r -t}.
2090 @cindex wide output, printing
2091 Format some lines for output devices that have more than 80 columns.
2092 Also do not truncate symbol names when they are displayed.
2095 @itemx --disassemble-zeroes
2096 Normally the disassembly output will skip blocks of zeroes. This
2097 option directs the disassembler to disassemble those blocks, just like
2104 @c man begin SEEALSO objdump
2105 nm(1), readelf(1), and the Info entries for @file{binutils}.
2113 @cindex archive contents
2114 @cindex symbol index
2116 @c man title ranlib generate index to archive.
2119 @c man begin SYNOPSIS ranlib
2120 ranlib [@option{-vVt}] @var{archive}
2124 @c man begin DESCRIPTION ranlib
2126 @command{ranlib} generates an index to the contents of an archive and
2127 stores it in the archive. The index lists each symbol defined by a
2128 member of an archive that is a relocatable object file.
2130 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2132 An archive with such an index speeds up linking to the library and
2133 allows routines in the library to call each other without regard to
2134 their placement in the archive.
2136 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2137 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2142 @c man begin OPTIONS ranlib
2148 Show the version number of @command{ranlib}.
2151 Update the timestamp of the symbol map of an archive.
2157 @c man begin SEEALSO ranlib
2158 ar(1), nm(1), and the Info entries for @file{binutils}.
2166 @cindex section sizes
2168 @c man title size list section sizes and total size.
2171 @c man begin SYNOPSIS size
2172 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2174 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2176 [@option{-t}|@option{--totals}]
2177 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2178 [@var{objfile}@dots{}]
2182 @c man begin DESCRIPTION size
2184 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2185 size---for each of the object or archive files @var{objfile} in its
2186 argument list. By default, one line of output is generated for each
2187 object file or each module in an archive.
2189 @var{objfile}@dots{} are the object files to be examined.
2190 If none are specified, the file @code{a.out} will be used.
2194 @c man begin OPTIONS size
2196 The command line options have the following meanings:
2201 @itemx --format=@var{compatibility}
2202 @cindex @command{size} display format
2203 Using one of these options, you can choose whether the output from @sc{gnu}
2204 @command{size} resembles output from System V @command{size} (using @option{-A},
2205 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2206 @option{--format=berkeley}). The default is the one-line format similar to
2208 @c Bonus for doc-source readers: you can also say --format=strange (or
2209 @c anything else that starts with 's') for sysv, and --format=boring (or
2210 @c anything else that starts with 'b') for Berkeley.
2212 Here is an example of the Berkeley (default) format of output from
2215 $ size --format=Berkeley ranlib size
2216 text data bss dec hex filename
2217 294880 81920 11592 388392 5ed28 ranlib
2218 294880 81920 11888 388688 5ee50 size
2222 This is the same data, but displayed closer to System V conventions:
2225 $ size --format=SysV ranlib size
2243 Show a summary of acceptable arguments and options.
2248 @itemx --radix=@var{number}
2249 @cindex @command{size} number format
2250 @cindex radix for section sizes
2251 Using one of these options, you can control whether the size of each
2252 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2253 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2254 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2255 values (8, 10, 16) are supported. The total size is always given in two
2256 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2257 octal and hexadecimal if you're using @option{-o}.
2260 Print total size of common symbols in each file. When using Berkeley
2261 format these are included in the bss size.
2265 Show totals of all objects listed (Berkeley format listing mode only).
2267 @item --target=@var{bfdname}
2268 @cindex object code format
2269 Specify that the object-code format for @var{objfile} is
2270 @var{bfdname}. This option may not be necessary; @command{size} can
2271 automatically recognize many formats.
2272 @xref{Target Selection}, for more information.
2276 Display the version number of @command{size}.
2282 @c man begin SEEALSO size
2283 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2290 @cindex listings strings
2291 @cindex printing strings
2292 @cindex strings, printing
2294 @c man title strings print the strings of printable characters in files.
2297 @c man begin SYNOPSIS strings
2298 strings [@option{-afov}] [@option{-}@var{min-len}]
2299 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2300 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2301 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2302 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2303 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2304 [@option{--help}] [@option{--version}] @var{file}@dots{}
2308 @c man begin DESCRIPTION strings
2310 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
2311 character sequences that are at least 4 characters long (or the number
2312 given with the options below) and are followed by an unprintable
2313 character. By default, it only prints the strings from the initialized
2314 and loaded sections of object files; for other types of files, it prints
2315 the strings from the whole file.
2317 @command{strings} is mainly useful for determining the contents of non-text
2322 @c man begin OPTIONS strings
2328 Do not scan only the initialized and loaded sections of object files;
2329 scan the whole files.
2332 @itemx --print-file-name
2333 Print the name of the file before each string.
2336 Print a summary of the program usage on the standard output and exit.
2338 @item -@var{min-len}
2339 @itemx -n @var{min-len}
2340 @itemx --bytes=@var{min-len}
2341 Print sequences of characters that are at least @var{min-len} characters
2342 long, instead of the default 4.
2345 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2346 act like @samp{-t d} instead. Since we can not be compatible with both
2347 ways, we simply chose one.
2349 @item -t @var{radix}
2350 @itemx --radix=@var{radix}
2351 Print the offset within the file before each string. The single
2352 character argument specifies the radix of the offset---@samp{o} for
2353 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2355 @item -e @var{encoding}
2356 @itemx --encoding=@var{encoding}
2357 Select the character encoding of the strings that are to be found.
2358 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2359 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2360 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2361 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2362 littleendian. Useful for finding wide character strings. (@samp{l}
2363 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2365 @item -T @var{bfdname}
2366 @itemx --target=@var{bfdname}
2367 @cindex object code format
2368 Specify an object code format other than your system's default format.
2369 @xref{Target Selection}, for more information.
2373 Print the program version number on the standard output and exit.
2379 @c man begin SEEALSO strings
2380 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2381 and the Info entries for @file{binutils}.
2389 @cindex removing symbols
2390 @cindex discarding symbols
2391 @cindex symbols, discarding
2393 @c man title strip Discard symbols from object files.
2396 @c man begin SYNOPSIS strip
2397 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2398 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2399 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2400 [@option{-s}|@option{--strip-all}]
2401 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2402 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2403 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2404 [@option{-w}|@option{--wildcard}]
2405 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2406 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2407 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2408 [@option{--keep-file-symbols}]
2409 [@option{--only-keep-debug}]
2410 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2411 [@option{--help}] [@option{--info}]
2412 @var{objfile}@dots{}
2416 @c man begin DESCRIPTION strip
2418 @sc{gnu} @command{strip} discards all symbols from object files
2419 @var{objfile}. The list of object files may include archives.
2420 At least one object file must be given.
2422 @command{strip} modifies the files named in its argument,
2423 rather than writing modified copies under different names.
2427 @c man begin OPTIONS strip
2430 @item -F @var{bfdname}
2431 @itemx --target=@var{bfdname}
2432 Treat the original @var{objfile} as a file with the object
2433 code format @var{bfdname}, and rewrite it in the same format.
2434 @xref{Target Selection}, for more information.
2437 Show a summary of the options to @command{strip} and exit.
2440 Display a list showing all architectures and object formats available.
2442 @item -I @var{bfdname}
2443 @itemx --input-target=@var{bfdname}
2444 Treat the original @var{objfile} as a file with the object
2445 code format @var{bfdname}.
2446 @xref{Target Selection}, for more information.
2448 @item -O @var{bfdname}
2449 @itemx --output-target=@var{bfdname}
2450 Replace @var{objfile} with a file in the output format @var{bfdname}.
2451 @xref{Target Selection}, for more information.
2453 @item -R @var{sectionname}
2454 @itemx --remove-section=@var{sectionname}
2455 Remove any section named @var{sectionname} from the output file. This
2456 option may be given more than once. Note that using this option
2457 inappropriately may make the output file unusable.
2466 @itemx --strip-debug
2467 Remove debugging symbols only.
2469 @item --strip-unneeded
2470 Remove all symbols that are not needed for relocation processing.
2472 @item -K @var{symbolname}
2473 @itemx --keep-symbol=@var{symbolname}
2474 When stripping symbols, keep symbol @var{symbolname} even if it would
2475 normally be stripped. This option may be given more than once.
2477 @item -N @var{symbolname}
2478 @itemx --strip-symbol=@var{symbolname}
2479 Remove symbol @var{symbolname} from the source file. This option may be
2480 given more than once, and may be combined with strip options other than
2484 Put the stripped output in @var{file}, rather than replacing the
2485 existing file. When this argument is used, only one @var{objfile}
2486 argument may be specified.
2489 @itemx --preserve-dates
2490 Preserve the access and modification dates of the file.
2494 Permit regular expressions in @var{symbolname}s used in other command
2495 line options. The question mark (?), asterisk (*), backslash (\) and
2496 square brackets ([]) operators can be used anywhere in the symbol
2497 name. If the first character of the symbol name is the exclamation
2498 point (!) then the sense of the switch is reversed for that symbol.
2505 would cause strip to only keep symbols that start with the letters
2506 ``fo'', but to discard the symbol ``foo''.
2509 @itemx --discard-all
2510 Remove non-global symbols.
2513 @itemx --discard-locals
2514 Remove compiler-generated local symbols.
2515 (These usually start with @samp{L} or @samp{.}.)
2517 @item --keep-file-symbols
2518 When stripping a file, perhaps with @option{--strip-debug} or
2519 @option{--strip-unneeded}, retain any symbols specifying source file names,
2520 which would otherwise get stripped.
2522 @item --only-keep-debug
2523 Strip a file, removing contents of any sections that would not be
2524 stripped by @option{--strip-debug} and leaving the debugging sections
2525 intact. In ELF files, this preserves all note sections in the output.
2527 The intention is that this option will be used in conjunction with
2528 @option{--add-gnu-debuglink} to create a two part executable. One a
2529 stripped binary which will occupy less space in RAM and in a
2530 distribution and the second a debugging information file which is only
2531 needed if debugging abilities are required. The suggested procedure
2532 to create these files is as follows:
2535 @item Link the executable as normal. Assuming that is is called
2537 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2538 create a file containing the debugging info.
2539 @item Run @code{objcopy --strip-debug foo} to create a
2540 stripped executable.
2541 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2542 to add a link to the debugging info into the stripped executable.
2545 Note---the choice of @code{.dbg} as an extension for the debug info
2546 file is arbitrary. Also the @code{--only-keep-debug} step is
2547 optional. You could instead do this:
2550 @item Link the executable as normal.
2551 @item Copy @code{foo} to @code{foo.full}
2552 @item Run @code{strip --strip-debug foo}
2553 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2556 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2557 full executable. It does not have to be a file created by the
2558 @option{--only-keep-debug} switch.
2560 Note---this switch is only intended for use on fully linked files. It
2561 does not make sense to use it on object files where the debugging
2562 information may be incomplete. Besides the gnu_debuglink feature
2563 currently only supports the presence of one filename containing
2564 debugging information, not multiple filenames on a one-per-object-file
2569 Show the version number for @command{strip}.
2573 Verbose output: list all object files modified. In the case of
2574 archives, @samp{strip -v} lists all members of the archive.
2580 @c man begin SEEALSO strip
2581 the Info entries for @file{binutils}.
2585 @node c++filt, addr2line, strip, Top
2589 @cindex demangling C++ symbols
2591 @c man title cxxfilt Demangle C++ and Java symbols.
2594 @c man begin SYNOPSIS cxxfilt
2595 c++filt [@option{-_}|@option{--strip-underscores}]
2596 [@option{-n}|@option{--no-strip-underscores}]
2597 [@option{-p}|@option{--no-params}]
2598 [@option{-t}|@option{--types}]
2599 [@option{-i}|@option{--no-verbose}]
2600 [@option{-s} @var{format}|@option{--format=}@var{format}]
2601 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2605 @c man begin DESCRIPTION cxxfilt
2608 The C++ and Java languages provide function overloading, which means
2609 that you can write many functions with the same name, providing that
2610 each function takes parameters of different types. In order to be
2611 able to distinguish these similarly named functions C++ and Java
2612 encode them into a low-level assembler name which uniquely identifies
2613 each different version. This process is known as @dfn{mangling}. The
2615 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2616 MS-DOS this program is named @command{CXXFILT}.}
2617 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2618 names into user-level names so that they can be read.
2620 Every alphanumeric word (consisting of letters, digits, underscores,
2621 dollars, or periods) seen in the input is a potential mangled name.
2622 If the name decodes into a C++ name, the C++ name replaces the
2623 low-level name in the output, otherwise the original word is output.
2624 In this way you can pass an entire assembler source file, containing
2625 mangled names, through @command{c++filt} and see the same source file
2626 containing demangled names.
2628 You can also use @command{c++filt} to decipher individual symbols by
2629 passing them on the command line:
2632 c++filt @var{symbol}
2635 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
2636 names from the standard input instead. All the results are printed on
2637 the standard output. The difference between reading names from the
2638 command line versus reading names from the standard input is that
2639 command line arguments are expected to be just mangled names and no
2640 checking is performed to separate them from surrounding text. Thus
2647 will work and demangle the name to ``f()'' whereas:
2653 will not work. (Note the extra comma at the end of the mangled
2654 name which makes it invalid). This command however will work:
2657 echo _Z1fv, | c++filt -n
2660 and will display ``f(),'', i.e., the demangled name followed by a
2661 trailing comma. This behaviour is because when the names are read
2662 from the standard input it is expected that they might be part of an
2663 assembler source file where there might be extra, extraneous
2664 characters trailing after a mangled name. For example:
2667 .type _Z1fv, @@function
2672 @c man begin OPTIONS cxxfilt
2676 @itemx --strip-underscores
2677 On some systems, both the C and C++ compilers put an underscore in front
2678 of every name. For example, the C name @code{foo} gets the low-level
2679 name @code{_foo}. This option removes the initial underscore. Whether
2680 @command{c++filt} removes the underscore by default is target dependent.
2684 Prints demangled names using Java syntax. The default is to use C++
2688 @itemx --no-strip-underscores
2689 Do not remove the initial underscore.
2693 When demangling the name of a function, do not display the types of
2694 the function's parameters.
2698 Attempt to demangle types as well as function names. This is disabled
2699 by default since mangled types are normally only used internally in
2700 the compiler, and they can be confused with non-mangled names. For example,
2701 a function called ``a'' treated as a mangled type name would be
2702 demangled to ``signed char''.
2706 Do not include implementation details (if any) in the demangled
2709 @item -s @var{format}
2710 @itemx --format=@var{format}
2711 @command{c++filt} can decode various methods of mangling, used by
2712 different compilers. The argument to this option selects which
2717 Automatic selection based on executable (the default method)
2719 the one used by the @sc{gnu} C++ compiler (g++)
2721 the one used by the Lucid compiler (lcc)
2723 the one specified by the C++ Annotated Reference Manual
2725 the one used by the HP compiler (aCC)
2727 the one used by the EDG compiler
2729 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
2731 the one used by the @sc{gnu} Java compiler (gcj)
2733 the one used by the @sc{gnu} Ada compiler (GNAT).
2737 Print a summary of the options to @command{c++filt} and exit.
2740 Print the version number of @command{c++filt} and exit.
2746 @c man begin SEEALSO cxxfilt
2747 the Info entries for @file{binutils}.
2752 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
2753 user interface are subject to change in future releases. In particular,
2754 a command-line option may be required in the future to decode a name
2755 passed as an argument on the command line; in other words,
2758 c++filt @var{symbol}
2762 may in a future release become
2765 c++filt @var{option} @var{symbol}
2773 @cindex address to file name and line number
2775 @c man title addr2line convert addresses into file names and line numbers.
2778 @c man begin SYNOPSIS addr2line
2779 addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
2780 [@option{-C}|@option{--demangle}[=@var{style}]]
2781 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
2782 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
2783 [@option{-i}|@option{--inlines}]
2784 [@option{-j}|@option{--section=}@var{name}]
2785 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
2790 @c man begin DESCRIPTION addr2line
2792 @command{addr2line} translates addresses into file names and line numbers.
2793 Given an address in an executable or an offset in a section of a relocatable
2794 object, it uses the debugging information to figure out which file name and
2795 line number are associated with it.
2797 The executable or relocatable object to use is specified with the @option{-e}
2798 option. The default is the file @file{a.out}. The section in the relocatable
2799 object to use is specified with the @option{-j} option.
2801 @command{addr2line} has two modes of operation.
2803 In the first, hexadecimal addresses are specified on the command line,
2804 and @command{addr2line} displays the file name and line number for each
2807 In the second, @command{addr2line} reads hexadecimal addresses from
2808 standard input, and prints the file name and line number for each
2809 address on standard output. In this mode, @command{addr2line} may be used
2810 in a pipe to convert dynamically chosen addresses.
2812 The format of the output is @samp{FILENAME:LINENO}. The file name and
2813 line number for each address is printed on a separate line. If the
2814 @command{-f} option is used, then each @samp{FILENAME:LINENO} line is
2815 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2816 containing the address.
2818 If the file name or function name can not be determined,
2819 @command{addr2line} will print two question marks in their place. If the
2820 line number can not be determined, @command{addr2line} will print 0.
2824 @c man begin OPTIONS addr2line
2826 The long and short forms of options, shown here as alternatives, are
2830 @item -b @var{bfdname}
2831 @itemx --target=@var{bfdname}
2832 @cindex object code format
2833 Specify that the object-code format for the object files is
2837 @itemx --demangle[=@var{style}]
2838 @cindex demangling in objdump
2839 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2840 Besides removing any initial underscore prepended by the system, this
2841 makes C++ function names readable. Different compilers have different
2842 mangling styles. The optional demangling style argument can be used to
2843 choose an appropriate demangling style for your compiler. @xref{c++filt},
2844 for more information on demangling.
2846 @item -e @var{filename}
2847 @itemx --exe=@var{filename}
2848 Specify the name of the executable for which addresses should be
2849 translated. The default file is @file{a.out}.
2853 Display function names as well as file and line number information.
2857 Display only the base of each file name.
2861 If the address belongs to a function that was inlined, the source
2862 information for all enclosing scopes back to the first non-inlined
2863 function will also be printed. For example, if @code{main} inlines
2864 @code{callee1} which inlines @code{callee2}, and address is from
2865 @code{callee2}, the source information for @code{callee1} and @code{main}
2866 will also be printed.
2870 Read offsets relative to the specified section instead of absolute addresses.
2876 @c man begin SEEALSO addr2line
2877 Info entries for @file{binutils}.
2884 @command{nlmconv} converts a relocatable object file into a NetWare
2888 @command{nlmconv} currently works with @samp{i386} object
2889 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
2890 object files in @sc{elf}, or @code{a.out} format@footnote{
2891 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
2892 format in the Binary File Descriptor library. It has only been tested
2893 with the above formats.}.
2897 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
2898 utilities, since it is only useful for NLM targets.
2901 @c man title nlmconv converts object code into an NLM.
2904 @c man begin SYNOPSIS nlmconv
2905 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
2906 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
2907 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
2908 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
2909 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
2910 @var{infile} @var{outfile}
2914 @c man begin DESCRIPTION nlmconv
2916 @command{nlmconv} converts the relocatable @samp{i386} object file
2917 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
2918 reading @var{headerfile} for NLM header information. For instructions
2919 on writing the NLM command file language used in header files, see the
2920 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
2921 Development and Tools Overview}, which is part of the NLM Software
2922 Developer's Kit (``NLM SDK''), available from Novell, Inc.
2923 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
2926 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
2929 @command{nlmconv} can perform a link step. In other words, you can list
2930 more than one object file for input if you list them in the definitions
2931 file (rather than simply specifying one input file on the command line).
2932 In this case, @command{nlmconv} calls the linker for you.
2936 @c man begin OPTIONS nlmconv
2939 @item -I @var{bfdname}
2940 @itemx --input-target=@var{bfdname}
2941 Object format of the input file. @command{nlmconv} can usually determine
2942 the format of a given file (so no default is necessary).
2943 @xref{Target Selection}, for more information.
2945 @item -O @var{bfdname}
2946 @itemx --output-target=@var{bfdname}
2947 Object format of the output file. @command{nlmconv} infers the output
2948 format based on the input format, e.g. for a @samp{i386} input file the
2949 output format is @samp{nlm32-i386}.
2950 @xref{Target Selection}, for more information.
2952 @item -T @var{headerfile}
2953 @itemx --header-file=@var{headerfile}
2954 Reads @var{headerfile} for NLM header information. For instructions on
2955 writing the NLM command file language used in header files, see@ see the
2956 @samp{linkers} section, of the @cite{NLM Development and Tools
2957 Overview}, which is part of the NLM Software Developer's Kit, available
2962 Displays (on standard error) the linker command line used by @command{nlmconv}.
2964 @item -l @var{linker}
2965 @itemx --linker=@var{linker}
2966 Use @var{linker} for any linking. @var{linker} can be an absolute or a
2971 Prints a usage summary.
2975 Prints the version number for @command{nlmconv}.
2981 @c man begin SEEALSO nlmconv
2982 the Info entries for @file{binutils}.
2989 @command{windmc} may be used to generator Windows message resources.
2992 @emph{Warning:} @command{windmc} is not always built as part of the binary
2993 utilities, since it is only useful for Windows targets.
2996 @c man title windmc generates Windows message resources.
2999 @c man begin SYNOPSIS windres
3000 windmc [options] input-file
3004 @c man begin DESCRIPTION windmc
3006 @command{windmc} reads message definitions from an input file (.mc) and
3007 translate them into a set of output files. The output files may be of
3012 A C header file containing the message definitions.
3015 A resource file compilable by the @command{windres} tool.
3018 One or more binary files containing the resource data for a specific
3022 A C include file that maps message id's to their symbolic name.
3025 The exact description of these different formats is available in
3026 documentation from Microsoft.
3028 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3029 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3030 Windows Message Compiler.
3034 @c man begin OPTIONS windmc
3039 Specifies that the input file specified is ANSI. This is the default
3044 Specifies that messages in the output @code{bin} files should be in ANSI
3049 Specifies that @code{bin} filenames should have to be prefixed by the
3050 basename of the source file.
3054 Sets the customer bit in all message id's.
3056 @item -C @var{codepage}
3057 @itemx --codepage_in @var{codepage}
3058 Sets the default codepage to be used to convert input file to UTF16. The
3059 default is ocdepage 1252.
3062 @itemx --decimal_values
3063 Outputs the constants in the header file in decimal. Default is using
3067 @itemx --extension @var{ext}
3068 The extension for the header file. The default is .h extension.
3070 @item -F @var{target}
3071 @itemx --target @var{target}
3072 Specify the BFD format to use for a bin file as output. This
3073 is a BFD target name; you can use the @option{--help} option to see a list
3074 of supported targets. Normally @command{windmc} will use the default
3075 format, which is the first one listed by the @option{--help} option.
3077 @ref{Target Selection}.
3081 @itemx --headerdir @var{path}
3082 The target directory of the generated header file. The default is the
3087 Displays a list of command line options and then exits.
3089 @item -m @var{characters}
3090 @itemx --maxlength @var{characters}
3091 Instructs @command{windmc} to generate a warning if the length
3092 of any message exceeds the number specified.
3095 @itemx --nullterminate
3096 Terminate message text in @code{bin} files by zero. By default they are
3097 terminated by CR/LF.
3100 @itemx --hresult_use
3101 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3102 file, using HRESULT definitions. Status codes are used if the flag is not
3105 @item -O @var{codepage}
3106 @itemx --codepage_out @var{codepage}
3107 Sets the default codepage to be used to output text files. The default
3111 @itemx --rcdir @var{path}
3112 The target directory for the generated @code{rc} script and the generated
3113 @code{bin} files that the resource compiler script includes. The default
3114 is the current directory.
3118 Specifies that the input file is UTF16.
3121 @itemx --unicode_out
3122 Specifies that messages in the output @code{bin} file should be in UTF16
3123 format. This is the default behaviour.
3127 Enable verbose mode.
3131 Prints the version number for @command{windmc}.
3134 @itemx --xdgb @var{path}
3135 The path of the @code{dbg} C include file that maps message id's to the
3136 symbolic name. No such file is generated without specifying the switch.
3142 @c man begin SEEALSO windmc
3143 the Info entries for @file{binutils}.
3150 @command{windres} may be used to manipulate Windows resources.
3153 @emph{Warning:} @command{windres} is not always built as part of the binary
3154 utilities, since it is only useful for Windows targets.
3157 @c man title windres manipulate Windows resources.
3160 @c man begin SYNOPSIS windres
3161 windres [options] [input-file] [output-file]
3165 @c man begin DESCRIPTION windres
3167 @command{windres} reads resources from an input file and copies them into
3168 an output file. Either file may be in one of three formats:
3172 A text format read by the Resource Compiler.
3175 A binary format generated by the Resource Compiler.
3178 A COFF object or executable.
3181 The exact description of these different formats is available in
3182 documentation from Microsoft.
3184 When @command{windres} converts from the @code{rc} format to the @code{res}
3185 format, it is acting like the Windows Resource Compiler. When
3186 @command{windres} converts from the @code{res} format to the @code{coff}
3187 format, it is acting like the Windows @code{CVTRES} program.
3189 When @command{windres} generates an @code{rc} file, the output is similar
3190 but not identical to the format expected for the input. When an input
3191 @code{rc} file refers to an external filename, an output @code{rc} file
3192 will instead include the file contents.
3194 If the input or output format is not specified, @command{windres} will
3195 guess based on the file name, or, for the input file, the file contents.
3196 A file with an extension of @file{.rc} will be treated as an @code{rc}
3197 file, a file with an extension of @file{.res} will be treated as a
3198 @code{res} file, and a file with an extension of @file{.o} or
3199 @file{.exe} will be treated as a @code{coff} file.
3201 If no output file is specified, @command{windres} will print the resources
3202 in @code{rc} format to standard output.
3204 The normal use is for you to write an @code{rc} file, use @command{windres}
3205 to convert it to a COFF object file, and then link the COFF file into
3206 your application. This will make the resources described in the
3207 @code{rc} file available to Windows.
3211 @c man begin OPTIONS windres
3214 @item -i @var{filename}
3215 @itemx --input @var{filename}
3216 The name of the input file. If this option is not used, then
3217 @command{windres} will use the first non-option argument as the input file
3218 name. If there are no non-option arguments, then @command{windres} will
3219 read from standard input. @command{windres} can not read a COFF file from
3222 @item -o @var{filename}
3223 @itemx --output @var{filename}
3224 The name of the output file. If this option is not used, then
3225 @command{windres} will use the first non-option argument, after any used
3226 for the input file name, as the output file name. If there is no
3227 non-option argument, then @command{windres} will write to standard output.
3228 @command{windres} can not write a COFF file to standard output. Note,
3229 for compatibility with @command{rc} the option @option{-fo} is also
3230 accepted, but its use is not recommended.
3232 @item -J @var{format}
3233 @itemx --input-format @var{format}
3234 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3235 @samp{coff}. If no input format is specified, @command{windres} will
3236 guess, as described above.
3238 @item -O @var{format}
3239 @itemx --output-format @var{format}
3240 The output format to generate. @var{format} may be @samp{res},
3241 @samp{rc}, or @samp{coff}. If no output format is specified,
3242 @command{windres} will guess, as described above.
3244 @item -F @var{target}
3245 @itemx --target @var{target}
3246 Specify the BFD format to use for a COFF file as input or output. This
3247 is a BFD target name; you can use the @option{--help} option to see a list
3248 of supported targets. Normally @command{windres} will use the default
3249 format, which is the first one listed by the @option{--help} option.
3251 @ref{Target Selection}.
3254 @item --preprocessor @var{program}
3255 When @command{windres} reads an @code{rc} file, it runs it through the C
3256 preprocessor first. This option may be used to specify the preprocessor
3257 to use, including any leading arguments. The default preprocessor
3258 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3260 @item -I @var{directory}
3261 @itemx --include-dir @var{directory}
3262 Specify an include directory to use when reading an @code{rc} file.
3263 @command{windres} will pass this to the preprocessor as an @option{-I}
3264 option. @command{windres} will also search this directory when looking for
3265 files named in the @code{rc} file. If the argument passed to this command
3266 matches any of the supported @var{formats} (as described in the @option{-J}
3267 option), it will issue a deprecation warning, and behave just like the
3268 @option{-J} option. New programs should not use this behaviour. If a
3269 directory happens to match a @var{format}, simple prefix it with @samp{./}
3270 to disable the backward compatibility.
3272 @item -D @var{target}
3273 @itemx --define @var{sym}[=@var{val}]
3274 Specify a @option{-D} option to pass to the preprocessor when reading an
3277 @item -U @var{target}
3278 @itemx --undefine @var{sym}
3279 Specify a @option{-U} option to pass to the preprocessor when reading an
3283 Ignored for compatibility with rc.
3286 Enable verbose mode. This tells you what the preprocessor is if you
3290 @item --codepage @var{val}
3291 Specify the default codepage to use when reading an @code{rc} file.
3292 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3293 codepage code. The valid range is from zero up to 0xffff, but the
3294 validity of the codepage is host and configuration dependent.
3297 @item --language @var{val}
3298 Specify the default language to use when reading an @code{rc} file.
3299 @var{val} should be a hexadecimal language code. The low eight bits are
3300 the language, and the high eight bits are the sublanguage.
3302 @item --use-temp-file
3303 Use a temporary file to instead of using popen to read the output of
3304 the preprocessor. Use this option if the popen implementation is buggy
3305 on the host (eg., certain non-English language versions of Windows 95 and
3306 Windows 98 are known to have buggy popen where the output will instead
3309 @item --no-use-temp-file
3310 Use popen, not a temporary file, to read the output of the preprocessor.
3311 This is the default behaviour.
3315 Prints a usage summary.
3319 Prints the version number for @command{windres}.
3322 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3323 this will turn on parser debugging.
3329 @c man begin SEEALSO windres
3330 the Info entries for @file{binutils}.
3339 @command{dlltool} is used to create the files needed to create dynamic
3340 link libraries (DLLs) on systems which understand PE format image
3341 files such as Windows. A DLL contains an export table which contains
3342 information that the runtime loader needs to resolve references from a
3343 referencing program.
3345 The export table is generated by this program by reading in a
3346 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3347 will be in the DLL. A @file{.o} file can contain information in
3348 special @samp{.drectve} sections with export information.
3351 @emph{Note:} @command{dlltool} is not always built as part of the
3352 binary utilities, since it is only useful for those targets which
3356 @c man title dlltool Create files needed to build and use DLLs.
3359 @c man begin SYNOPSIS dlltool
3360 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3361 [@option{-b}|@option{--base-file} @var{base-file-name}]
3362 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3363 [@option{-z}|@option{--output-def} @var{def-file-name}]
3364 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3365 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3366 [@option{--exclude-symbols} @var{list}]
3367 [@option{--no-default-excludes}]
3368 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3369 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3370 [@option{-a}|@option{--add-indirect}]
3371 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3372 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3373 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3374 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
3375 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{-i}|@option{--interwork}]
3376 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3377 [@option{-v}|@option{--verbose}]
3378 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3379 [object-file @dots{}]
3383 @c man begin DESCRIPTION dlltool
3385 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3386 @option{-b} options as well as object files specified on the command
3387 line. It then processes these inputs and if the @option{-e} option has
3388 been specified it creates a exports file. If the @option{-l} option
3389 has been specified it creates a library file and if the @option{-z} option
3390 has been specified it creates a def file. Any or all of the @option{-e},
3391 @option{-l} and @option{-z} options can be present in one invocation of
3394 When creating a DLL, along with the source for the DLL, it is necessary
3395 to have three other files. @command{dlltool} can help with the creation of
3398 The first file is a @file{.def} file which specifies which functions are
3399 exported from the DLL, which functions the DLL imports, and so on. This
3400 is a text file and can be created by hand, or @command{dlltool} can be used
3401 to create it using the @option{-z} option. In this case @command{dlltool}
3402 will scan the object files specified on its command line looking for
3403 those functions which have been specially marked as being exported and
3404 put entries for them in the @file{.def} file it creates.
3406 In order to mark a function as being exported from a DLL, it needs to
3407 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3408 section of the object file. This can be done in C by using the
3412 asm (".section .drectve");
3413 asm (".ascii \"-export:my_func\"");
3415 int my_func (void) @{ @dots{} @}
3418 The second file needed for DLL creation is an exports file. This file
3419 is linked with the object files that make up the body of the DLL and it
3420 handles the interface between the DLL and the outside world. This is a
3421 binary file and it can be created by giving the @option{-e} option to
3422 @command{dlltool} when it is creating or reading in a @file{.def} file.
3424 The third file needed for DLL creation is the library file that programs
3425 will link with in order to access the functions in the DLL (an `import
3426 library'). This file can be created by giving the @option{-l} option to
3427 dlltool when it is creating or reading in a @file{.def} file.
3429 @command{dlltool} builds the library file by hand, but it builds the
3430 exports file by creating temporary files containing assembler statements
3431 and then assembling these. The @option{-S} command line option can be
3432 used to specify the path to the assembler that dlltool will use,
3433 and the @option{-f} option can be used to pass specific flags to that
3434 assembler. The @option{-n} can be used to prevent dlltool from deleting
3435 these temporary assembler files when it is done, and if @option{-n} is
3436 specified twice then this will prevent dlltool from deleting the
3437 temporary object files it used to build the library.
3439 Here is an example of creating a DLL from a source file @samp{dll.c} and
3440 also creating a program (from an object file called @samp{program.o})
3445 dlltool -e exports.o -l dll.lib dll.o
3446 gcc dll.o exports.o -o dll.dll
3447 gcc program.o dll.lib -o program
3451 @command{dlltool} may also be used to query an existing import library
3452 to determine the name of the DLL to which it is associated. See the
3453 description of the @option{-I} or @option{--identify} option.
3457 @c man begin OPTIONS dlltool
3459 The command line options have the following meanings:
3463 @item -d @var{filename}
3464 @itemx --input-def @var{filename}
3465 @cindex input .def file
3466 Specifies the name of a @file{.def} file to be read in and processed.
3468 @item -b @var{filename}
3469 @itemx --base-file @var{filename}
3471 Specifies the name of a base file to be read in and processed. The
3472 contents of this file will be added to the relocation section in the
3473 exports file generated by dlltool.
3475 @item -e @var{filename}
3476 @itemx --output-exp @var{filename}
3477 Specifies the name of the export file to be created by dlltool.
3479 @item -z @var{filename}
3480 @itemx --output-def @var{filename}
3481 Specifies the name of the @file{.def} file to be created by dlltool.
3483 @item -l @var{filename}
3484 @itemx --output-lib @var{filename}
3485 Specifies the name of the library file to be created by dlltool.
3487 @item --export-all-symbols
3488 Treat all global and weak defined symbols found in the input object
3489 files as symbols to be exported. There is a small list of symbols which
3490 are not exported by default; see the @option{--no-default-excludes}
3491 option. You may add to the list of symbols to not export by using the
3492 @option{--exclude-symbols} option.
3494 @item --no-export-all-symbols
3495 Only export symbols explicitly listed in an input @file{.def} file or in
3496 @samp{.drectve} sections in the input object files. This is the default
3497 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3498 attributes in the source code.
3500 @item --exclude-symbols @var{list}
3501 Do not export the symbols in @var{list}. This is a list of symbol names
3502 separated by comma or colon characters. The symbol names should not
3503 contain a leading underscore. This is only meaningful when
3504 @option{--export-all-symbols} is used.
3506 @item --no-default-excludes
3507 When @option{--export-all-symbols} is used, it will by default avoid
3508 exporting certain special symbols. The current list of symbols to avoid
3509 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3510 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3511 to go ahead and export these special symbols. This is only meaningful
3512 when @option{--export-all-symbols} is used.
3515 @itemx --as @var{path}
3516 Specifies the path, including the filename, of the assembler to be used
3517 to create the exports file.
3519 @item -f @var{options}
3520 @itemx --as-flags @var{options}
3521 Specifies any specific command line options to be passed to the
3522 assembler when building the exports file. This option will work even if
3523 the @option{-S} option is not used. This option only takes one argument,
3524 and if it occurs more than once on the command line, then later
3525 occurrences will override earlier occurrences. So if it is necessary to
3526 pass multiple options to the assembler they should be enclosed in
3530 @itemx --dll-name @var{name}
3531 Specifies the name to be stored in the @file{.def} file as the name of
3532 the DLL when the @option{-e} option is used. If this option is not
3533 present, then the filename given to the @option{-e} option will be
3534 used as the name of the DLL.
3536 @item -m @var{machine}
3537 @itemx -machine @var{machine}
3538 Specifies the type of machine for which the library file should be
3539 built. @command{dlltool} has a built in default type, depending upon how
3540 it was created, but this option can be used to override that. This is
3541 normally only useful when creating DLLs for an ARM processor, when the
3542 contents of the DLL are actually encode using Thumb instructions.
3545 @itemx --add-indirect
3546 Specifies that when @command{dlltool} is creating the exports file it
3547 should add a section which allows the exported functions to be
3548 referenced without using the import library. Whatever the hell that
3552 @itemx --add-underscore
3553 Specifies that when @command{dlltool} is creating the exports file it
3554 should prepend an underscore to the names of @emph{all} exported symbols.
3556 @item --add-stdcall-underscore
3557 Specifies that when @command{dlltool} is creating the exports file it
3558 should prepend an underscore to the names of exported @emph{stdcall}
3559 functions. Variable names and non-stdcall function names are not modified.
3560 This option is useful when creating GNU-compatible import libs for third
3561 party DLLs that were built with MS-Windows tools.
3565 Specifies that when @command{dlltool} is creating the exports file it
3566 should not append the string @samp{@@ <number>}. These numbers are
3567 called ordinal numbers and they represent another way of accessing the
3568 function in a DLL, other than by name.
3571 @itemx --add-stdcall-alias
3572 Specifies that when @command{dlltool} is creating the exports file it
3573 should add aliases for stdcall symbols without @samp{@@ <number>}
3574 in addition to the symbols with @samp{@@ <number>}.
3577 @itemx --ext-prefix-alias @var{prefix}
3578 Causes @command{dlltool} to create external aliases for all DLL
3579 imports with the specified prefix. The aliases are created for both
3580 external and import symbols with no leading underscore.
3584 Specifies that when @command{dlltool} is creating the exports and library
3585 files it should omit the @code{.idata4} section. This is for compatibility
3586 with certain operating systems.
3590 Specifies that when @command{dlltool} is creating the exports and library
3591 files it should omit the @code{.idata5} section. This is for compatibility
3592 with certain operating systems.
3594 @item -I @var{filename}
3595 @itemx --identify @var{filename}
3596 Specifies that @command{dlltool} should inspect the import library
3597 indicated by @var{filename} and report, on @code{stdout}, the name of
3598 the associated DLL. This can be performed in addition to any other
3599 operations indicated by the other options and arguments. @command{dlltool}
3600 @option{--identify} fails if the import library does not exist, is not
3601 actually an import library, or (rarely) if the import library somehow
3602 specifies more than one associated DLL.
3606 Specifies that @command{dlltool} should mark the objects in the library
3607 file and exports file that it produces as supporting interworking
3608 between ARM and Thumb code.
3612 Makes @command{dlltool} preserve the temporary assembler files it used to
3613 create the exports file. If this option is repeated then dlltool will
3614 also preserve the temporary object files it uses to create the library
3617 @item -t @var{prefix}
3618 @itemx --temp-prefix @var{prefix}
3619 Makes @command{dlltool} use @var{prefix} when constructing the names of
3620 temporary assembler and object files. By default, the temp file prefix
3621 is generated from the pid.
3625 Make dlltool describe what it is doing.
3629 Displays a list of command line options and then exits.
3633 Displays dlltool's version number and then exits.
3640 * def file format:: The format of the dlltool @file{.def} file
3643 @node def file format
3644 @section The format of the @command{dlltool} @file{.def} file
3646 A @file{.def} file contains any number of the following commands:
3650 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
3651 The result is going to be named @var{name}@code{.exe}.
3653 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
3654 The result is going to be named @var{name}@code{.dll}.
3656 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) )}
3657 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
3658 Declares @var{name1} as an exported symbol from the DLL, with optional
3659 ordinal number @var{integer}, or declares @var{name1} as an alias
3660 (forward) of the function @var{external-name} in the DLL
3663 @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{) ) *}
3664 Declares that @var{external-name} or the exported function whose
3665 ordinal number is @var{integer} is to be imported from the file
3666 @var{module-name}. If @var{internal-name} is specified then this is
3667 the name that the imported function will be referred to in the body of
3670 @item @code{DESCRIPTION} @var{string}
3671 Puts @var{string} into the output @file{.exp} file in the
3672 @code{.rdata} section.
3674 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3675 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3676 Generates @code{--stack} or @code{--heap}
3677 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
3678 section. The linker will see this and act upon it.
3680 @item @code{CODE} @var{attr} @code{+}
3681 @item @code{DATA} @var{attr} @code{+}
3682 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
3683 Generates @code{--attr} @var{section-name} @var{attr} in the output
3684 @code{.drectve} section, where @var{attr} is one of @code{READ},
3685 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
3686 this and act upon it.
3691 @c man begin SEEALSO dlltool
3692 The Info pages for @file{binutils}.
3699 @cindex ELF file information
3702 @c man title readelf Displays information about ELF files.
3705 @c man begin SYNOPSIS readelf
3706 readelf [@option{-a}|@option{--all}]
3707 [@option{-h}|@option{--file-header}]
3708 [@option{-l}|@option{--program-headers}|@option{--segments}]
3709 [@option{-S}|@option{--section-headers}|@option{--sections}]
3710 [@option{-g}|@option{--section-groups}]
3711 [@option{-t}|@option{--section-details}]
3712 [@option{-e}|@option{--headers}]
3713 [@option{-s}|@option{--syms}|@option{--symbols}]
3714 [@option{-n}|@option{--notes}]
3715 [@option{-r}|@option{--relocs}]
3716 [@option{-u}|@option{--unwind}]
3717 [@option{-d}|@option{--dynamic}]
3718 [@option{-V}|@option{--version-info}]
3719 [@option{-A}|@option{--arch-specific}]
3720 [@option{-D}|@option{--use-dynamic}]
3721 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
3722 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
3723 [@option{-c}|@option{--archive-index}]
3724 [@option{-w[lLiaprmfFsoR]}|
3725 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
3726 [@option{-I}|@option{-histogram}]
3727 [@option{-v}|@option{--version}]
3728 [@option{-W}|@option{--wide}]
3729 [@option{-H}|@option{--help}]
3730 @var{elffile}@dots{}
3734 @c man begin DESCRIPTION readelf
3736 @command{readelf} displays information about one or more ELF format object
3737 files. The options control what particular information to display.
3739 @var{elffile}@dots{} are the object files to be examined. 32-bit and
3740 64-bit ELF files are supported, as are archives containing ELF files.
3742 This program performs a similar function to @command{objdump} but it
3743 goes into more detail and it exists independently of the @sc{bfd}
3744 library, so if there is a bug in @sc{bfd} then readelf will not be
3749 @c man begin OPTIONS readelf
3751 The long and short forms of options, shown here as alternatives, are
3752 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
3758 Equivalent to specifying @option{--file-header},
3759 @option{--program-headers}, @option{--sections}, @option{--symbols},
3760 @option{--relocs}, @option{--dynamic}, @option{--notes} and
3761 @option{--version-info}.
3764 @itemx --file-header
3765 @cindex ELF file header information
3766 Displays the information contained in the ELF header at the start of the
3770 @itemx --program-headers
3772 @cindex ELF program header information
3773 @cindex ELF segment information
3774 Displays the information contained in the file's segment headers, if it
3779 @itemx --section-headers
3780 @cindex ELF section information
3781 Displays the information contained in the file's section headers, if it
3785 @itemx --section-groups
3786 @cindex ELF section group information
3787 Displays the information contained in the file's section groups, if it
3791 @itemx --section-details
3792 @cindex ELF section information
3793 Displays the detailed section information. Implies @option{-S}.
3798 @cindex ELF symbol table information
3799 Displays the entries in symbol table section of the file, if it has one.
3803 Display all the headers in the file. Equivalent to @option{-h -l -S}.
3808 Displays the contents of the NOTE segments and/or sections, if any.
3812 @cindex ELF reloc information
3813 Displays the contents of the file's relocation section, if it has one.
3817 @cindex unwind information
3818 Displays the contents of the file's unwind section, if it has one. Only
3819 the unwind sections for IA64 ELF files are currently supported.
3823 @cindex ELF dynamic section information
3824 Displays the contents of the file's dynamic section, if it has one.
3827 @itemx --version-info
3828 @cindex ELF version sections informations
3829 Displays the contents of the version sections in the file, it they
3833 @itemx --arch-specific
3834 Displays architecture-specific information in the file, if there
3838 @itemx --use-dynamic
3839 When displaying symbols, this option makes @command{readelf} use the
3840 symbol table in the file's dynamic section, rather than the one in the
3843 @item -x <number or name>
3844 @itemx --hex-dump=<number or name>
3845 Displays the contents of the indicated section as a hexadecimal dump.
3846 A number identifies a particular section by index in the section table;
3847 any other string identifies all sections with that name in the object file.
3849 @item -p <number or name>
3850 @itemx --string-dump=<number or name>
3851 Displays the contents of the indicated section as printable strings.
3852 A number identifies a particular section by index in the section table;
3853 any other string identifies all sections with that name in the object file.
3856 @itemx --archive-index
3857 @cindex Archive file symbol index information
3858 Displays the file symbol index infomation contained in the header part
3859 of binary archives. Performs the same function as the @option{t}
3860 command to @command{ar}, but without using the BFD library. @xref{ar}.
3862 @item -w[lLiaprmfFsoR]
3863 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]
3864 Displays the contents of the debug sections in the file, if any are
3865 present. If one of the optional letters or words follows the switch
3866 then only data found in those specific sections will be dumped.
3868 Note: the @option{=decodedline} option will display the interpreted
3869 contents of a .debug_line section whereas the @option{=rawline} option
3870 dumps the contents in a raw format.
3874 Display a histogram of bucket list lengths when displaying the contents
3875 of the symbol tables.
3879 Display the version number of readelf.
3883 Don't break output lines to fit into 80 columns. By default
3884 @command{readelf} breaks section header and segment listing lines for
3885 64-bit ELF files, so that they fit into 80 columns. This option causes
3886 @command{readelf} to print each section header resp. each segment one a
3887 single line, which is far more readable on terminals wider than 80 columns.
3891 Display the command line options understood by @command{readelf}.
3898 @c man begin SEEALSO readelf
3899 objdump(1), and the Info entries for @file{binutils}.
3903 @node Common Options
3904 @chapter Common Options
3906 The following command-line options are supported by all of the
3907 programs described in this manual.
3909 @c man begin OPTIONS
3911 @include at-file.texi
3915 Display the command-line options supported by the program.
3918 Display the version number of the program.
3920 @c man begin OPTIONS
3924 @node Selecting the Target System
3925 @chapter Selecting the Target System
3927 You can specify two aspects of the target system to the @sc{gnu}
3928 binary file utilities, each in several ways:
3938 In the following summaries, the lists of ways to specify values are in
3939 order of decreasing precedence. The ways listed first override those
3942 The commands to list valid values only list the values for which the
3943 programs you are running were configured. If they were configured with
3944 @option{--enable-targets=all}, the commands list most of the available
3945 values, but a few are left out; not all targets can be configured in at
3946 once because some of them can only be configured @dfn{native} (on hosts
3947 with the same type as the target system).
3950 * Target Selection::
3951 * Architecture Selection::
3954 @node Target Selection
3955 @section Target Selection
3957 A @dfn{target} is an object file format. A given target may be
3958 supported for multiple architectures (@pxref{Architecture Selection}).
3959 A target selection may also have variations for different operating
3960 systems or architectures.
3962 The command to list valid target values is @samp{objdump -i}
3963 (the first column of output contains the relevant information).
3965 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
3966 @samp{a.out-sunos-big}.
3968 You can also specify a target using a configuration triplet. This is
3969 the same sort of name that is passed to @file{configure} to specify a
3970 target. When you use a configuration triplet as an argument, it must be
3971 fully canonicalized. You can see the canonical version of a triplet by
3972 running the shell script @file{config.sub} which is included with the
3975 Some sample configuration triplets are: @samp{m68k-hp-bsd},
3976 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
3978 @subheading @command{objdump} Target
3984 command line option: @option{-b} or @option{--target}
3987 environment variable @code{GNUTARGET}
3990 deduced from the input file
3993 @subheading @command{objcopy} and @command{strip} Input Target
3999 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4002 environment variable @code{GNUTARGET}
4005 deduced from the input file
4008 @subheading @command{objcopy} and @command{strip} Output Target
4014 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4017 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4020 environment variable @code{GNUTARGET}
4023 deduced from the input file
4026 @subheading @command{nm}, @command{size}, and @command{strings} Target
4032 command line option: @option{--target}
4035 environment variable @code{GNUTARGET}
4038 deduced from the input file
4041 @node Architecture Selection
4042 @section Architecture Selection
4044 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4045 to run. Its name may contain a colon, separating the name of the
4046 processor family from the name of the particular @sc{cpu}.
4048 The command to list valid architecture values is @samp{objdump -i} (the
4049 second column contains the relevant information).
4051 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4053 @subheading @command{objdump} Architecture
4059 command line option: @option{-m} or @option{--architecture}
4062 deduced from the input file
4065 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4071 deduced from the input file
4074 @node Reporting Bugs
4075 @chapter Reporting Bugs
4077 @cindex reporting bugs
4079 Your bug reports play an essential role in making the binary utilities
4082 Reporting a bug may help you by bringing a solution to your problem, or
4083 it may not. But in any case the principal function of a bug report is
4084 to help the entire community by making the next version of the binary
4085 utilities work better. Bug reports are your contribution to their
4088 In order for a bug report to serve its purpose, you must include the
4089 information that enables us to fix the bug.
4092 * Bug Criteria:: Have you found a bug?
4093 * Bug Reporting:: How to report bugs
4097 @section Have You Found a Bug?
4098 @cindex bug criteria
4100 If you are not sure whether you have found a bug, here are some guidelines:
4103 @cindex fatal signal
4106 If a binary utility gets a fatal signal, for any input whatever, that is
4107 a bug. Reliable utilities never crash.
4109 @cindex error on valid input
4111 If a binary utility produces an error message for valid input, that is a
4115 If you are an experienced user of binary utilities, your suggestions for
4116 improvement are welcome in any case.
4120 @section How to Report Bugs
4122 @cindex bugs, reporting
4124 A number of companies and individuals offer support for @sc{gnu}
4125 products. If you obtained the binary utilities from a support
4126 organization, we recommend you contact that organization first.
4128 You can find contact information for many support companies and
4129 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4133 In any event, we also recommend that you send bug reports for the binary
4134 utilities to @value{BUGURL}.
4137 The fundamental principle of reporting bugs usefully is this:
4138 @strong{report all the facts}. If you are not sure whether to state a
4139 fact or leave it out, state it!
4141 Often people omit facts because they think they know what causes the
4142 problem and assume that some details do not matter. Thus, you might
4143 assume that the name of a file you use in an example does not matter.
4144 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4145 a stray memory reference which happens to fetch from the location where
4146 that pathname is stored in memory; perhaps, if the pathname were
4147 different, the contents of that location would fool the utility into
4148 doing the right thing despite the bug. Play it safe and give a
4149 specific, complete example. That is the easiest thing for you to do,
4150 and the most helpful.
4152 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4153 it is new to us. Therefore, always write your bug reports on the assumption
4154 that the bug has not been reported previously.
4156 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4157 bell?'' This cannot help us fix a bug, so it is basically useless. We
4158 respond by asking for enough details to enable us to investigate.
4159 You might as well expedite matters by sending them to begin with.
4161 To enable us to fix the bug, you should include all these things:
4165 The version of the utility. Each utility announces it if you start it
4166 with the @option{--version} argument.
4168 Without this, we will not know whether there is any point in looking for
4169 the bug in the current version of the binary utilities.
4172 Any patches you may have applied to the source, including any patches
4173 made to the @code{BFD} library.
4176 The type of machine you are using, and the operating system name and
4180 What compiler (and its version) was used to compile the utilities---e.g.
4184 The command arguments you gave the utility to observe the bug. To
4185 guarantee you will not omit something important, list them all. A copy
4186 of the Makefile (or the output from make) is sufficient.
4188 If we were to try to guess the arguments, we would probably guess wrong
4189 and then we might not encounter the bug.
4192 A complete input file, or set of input files, that will reproduce the
4193 bug. If the utility is reading an object file or files, then it is
4194 generally most helpful to send the actual object files.
4196 If the source files were produced exclusively using @sc{gnu} programs
4197 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4198 may be OK to send the source files rather than the object files. In
4199 this case, be sure to say exactly what version of @command{gcc}, or
4200 whatever, was used to produce the object files. Also say how
4201 @command{gcc}, or whatever, was configured.
4204 A description of what behavior you observe that you believe is
4205 incorrect. For example, ``It gets a fatal signal.''
4207 Of course, if the bug is that the utility gets a fatal signal, then we
4208 will certainly notice it. But if the bug is incorrect output, we might
4209 not notice unless it is glaringly wrong. You might as well not give us
4210 a chance to make a mistake.
4212 Even if the problem you experience is a fatal signal, you should still
4213 say so explicitly. Suppose something strange is going on, such as your
4214 copy of the utility is out of sync, or you have encountered a bug in
4215 the C library on your system. (This has happened!) Your copy might
4216 crash and ours would not. If you told us to expect a crash, then when
4217 ours fails to crash, we would know that the bug was not happening for
4218 us. If you had not told us to expect a crash, then we would not be able
4219 to draw any conclusion from our observations.
4222 If you wish to suggest changes to the source, send us context diffs, as
4223 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4224 option. Always send diffs from the old file to the new file. If you
4225 wish to discuss something in the @command{ld} source, refer to it by
4226 context, not by line number.
4228 The line numbers in our development sources will not match those in your
4229 sources. Your line numbers would convey no useful information to us.
4232 Here are some things that are not necessary:
4236 A description of the envelope of the bug.
4238 Often people who encounter a bug spend a lot of time investigating
4239 which changes to the input file will make the bug go away and which
4240 changes will not affect it.
4242 This is often time consuming and not very useful, because the way we
4243 will find the bug is by running a single example under the debugger
4244 with breakpoints, not by pure deduction from a series of examples.
4245 We recommend that you save your time for something else.
4247 Of course, if you can find a simpler example to report @emph{instead}
4248 of the original one, that is a convenience for us. Errors in the
4249 output will be easier to spot, running under the debugger will take
4250 less time, and so on.
4252 However, simplification is not vital; if you do not want to do this,
4253 report the bug anyway and send us the entire test case you used.
4256 A patch for the bug.
4258 A patch for the bug does help us if it is a good one. But do not omit
4259 the necessary information, such as the test case, on the assumption that
4260 a patch is all we need. We might see problems with your patch and decide
4261 to fix the problem another way, or we might not understand it at all.
4263 Sometimes with programs as complicated as the binary utilities it is
4264 very hard to construct an example that will make the program follow a
4265 certain path through the code. If you do not send us the example, we
4266 will not be able to construct one, so we will not be able to verify that
4269 And if we cannot understand what bug you are trying to fix, or why your
4270 patch should be an improvement, we will not install it. A test case will
4271 help us to understand.
4274 A guess about what the bug is or what it depends on.
4276 Such guesses are usually wrong. Even we cannot guess right about such
4277 things without first using the debugger to find the facts.
4280 @node GNU Free Documentation License
4281 @appendix GNU Free Documentation License
4285 @node Binutils Index
4286 @unnumbered Binutils Index