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.3
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 version 1.3. A copy of the license is included
137 in the 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 in a section specific to the implementation of DLLs.
736 The symbol is a debugging symbol.
739 The symbols is in a stack unwind section.
743 The symbol is in a read only data section.
747 The symbol is in an uninitialized data section for small objects.
751 The symbol is in the text (code) section.
754 The symbol is undefined.
758 The symbol is a weak object. When a weak defined symbol is linked with
759 a normal defined symbol, the normal defined symbol is used with no error.
760 When a weak undefined symbol is linked and the symbol is not defined,
761 the value of the weak symbol becomes zero with no error. On some
762 systems, uppercase indicates that a default value has been specified.
766 The symbol is a weak symbol that has not been specifically tagged as a
767 weak object symbol. When a weak defined symbol is linked with a normal
768 defined symbol, the normal defined symbol is used with no error.
769 When a weak undefined symbol is linked and the symbol is not defined,
770 the value of the symbol is determined in a system-specific manner without
771 error. On some systems, uppercase indicates that a default value has been
775 The symbol is a stabs symbol in an a.out object file. In this case, the
776 next values printed are the stabs other field, the stabs desc field, and
777 the stab type. Stabs symbols are used to hold debugging information.
779 For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
780 ``stabs'' debug format}.
784 The symbol type is unknown, or object file format specific.
793 @c man begin OPTIONS nm
794 The long and short forms of options, shown here as alternatives, are
800 @itemx --print-file-name
801 @cindex input file name
803 @cindex source file name
804 Precede each symbol by the name of the input file (or archive member)
805 in which it was found, rather than identifying the input file once only,
806 before all of its symbols.
810 @cindex debugging symbols
811 Display all symbols, even debugger-only symbols; normally these are not
815 @cindex @command{nm} format
816 @cindex @command{nm} compatibility
817 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
820 @itemx --demangle[=@var{style}]
821 @cindex demangling in nm
822 Decode (@dfn{demangle}) low-level symbol names into user-level names.
823 Besides removing any initial underscore prepended by the system, this
824 makes C++ function names readable. Different compilers have different
825 mangling styles. The optional demangling style argument can be used to
826 choose an appropriate demangling style for your compiler. @xref{c++filt},
827 for more information on demangling.
830 Do not demangle low-level symbol names. This is the default.
834 @cindex dynamic symbols
835 Display the dynamic symbols rather than the normal symbols. This is
836 only meaningful for dynamic objects, such as certain types of shared
839 @item -f @var{format}
840 @itemx --format=@var{format}
841 @cindex @command{nm} format
842 @cindex @command{nm} compatibility
843 Use the output format @var{format}, which can be @code{bsd},
844 @code{sysv}, or @code{posix}. The default is @code{bsd}.
845 Only the first character of @var{format} is significant; it can be
846 either upper or lower case.
850 @cindex external symbols
851 Display only external symbols.
854 @itemx --line-numbers
855 @cindex symbol line numbers
856 For each symbol, use debugging information to try to find a filename and
857 line number. For a defined symbol, look for the line number of the
858 address of the symbol. For an undefined symbol, look for the line
859 number of a relocation entry which refers to the symbol. If line number
860 information can be found, print it after the other symbol information.
864 @itemx --numeric-sort
865 Sort symbols numerically by their addresses, rather than alphabetically
870 @cindex sorting symbols
871 Do not bother to sort the symbols in any order; print them in the order
876 Use the POSIX.2 standard output format instead of the default format.
877 Equivalent to @samp{-f posix}.
881 Print size, not the value, of defined symbols for the @code{bsd} output format.
885 @cindex symbol index, listing
886 When listing symbols from archive members, include the index: a mapping
887 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
888 contain definitions for which names.
891 @itemx --reverse-sort
892 Reverse the order of the sort (whether numeric or alphabetic); let the
896 Sort symbols by size. The size is computed as the difference between
897 the value of the symbol and the value of the symbol with the next higher
898 value. If the @code{bsd} output format is used the size of the symbol
899 is printed, rather than the value, and @samp{-S} must be used in order
900 both size and value to be printed.
903 Display symbols which have a target-specific special meaning. These
904 symbols are usually used by the target for some special processing and
905 are not normally helpful when included included in the normal symbol
906 lists. For example for ARM targets this option would skip the mapping
907 symbols used to mark transitions between ARM code, THUMB code and
911 @itemx --radix=@var{radix}
912 Use @var{radix} as the radix for printing the symbol values. It must be
913 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
915 @item --target=@var{bfdname}
916 @cindex object code format
917 Specify an object code format other than your system's default format.
918 @xref{Target Selection}, for more information.
921 @itemx --undefined-only
922 @cindex external symbols
923 @cindex undefined symbols
924 Display only undefined symbols (those external to each object file).
927 @cindex external symbols
928 @cindex undefined symbols
929 Display only defined symbols for each object file.
933 Show the version number of @command{nm} and exit.
936 This option is ignored for compatibility with the AIX version of
937 @command{nm}. It takes one parameter which must be the string
938 @option{32_64}. The default mode of AIX @command{nm} corresponds
939 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
942 Show a summary of the options to @command{nm} and exit.
948 @c man begin SEEALSO nm
949 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
956 @c man title objcopy copy and translate object files
959 @c man begin SYNOPSIS objcopy
960 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
961 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
962 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
963 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
964 [@option{-S}|@option{--strip-all}]
965 [@option{-g}|@option{--strip-debug}]
966 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
967 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
968 [@option{--strip-unneeded-symbol=}@var{symbolname}]
969 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
970 [@option{--localize-hidden}]
971 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
972 [@option{--globalize-symbol=}@var{symbolname}]
973 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
974 [@option{-w}|@option{--wildcard}]
975 [@option{-x}|@option{--discard-all}]
976 [@option{-X}|@option{--discard-locals}]
977 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
978 [@option{-i} @var{interleave}|@option{--interleave=}@var{interleave}]
979 [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
980 [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
981 [@option{-p}|@option{--preserve-dates}]
982 [@option{--debugging}]
983 [@option{--gap-fill=}@var{val}]
984 [@option{--pad-to=}@var{address}]
985 [@option{--set-start=}@var{val}]
986 [@option{--adjust-start=}@var{incr}]
987 [@option{--change-addresses=}@var{incr}]
988 [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
989 [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
990 [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
991 [@option{--change-warnings}] [@option{--no-change-warnings}]
992 [@option{--set-section-flags} @var{section}=@var{flags}]
993 [@option{--add-section} @var{sectionname}=@var{filename}]
994 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
995 [@option{--change-leading-char}] [@option{--remove-leading-char}]
996 [@option{--reverse-bytes=}@var{num}]
997 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
998 [@option{--redefine-sym} @var{old}=@var{new}]
999 [@option{--redefine-syms=}@var{filename}]
1001 [@option{--keep-symbols=}@var{filename}]
1002 [@option{--strip-symbols=}@var{filename}]
1003 [@option{--strip-unneeded-symbols=}@var{filename}]
1004 [@option{--keep-global-symbols=}@var{filename}]
1005 [@option{--localize-symbols=}@var{filename}]
1006 [@option{--globalize-symbols=}@var{filename}]
1007 [@option{--weaken-symbols=}@var{filename}]
1008 [@option{--alt-machine-code=}@var{index}]
1009 [@option{--prefix-symbols=}@var{string}]
1010 [@option{--prefix-sections=}@var{string}]
1011 [@option{--prefix-alloc-sections=}@var{string}]
1012 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1013 [@option{--keep-file-symbols}]
1014 [@option{--only-keep-debug}]
1015 [@option{--extract-symbol}]
1016 [@option{--writable-text}]
1017 [@option{--readonly-text}]
1020 [@option{-v}|@option{--verbose}]
1021 [@option{-V}|@option{--version}]
1022 [@option{--help}] [@option{--info}]
1023 @var{infile} [@var{outfile}]
1027 @c man begin DESCRIPTION objcopy
1028 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1029 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1030 read and write the object files. It can write the destination object
1031 file in a format different from that of the source object file. The
1032 exact behavior of @command{objcopy} is controlled by command-line options.
1033 Note that @command{objcopy} should be able to copy a fully linked file
1034 between any two formats. However, copying a relocatable object file
1035 between any two formats may not work as expected.
1037 @command{objcopy} creates temporary files to do its translations and
1038 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1039 translation work; it has access to all the formats described in @sc{bfd}
1040 and thus is able to recognize most formats without being told
1041 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1043 @command{objcopy} can be used to generate S-records by using an output
1044 target of @samp{srec} (e.g., use @samp{-O srec}).
1046 @command{objcopy} can be used to generate a raw binary file by using an
1047 output target of @samp{binary} (e.g., use @option{-O binary}). When
1048 @command{objcopy} generates a raw binary file, it will essentially produce
1049 a memory dump of the contents of the input object file. All symbols and
1050 relocation information will be discarded. The memory dump will start at
1051 the load address of the lowest section copied into the output file.
1053 When generating an S-record or a raw binary file, it may be helpful to
1054 use @option{-S} to remove sections containing debugging information. In
1055 some cases @option{-R} will be useful to remove sections which contain
1056 information that is not needed by the binary file.
1058 Note---@command{objcopy} is not able to change the endianness of its input
1059 files. If the input format has an endianness (some formats do not),
1060 @command{objcopy} can only copy the inputs into file formats that have the
1061 same endianness or which have no endianness (e.g., @samp{srec}).
1062 (However, see the @option{--reverse-bytes} option.)
1066 @c man begin OPTIONS objcopy
1070 @itemx @var{outfile}
1071 The input and output files, respectively.
1072 If you do not specify @var{outfile}, @command{objcopy} creates a
1073 temporary file and destructively renames the result with
1074 the name of @var{infile}.
1076 @item -I @var{bfdname}
1077 @itemx --input-target=@var{bfdname}
1078 Consider the source file's object format to be @var{bfdname}, rather than
1079 attempting to deduce it. @xref{Target Selection}, for more information.
1081 @item -O @var{bfdname}
1082 @itemx --output-target=@var{bfdname}
1083 Write the output file using the object format @var{bfdname}.
1084 @xref{Target Selection}, for more information.
1086 @item -F @var{bfdname}
1087 @itemx --target=@var{bfdname}
1088 Use @var{bfdname} as the object format for both the input and the output
1089 file; i.e., simply transfer data from source to destination with no
1090 translation. @xref{Target Selection}, for more information.
1092 @item -B @var{bfdarch}
1093 @itemx --binary-architecture=@var{bfdarch}
1094 Useful when transforming a raw binary input file into an object file.
1095 In this case the output architecture can be set to @var{bfdarch}. This
1096 option will be ignored if the input file has a known @var{bfdarch}. You
1097 can access this binary data inside a program by referencing the special
1098 symbols that are created by the conversion process. These symbols are
1099 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1100 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1101 an object file and then access it in your code using these symbols.
1103 @item -j @var{sectionname}
1104 @itemx --only-section=@var{sectionname}
1105 Copy only the named section from the input file to the output file.
1106 This option may be given more than once. Note that using this option
1107 inappropriately may make the output file unusable.
1109 @item -R @var{sectionname}
1110 @itemx --remove-section=@var{sectionname}
1111 Remove any section named @var{sectionname} from the output file. This
1112 option may be given more than once. Note that using this option
1113 inappropriately may make the output file unusable.
1117 Do not copy relocation and symbol information from the source file.
1120 @itemx --strip-debug
1121 Do not copy debugging symbols or sections from the source file.
1123 @item --strip-unneeded
1124 Strip all symbols that are not needed for relocation processing.
1126 @item -K @var{symbolname}
1127 @itemx --keep-symbol=@var{symbolname}
1128 When stripping symbols, keep symbol @var{symbolname} even if it would
1129 normally be stripped. This option may be given more than once.
1131 @item -N @var{symbolname}
1132 @itemx --strip-symbol=@var{symbolname}
1133 Do not copy symbol @var{symbolname} from the source file. This option
1134 may be given more than once.
1136 @item --strip-unneeded-symbol=@var{symbolname}
1137 Do not copy symbol @var{symbolname} from the source file unless it is needed
1138 by a relocation. This option may be given more than once.
1140 @item -G @var{symbolname}
1141 @itemx --keep-global-symbol=@var{symbolname}
1142 Keep only symbol @var{symbolname} global. Make all other symbols local
1143 to the file, so that they are not visible externally. This option may
1144 be given more than once.
1146 @item --localize-hidden
1147 In an ELF object, mark all symbols that have hidden or internal visibility
1148 as local. This option applies on top of symbol-specific localization options
1149 such as @option{-L}.
1151 @item -L @var{symbolname}
1152 @itemx --localize-symbol=@var{symbolname}
1153 Make symbol @var{symbolname} local to the file, so that it is not
1154 visible externally. This option may be given more than once.
1156 @item -W @var{symbolname}
1157 @itemx --weaken-symbol=@var{symbolname}
1158 Make symbol @var{symbolname} weak. This option may be given more than once.
1160 @item --globalize-symbol=@var{symbolname}
1161 Give symbol @var{symbolname} global scoping so that it is visible
1162 outside of the file in which it is defined. This option may be given
1167 Permit regular expressions in @var{symbolname}s used in other command
1168 line options. The question mark (?), asterisk (*), backslash (\) and
1169 square brackets ([]) operators can be used anywhere in the symbol
1170 name. If the first character of the symbol name is the exclamation
1171 point (!) then the sense of the switch is reversed for that symbol.
1178 would cause objcopy to weaken all symbols that start with ``fo''
1179 except for the symbol ``foo''.
1182 @itemx --discard-all
1183 Do not copy non-global symbols from the source file.
1184 @c FIXME any reason to prefer "non-global" to "local" here?
1187 @itemx --discard-locals
1188 Do not copy compiler-generated local symbols.
1189 (These usually start with @samp{L} or @samp{.}.)
1192 @itemx --byte=@var{byte}
1193 Keep only every @var{byte}th byte of the input file (header data is not
1194 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
1195 where @var{interleave} is given by the @option{-i} or @option{--interleave}
1196 option, or the default of 4. This option is useful for creating files
1197 to program @sc{rom}. It is typically used with an @code{srec} output
1200 @item -i @var{interleave}
1201 @itemx --interleave=@var{interleave}
1202 Only copy one out of every @var{interleave} bytes. Select which byte to
1203 copy with the @option{-b} or @option{--byte} option. The default is 4.
1204 @command{objcopy} ignores this option if you do not specify either @option{-b} or
1208 @itemx --preserve-dates
1209 Set the access and modification dates of the output file to be the same
1210 as those of the input file.
1213 Convert debugging information, if possible. This is not the default
1214 because only certain debugging formats are supported, and the
1215 conversion process can be time consuming.
1217 @item --gap-fill @var{val}
1218 Fill gaps between sections with @var{val}. This operation applies to
1219 the @emph{load address} (LMA) of the sections. It is done by increasing
1220 the size of the section with the lower address, and filling in the extra
1221 space created with @var{val}.
1223 @item --pad-to @var{address}
1224 Pad the output file up to the load address @var{address}. This is
1225 done by increasing the size of the last section. The extra space is
1226 filled in with the value specified by @option{--gap-fill} (default zero).
1228 @item --set-start @var{val}
1229 Set the start address of the new file to @var{val}. Not all object file
1230 formats support setting the start address.
1232 @item --change-start @var{incr}
1233 @itemx --adjust-start @var{incr}
1234 @cindex changing start address
1235 Change the start address by adding @var{incr}. Not all object file
1236 formats support setting the start address.
1238 @item --change-addresses @var{incr}
1239 @itemx --adjust-vma @var{incr}
1240 @cindex changing object addresses
1241 Change the VMA and LMA addresses of all sections, as well as the start
1242 address, by adding @var{incr}. Some object file formats do not permit
1243 section addresses to be changed arbitrarily. Note that this does not
1244 relocate the sections; if the program expects sections to be loaded at a
1245 certain address, and this option is used to change the sections such
1246 that they are loaded at a different address, the program may fail.
1248 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1249 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1250 @cindex changing section address
1251 Set or change both the VMA address and the LMA address of the named
1252 @var{section}. If @samp{=} is used, the section address is set to
1253 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1254 section address. See the comments under @option{--change-addresses},
1255 above. If @var{section} does not exist in the input file, a warning will
1256 be issued, unless @option{--no-change-warnings} is used.
1258 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1259 @cindex changing section LMA
1260 Set or change the LMA address of the named @var{section}. The LMA
1261 address is the address where the section will be loaded into memory at
1262 program load time. Normally this is the same as the VMA address, which
1263 is the address of the section at program run time, but on some systems,
1264 especially those where a program is held in ROM, the two can be
1265 different. If @samp{=} is used, the section address is set to
1266 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1267 section address. See the comments under @option{--change-addresses},
1268 above. If @var{section} does not exist in the input file, a warning
1269 will be issued, unless @option{--no-change-warnings} is used.
1271 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1272 @cindex changing section VMA
1273 Set or change the VMA address of the named @var{section}. The VMA
1274 address is the address where the section will be located once the
1275 program has started executing. Normally this is the same as the LMA
1276 address, which is the address where the section will be loaded into
1277 memory, but on some systems, especially those where a program is held in
1278 ROM, the two can be different. If @samp{=} is used, the section address
1279 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1280 from the section address. See the comments under
1281 @option{--change-addresses}, above. If @var{section} does not exist in
1282 the input file, a warning will be issued, unless
1283 @option{--no-change-warnings} is used.
1285 @item --change-warnings
1286 @itemx --adjust-warnings
1287 If @option{--change-section-address} or @option{--change-section-lma} or
1288 @option{--change-section-vma} is used, and the named section does not
1289 exist, issue a warning. This is the default.
1291 @item --no-change-warnings
1292 @itemx --no-adjust-warnings
1293 Do not issue a warning if @option{--change-section-address} or
1294 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1295 if the named section does not exist.
1297 @item --set-section-flags @var{section}=@var{flags}
1298 Set the flags for the named section. The @var{flags} argument is a
1299 comma separated string of flag names. The recognized names are
1300 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1301 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1302 @samp{debug}. You can set the @samp{contents} flag for a section which
1303 does not have contents, but it is not meaningful to clear the
1304 @samp{contents} flag of a section which does have contents--just remove
1305 the section instead. Not all flags are meaningful for all object file
1308 @item --add-section @var{sectionname}=@var{filename}
1309 Add a new section named @var{sectionname} while copying the file. The
1310 contents of the new section are taken from the file @var{filename}. The
1311 size of the section will be the size of the file. This option only
1312 works on file formats which can support sections with arbitrary names.
1314 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1315 Rename a section from @var{oldname} to @var{newname}, optionally
1316 changing the section's flags to @var{flags} in the process. This has
1317 the advantage over usng a linker script to perform the rename in that
1318 the output stays as an object file and does not become a linked
1321 This option is particularly helpful when the input format is binary,
1322 since this will always create a section called .data. If for example,
1323 you wanted instead to create a section called .rodata containing binary
1324 data you could use the following command line to achieve it:
1327 objcopy -I binary -O <output_format> -B <architecture> \
1328 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1329 <input_binary_file> <output_object_file>
1332 @item --change-leading-char
1333 Some object file formats use special characters at the start of
1334 symbols. The most common such character is underscore, which compilers
1335 often add before every symbol. This option tells @command{objcopy} to
1336 change the leading character of every symbol when it converts between
1337 object file formats. If the object file formats use the same leading
1338 character, this option has no effect. Otherwise, it will add a
1339 character, or remove a character, or change a character, as
1342 @item --remove-leading-char
1343 If the first character of a global symbol is a special symbol leading
1344 character used by the object file format, remove the character. The
1345 most common symbol leading character is underscore. This option will
1346 remove a leading underscore from all global symbols. This can be useful
1347 if you want to link together objects of different file formats with
1348 different conventions for symbol names. This is different from
1349 @option{--change-leading-char} because it always changes the symbol name
1350 when appropriate, regardless of the object file format of the output
1353 @item --reverse-bytes=@var{num}
1354 Reverse the bytes in a section with output contents. A section length must
1355 be evenly divisible by the value given in order for the swap to be able to
1356 take place. Reversing takes place before the interleaving is performed.
1358 This option is used typically in generating ROM images for problematic
1359 target systems. For example, on some target boards, the 32-bit words
1360 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1361 regardless of the CPU byte order. Depending on the programming model, the
1362 endianness of the ROM may need to be modified.
1364 Consider a simple file with a section containing the following eight
1365 bytes: @code{12345678}.
1367 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1368 output file would be ordered @code{21436587}.
1370 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1371 output file would be ordered @code{43218765}.
1373 By using @samp{--reverse-bytes=2} for the above example, followed by
1374 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1375 output file would be ordered @code{34127856}.
1377 @item --srec-len=@var{ival}
1378 Meaningful only for srec output. Set the maximum length of the Srecords
1379 being produced to @var{ival}. This length covers both address, data and
1382 @item --srec-forceS3
1383 Meaningful only for srec output. Avoid generation of S1/S2 records,
1384 creating S3-only record format.
1386 @item --redefine-sym @var{old}=@var{new}
1387 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1388 when one is trying link two things together for which you have no
1389 source, and there are name collisions.
1391 @item --redefine-syms=@var{filename}
1392 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1393 listed in the file @var{filename}. @var{filename} is simply a flat file,
1394 with one symbol pair per line. Line comments may be introduced by the hash
1395 character. This option may be given more than once.
1398 Change all global symbols in the file to be weak. This can be useful
1399 when building an object which will be linked against other objects using
1400 the @option{-R} option to the linker. This option is only effective when
1401 using an object file format which supports weak symbols.
1403 @item --keep-symbols=@var{filename}
1404 Apply @option{--keep-symbol} option to each symbol listed in the file
1405 @var{filename}. @var{filename} is simply a flat file, with one symbol
1406 name per line. Line comments may be introduced by the hash character.
1407 This option may be given more than once.
1409 @item --strip-symbols=@var{filename}
1410 Apply @option{--strip-symbol} option to each symbol listed in the file
1411 @var{filename}. @var{filename} is simply a flat file, with one symbol
1412 name per line. Line comments may be introduced by the hash character.
1413 This option may be given more than once.
1415 @item --strip-unneeded-symbols=@var{filename}
1416 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1417 the file @var{filename}. @var{filename} is simply a flat file, with one
1418 symbol name per line. Line comments may be introduced by the hash
1419 character. This option may be given more than once.
1421 @item --keep-global-symbols=@var{filename}
1422 Apply @option{--keep-global-symbol} option to each symbol listed in the
1423 file @var{filename}. @var{filename} is simply a flat file, with one
1424 symbol name per line. Line comments may be introduced by the hash
1425 character. This option may be given more than once.
1427 @item --localize-symbols=@var{filename}
1428 Apply @option{--localize-symbol} option to each symbol listed in the file
1429 @var{filename}. @var{filename} is simply a flat file, with one symbol
1430 name per line. Line comments may be introduced by the hash character.
1431 This option may be given more than once.
1433 @item --globalize-symbols=@var{filename}
1434 Apply @option{--globalize-symbol} option to each symbol listed in the file
1435 @var{filename}. @var{filename} is simply a flat file, with one symbol
1436 name per line. Line comments may be introduced by the hash character.
1437 This option may be given more than once.
1439 @item --weaken-symbols=@var{filename}
1440 Apply @option{--weaken-symbol} option to each symbol listed in the file
1441 @var{filename}. @var{filename} is simply a flat file, with one symbol
1442 name per line. Line comments may be introduced by the hash character.
1443 This option may be given more than once.
1445 @item --alt-machine-code=@var{index}
1446 If the output architecture has alternate machine codes, use the
1447 @var{index}th code instead of the default one. This is useful in case
1448 a machine is assigned an official code and the tool-chain adopts the
1449 new code, but other applications still depend on the original code
1450 being used. For ELF based architectures if the @var{index}
1451 alternative does not exist then the value is treated as an absolute
1452 number to be stored in the e_machine field of the ELF header.
1454 @item --writable-text
1455 Mark the output text as writable. This option isn't meaningful for all
1456 object file formats.
1458 @item --readonly-text
1459 Make the output text write protected. This option isn't meaningful for all
1460 object file formats.
1463 Mark the output file as demand paged. This option isn't meaningful for all
1464 object file formats.
1467 Mark the output file as impure. This option isn't meaningful for all
1468 object file formats.
1470 @item --prefix-symbols=@var{string}
1471 Prefix all symbols in the output file with @var{string}.
1473 @item --prefix-sections=@var{string}
1474 Prefix all section names in the output file with @var{string}.
1476 @item --prefix-alloc-sections=@var{string}
1477 Prefix all the names of all allocated sections in the output file with
1480 @item --add-gnu-debuglink=@var{path-to-file}
1481 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1482 and adds it to the output file.
1484 @item --keep-file-symbols
1485 When stripping a file, perhaps with @option{--strip-debug} or
1486 @option{--strip-unneeded}, retain any symbols specifying source file names,
1487 which would otherwise get stripped.
1489 @item --only-keep-debug
1490 Strip a file, removing contents of any sections that would not be
1491 stripped by @option{--strip-debug} and leaving the debugging sections
1492 intact. In ELF files, this preserves all note sections in the output.
1494 The intention is that this option will be used in conjunction with
1495 @option{--add-gnu-debuglink} to create a two part executable. One a
1496 stripped binary which will occupy less space in RAM and in a
1497 distribution and the second a debugging information file which is only
1498 needed if debugging abilities are required. The suggested procedure
1499 to create these files is as follows:
1502 @item Link the executable as normal. Assuming that is is called
1504 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1505 create a file containing the debugging info.
1506 @item Run @code{objcopy --strip-debug foo} to create a
1507 stripped executable.
1508 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1509 to add a link to the debugging info into the stripped executable.
1512 Note---the choice of @code{.dbg} as an extension for the debug info
1513 file is arbitrary. Also the @code{--only-keep-debug} step is
1514 optional. You could instead do this:
1517 @item Link the executable as normal.
1518 @item Copy @code{foo} to @code{foo.full}
1519 @item Run @code{objcopy --strip-debug foo}
1520 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1523 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1524 full executable. It does not have to be a file created by the
1525 @option{--only-keep-debug} switch.
1527 Note---this switch is only intended for use on fully linked files. It
1528 does not make sense to use it on object files where the debugging
1529 information may be incomplete. Besides the gnu_debuglink feature
1530 currently only supports the presence of one filename containing
1531 debugging information, not multiple filenames on a one-per-object-file
1534 @item --extract-symbol
1535 Keep the file's section flags and symbols but remove all section data.
1536 Specifically, the option:
1539 @item removes the contents of all sections;
1540 @item sets the size of every section to zero; and
1541 @item sets the file's start address to zero.
1544 This option is used to build a @file{.sym} file for a VxWorks kernel.
1545 It can also be a useful way of reducing the size of a @option{--just-symbols}
1550 Show the version number of @command{objcopy}.
1554 Verbose output: list all object files modified. In the case of
1555 archives, @samp{objcopy -V} lists all members of the archive.
1558 Show a summary of the options to @command{objcopy}.
1561 Display a list showing all architectures and object formats available.
1567 @c man begin SEEALSO objcopy
1568 ld(1), objdump(1), and the Info entries for @file{binutils}.
1575 @cindex object file information
1578 @c man title objdump display information from object files.
1581 @c man begin SYNOPSIS objdump
1582 objdump [@option{-a}|@option{--archive-headers}]
1583 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1584 [@option{-C}|@option{--demangle}[=@var{style}] ]
1585 [@option{-d}|@option{--disassemble}]
1586 [@option{-D}|@option{--disassemble-all}]
1587 [@option{-z}|@option{--disassemble-zeroes}]
1588 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1589 [@option{-f}|@option{--file-headers}]
1590 [@option{-F}|@option{--file-offsets}]
1591 [@option{--file-start-context}]
1592 [@option{-g}|@option{--debugging}]
1593 [@option{-e}|@option{--debugging-tags}]
1594 [@option{-h}|@option{--section-headers}|@option{--headers}]
1595 [@option{-i}|@option{--info}]
1596 [@option{-j} @var{section}|@option{--section=}@var{section}]
1597 [@option{-l}|@option{--line-numbers}]
1598 [@option{-S}|@option{--source}]
1599 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1600 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1601 [@option{-p}|@option{--private-headers}]
1602 [@option{-r}|@option{--reloc}]
1603 [@option{-R}|@option{--dynamic-reloc}]
1604 [@option{-s}|@option{--full-contents}]
1605 [@option{-W}|@option{--dwarf}]
1606 [@option{-G}|@option{--stabs}]
1607 [@option{-t}|@option{--syms}]
1608 [@option{-T}|@option{--dynamic-syms}]
1609 [@option{-x}|@option{--all-headers}]
1610 [@option{-w}|@option{--wide}]
1611 [@option{--start-address=}@var{address}]
1612 [@option{--stop-address=}@var{address}]
1613 [@option{--prefix-addresses}]
1614 [@option{--[no-]show-raw-insn}]
1615 [@option{--adjust-vma=}@var{offset}]
1616 [@option{--special-syms}]
1617 [@option{-V}|@option{--version}]
1618 [@option{-H}|@option{--help}]
1619 @var{objfile}@dots{}
1623 @c man begin DESCRIPTION objdump
1625 @command{objdump} displays information about one or more object files.
1626 The options control what particular information to display. This
1627 information is mostly useful to programmers who are working on the
1628 compilation tools, as opposed to programmers who just want their
1629 program to compile and work.
1631 @var{objfile}@dots{} are the object files to be examined. When you
1632 specify archives, @command{objdump} shows information on each of the member
1637 @c man begin OPTIONS objdump
1639 The long and short forms of options, shown here as alternatives, are
1640 equivalent. At least one option from the list
1641 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1645 @itemx --archive-header
1646 @cindex archive headers
1647 If any of the @var{objfile} files are archives, display the archive
1648 header information (in a format similar to @samp{ls -l}). Besides the
1649 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1650 the object file format of each archive member.
1652 @item --adjust-vma=@var{offset}
1653 @cindex section addresses in objdump
1654 @cindex VMA in objdump
1655 When dumping information, first add @var{offset} to all the section
1656 addresses. This is useful if the section addresses do not correspond to
1657 the symbol table, which can happen when putting sections at particular
1658 addresses when using a format which can not represent section addresses,
1661 @item -b @var{bfdname}
1662 @itemx --target=@var{bfdname}
1663 @cindex object code format
1664 Specify that the object-code format for the object files is
1665 @var{bfdname}. This option may not be necessary; @var{objdump} can
1666 automatically recognize many formats.
1670 objdump -b oasys -m vax -h fu.o
1673 displays summary information from the section headers (@option{-h}) of
1674 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1675 file in the format produced by Oasys compilers. You can list the
1676 formats available with the @option{-i} option.
1677 @xref{Target Selection}, for more information.
1680 @itemx --demangle[=@var{style}]
1681 @cindex demangling in objdump
1682 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1683 Besides removing any initial underscore prepended by the system, this
1684 makes C++ function names readable. Different compilers have different
1685 mangling styles. The optional demangling style argument can be used to
1686 choose an appropriate demangling style for your compiler. @xref{c++filt},
1687 for more information on demangling.
1691 Display debugging information. This attempts to parse STABS and IEEE
1692 debugging format information stored in the file and print it out using
1693 a C like syntax. If neither of these formats are found this option
1694 falls back on the @option{-W} option to print any DWARF information in
1698 @itemx --debugging-tags
1699 Like @option{-g}, but the information is generated in a format compatible
1703 @itemx --disassemble
1704 @cindex disassembling object code
1705 @cindex machine instructions
1706 Display the assembler mnemonics for the machine instructions from
1707 @var{objfile}. This option only disassembles those sections which are
1708 expected to contain instructions.
1711 @itemx --disassemble-all
1712 Like @option{-d}, but disassemble the contents of all sections, not just
1713 those expected to contain instructions.
1715 @item --prefix-addresses
1716 When disassembling, print the complete address on each line. This is
1717 the older disassembly format.
1721 @itemx --endian=@{big|little@}
1723 @cindex disassembly endianness
1724 Specify the endianness of the object files. This only affects
1725 disassembly. This can be useful when disassembling a file format which
1726 does not describe endianness information, such as S-records.
1729 @itemx --file-headers
1730 @cindex object file header
1731 Display summary information from the overall header of
1732 each of the @var{objfile} files.
1735 @itemx --file-offsets
1736 @cindex object file offsets
1737 When disassembling sections, whenever a symbol is displayed, also
1738 display the file offset of the region of data that is about to be
1739 dumped. If zeroes are being skipped, then when disassembly resumes,
1740 tell the user how many zeroes were skipped and the file offset of the
1741 location from where the disassembly resumes. When dumping sections,
1742 display the file offset of the location from where the dump starts.
1744 @item --file-start-context
1745 @cindex source code context
1746 Specify that when displaying interlisted source code/disassembly
1747 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1748 context to the start of the file.
1751 @itemx --section-headers
1753 @cindex section headers
1754 Display summary information from the section headers of the
1757 File segments may be relocated to nonstandard addresses, for example by
1758 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1759 @command{ld}. However, some object file formats, such as a.out, do not
1760 store the starting address of the file segments. In those situations,
1761 although @command{ld} relocates the sections correctly, using @samp{objdump
1762 -h} to list the file section headers cannot show the correct addresses.
1763 Instead, it shows the usual addresses, which are implicit for the
1768 Print a summary of the options to @command{objdump} and exit.
1772 @cindex architectures available
1773 @cindex object formats available
1774 Display a list showing all architectures and object formats available
1775 for specification with @option{-b} or @option{-m}.
1778 @itemx --section=@var{name}
1779 @cindex section information
1780 Display information only for section @var{name}.
1783 @itemx --line-numbers
1784 @cindex source filenames for object files
1785 Label the display (using debugging information) with the filename and
1786 source line numbers corresponding to the object code or relocs shown.
1787 Only useful with @option{-d}, @option{-D}, or @option{-r}.
1789 @item -m @var{machine}
1790 @itemx --architecture=@var{machine}
1791 @cindex architecture
1792 @cindex disassembly architecture
1793 Specify the architecture to use when disassembling object files. This
1794 can be useful when disassembling object files which do not describe
1795 architecture information, such as S-records. You can list the available
1796 architectures with the @option{-i} option.
1798 @item -M @var{options}
1799 @itemx --disassembler-options=@var{options}
1800 Pass target specific information to the disassembler. Only supported on
1801 some targets. If it is necessary to specify more than one
1802 disassembler option then multiple @option{-M} options can be used or
1803 can be placed together into a comma separated list.
1805 If the target is an ARM architecture then this switch can be used to
1806 select which register name set is used during disassembler. Specifying
1807 @option{-M reg-names-std} (the default) will select the register names as
1808 used in ARM's instruction set documentation, but with register 13 called
1809 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
1810 @option{-M reg-names-apcs} will select the name set used by the ARM
1811 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
1812 just use @samp{r} followed by the register number.
1814 There are also two variants on the APCS register naming scheme enabled
1815 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
1816 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
1817 with the normal register names or the special register names).
1819 This option can also be used for ARM architectures to force the
1820 disassembler to interpret all instructions as Thumb instructions by
1821 using the switch @option{--disassembler-options=force-thumb}. This can be
1822 useful when attempting to disassemble thumb code produced by other
1825 For the x86, some of the options duplicate functions of the @option{-m}
1826 switch, but allow finer grained control. Multiple selections from the
1827 following may be specified as a comma separated string.
1828 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
1829 the given architecture. @option{intel} and @option{att} select between
1830 intel syntax mode and AT&T syntax mode.
1831 @option{intel-mnemonic} and @option{att-mnemonic} select between
1832 intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic}
1833 implies @option{intel} and @option{att-mnemonic} implies @option{att}.
1834 @option{addr64}, @option{addr32},
1835 @option{addr16}, @option{data32} and @option{data16} specify the default
1836 address size and operand size. These four options will be overridden if
1837 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
1838 option string. Lastly, @option{suffix}, when in AT&T mode,
1839 instructs the disassembler to print a mnemonic suffix even when the
1840 suffix could be inferred by the operands.
1842 For PowerPC, @option{booke} controls the disassembly of BookE
1843 instructions. @option{32} and @option{64} select PowerPC and
1844 PowerPC64 disassembly, respectively. @option{e300} selects
1845 disassembly for the e300 family. @option{440} selects disassembly for
1846 the PowerPC 440. @option{ppcps} selects disassembly for the paired
1847 single instructions of the PPC750CL.
1849 For MIPS, this option controls the printing of instruction mnemonic
1850 names and register names in disassembled instructions. Multiple
1851 selections from the following may be specified as a comma separated
1852 string, and invalid options are ignored:
1856 Print the 'raw' instruction mnemonic instead of some pseudo
1857 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
1858 'sll' instead of 'nop', etc.
1860 @item gpr-names=@var{ABI}
1861 Print GPR (general-purpose register) names as appropriate
1862 for the specified ABI. By default, GPR names are selected according to
1863 the ABI of the binary being disassembled.
1865 @item fpr-names=@var{ABI}
1866 Print FPR (floating-point register) names as
1867 appropriate for the specified ABI. By default, FPR numbers are printed
1870 @item cp0-names=@var{ARCH}
1871 Print CP0 (system control coprocessor; coprocessor 0) register names
1872 as appropriate for the CPU or architecture specified by
1873 @var{ARCH}. By default, CP0 register names are selected according to
1874 the architecture and CPU of the binary being disassembled.
1876 @item hwr-names=@var{ARCH}
1877 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
1878 as appropriate for the CPU or architecture specified by
1879 @var{ARCH}. By default, HWR names are selected according to
1880 the architecture and CPU of the binary being disassembled.
1882 @item reg-names=@var{ABI}
1883 Print GPR and FPR names as appropriate for the selected ABI.
1885 @item reg-names=@var{ARCH}
1886 Print CPU-specific register names (CP0 register and HWR names)
1887 as appropriate for the selected CPU or architecture.
1890 For any of the options listed above, @var{ABI} or
1891 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
1892 rather than names, for the selected types of registers.
1893 You can list the available values of @var{ABI} and @var{ARCH} using
1894 the @option{--help} option.
1896 For VAX, you can specify function entry addresses with @option{-M
1897 entry:0xf00ba}. You can use this multiple times to properly
1898 disassemble VAX binary files that don't contain symbol tables (like
1899 ROM dumps). In these cases, the function entry mask would otherwise
1900 be decoded as VAX instructions, which would probably lead the rest
1901 of the function being wrongly disassembled.
1904 @itemx --private-headers
1905 Print information that is specific to the object file format. The exact
1906 information printed depends upon the object file format. For some
1907 object file formats, no additional information is printed.
1911 @cindex relocation entries, in object file
1912 Print the relocation entries of the file. If used with @option{-d} or
1913 @option{-D}, the relocations are printed interspersed with the
1917 @itemx --dynamic-reloc
1918 @cindex dynamic relocation entries, in object file
1919 Print the dynamic relocation entries of the file. This is only
1920 meaningful for dynamic objects, such as certain types of shared
1924 @itemx --full-contents
1925 @cindex sections, full contents
1926 @cindex object file sections
1927 Display the full contents of any sections requested. By default all
1928 non-empty sections are displayed.
1932 @cindex source disassembly
1933 @cindex disassembly, with source
1934 Display source code intermixed with disassembly, if possible. Implies
1937 @item --show-raw-insn
1938 When disassembling instructions, print the instruction in hex as well as
1939 in symbolic form. This is the default except when
1940 @option{--prefix-addresses} is used.
1942 @item --no-show-raw-insn
1943 When disassembling instructions, do not print the instruction bytes.
1944 This is the default when @option{--prefix-addresses} is used.
1949 @cindex debug symbols
1950 Displays the contents of the DWARF debug sections in the file, if any
1957 @cindex debug symbols
1958 @cindex ELF object file format
1959 Display the full contents of any sections requested. Display the
1960 contents of the .stab and .stab.index and .stab.excl sections from an
1961 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1962 @code{.stab} debugging symbol-table entries are carried in an ELF
1963 section. In most other file formats, debugging symbol-table entries are
1964 interleaved with linkage symbols, and are visible in the @option{--syms}
1967 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1968 Overview,stabs.info, The ``stabs'' debug format}.
1971 @item --start-address=@var{address}
1972 @cindex start-address
1973 Start displaying data at the specified address. This affects the output
1974 of the @option{-d}, @option{-r} and @option{-s} options.
1976 @item --stop-address=@var{address}
1977 @cindex stop-address
1978 Stop displaying data at the specified address. This affects the output
1979 of the @option{-d}, @option{-r} and @option{-s} options.
1983 @cindex symbol table entries, printing
1984 Print the symbol table entries of the file.
1985 This is similar to the information provided by the @samp{nm} program,
1986 although the display format is different. The format of the output
1987 depends upon the format of the file being dumped, but there are two main
1988 types. One looks like this:
1991 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
1992 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
1995 where the number inside the square brackets is the number of the entry
1996 in the symbol table, the @var{sec} number is the section number, the
1997 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
1998 symbol's type, the @var{scl} number is the symbol's storage class and
1999 the @var{nx} value is the number of auxilary entries associated with
2000 the symbol. The last two fields are the symbol's value and its name.
2002 The other common output format, usually seen with ELF based files,
2006 00000000 l d .bss 00000000 .bss
2007 00000000 g .text 00000000 fred
2010 Here the first number is the symbol's value (sometimes refered to as
2011 its address). The next field is actually a set of characters and
2012 spaces indicating the flag bits that are set on the symbol. These
2013 characters are described below. Next is the section with which the
2014 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2015 not connected with any section), or @emph{*UND*} if the section is
2016 referenced in the file being dumped, but not defined there.
2018 After the section name comes another field, a number, which for common
2019 symbols is the alignment and for other symbol is the size. Finally
2020 the symbol's name is displayed.
2022 The flag characters are divided into 7 groups as follows:
2027 The symbol is local (l), global (g), neither (a space) or both (!). A
2028 symbol can be neither local or global for a variety of reasons, e.g.,
2029 because it is used for debugging, but it is probably an indication of
2030 a bug if it is ever both local and global.
2033 The symbol is weak (w) or strong (a space).
2036 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2039 The symbol is a warning (W) or a normal symbol (a space). A warning
2040 symbol's name is a message to be displayed if the symbol following the
2041 warning symbol is ever referenced.
2045 The symbol is an indirect reference to another symbol (I), a function
2046 to be evaluated during reloc processing (i) or a normal symbol (a
2051 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2052 normal symbol (a space).
2057 The symbol is the name of a function (F) or a file (f) or an object
2058 (O) or just a normal symbol (a space).
2062 @itemx --dynamic-syms
2063 @cindex dynamic symbol table entries, printing
2064 Print the dynamic symbol table entries of the file. This is only
2065 meaningful for dynamic objects, such as certain types of shared
2066 libraries. This is similar to the information provided by the @samp{nm}
2067 program when given the @option{-D} (@option{--dynamic}) option.
2069 @item --special-syms
2070 When displaying symbols include those which the target considers to be
2071 special in some way and which would not normally be of interest to the
2076 Print the version number of @command{objdump} and exit.
2079 @itemx --all-headers
2080 @cindex all header information, object file
2081 @cindex header information, all
2082 Display all available header information, including the symbol table and
2083 relocation entries. Using @option{-x} is equivalent to specifying all of
2084 @option{-a -f -h -p -r -t}.
2088 @cindex wide output, printing
2089 Format some lines for output devices that have more than 80 columns.
2090 Also do not truncate symbol names when they are displayed.
2093 @itemx --disassemble-zeroes
2094 Normally the disassembly output will skip blocks of zeroes. This
2095 option directs the disassembler to disassemble those blocks, just like
2102 @c man begin SEEALSO objdump
2103 nm(1), readelf(1), and the Info entries for @file{binutils}.
2111 @cindex archive contents
2112 @cindex symbol index
2114 @c man title ranlib generate index to archive.
2117 @c man begin SYNOPSIS ranlib
2118 ranlib [@option{-vVt}] @var{archive}
2122 @c man begin DESCRIPTION ranlib
2124 @command{ranlib} generates an index to the contents of an archive and
2125 stores it in the archive. The index lists each symbol defined by a
2126 member of an archive that is a relocatable object file.
2128 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2130 An archive with such an index speeds up linking to the library and
2131 allows routines in the library to call each other without regard to
2132 their placement in the archive.
2134 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2135 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2140 @c man begin OPTIONS ranlib
2146 Show the version number of @command{ranlib}.
2149 Update the timestamp of the symbol map of an archive.
2155 @c man begin SEEALSO ranlib
2156 ar(1), nm(1), and the Info entries for @file{binutils}.
2164 @cindex section sizes
2166 @c man title size list section sizes and total size.
2169 @c man begin SYNOPSIS size
2170 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2172 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2174 [@option{-t}|@option{--totals}]
2175 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2176 [@var{objfile}@dots{}]
2180 @c man begin DESCRIPTION size
2182 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2183 size---for each of the object or archive files @var{objfile} in its
2184 argument list. By default, one line of output is generated for each
2185 object file or each module in an archive.
2187 @var{objfile}@dots{} are the object files to be examined.
2188 If none are specified, the file @code{a.out} will be used.
2192 @c man begin OPTIONS size
2194 The command line options have the following meanings:
2199 @itemx --format=@var{compatibility}
2200 @cindex @command{size} display format
2201 Using one of these options, you can choose whether the output from @sc{gnu}
2202 @command{size} resembles output from System V @command{size} (using @option{-A},
2203 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2204 @option{--format=berkeley}). The default is the one-line format similar to
2206 @c Bonus for doc-source readers: you can also say --format=strange (or
2207 @c anything else that starts with 's') for sysv, and --format=boring (or
2208 @c anything else that starts with 'b') for Berkeley.
2210 Here is an example of the Berkeley (default) format of output from
2213 $ size --format=Berkeley ranlib size
2214 text data bss dec hex filename
2215 294880 81920 11592 388392 5ed28 ranlib
2216 294880 81920 11888 388688 5ee50 size
2220 This is the same data, but displayed closer to System V conventions:
2223 $ size --format=SysV ranlib size
2241 Show a summary of acceptable arguments and options.
2246 @itemx --radix=@var{number}
2247 @cindex @command{size} number format
2248 @cindex radix for section sizes
2249 Using one of these options, you can control whether the size of each
2250 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2251 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2252 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2253 values (8, 10, 16) are supported. The total size is always given in two
2254 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2255 octal and hexadecimal if you're using @option{-o}.
2258 Print total size of common symbols in each file. When using Berkeley
2259 format these are included in the bss size.
2263 Show totals of all objects listed (Berkeley format listing mode only).
2265 @item --target=@var{bfdname}
2266 @cindex object code format
2267 Specify that the object-code format for @var{objfile} is
2268 @var{bfdname}. This option may not be necessary; @command{size} can
2269 automatically recognize many formats.
2270 @xref{Target Selection}, for more information.
2274 Display the version number of @command{size}.
2280 @c man begin SEEALSO size
2281 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2288 @cindex listings strings
2289 @cindex printing strings
2290 @cindex strings, printing
2292 @c man title strings print the strings of printable characters in files.
2295 @c man begin SYNOPSIS strings
2296 strings [@option{-afov}] [@option{-}@var{min-len}]
2297 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2298 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2299 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2300 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2301 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2302 [@option{--help}] [@option{--version}] @var{file}@dots{}
2306 @c man begin DESCRIPTION strings
2308 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
2309 character sequences that are at least 4 characters long (or the number
2310 given with the options below) and are followed by an unprintable
2311 character. By default, it only prints the strings from the initialized
2312 and loaded sections of object files; for other types of files, it prints
2313 the strings from the whole file.
2315 @command{strings} is mainly useful for determining the contents of non-text
2320 @c man begin OPTIONS strings
2326 Do not scan only the initialized and loaded sections of object files;
2327 scan the whole files.
2330 @itemx --print-file-name
2331 Print the name of the file before each string.
2334 Print a summary of the program usage on the standard output and exit.
2336 @item -@var{min-len}
2337 @itemx -n @var{min-len}
2338 @itemx --bytes=@var{min-len}
2339 Print sequences of characters that are at least @var{min-len} characters
2340 long, instead of the default 4.
2343 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2344 act like @samp{-t d} instead. Since we can not be compatible with both
2345 ways, we simply chose one.
2347 @item -t @var{radix}
2348 @itemx --radix=@var{radix}
2349 Print the offset within the file before each string. The single
2350 character argument specifies the radix of the offset---@samp{o} for
2351 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2353 @item -e @var{encoding}
2354 @itemx --encoding=@var{encoding}
2355 Select the character encoding of the strings that are to be found.
2356 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2357 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2358 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2359 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2360 littleendian. Useful for finding wide character strings. (@samp{l}
2361 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2363 @item -T @var{bfdname}
2364 @itemx --target=@var{bfdname}
2365 @cindex object code format
2366 Specify an object code format other than your system's default format.
2367 @xref{Target Selection}, for more information.
2371 Print the program version number on the standard output and exit.
2377 @c man begin SEEALSO strings
2378 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2379 and the Info entries for @file{binutils}.
2387 @cindex removing symbols
2388 @cindex discarding symbols
2389 @cindex symbols, discarding
2391 @c man title strip Discard symbols from object files.
2394 @c man begin SYNOPSIS strip
2395 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2396 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2397 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2398 [@option{-s}|@option{--strip-all}]
2399 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2400 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2401 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2402 [@option{-w}|@option{--wildcard}]
2403 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2404 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2405 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2406 [@option{--keep-file-symbols}]
2407 [@option{--only-keep-debug}]
2408 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2409 [@option{--help}] [@option{--info}]
2410 @var{objfile}@dots{}
2414 @c man begin DESCRIPTION strip
2416 @sc{gnu} @command{strip} discards all symbols from object files
2417 @var{objfile}. The list of object files may include archives.
2418 At least one object file must be given.
2420 @command{strip} modifies the files named in its argument,
2421 rather than writing modified copies under different names.
2425 @c man begin OPTIONS strip
2428 @item -F @var{bfdname}
2429 @itemx --target=@var{bfdname}
2430 Treat the original @var{objfile} as a file with the object
2431 code format @var{bfdname}, and rewrite it in the same format.
2432 @xref{Target Selection}, for more information.
2435 Show a summary of the options to @command{strip} and exit.
2438 Display a list showing all architectures and object formats available.
2440 @item -I @var{bfdname}
2441 @itemx --input-target=@var{bfdname}
2442 Treat the original @var{objfile} as a file with the object
2443 code format @var{bfdname}.
2444 @xref{Target Selection}, for more information.
2446 @item -O @var{bfdname}
2447 @itemx --output-target=@var{bfdname}
2448 Replace @var{objfile} with a file in the output format @var{bfdname}.
2449 @xref{Target Selection}, for more information.
2451 @item -R @var{sectionname}
2452 @itemx --remove-section=@var{sectionname}
2453 Remove any section named @var{sectionname} from the output file. This
2454 option may be given more than once. Note that using this option
2455 inappropriately may make the output file unusable.
2464 @itemx --strip-debug
2465 Remove debugging symbols only.
2467 @item --strip-unneeded
2468 Remove all symbols that are not needed for relocation processing.
2470 @item -K @var{symbolname}
2471 @itemx --keep-symbol=@var{symbolname}
2472 When stripping symbols, keep symbol @var{symbolname} even if it would
2473 normally be stripped. This option may be given more than once.
2475 @item -N @var{symbolname}
2476 @itemx --strip-symbol=@var{symbolname}
2477 Remove symbol @var{symbolname} from the source file. This option may be
2478 given more than once, and may be combined with strip options other than
2482 Put the stripped output in @var{file}, rather than replacing the
2483 existing file. When this argument is used, only one @var{objfile}
2484 argument may be specified.
2487 @itemx --preserve-dates
2488 Preserve the access and modification dates of the file.
2492 Permit regular expressions in @var{symbolname}s used in other command
2493 line options. The question mark (?), asterisk (*), backslash (\) and
2494 square brackets ([]) operators can be used anywhere in the symbol
2495 name. If the first character of the symbol name is the exclamation
2496 point (!) then the sense of the switch is reversed for that symbol.
2503 would cause strip to only keep symbols that start with the letters
2504 ``fo'', but to discard the symbol ``foo''.
2507 @itemx --discard-all
2508 Remove non-global symbols.
2511 @itemx --discard-locals
2512 Remove compiler-generated local symbols.
2513 (These usually start with @samp{L} or @samp{.}.)
2515 @item --keep-file-symbols
2516 When stripping a file, perhaps with @option{--strip-debug} or
2517 @option{--strip-unneeded}, retain any symbols specifying source file names,
2518 which would otherwise get stripped.
2520 @item --only-keep-debug
2521 Strip a file, removing contents of any sections that would not be
2522 stripped by @option{--strip-debug} and leaving the debugging sections
2523 intact. In ELF files, this preserves all note sections in the output.
2525 The intention is that this option will be used in conjunction with
2526 @option{--add-gnu-debuglink} to create a two part executable. One a
2527 stripped binary which will occupy less space in RAM and in a
2528 distribution and the second a debugging information file which is only
2529 needed if debugging abilities are required. The suggested procedure
2530 to create these files is as follows:
2533 @item Link the executable as normal. Assuming that is is called
2535 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2536 create a file containing the debugging info.
2537 @item Run @code{objcopy --strip-debug foo} to create a
2538 stripped executable.
2539 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2540 to add a link to the debugging info into the stripped executable.
2543 Note---the choice of @code{.dbg} as an extension for the debug info
2544 file is arbitrary. Also the @code{--only-keep-debug} step is
2545 optional. You could instead do this:
2548 @item Link the executable as normal.
2549 @item Copy @code{foo} to @code{foo.full}
2550 @item Run @code{strip --strip-debug foo}
2551 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2554 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2555 full executable. It does not have to be a file created by the
2556 @option{--only-keep-debug} switch.
2558 Note---this switch is only intended for use on fully linked files. It
2559 does not make sense to use it on object files where the debugging
2560 information may be incomplete. Besides the gnu_debuglink feature
2561 currently only supports the presence of one filename containing
2562 debugging information, not multiple filenames on a one-per-object-file
2567 Show the version number for @command{strip}.
2571 Verbose output: list all object files modified. In the case of
2572 archives, @samp{strip -v} lists all members of the archive.
2578 @c man begin SEEALSO strip
2579 the Info entries for @file{binutils}.
2583 @node c++filt, addr2line, strip, Top
2587 @cindex demangling C++ symbols
2589 @c man title cxxfilt Demangle C++ and Java symbols.
2592 @c man begin SYNOPSIS cxxfilt
2593 c++filt [@option{-_}|@option{--strip-underscores}]
2594 [@option{-n}|@option{--no-strip-underscores}]
2595 [@option{-p}|@option{--no-params}]
2596 [@option{-t}|@option{--types}]
2597 [@option{-i}|@option{--no-verbose}]
2598 [@option{-s} @var{format}|@option{--format=}@var{format}]
2599 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2603 @c man begin DESCRIPTION cxxfilt
2606 The C++ and Java languages provide function overloading, which means
2607 that you can write many functions with the same name, providing that
2608 each function takes parameters of different types. In order to be
2609 able to distinguish these similarly named functions C++ and Java
2610 encode them into a low-level assembler name which uniquely identifies
2611 each different version. This process is known as @dfn{mangling}. The
2613 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2614 MS-DOS this program is named @command{CXXFILT}.}
2615 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2616 names into user-level names so that they can be read.
2618 Every alphanumeric word (consisting of letters, digits, underscores,
2619 dollars, or periods) seen in the input is a potential mangled name.
2620 If the name decodes into a C++ name, the C++ name replaces the
2621 low-level name in the output, otherwise the original word is output.
2622 In this way you can pass an entire assembler source file, containing
2623 mangled names, through @command{c++filt} and see the same source file
2624 containing demangled names.
2626 You can also use @command{c++filt} to decipher individual symbols by
2627 passing them on the command line:
2630 c++filt @var{symbol}
2633 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
2634 names from the standard input instead. All the results are printed on
2635 the standard output. The difference between reading names from the
2636 command line versus reading names from the standard input is that
2637 command line arguments are expected to be just mangled names and no
2638 checking is performed to separate them from surrounding text. Thus
2645 will work and demangle the name to ``f()'' whereas:
2651 will not work. (Note the extra comma at the end of the mangled
2652 name which makes it invalid). This command however will work:
2655 echo _Z1fv, | c++filt -n
2658 and will display ``f(),'', i.e., the demangled name followed by a
2659 trailing comma. This behaviour is because when the names are read
2660 from the standard input it is expected that they might be part of an
2661 assembler source file where there might be extra, extraneous
2662 characters trailing after a mangled name. For example:
2665 .type _Z1fv, @@function
2670 @c man begin OPTIONS cxxfilt
2674 @itemx --strip-underscores
2675 On some systems, both the C and C++ compilers put an underscore in front
2676 of every name. For example, the C name @code{foo} gets the low-level
2677 name @code{_foo}. This option removes the initial underscore. Whether
2678 @command{c++filt} removes the underscore by default is target dependent.
2682 Prints demangled names using Java syntax. The default is to use C++
2686 @itemx --no-strip-underscores
2687 Do not remove the initial underscore.
2691 When demangling the name of a function, do not display the types of
2692 the function's parameters.
2696 Attempt to demangle types as well as function names. This is disabled
2697 by default since mangled types are normally only used internally in
2698 the compiler, and they can be confused with non-mangled names. For example,
2699 a function called ``a'' treated as a mangled type name would be
2700 demangled to ``signed char''.
2704 Do not include implementation details (if any) in the demangled
2707 @item -s @var{format}
2708 @itemx --format=@var{format}
2709 @command{c++filt} can decode various methods of mangling, used by
2710 different compilers. The argument to this option selects which
2715 Automatic selection based on executable (the default method)
2717 the one used by the @sc{gnu} C++ compiler (g++)
2719 the one used by the Lucid compiler (lcc)
2721 the one specified by the C++ Annotated Reference Manual
2723 the one used by the HP compiler (aCC)
2725 the one used by the EDG compiler
2727 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
2729 the one used by the @sc{gnu} Java compiler (gcj)
2731 the one used by the @sc{gnu} Ada compiler (GNAT).
2735 Print a summary of the options to @command{c++filt} and exit.
2738 Print the version number of @command{c++filt} and exit.
2744 @c man begin SEEALSO cxxfilt
2745 the Info entries for @file{binutils}.
2750 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
2751 user interface are subject to change in future releases. In particular,
2752 a command-line option may be required in the future to decode a name
2753 passed as an argument on the command line; in other words,
2756 c++filt @var{symbol}
2760 may in a future release become
2763 c++filt @var{option} @var{symbol}
2771 @cindex address to file name and line number
2773 @c man title addr2line convert addresses into file names and line numbers.
2776 @c man begin SYNOPSIS addr2line
2777 addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
2778 [@option{-C}|@option{--demangle}[=@var{style}]]
2779 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
2780 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
2781 [@option{-i}|@option{--inlines}]
2782 [@option{-j}|@option{--section=}@var{name}]
2783 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
2788 @c man begin DESCRIPTION addr2line
2790 @command{addr2line} translates addresses into file names and line numbers.
2791 Given an address in an executable or an offset in a section of a relocatable
2792 object, it uses the debugging information to figure out which file name and
2793 line number are associated with it.
2795 The executable or relocatable object to use is specified with the @option{-e}
2796 option. The default is the file @file{a.out}. The section in the relocatable
2797 object to use is specified with the @option{-j} option.
2799 @command{addr2line} has two modes of operation.
2801 In the first, hexadecimal addresses are specified on the command line,
2802 and @command{addr2line} displays the file name and line number for each
2805 In the second, @command{addr2line} reads hexadecimal addresses from
2806 standard input, and prints the file name and line number for each
2807 address on standard output. In this mode, @command{addr2line} may be used
2808 in a pipe to convert dynamically chosen addresses.
2810 The format of the output is @samp{FILENAME:LINENO}. The file name and
2811 line number for each address is printed on a separate line. If the
2812 @command{-f} option is used, then each @samp{FILENAME:LINENO} line is
2813 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2814 containing the address.
2816 If the file name or function name can not be determined,
2817 @command{addr2line} will print two question marks in their place. If the
2818 line number can not be determined, @command{addr2line} will print 0.
2822 @c man begin OPTIONS addr2line
2824 The long and short forms of options, shown here as alternatives, are
2828 @item -b @var{bfdname}
2829 @itemx --target=@var{bfdname}
2830 @cindex object code format
2831 Specify that the object-code format for the object files is
2835 @itemx --demangle[=@var{style}]
2836 @cindex demangling in objdump
2837 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2838 Besides removing any initial underscore prepended by the system, this
2839 makes C++ function names readable. Different compilers have different
2840 mangling styles. The optional demangling style argument can be used to
2841 choose an appropriate demangling style for your compiler. @xref{c++filt},
2842 for more information on demangling.
2844 @item -e @var{filename}
2845 @itemx --exe=@var{filename}
2846 Specify the name of the executable for which addresses should be
2847 translated. The default file is @file{a.out}.
2851 Display function names as well as file and line number information.
2855 Display only the base of each file name.
2859 If the address belongs to a function that was inlined, the source
2860 information for all enclosing scopes back to the first non-inlined
2861 function will also be printed. For example, if @code{main} inlines
2862 @code{callee1} which inlines @code{callee2}, and address is from
2863 @code{callee2}, the source information for @code{callee1} and @code{main}
2864 will also be printed.
2868 Read offsets relative to the specified section instead of absolute addresses.
2874 @c man begin SEEALSO addr2line
2875 Info entries for @file{binutils}.
2882 @command{nlmconv} converts a relocatable object file into a NetWare
2886 @command{nlmconv} currently works with @samp{i386} object
2887 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
2888 object files in @sc{elf}, or @code{a.out} format@footnote{
2889 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
2890 format in the Binary File Descriptor library. It has only been tested
2891 with the above formats.}.
2895 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
2896 utilities, since it is only useful for NLM targets.
2899 @c man title nlmconv converts object code into an NLM.
2902 @c man begin SYNOPSIS nlmconv
2903 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
2904 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
2905 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
2906 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
2907 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
2908 @var{infile} @var{outfile}
2912 @c man begin DESCRIPTION nlmconv
2914 @command{nlmconv} converts the relocatable @samp{i386} object file
2915 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
2916 reading @var{headerfile} for NLM header information. For instructions
2917 on writing the NLM command file language used in header files, see the
2918 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
2919 Development and Tools Overview}, which is part of the NLM Software
2920 Developer's Kit (``NLM SDK''), available from Novell, Inc.
2921 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
2924 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
2927 @command{nlmconv} can perform a link step. In other words, you can list
2928 more than one object file for input if you list them in the definitions
2929 file (rather than simply specifying one input file on the command line).
2930 In this case, @command{nlmconv} calls the linker for you.
2934 @c man begin OPTIONS nlmconv
2937 @item -I @var{bfdname}
2938 @itemx --input-target=@var{bfdname}
2939 Object format of the input file. @command{nlmconv} can usually determine
2940 the format of a given file (so no default is necessary).
2941 @xref{Target Selection}, for more information.
2943 @item -O @var{bfdname}
2944 @itemx --output-target=@var{bfdname}
2945 Object format of the output file. @command{nlmconv} infers the output
2946 format based on the input format, e.g. for a @samp{i386} input file the
2947 output format is @samp{nlm32-i386}.
2948 @xref{Target Selection}, for more information.
2950 @item -T @var{headerfile}
2951 @itemx --header-file=@var{headerfile}
2952 Reads @var{headerfile} for NLM header information. For instructions on
2953 writing the NLM command file language used in header files, see@ see the
2954 @samp{linkers} section, of the @cite{NLM Development and Tools
2955 Overview}, which is part of the NLM Software Developer's Kit, available
2960 Displays (on standard error) the linker command line used by @command{nlmconv}.
2962 @item -l @var{linker}
2963 @itemx --linker=@var{linker}
2964 Use @var{linker} for any linking. @var{linker} can be an absolute or a
2969 Prints a usage summary.
2973 Prints the version number for @command{nlmconv}.
2979 @c man begin SEEALSO nlmconv
2980 the Info entries for @file{binutils}.
2987 @command{windmc} may be used to generator Windows message resources.
2990 @emph{Warning:} @command{windmc} is not always built as part of the binary
2991 utilities, since it is only useful for Windows targets.
2994 @c man title windmc generates Windows message resources.
2997 @c man begin SYNOPSIS windres
2998 windmc [options] input-file
3002 @c man begin DESCRIPTION windmc
3004 @command{windmc} reads message definitions from an input file (.mc) and
3005 translate them into a set of output files. The output files may be of
3010 A C header file containing the message definitions.
3013 A resource file compilable by the @command{windres} tool.
3016 One or more binary files containing the resource data for a specific
3020 A C include file that maps message id's to their symbolic name.
3023 The exact description of these different formats is available in
3024 documentation from Microsoft.
3026 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3027 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3028 Windows Message Compiler.
3032 @c man begin OPTIONS windmc
3037 Specifies that the input file specified is ANSI. This is the default
3042 Specifies that messages in the output @code{bin} files should be in ANSI
3047 Specifies that @code{bin} filenames should have to be prefixed by the
3048 basename of the source file.
3052 Sets the customer bit in all message id's.
3054 @item -C @var{codepage}
3055 @itemx --codepage_in @var{codepage}
3056 Sets the default codepage to be used to convert input file to UTF16. The
3057 default is ocdepage 1252.
3060 @itemx --decimal_values
3061 Outputs the constants in the header file in decimal. Default is using
3065 @itemx --extension @var{ext}
3066 The extension for the header file. The default is .h extension.
3068 @item -F @var{target}
3069 @itemx --target @var{target}
3070 Specify the BFD format to use for a bin file as output. This
3071 is a BFD target name; you can use the @option{--help} option to see a list
3072 of supported targets. Normally @command{windmc} will use the default
3073 format, which is the first one listed by the @option{--help} option.
3075 @ref{Target Selection}.
3079 @itemx --headerdir @var{path}
3080 The target directory of the generated header file. The default is the
3085 Displays a list of command line options and then exits.
3087 @item -m @var{characters}
3088 @itemx --maxlength @var{characters}
3089 Instructs @command{windmc} to generate a warning if the length
3090 of any message exceeds the number specified.
3093 @itemx --nullterminate
3094 Terminate message text in @code{bin} files by zero. By default they are
3095 terminated by CR/LF.
3098 @itemx --hresult_use
3099 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3100 file, using HRESULT definitions. Status codes are used if the flag is not
3103 @item -O @var{codepage}
3104 @itemx --codepage_out @var{codepage}
3105 Sets the default codepage to be used to output text files. The default
3109 @itemx --rcdir @var{path}
3110 The target directory for the generated @code{rc} script and the generated
3111 @code{bin} files that the resource compiler script includes. The default
3112 is the current directory.
3116 Specifies that the input file is UTF16.
3119 @itemx --unicode_out
3120 Specifies that messages in the output @code{bin} file should be in UTF16
3121 format. This is the default behaviour.
3125 Enable verbose mode.
3129 Prints the version number for @command{windmc}.
3132 @itemx --xdgb @var{path}
3133 The path of the @code{dbg} C include file that maps message id's to the
3134 symbolic name. No such file is generated without specifying the switch.
3140 @c man begin SEEALSO windmc
3141 the Info entries for @file{binutils}.
3148 @command{windres} may be used to manipulate Windows resources.
3151 @emph{Warning:} @command{windres} is not always built as part of the binary
3152 utilities, since it is only useful for Windows targets.
3155 @c man title windres manipulate Windows resources.
3158 @c man begin SYNOPSIS windres
3159 windres [options] [input-file] [output-file]
3163 @c man begin DESCRIPTION windres
3165 @command{windres} reads resources from an input file and copies them into
3166 an output file. Either file may be in one of three formats:
3170 A text format read by the Resource Compiler.
3173 A binary format generated by the Resource Compiler.
3176 A COFF object or executable.
3179 The exact description of these different formats is available in
3180 documentation from Microsoft.
3182 When @command{windres} converts from the @code{rc} format to the @code{res}
3183 format, it is acting like the Windows Resource Compiler. When
3184 @command{windres} converts from the @code{res} format to the @code{coff}
3185 format, it is acting like the Windows @code{CVTRES} program.
3187 When @command{windres} generates an @code{rc} file, the output is similar
3188 but not identical to the format expected for the input. When an input
3189 @code{rc} file refers to an external filename, an output @code{rc} file
3190 will instead include the file contents.
3192 If the input or output format is not specified, @command{windres} will
3193 guess based on the file name, or, for the input file, the file contents.
3194 A file with an extension of @file{.rc} will be treated as an @code{rc}
3195 file, a file with an extension of @file{.res} will be treated as a
3196 @code{res} file, and a file with an extension of @file{.o} or
3197 @file{.exe} will be treated as a @code{coff} file.
3199 If no output file is specified, @command{windres} will print the resources
3200 in @code{rc} format to standard output.
3202 The normal use is for you to write an @code{rc} file, use @command{windres}
3203 to convert it to a COFF object file, and then link the COFF file into
3204 your application. This will make the resources described in the
3205 @code{rc} file available to Windows.
3209 @c man begin OPTIONS windres
3212 @item -i @var{filename}
3213 @itemx --input @var{filename}
3214 The name of the input file. If this option is not used, then
3215 @command{windres} will use the first non-option argument as the input file
3216 name. If there are no non-option arguments, then @command{windres} will
3217 read from standard input. @command{windres} can not read a COFF file from
3220 @item -o @var{filename}
3221 @itemx --output @var{filename}
3222 The name of the output file. If this option is not used, then
3223 @command{windres} will use the first non-option argument, after any used
3224 for the input file name, as the output file name. If there is no
3225 non-option argument, then @command{windres} will write to standard output.
3226 @command{windres} can not write a COFF file to standard output. Note,
3227 for compatibility with @command{rc} the option @option{-fo} is also
3228 accepted, but its use is not recommended.
3230 @item -J @var{format}
3231 @itemx --input-format @var{format}
3232 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3233 @samp{coff}. If no input format is specified, @command{windres} will
3234 guess, as described above.
3236 @item -O @var{format}
3237 @itemx --output-format @var{format}
3238 The output format to generate. @var{format} may be @samp{res},
3239 @samp{rc}, or @samp{coff}. If no output format is specified,
3240 @command{windres} will guess, as described above.
3242 @item -F @var{target}
3243 @itemx --target @var{target}
3244 Specify the BFD format to use for a COFF file as input or output. This
3245 is a BFD target name; you can use the @option{--help} option to see a list
3246 of supported targets. Normally @command{windres} will use the default
3247 format, which is the first one listed by the @option{--help} option.
3249 @ref{Target Selection}.
3252 @item --preprocessor @var{program}
3253 When @command{windres} reads an @code{rc} file, it runs it through the C
3254 preprocessor first. This option may be used to specify the preprocessor
3255 to use, including any leading arguments. The default preprocessor
3256 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3258 @item -I @var{directory}
3259 @itemx --include-dir @var{directory}
3260 Specify an include directory to use when reading an @code{rc} file.
3261 @command{windres} will pass this to the preprocessor as an @option{-I}
3262 option. @command{windres} will also search this directory when looking for
3263 files named in the @code{rc} file. If the argument passed to this command
3264 matches any of the supported @var{formats} (as described in the @option{-J}
3265 option), it will issue a deprecation warning, and behave just like the
3266 @option{-J} option. New programs should not use this behaviour. If a
3267 directory happens to match a @var{format}, simple prefix it with @samp{./}
3268 to disable the backward compatibility.
3270 @item -D @var{target}
3271 @itemx --define @var{sym}[=@var{val}]
3272 Specify a @option{-D} option to pass to the preprocessor when reading an
3275 @item -U @var{target}
3276 @itemx --undefine @var{sym}
3277 Specify a @option{-U} option to pass to the preprocessor when reading an
3281 Ignored for compatibility with rc.
3284 Enable verbose mode. This tells you what the preprocessor is if you
3288 @item --codepage @var{val}
3289 Specify the default codepage to use when reading an @code{rc} file.
3290 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3291 codepage code. The valid range is from zero up to 0xffff, but the
3292 validity of the codepage is host and configuration dependent.
3295 @item --language @var{val}
3296 Specify the default language to use when reading an @code{rc} file.
3297 @var{val} should be a hexadecimal language code. The low eight bits are
3298 the language, and the high eight bits are the sublanguage.
3300 @item --use-temp-file
3301 Use a temporary file to instead of using popen to read the output of
3302 the preprocessor. Use this option if the popen implementation is buggy
3303 on the host (eg., certain non-English language versions of Windows 95 and
3304 Windows 98 are known to have buggy popen where the output will instead
3307 @item --no-use-temp-file
3308 Use popen, not a temporary file, to read the output of the preprocessor.
3309 This is the default behaviour.
3313 Prints a usage summary.
3317 Prints the version number for @command{windres}.
3320 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3321 this will turn on parser debugging.
3327 @c man begin SEEALSO windres
3328 the Info entries for @file{binutils}.
3337 @command{dlltool} is used to create the files needed to create dynamic
3338 link libraries (DLLs) on systems which understand PE format image
3339 files such as Windows. A DLL contains an export table which contains
3340 information that the runtime loader needs to resolve references from a
3341 referencing program.
3343 The export table is generated by this program by reading in a
3344 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3345 will be in the DLL. A @file{.o} file can contain information in
3346 special @samp{.drectve} sections with export information.
3349 @emph{Note:} @command{dlltool} is not always built as part of the
3350 binary utilities, since it is only useful for those targets which
3354 @c man title dlltool Create files needed to build and use DLLs.
3357 @c man begin SYNOPSIS dlltool
3358 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3359 [@option{-b}|@option{--base-file} @var{base-file-name}]
3360 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3361 [@option{-z}|@option{--output-def} @var{def-file-name}]
3362 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3363 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3364 [@option{--exclude-symbols} @var{list}]
3365 [@option{--no-default-excludes}]
3366 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3367 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3368 [@option{-a}|@option{--add-indirect}]
3369 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3370 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3371 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3372 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
3373 [@option{--use-nul-prefixed-import-tables}]
3374 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{-i}|@option{--interwork}]
3375 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3376 [@option{-v}|@option{--verbose}]
3377 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3378 [object-file @dots{}]
3382 @c man begin DESCRIPTION dlltool
3384 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3385 @option{-b} options as well as object files specified on the command
3386 line. It then processes these inputs and if the @option{-e} option has
3387 been specified it creates a exports file. If the @option{-l} option
3388 has been specified it creates a library file and if the @option{-z} option
3389 has been specified it creates a def file. Any or all of the @option{-e},
3390 @option{-l} and @option{-z} options can be present in one invocation of
3393 When creating a DLL, along with the source for the DLL, it is necessary
3394 to have three other files. @command{dlltool} can help with the creation of
3397 The first file is a @file{.def} file which specifies which functions are
3398 exported from the DLL, which functions the DLL imports, and so on. This
3399 is a text file and can be created by hand, or @command{dlltool} can be used
3400 to create it using the @option{-z} option. In this case @command{dlltool}
3401 will scan the object files specified on its command line looking for
3402 those functions which have been specially marked as being exported and
3403 put entries for them in the @file{.def} file it creates.
3405 In order to mark a function as being exported from a DLL, it needs to
3406 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3407 section of the object file. This can be done in C by using the
3411 asm (".section .drectve");
3412 asm (".ascii \"-export:my_func\"");
3414 int my_func (void) @{ @dots{} @}
3417 The second file needed for DLL creation is an exports file. This file
3418 is linked with the object files that make up the body of the DLL and it
3419 handles the interface between the DLL and the outside world. This is a
3420 binary file and it can be created by giving the @option{-e} option to
3421 @command{dlltool} when it is creating or reading in a @file{.def} file.
3423 The third file needed for DLL creation is the library file that programs
3424 will link with in order to access the functions in the DLL (an `import
3425 library'). This file can be created by giving the @option{-l} option to
3426 dlltool when it is creating or reading in a @file{.def} file.
3428 @command{dlltool} builds the library file by hand, but it builds the
3429 exports file by creating temporary files containing assembler statements
3430 and then assembling these. The @option{-S} command line option can be
3431 used to specify the path to the assembler that dlltool will use,
3432 and the @option{-f} option can be used to pass specific flags to that
3433 assembler. The @option{-n} can be used to prevent dlltool from deleting
3434 these temporary assembler files when it is done, and if @option{-n} is
3435 specified twice then this will prevent dlltool from deleting the
3436 temporary object files it used to build the library.
3438 Here is an example of creating a DLL from a source file @samp{dll.c} and
3439 also creating a program (from an object file called @samp{program.o})
3444 dlltool -e exports.o -l dll.lib dll.o
3445 gcc dll.o exports.o -o dll.dll
3446 gcc program.o dll.lib -o program
3450 @command{dlltool} may also be used to query an existing import library
3451 to determine the name of the DLL to which it is associated. See the
3452 description of the @option{-I} or @option{--identify} option.
3456 @c man begin OPTIONS dlltool
3458 The command line options have the following meanings:
3462 @item -d @var{filename}
3463 @itemx --input-def @var{filename}
3464 @cindex input .def file
3465 Specifies the name of a @file{.def} file to be read in and processed.
3467 @item -b @var{filename}
3468 @itemx --base-file @var{filename}
3470 Specifies the name of a base file to be read in and processed. The
3471 contents of this file will be added to the relocation section in the
3472 exports file generated by dlltool.
3474 @item -e @var{filename}
3475 @itemx --output-exp @var{filename}
3476 Specifies the name of the export file to be created by dlltool.
3478 @item -z @var{filename}
3479 @itemx --output-def @var{filename}
3480 Specifies the name of the @file{.def} file to be created by dlltool.
3482 @item -l @var{filename}
3483 @itemx --output-lib @var{filename}
3484 Specifies the name of the library file to be created by dlltool.
3486 @item --export-all-symbols
3487 Treat all global and weak defined symbols found in the input object
3488 files as symbols to be exported. There is a small list of symbols which
3489 are not exported by default; see the @option{--no-default-excludes}
3490 option. You may add to the list of symbols to not export by using the
3491 @option{--exclude-symbols} option.
3493 @item --no-export-all-symbols
3494 Only export symbols explicitly listed in an input @file{.def} file or in
3495 @samp{.drectve} sections in the input object files. This is the default
3496 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3497 attributes in the source code.
3499 @item --exclude-symbols @var{list}
3500 Do not export the symbols in @var{list}. This is a list of symbol names
3501 separated by comma or colon characters. The symbol names should not
3502 contain a leading underscore. This is only meaningful when
3503 @option{--export-all-symbols} is used.
3505 @item --no-default-excludes
3506 When @option{--export-all-symbols} is used, it will by default avoid
3507 exporting certain special symbols. The current list of symbols to avoid
3508 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3509 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3510 to go ahead and export these special symbols. This is only meaningful
3511 when @option{--export-all-symbols} is used.
3514 @itemx --as @var{path}
3515 Specifies the path, including the filename, of the assembler to be used
3516 to create the exports file.
3518 @item -f @var{options}
3519 @itemx --as-flags @var{options}
3520 Specifies any specific command line options to be passed to the
3521 assembler when building the exports file. This option will work even if
3522 the @option{-S} option is not used. This option only takes one argument,
3523 and if it occurs more than once on the command line, then later
3524 occurrences will override earlier occurrences. So if it is necessary to
3525 pass multiple options to the assembler they should be enclosed in
3529 @itemx --dll-name @var{name}
3530 Specifies the name to be stored in the @file{.def} file as the name of
3531 the DLL when the @option{-e} option is used. If this option is not
3532 present, then the filename given to the @option{-e} option will be
3533 used as the name of the DLL.
3535 @item -m @var{machine}
3536 @itemx -machine @var{machine}
3537 Specifies the type of machine for which the library file should be
3538 built. @command{dlltool} has a built in default type, depending upon how
3539 it was created, but this option can be used to override that. This is
3540 normally only useful when creating DLLs for an ARM processor, when the
3541 contents of the DLL are actually encode using Thumb instructions.
3544 @itemx --add-indirect
3545 Specifies that when @command{dlltool} is creating the exports file it
3546 should add a section which allows the exported functions to be
3547 referenced without using the import library. Whatever the hell that
3551 @itemx --add-underscore
3552 Specifies that when @command{dlltool} is creating the exports file it
3553 should prepend an underscore to the names of @emph{all} exported symbols.
3555 @item --add-stdcall-underscore
3556 Specifies that when @command{dlltool} is creating the exports file it
3557 should prepend an underscore to the names of exported @emph{stdcall}
3558 functions. Variable names and non-stdcall function names are not modified.
3559 This option is useful when creating GNU-compatible import libs for third
3560 party DLLs that were built with MS-Windows tools.
3564 Specifies that when @command{dlltool} is creating the exports file it
3565 should not append the string @samp{@@ <number>}. These numbers are
3566 called ordinal numbers and they represent another way of accessing the
3567 function in a DLL, other than by name.
3570 @itemx --add-stdcall-alias
3571 Specifies that when @command{dlltool} is creating the exports file it
3572 should add aliases for stdcall symbols without @samp{@@ <number>}
3573 in addition to the symbols with @samp{@@ <number>}.
3576 @itemx --ext-prefix-alias @var{prefix}
3577 Causes @command{dlltool} to create external aliases for all DLL
3578 imports with the specified prefix. The aliases are created for both
3579 external and import symbols with no leading underscore.
3583 Specifies that when @command{dlltool} is creating the exports and library
3584 files it should omit the @code{.idata4} section. This is for compatibility
3585 with certain operating systems.
3587 @item --use-nul-prefixed-import-tables
3588 Specifies that when @command{dlltool} is creating the exports and library
3589 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
3590 element. This emulates old gnu import library generation of
3591 @code{dlltool}. By default this option is turned off.
3595 Specifies that when @command{dlltool} is creating the exports and library
3596 files it should omit the @code{.idata5} section. This is for compatibility
3597 with certain operating systems.
3599 @item -I @var{filename}
3600 @itemx --identify @var{filename}
3601 Specifies that @command{dlltool} should inspect the import library
3602 indicated by @var{filename} and report, on @code{stdout}, the name of
3603 the associated DLL. This can be performed in addition to any other
3604 operations indicated by the other options and arguments. @command{dlltool}
3605 @option{--identify} fails if the import library does not exist, is not
3606 actually an import library, or (rarely) if the import library somehow
3607 specifies more than one associated DLL.
3611 Specifies that @command{dlltool} should mark the objects in the library
3612 file and exports file that it produces as supporting interworking
3613 between ARM and Thumb code.
3617 Makes @command{dlltool} preserve the temporary assembler files it used to
3618 create the exports file. If this option is repeated then dlltool will
3619 also preserve the temporary object files it uses to create the library
3622 @item -t @var{prefix}
3623 @itemx --temp-prefix @var{prefix}
3624 Makes @command{dlltool} use @var{prefix} when constructing the names of
3625 temporary assembler and object files. By default, the temp file prefix
3626 is generated from the pid.
3630 Make dlltool describe what it is doing.
3634 Displays a list of command line options and then exits.
3638 Displays dlltool's version number and then exits.
3645 * def file format:: The format of the dlltool @file{.def} file
3648 @node def file format
3649 @section The format of the @command{dlltool} @file{.def} file
3651 A @file{.def} file contains any number of the following commands:
3655 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
3656 The result is going to be named @var{name}@code{.exe}.
3658 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
3659 The result is going to be named @var{name}@code{.dll}.
3661 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) )}
3662 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
3663 Declares @var{name1} as an exported symbol from the DLL, with optional
3664 ordinal number @var{integer}, or declares @var{name1} as an alias
3665 (forward) of the function @var{external-name} in the DLL
3668 @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{) ) *}
3669 Declares that @var{external-name} or the exported function whose
3670 ordinal number is @var{integer} is to be imported from the file
3671 @var{module-name}. If @var{internal-name} is specified then this is
3672 the name that the imported function will be referred to in the body of
3675 @item @code{DESCRIPTION} @var{string}
3676 Puts @var{string} into the output @file{.exp} file in the
3677 @code{.rdata} section.
3679 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3680 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3681 Generates @code{--stack} or @code{--heap}
3682 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
3683 section. The linker will see this and act upon it.
3685 @item @code{CODE} @var{attr} @code{+}
3686 @item @code{DATA} @var{attr} @code{+}
3687 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
3688 Generates @code{--attr} @var{section-name} @var{attr} in the output
3689 @code{.drectve} section, where @var{attr} is one of @code{READ},
3690 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
3691 this and act upon it.
3696 @c man begin SEEALSO dlltool
3697 The Info pages for @file{binutils}.
3704 @cindex ELF file information
3707 @c man title readelf Displays information about ELF files.
3710 @c man begin SYNOPSIS readelf
3711 readelf [@option{-a}|@option{--all}]
3712 [@option{-h}|@option{--file-header}]
3713 [@option{-l}|@option{--program-headers}|@option{--segments}]
3714 [@option{-S}|@option{--section-headers}|@option{--sections}]
3715 [@option{-g}|@option{--section-groups}]
3716 [@option{-t}|@option{--section-details}]
3717 [@option{-e}|@option{--headers}]
3718 [@option{-s}|@option{--syms}|@option{--symbols}]
3719 [@option{-n}|@option{--notes}]
3720 [@option{-r}|@option{--relocs}]
3721 [@option{-u}|@option{--unwind}]
3722 [@option{-d}|@option{--dynamic}]
3723 [@option{-V}|@option{--version-info}]
3724 [@option{-A}|@option{--arch-specific}]
3725 [@option{-D}|@option{--use-dynamic}]
3726 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
3727 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
3728 [@option{-c}|@option{--archive-index}]
3729 [@option{-w[lLiaprmfFsoR]}|
3730 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
3731 [@option{-I}|@option{-histogram}]
3732 [@option{-v}|@option{--version}]
3733 [@option{-W}|@option{--wide}]
3734 [@option{-H}|@option{--help}]
3735 @var{elffile}@dots{}
3739 @c man begin DESCRIPTION readelf
3741 @command{readelf} displays information about one or more ELF format object
3742 files. The options control what particular information to display.
3744 @var{elffile}@dots{} are the object files to be examined. 32-bit and
3745 64-bit ELF files are supported, as are archives containing ELF files.
3747 This program performs a similar function to @command{objdump} but it
3748 goes into more detail and it exists independently of the @sc{bfd}
3749 library, so if there is a bug in @sc{bfd} then readelf will not be
3754 @c man begin OPTIONS readelf
3756 The long and short forms of options, shown here as alternatives, are
3757 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
3763 Equivalent to specifying @option{--file-header},
3764 @option{--program-headers}, @option{--sections}, @option{--symbols},
3765 @option{--relocs}, @option{--dynamic}, @option{--notes} and
3766 @option{--version-info}.
3769 @itemx --file-header
3770 @cindex ELF file header information
3771 Displays the information contained in the ELF header at the start of the
3775 @itemx --program-headers
3777 @cindex ELF program header information
3778 @cindex ELF segment information
3779 Displays the information contained in the file's segment headers, if it
3784 @itemx --section-headers
3785 @cindex ELF section information
3786 Displays the information contained in the file's section headers, if it
3790 @itemx --section-groups
3791 @cindex ELF section group information
3792 Displays the information contained in the file's section groups, if it
3796 @itemx --section-details
3797 @cindex ELF section information
3798 Displays the detailed section information. Implies @option{-S}.
3803 @cindex ELF symbol table information
3804 Displays the entries in symbol table section of the file, if it has one.
3808 Display all the headers in the file. Equivalent to @option{-h -l -S}.
3813 Displays the contents of the NOTE segments and/or sections, if any.
3817 @cindex ELF reloc information
3818 Displays the contents of the file's relocation section, if it has one.
3822 @cindex unwind information
3823 Displays the contents of the file's unwind section, if it has one. Only
3824 the unwind sections for IA64 ELF files are currently supported.
3828 @cindex ELF dynamic section information
3829 Displays the contents of the file's dynamic section, if it has one.
3832 @itemx --version-info
3833 @cindex ELF version sections informations
3834 Displays the contents of the version sections in the file, it they
3838 @itemx --arch-specific
3839 Displays architecture-specific information in the file, if there
3843 @itemx --use-dynamic
3844 When displaying symbols, this option makes @command{readelf} use the
3845 symbol table in the file's dynamic section, rather than the one in the
3848 @item -x <number or name>
3849 @itemx --hex-dump=<number or name>
3850 Displays the contents of the indicated section as a hexadecimal dump.
3851 A number identifies a particular section by index in the section table;
3852 any other string identifies all sections with that name in the object file.
3854 @item -p <number or name>
3855 @itemx --string-dump=<number or name>
3856 Displays the contents of the indicated section as printable strings.
3857 A number identifies a particular section by index in the section table;
3858 any other string identifies all sections with that name in the object file.
3861 @itemx --archive-index
3862 @cindex Archive file symbol index information
3863 Displays the file symbol index infomation contained in the header part
3864 of binary archives. Performs the same function as the @option{t}
3865 command to @command{ar}, but without using the BFD library. @xref{ar}.
3867 @item -w[lLiaprmfFsoR]
3868 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]
3869 Displays the contents of the debug sections in the file, if any are
3870 present. If one of the optional letters or words follows the switch
3871 then only data found in those specific sections will be dumped.
3873 Note: the @option{=decodedline} option will display the interpreted
3874 contents of a .debug_line section whereas the @option{=rawline} option
3875 dumps the contents in a raw format.
3879 Display a histogram of bucket list lengths when displaying the contents
3880 of the symbol tables.
3884 Display the version number of readelf.
3888 Don't break output lines to fit into 80 columns. By default
3889 @command{readelf} breaks section header and segment listing lines for
3890 64-bit ELF files, so that they fit into 80 columns. This option causes
3891 @command{readelf} to print each section header resp. each segment one a
3892 single line, which is far more readable on terminals wider than 80 columns.
3896 Display the command line options understood by @command{readelf}.
3903 @c man begin SEEALSO readelf
3904 objdump(1), and the Info entries for @file{binutils}.
3908 @node Common Options
3909 @chapter Common Options
3911 The following command-line options are supported by all of the
3912 programs described in this manual.
3914 @c man begin OPTIONS
3916 @include at-file.texi
3920 Display the command-line options supported by the program.
3923 Display the version number of the program.
3925 @c man begin OPTIONS
3929 @node Selecting the Target System
3930 @chapter Selecting the Target System
3932 You can specify two aspects of the target system to the @sc{gnu}
3933 binary file utilities, each in several ways:
3943 In the following summaries, the lists of ways to specify values are in
3944 order of decreasing precedence. The ways listed first override those
3947 The commands to list valid values only list the values for which the
3948 programs you are running were configured. If they were configured with
3949 @option{--enable-targets=all}, the commands list most of the available
3950 values, but a few are left out; not all targets can be configured in at
3951 once because some of them can only be configured @dfn{native} (on hosts
3952 with the same type as the target system).
3955 * Target Selection::
3956 * Architecture Selection::
3959 @node Target Selection
3960 @section Target Selection
3962 A @dfn{target} is an object file format. A given target may be
3963 supported for multiple architectures (@pxref{Architecture Selection}).
3964 A target selection may also have variations for different operating
3965 systems or architectures.
3967 The command to list valid target values is @samp{objdump -i}
3968 (the first column of output contains the relevant information).
3970 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
3971 @samp{a.out-sunos-big}.
3973 You can also specify a target using a configuration triplet. This is
3974 the same sort of name that is passed to @file{configure} to specify a
3975 target. When you use a configuration triplet as an argument, it must be
3976 fully canonicalized. You can see the canonical version of a triplet by
3977 running the shell script @file{config.sub} which is included with the
3980 Some sample configuration triplets are: @samp{m68k-hp-bsd},
3981 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
3983 @subheading @command{objdump} Target
3989 command line option: @option{-b} or @option{--target}
3992 environment variable @code{GNUTARGET}
3995 deduced from the input file
3998 @subheading @command{objcopy} and @command{strip} Input Target
4004 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4007 environment variable @code{GNUTARGET}
4010 deduced from the input file
4013 @subheading @command{objcopy} and @command{strip} Output Target
4019 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4022 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4025 environment variable @code{GNUTARGET}
4028 deduced from the input file
4031 @subheading @command{nm}, @command{size}, and @command{strings} Target
4037 command line option: @option{--target}
4040 environment variable @code{GNUTARGET}
4043 deduced from the input file
4046 @node Architecture Selection
4047 @section Architecture Selection
4049 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4050 to run. Its name may contain a colon, separating the name of the
4051 processor family from the name of the particular @sc{cpu}.
4053 The command to list valid architecture values is @samp{objdump -i} (the
4054 second column contains the relevant information).
4056 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4058 @subheading @command{objdump} Architecture
4064 command line option: @option{-m} or @option{--architecture}
4067 deduced from the input file
4070 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4076 deduced from the input file
4079 @node Reporting Bugs
4080 @chapter Reporting Bugs
4082 @cindex reporting bugs
4084 Your bug reports play an essential role in making the binary utilities
4087 Reporting a bug may help you by bringing a solution to your problem, or
4088 it may not. But in any case the principal function of a bug report is
4089 to help the entire community by making the next version of the binary
4090 utilities work better. Bug reports are your contribution to their
4093 In order for a bug report to serve its purpose, you must include the
4094 information that enables us to fix the bug.
4097 * Bug Criteria:: Have you found a bug?
4098 * Bug Reporting:: How to report bugs
4102 @section Have You Found a Bug?
4103 @cindex bug criteria
4105 If you are not sure whether you have found a bug, here are some guidelines:
4108 @cindex fatal signal
4111 If a binary utility gets a fatal signal, for any input whatever, that is
4112 a bug. Reliable utilities never crash.
4114 @cindex error on valid input
4116 If a binary utility produces an error message for valid input, that is a
4120 If you are an experienced user of binary utilities, your suggestions for
4121 improvement are welcome in any case.
4125 @section How to Report Bugs
4127 @cindex bugs, reporting
4129 A number of companies and individuals offer support for @sc{gnu}
4130 products. If you obtained the binary utilities from a support
4131 organization, we recommend you contact that organization first.
4133 You can find contact information for many support companies and
4134 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4138 In any event, we also recommend that you send bug reports for the binary
4139 utilities to @value{BUGURL}.
4142 The fundamental principle of reporting bugs usefully is this:
4143 @strong{report all the facts}. If you are not sure whether to state a
4144 fact or leave it out, state it!
4146 Often people omit facts because they think they know what causes the
4147 problem and assume that some details do not matter. Thus, you might
4148 assume that the name of a file you use in an example does not matter.
4149 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4150 a stray memory reference which happens to fetch from the location where
4151 that pathname is stored in memory; perhaps, if the pathname were
4152 different, the contents of that location would fool the utility into
4153 doing the right thing despite the bug. Play it safe and give a
4154 specific, complete example. That is the easiest thing for you to do,
4155 and the most helpful.
4157 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4158 it is new to us. Therefore, always write your bug reports on the assumption
4159 that the bug has not been reported previously.
4161 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4162 bell?'' This cannot help us fix a bug, so it is basically useless. We
4163 respond by asking for enough details to enable us to investigate.
4164 You might as well expedite matters by sending them to begin with.
4166 To enable us to fix the bug, you should include all these things:
4170 The version of the utility. Each utility announces it if you start it
4171 with the @option{--version} argument.
4173 Without this, we will not know whether there is any point in looking for
4174 the bug in the current version of the binary utilities.
4177 Any patches you may have applied to the source, including any patches
4178 made to the @code{BFD} library.
4181 The type of machine you are using, and the operating system name and
4185 What compiler (and its version) was used to compile the utilities---e.g.
4189 The command arguments you gave the utility to observe the bug. To
4190 guarantee you will not omit something important, list them all. A copy
4191 of the Makefile (or the output from make) is sufficient.
4193 If we were to try to guess the arguments, we would probably guess wrong
4194 and then we might not encounter the bug.
4197 A complete input file, or set of input files, that will reproduce the
4198 bug. If the utility is reading an object file or files, then it is
4199 generally most helpful to send the actual object files.
4201 If the source files were produced exclusively using @sc{gnu} programs
4202 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4203 may be OK to send the source files rather than the object files. In
4204 this case, be sure to say exactly what version of @command{gcc}, or
4205 whatever, was used to produce the object files. Also say how
4206 @command{gcc}, or whatever, was configured.
4209 A description of what behavior you observe that you believe is
4210 incorrect. For example, ``It gets a fatal signal.''
4212 Of course, if the bug is that the utility gets a fatal signal, then we
4213 will certainly notice it. But if the bug is incorrect output, we might
4214 not notice unless it is glaringly wrong. You might as well not give us
4215 a chance to make a mistake.
4217 Even if the problem you experience is a fatal signal, you should still
4218 say so explicitly. Suppose something strange is going on, such as your
4219 copy of the utility is out of sync, or you have encountered a bug in
4220 the C library on your system. (This has happened!) Your copy might
4221 crash and ours would not. If you told us to expect a crash, then when
4222 ours fails to crash, we would know that the bug was not happening for
4223 us. If you had not told us to expect a crash, then we would not be able
4224 to draw any conclusion from our observations.
4227 If you wish to suggest changes to the source, send us context diffs, as
4228 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4229 option. Always send diffs from the old file to the new file. If you
4230 wish to discuss something in the @command{ld} source, refer to it by
4231 context, not by line number.
4233 The line numbers in our development sources will not match those in your
4234 sources. Your line numbers would convey no useful information to us.
4237 Here are some things that are not necessary:
4241 A description of the envelope of the bug.
4243 Often people who encounter a bug spend a lot of time investigating
4244 which changes to the input file will make the bug go away and which
4245 changes will not affect it.
4247 This is often time consuming and not very useful, because the way we
4248 will find the bug is by running a single example under the debugger
4249 with breakpoints, not by pure deduction from a series of examples.
4250 We recommend that you save your time for something else.
4252 Of course, if you can find a simpler example to report @emph{instead}
4253 of the original one, that is a convenience for us. Errors in the
4254 output will be easier to spot, running under the debugger will take
4255 less time, and so on.
4257 However, simplification is not vital; if you do not want to do this,
4258 report the bug anyway and send us the entire test case you used.
4261 A patch for the bug.
4263 A patch for the bug does help us if it is a good one. But do not omit
4264 the necessary information, such as the test case, on the assumption that
4265 a patch is all we need. We might see problems with your patch and decide
4266 to fix the problem another way, or we might not understand it at all.
4268 Sometimes with programs as complicated as the binary utilities it is
4269 very hard to construct an example that will make the program follow a
4270 certain path through the code. If you do not send us the example, we
4271 will not be able to construct one, so we will not be able to verify that
4274 And if we cannot understand what bug you are trying to fix, or why your
4275 patch should be an improvement, we will not install it. A test case will
4276 help us to understand.
4279 A guess about what the bug is or what it depends on.
4281 Such guesses are usually wrong. Even we cannot guess right about such
4282 things without first using the debugger to find the facts.
4285 @node GNU Free Documentation License
4286 @appendix GNU Free Documentation License
4290 @node Binutils Index
4291 @unnumbered Binutils Index