1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
7 * Binutils:: The GNU binary utilities "ar", "ld", "objcopy",
8 "objdump", "nm", "size", "strings", "strip", and "ranlib".
14 Copyright @copyright{} 1991, 1992, 1993 Free Software Foundation, Inc.
16 Permission is granted to make and distribute verbatim copies of
17 this manual provided the copyright notice and this permission notice
18 are preserved on all copies.
21 Permission is granted to process this file through TeX and print the
22 results, provided the printed document carries a copying permission
23 notice identical to this one except for the removal of this paragraph
24 (this paragraph not being relevant to the printed manual).
28 Permission is granted to copy and distribute modified versions of this
29 manual under the conditions for verbatim copying, provided also that
30 the entire resulting derived work is distributed under the terms of a
31 permission notice identical to this one.
33 Permission is granted to copy and distribute translations of this manual
34 into another language, under the above conditions for modified versions.
39 @c This file documents the GNU binary utilities "ar", "ld", "objcopy",
40 @c "objdump", "nm", "size", "strings", "strip", and "ranlib".
42 @c Copyright (C) 1991, 1992, 1993 Free Software Foundation, Inc.
44 @c This text may be freely distributed under the terms of the GNU
45 @c General Public License.
48 @setchapternewpage odd
49 @settitle GNU Binary Utilities
54 @title The GNU Binary Utilities
58 @author Roland H. Pesch
59 @author Cygnus Support
63 {\parskip=0pt \hfill Cygnus Support\par \hfill
64 \TeX{}info \texinfoversion\par }
67 @vskip 0pt plus 1filll
68 Copyright @copyright{} 1991, 1992, 1993 Free Software Foundation, Inc.
70 Permission is granted to make and distribute verbatim copies of
71 this manual provided the copyright notice and this permission notice
72 are preserved on all copies.
74 Permission is granted to copy and distribute modified versions of this
75 manual under the conditions for verbatim copying, provided also that
76 the entire resulting derived work is distributed under the terms of a
77 permission notice identical to this one.
79 Permission is granted to copy and distribute translations of this manual
80 into another language, under the above conditions for modified versions.
83 @node Top, ar, (dir), (dir)
87 This brief manual contains preliminary documentation for the GNU binary
88 utilities (collectively version 2.2):
93 Create, modify, and extract from archives
96 List symbols from object files
99 Copy and translate object files
102 Display information from object files
105 Generate index to archive contents
108 List section sizes and total size
111 List printable strings from files
119 * ar:: Create, modify, and extract from archives
120 * ld:(ld)Overview. Combine object and archive files
121 * nm:: List symbols from object files
122 * objcopy:: Copy and translate object files
123 * objdump:: Display information from object files
124 * ranlib:: Generate index to archive contents
125 * size:: List section sizes and total size
126 * strings:: List printable strings from files
127 * strip:: Discard symbols
128 * c++filt:: Filter to demangle encoded C++ symbols
129 * nlmconv:: Converts object code into an NLM
133 @node ar, nm, Top, Top
138 @cindex collections of files
140 ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
141 ar -M [ <mri-script ]
144 The GNU @code{ar} program creates, modifies, and extracts from
145 archives. An @dfn{archive} is a single file holding a collection of
146 other files in a structure that makes it possible to retrieve
147 the original individual files (called @dfn{members} of the archive).
149 The original files' contents, mode (permissions), timestamp, owner, and
150 group are preserved in the archive, and can be restored on
154 GNU @code{ar} can maintain archives whose members have names of any
155 length; however, depending on how @code{ar} is configured on your
156 system, a limit on member-name length may be imposed for compatibility
157 with archive formats maintained with other tools. If it exists, the
158 limit is often 15 characters (typical of formats related to a.out) or 16
159 characters (typical of formats related to coff).
162 @code{ar} is considered a binary utility because archives of this sort
163 are most often used as @dfn{libraries} holding commonly needed
167 @code{ar} creates an index to the symbols defined in relocatable
168 object modules in the archive when you specify the modifier @samp{s}.
169 Once created, this index is updated in the archive whenever @code{ar}
170 makes a change to its contents (save for the @samp{q} update operation).
171 An archive with such an index speeds up linking to the library, and
172 allows routines in the library to call each other without regard to
173 their placement in the archive.
175 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
176 table. If an archive lacks the table, another form of @code{ar} called
177 @code{ranlib} can be used to add just the table.
179 @cindex compatibility, @code{ar}
180 @cindex @code{ar} compatibility
181 GNU @code{ar} is designed to be compatible with two different
182 facilities. You can control its activity using command-line options,
183 like the different varieties of @code{ar} on Unix systems; or, if you
184 specify the single command-line option @samp{-M}, you can control it
185 with a script supplied via standard input, like the MRI ``librarian''
189 * ar-cmdline:: Controlling @code{ar} on the command line
190 * ar-scripts:: Controlling @code{ar} with a script
194 @node ar-cmdline, ar-scripts, ar, ar
195 @section Controlling @code{ar} on the command line
198 ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
201 @cindex Unix compatibility, @code{ar}
202 When you use @code{ar} in the Unix style, @code{ar} insists on at least two
203 arguments to execute: one keyletter specifying the @emph{operation}
204 (optionally accompanied by other keyletters specifying
205 @emph{modifiers}), and the archive name to act on.
207 Most operations can also accept further @var{member} arguments,
208 specifying particular files to operate on.
210 GNU @code{ar} allows you to mix the operation code @var{p} and modifier
211 flags @var{mod} in any order, within the first command-line argument.
213 If you wish, you may begin the first command-line argument with a
216 @cindex operations on archive
217 The @var{p} keyletter specifies what operation to execute; it may be
218 any of the following, but you must specify only one of them:
222 @cindex deleting from archive
223 @emph{Delete} modules from the archive. Specify the names of modules to
224 be deleted as @var{member}@dots{}; the archive is untouched if you
225 specify no files to delete.
227 If you specify the @samp{v} modifier, @code{ar} lists each module
231 @cindex moving in archive
232 Use this operation to @emph{move} members in an archive.
234 The ordering of members in an archive can make a difference in how
235 programs are linked using the library, if a symbol is defined in more
238 If no modifiers are used with @code{m}, any members you name in the
239 @var{member} arguments are moved to the @emph{end} of the archive;
240 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
241 specified place instead.
244 @cindex printing from archive
245 @emph{Print} the specified members of the archive, to the standard
246 output file. If the @samp{v} modifier is specified, show the member
247 name before copying its contents to standard output.
249 If you specify no @var{member} arguments, all the files in the archive are
253 @cindex quick append to archive
254 @emph{Quick append}; add the files @var{member}@dots{} to the end of
255 @var{archive}, without checking for replacement.
257 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
258 operation; new members are always placed at the end of the archive.
260 The modifier @samp{v} makes @code{ar} list each file as it is appended.
262 Since the point of this operation is speed, the archive's symbol table
263 index is not updated, even if it already existed; you can use @samp{ar s} or
264 @code{ranlib} explicitly to update the symbol table index.
267 @cindex replacement in archive
268 Insert the files @var{member}@dots{} into @var{archive} (with
269 @emph{replacement}). This operation differs from @samp{q} in that any
270 previously existing members are deleted if their names match those being
273 If one of the files named in @var{member}@dots{} does not exist, @code{ar}
274 displays an error message, and leaves undisturbed any existing members
275 of the archive matching that name.
277 By default, new members are added at the end of the file; but you may
278 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
279 placement relative to some existing member.
281 The modifier @samp{v} used with this operation elicits a line of
282 output for each file inserted, along with one of the letters @samp{a} or
283 @samp{r} to indicate whether the file was appended (no old member
284 deleted) or replaced.
287 @cindex contents of archive
288 Display a @emph{table} listing the contents of @var{archive}, or those
289 of the files listed in @var{member}@dots{} that are present in the
290 archive. Normally only the member name is shown; if you also want to
291 see the modes (permissions), timestamp, owner, group, and size, you can
292 request that by also specifying the @samp{v} modifier.
294 If you do not specify a @var{member}, all files in the archive
297 @cindex repeated names in archive
298 @cindex name duplication in archive
299 If there is more than one file with the same name (say, @samp{fie}) in
300 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
301 first instance; to see them all, you must ask for a complete
302 listing---in our example, @samp{ar t b.a}.
303 @c WRS only; per Gumby, this is implementation-dependent, and in a more
304 @c recent case in fact works the other way.
307 @cindex extract from archive
308 @emph{Extract} members (named @var{member}) from the archive. You can
309 use the @samp{v} modifier with this operation, to request that
310 @code{ar} list each name as it extracts it.
312 If you do not specify a @var{member}, all files in the archive
317 A number of modifiers (@var{mod}) may immediately follow the @var{p}
318 keyletter, to specify variations on an operation's behavior:
322 @cindex relative placement in archive
323 Add new files @emph{after} an existing member of the
324 archive. If you use the modifier @samp{a}, the name of an existing archive
325 member must be present as the @var{relpos} argument, before the
326 @var{archive} specification.
329 Add new files @emph{before} an existing member of the
330 archive. If you use the modifier @samp{b}, the name of an existing archive
331 member must be present as the @var{relpos} argument, before the
332 @var{archive} specification. (same as @samp{i}).
335 @cindex creating archives
336 @emph{Create} the archive. The specified @var{archive} is always
337 created if it did not exist, when you request an update. But a warning is
338 issued unless you specify in advance that you expect to create it, by
342 Insert new files @emph{before} an existing member of the
343 archive. If you use the modifier @samp{i}, the name of an existing archive
344 member must be present as the @var{relpos} argument, before the
345 @var{archive} specification. (same as @samp{b}).
348 This modifier is accepted but not used.
349 @c whaffor ar l modifier??? presumably compat; with
350 @c what???---pesch@@cygnus.com, 25jan91
353 @cindex dates in archive
354 Preserve the @emph{original} dates of members when extracting them. If
355 you do not specify this modifier, files extracted from the archive
356 are stamped with the time of extraction.
359 @cindex writing archive index
360 Write an object-file index into the archive, or update an existing one,
361 even if no other change is made to the archive. You may use this modifier
362 flag either with any operation, or alone. Running @samp{ar s} on an
363 archive is equivalent to running @samp{ranlib} on it.
366 @cindex updating an archive
367 Normally, @samp{ar r}@dots{} inserts all files
368 listed into the archive. If you would like to insert @emph{only} those
369 of the files you list that are newer than existing members of the same
370 names, use this modifier. The @samp{u} modifier is allowed only for the
371 operation @samp{r} (replace). In particular, the combination @samp{qu} is
372 not allowed, since checking the timestamps would lose any speed
373 advantage from the operation @samp{q}.
376 This modifier requests the @emph{verbose} version of an operation. Many
377 operations display additional information, such as filenames processed,
378 when the modifier @samp{v} is appended.
381 This modifier shows the version number of @code{ar}.
384 @node ar-scripts, , ar-cmdline, ar
385 @section Controlling @code{ar} with a script
388 ar -M [ <@var{script} ]
391 @cindex MRI compatibility, @code{ar}
392 @cindex scripts, @code{ar}
393 If you use the single command-line option @samp{-M} with @code{ar}, you
394 can control its operation with a rudimentary command language. This
395 form of @code{ar} operates interactively if standard input is coming
396 directly from a terminal. During interactive use, @code{ar} prompts for
397 input (the prompt is @samp{AR >}), and continues executing even after
398 errors. If you redirect standard input to a script file, no prompts are
399 issued, and @code{ar} abandons execution (with a nonzero exit code)
402 The @code{ar} command language is @emph{not} designed to be equivalent
403 to the command-line options; in fact, it provides somewhat less control
404 over archives. The only purpose of the command language is to ease the
405 transition to GNU @code{ar} for developers who already have scripts
406 written for the MRI ``librarian'' program.
408 The syntax for the @code{ar} command language is straightforward:
411 commands are recognized in upper or lower case; for example, @code{LIST}
412 is the same as @code{list}. In the following descriptions, commands are
413 shown in upper case for clarity.
416 a single command may appear on each line; it is the first word on the
420 empty lines are allowed, and have no effect.
423 comments are allowed; text after either of the characters @samp{*}
424 or @samp{;} is ignored.
427 Whenever you use a list of names as part of the argument to an @code{ar}
428 command, you can separate the individual names with either commas or
429 blanks. Commas are shown in the explanations below, for clarity.
432 @samp{+} is used as a line continuation character; if @samp{+} appears
433 at the end of a line, the text on the following line is considered part
434 of the current command.
437 Here are the commands you can use in @code{ar} scripts, or when using
438 @code{ar} interactively. Three of them have special significance:
440 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
441 a temporary file required for most of the other commands.
443 @code{SAVE} commits the changes so far specified by the script. Prior
444 to @code{SAVE}, commands affect only the temporary copy of the current
448 @item ADDLIB @var{archive}
449 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
450 Add all the contents of @var{archive} (or, if specified, each named
451 @var{module} from @var{archive}) to the current archive.
453 Requires prior use of @code{OPEN} or @code{CREATE}.
455 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
456 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
457 @c else like "ar q..."
458 Add each named @var{member} as a module in the current archive.
460 Requires prior use of @code{OPEN} or @code{CREATE}.
463 Discard the contents of the current archive, cancelling the effect of
464 any operations since the last @code{SAVE}. May be executed (with no
465 effect) even if no current archive is specified.
467 @item CREATE @var{archive}
468 Creates an archive, and makes it the current archive (required for many
469 other commands). The new archive is created with a temporary name; it
470 is not actually saved as @var{archive} until you use @code{SAVE}.
471 You can overwrite existing archives; similarly, the contents of any
472 existing file named @var{archive} will not be destroyed until @code{SAVE}.
474 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
475 Delete each listed @var{module} from the current archive; equivalent to
476 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
478 Requires prior use of @code{OPEN} or @code{CREATE}.
480 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
481 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
482 List each named @var{module} present in @var{archive}. The separate
483 command @code{VERBOSE} specifies the form of the output: when verbose
484 output is off, output is like that of @samp{ar -t @var{archive}
485 @var{module}@dots{}}. When verbose output is on, the listing is like
486 @samp{ar -tv @var{archive} @var{module}@dots{}}.
488 Output normally goes to the standard output stream; however, if you
489 specify @var{outputfile} as a final argument, @code{ar} directs the
493 Exit from @code{ar}, with a @code{0} exit code to indicate successful
494 completion. This command does not save the output file; if you have
495 changed the current archive since the last @code{SAVE} command, those
498 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
499 Extract each named @var{module} from the current archive, writing them
500 into the current directory as separate files. Equivalent to @samp{ar -x
501 @var{archive} @var{module}@dots{}}.
503 Requires prior use of @code{OPEN} or @code{CREATE}.
506 @c FIXME Tokens but no commands???
513 Display full contents of the current archive, in ``verbose'' style
514 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
515 tv @var{archive}}). (This single command is a GNU @code{ld}
516 enhancement, rather than present for MRI compatibility.)
518 Requires prior use of @code{OPEN} or @code{CREATE}.
520 @item OPEN @var{archive}
521 Opens an existing archive for use as the current archive (required for
522 many other commands). Any changes as the result of subsequent commands
523 will not actually affect @var{archive} until you next use @code{SAVE}.
525 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
526 In the current archive, replace each existing @var{module} (named in
527 the @code{REPLACE} arguments) from files in the current working directory.
528 To execute this command without errors, both the file, and the module in
529 the current archive, must exist.
531 Requires prior use of @code{OPEN} or @code{CREATE}.
534 Toggle an internal flag governing the output from @code{DIRECTORY}.
535 When the flag is on, @code{DIRECTORY} output matches output from
536 @samp{ar -tv }@dots{}.
539 Commit your changes to the current archive, and actually save it as a
540 file with the name specified in the last @code{CREATE} or @code{OPEN}
543 Requires prior use of @code{OPEN} or @code{CREATE}.
552 The GNU linker @code{ld} is now described in a separate manual.
553 @xref{Top,, Overview,, Using LD: the GNU linker}.
556 @node nm, objcopy, ar, Top
562 nm [ -a | --debug-syms ] [ -g | --extern-only ]
563 [ -B ] [ -C | --demangle ]
564 [ -s | --print-armap ] [ -A | -o | --print-file-name ]
565 [ -n | -v | --numeric-sort ] [ -p | --no-sort ]
566 [ -r | --reverse-sort ] [ -u | --undefined-only ]
567 [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ]
568 [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ]
569 [ -V | --version ] [ --help ] [ @var{objfile}@dots{} ]
572 GNU @code{nm} lists the symbols from object files @var{objfile}@dots{}.
573 If no object files are listed as arguments, @code{nm} assumes
576 For each symbol, @code{nm} shows:
580 The symbol value, in the radix selected by options (see below), or
581 hexadecimal by default.
584 The symbol type. At least the following types are used; others are, as
585 well, depending on the object file format. If lowercase, the symbol is
586 local; if uppercase, the symbol is global (external).
588 @c Some more detail on exactly what these symbol types are used for
595 BSS (uninitialized data).
617 The long and short forms of options, shown here as alternatives, are
623 @itemx --print-file-name
624 @cindex input file name
626 @cindex source file name
627 Precede each symbol by the name of the input file (or archive element)
628 in which it was found, rather than identifying the input file once only,
629 before all of its symbols.
633 @cindex debugging symbols
634 Display all symbols, even debugger-only symbols; normally these are not
638 @cindex @code{nm} format
639 @cindex @code{nm} compatibility
640 The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}).
644 @cindex demangling C++ symbols
645 Decode (@dfn{demangle}) low-level symbol names into user-level names.
646 Besides removing any initial underscore prepended by the system, this
647 makes C++ function names readable. @xref{c++filt}, for more information
650 @item -f @var{format}
651 @itemx --format=@var{format}
652 @cindex @code{nm} format
653 @cindex @code{nm} compatibility
654 Use the output format @var{format}, which can be @code{bsd},
655 @code{sysv}, or @code{posix}. The default is @code{bsd}.
656 Only the first character of @var{format} is significant; it can be
657 either upper or lower case.
661 @cindex external symbols
662 Display only external symbols.
666 @itemx --numeric-sort
667 Sort symbols numerically by their addresses, rather than alphabetically
672 @cindex sorting symbols
673 Do not bother to sort the symbols in any order; print them in the order
678 Use the POSIX.2 standard output format instead of the default format.
679 Equivalent to @samp{-f posix}.
683 @cindex symbol index, listing
684 When listing symbols from archive members, include the index: a mapping
685 (stored in the archive by @code{ar} or @code{ranlib}) of which modules
686 contain definitions for which names.
689 @itemx --reverse-sort
690 Reverse the order of the sort (whether numeric or alphabetic); let the
694 @itemx --radix=@var{radix}
695 Use @var{radix} as the radix for printing the symbol values. It must be
696 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
698 @item --target=@var{bfdname}
699 @cindex object code format
700 Specify an object code format other than your system's default format.
701 @xref{objdump}, for information on listing available formats.
704 @itemx --undefined-only
705 @cindex external symbols
706 @cindex undefined symbols
707 Display only undefined symbols (those external to each object file).
711 Show the version number of @code{nm} and exit.
714 Show a summary of the options to @code{nm} and exit.
717 @node objcopy, objdump, nm, Top
721 objcopy [ -F @var{format} | --format=@var{format} ]
722 [ -I @var{format} | --input-format=@var{format} ]
723 [ -O @var{format} | --output-format=@var{format} ]
724 [ -S | --strip-all ] [ -g | --strip-debug ]
725 [ -x | --discard-all ] [ -X | --discard-locals ]
726 [ -v | --verbose ] [ -V | --version ] [ --help ]
727 @var{infile} [@var{outfile}]
730 The GNU @code{objcopy} utility copies the contents of an object file to
731 another. @code{objcopy} uses the GNU BFD Library to read and write the
732 object files. It can write the destination object file in a format
733 different from that of the source object file. The exact behavior of
734 @code{objcopy} is controlled by command-line options.
736 @code{objcopy} creates temporary files to do its translations and
737 deletes them afterward. @code{objcopy} uses BFD to do all its
738 translation work; it knows about all the formats BFD knows about, and
739 thus is able to recognize most formats without being told explicitly.
740 @xref{BFD,,BFD,ld.info,Using LD, the GNU linker}.
745 The source and output files respectively.
746 If you do not specify @var{outfile}, @code{objcopy} creates a
747 temporary file and destructively renames the result with
748 the name of the input file.
750 @item -I @var{format}
751 @itemx --input-format=@var{format}
752 Consider the source file's object format to be @var{format}, rather than
753 attempting to deduce it.
755 @item -O @var{format}
756 @itemx --output-format=@var{format}
757 Write the output file using the object format @var{format}.
759 @item -F @var{format}
760 @itemx --format=@var{format}
761 Use @var{format} as the object format for both the input and the output
762 file; i.e. simply transfer data from source to destination with no
767 Do not copy relocation and symbol information from the source file.
771 Do not copy debugging symbols from the source file.
775 Do not copy non-global symbols from the source file.
776 @c FIXME any reason to prefer "non-global" to "local" here?
779 @itemx --discard-locals
780 Do not copy compiler-generated local symbols.
781 (These usually start with @samp{L} or @samp{.}.)
785 Show the version number of @code{objcopy}.
789 Verbose output: list all object files modified. In the case of
790 archives, @samp{objcopy -V} lists all members of the archive.
793 Show a summary of the options to @code{objcopy}.
796 @node objdump, ranlib, objcopy, Top
799 @cindex object file information
803 objdump [ -a ] [ -b @var{bfdname} ] [ -d ] [ -f ]
804 [ -h | --header ] [ -i ] [ -j @var{section} ] [ -l ]
805 [ -m @var{machine} ] [ -r | --reloc ] [ -s ] [ --stabs ]
806 [ -t | --syms ] [ -x ] [ --version ] [ --help ]
810 @code{objdump} displays information about one or more object files.
811 The options control what particular information to display. This
812 information is mostly useful to programmers who are working on the
813 compilation tools, as opposed to programmers who just want their
814 program to compile and work.
816 @var{objfile}@dots{} are the object files to be examined. When you
817 specify archives, @code{objdump} shows information on each of the member
820 The long and short forms of options, shown here as alternatives, are
821 equivalent. At least one option besides @samp{-l} must be given.
826 @cindex archive headers
827 If any of the @var{objfile} files are archives, display the archive
828 header information (in a format similar to @samp{ls -l}). Besides the
829 information you could list with @samp{ar tv}, @samp{objdump -a} shows
830 the object file format of each archive member.
832 @c suggest longname --target or --format or --bfd
833 @item -b @var{bfdname}
834 @cindex object code format
835 Specify that the object-code format for the object files is
836 @var{bfdname}. This option may not be necessary; @var{objdump} can
837 automatically recognize many formats.
841 objdump -b oasys -m vax -h fu.o
844 displays summary information from the section headers (@samp{-h}) of
845 @file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
846 file in the format produced by Oasys compilers. You can list the
847 formats available with the @samp{-i} option.
850 @cindex disassembling object code
851 @cindex machine instructions
852 Disassemble. Display the assembler mnemonics for the machine
853 instructions from @var{objfile}.
856 @cindex object file header
857 File header. Display summary information from the overall header of
858 each of the @var{objfile} files.
862 @cindex section headers
863 Header. Display summary information from the section headers of the
867 Print a summary of the options to @code{objdump} and exit.
870 @cindex architectures available
871 @cindex object formats available
872 Display a list showing all architectures and object formats available
873 for specification with @samp{-b} or @samp{-m}.
875 @c suggest longname --section
877 @cindex section information
878 Display information only for section @var{name}.
880 @c suggest longname --label or --linespec
882 @cindex source filenames for object files
883 Label the display (using debugging information) with the source filename
884 and line numbers corresponding to the object code shown.
886 @c suggest longname --architecture
887 @item -m @var{machine}
889 Specify that the object files @var{objfile} are for architecture
890 @var{machine}. You can list available architectures using the @samp{-i}
895 @cindex relocation entries, in object file
896 Relocation. Print the relocation entries of the file.
899 @cindex sections, full contents
900 @cindex object file sections
901 Display the full contents of any sections requested.
906 @cindex debug symbols
907 @cindex ELF object file format
908 Display the full contents of any sections requested. Display the
909 contents of the .stab and .stab.index and .stab.excl sections from an
910 ELF file. This is only useful on systems (such as Solaris 2.0) in which
911 @code{.stab} debugging symbol-table entries are carried in an ELF
912 section. In most other file formats, debugging symbol-table entries are
913 interleaved with linkage symbols, and are visible in the @samp{--syms}
918 @cindex symbol table entries, printing
919 Symbol Table. Print the symbol table entries of the file.
920 This is similar to the information provided by the @samp{nm} program.
923 Print the version number of @code{objdump} and exit.
926 @cindex all header information, object file
927 @cindex header information, all
928 Display all available header information, including the symbol table and
929 relocation entries. Using @samp{-x} is equivalent to specifying all of
930 @samp{-a -f -h -r -t}.
933 @node ranlib, size, objdump, Top
937 @cindex archive contents
941 ranlib [-vV] @var{archive}
944 @code{ranlib} generates an index to the contents of an archive and
945 stores it in the archive. The index lists each symbol defined by a
946 member of an archive that is a relocatable object file.
948 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
950 An archive with such an index speeds up linking to the library and
951 allows routines in the library to call each other without regard to
952 their placement in the archive.
954 The GNU @code{ranlib} program is another form of GNU @code{ar}; running
955 @code{ranlib} is completely equivalent to executing @samp{ar -s}.
961 Show the version number of @code{ranlib}.
964 @node size, strings, ranlib, Top
968 @cindex section sizes
971 size [ -A | -B | --format=@var{compatibility} ]
972 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
973 [ --target=@var{bfdname} ] [ -V | --version ]
977 The GNU @code{size} utility lists the section sizes---and the total
978 size---for each of the object or archive files @var{objfile} in its
979 argument list. By default, one line of output is generated for each
980 object file or each module in an archive.
982 @var{objfile}@dots{} are the object files to be examined.
984 The command line options have the following meanings:
989 @itemx --format=@var{compatibility}
990 @cindex @code{size} display format
991 Using one of these options, you can choose whether the output from GNU
992 @code{size} resembles output from System V @code{size} (using @samp{-A},
993 or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
994 @samp{--format=berkeley}). The default is the one-line format similar to
996 @c Bonus for doc-source readers: you can also say --format=strange (or
997 @c anything else that starts with 's') for sysv, and --format=boring (or
998 @c anything else that starts with 'b') for Berkeley.
1000 Here is an example of the Berkeley (default) format of output from
1003 size --format Berkeley ranlib size
1004 text data bss dec hex filename
1005 294880 81920 11592 388392 5ed28 ranlib
1006 294880 81920 11888 388688 5ee50 size
1010 This is the same data, but displayed closer to System V conventions:
1013 size --format SysV ranlib size
1031 Show a summary of acceptable arguments and options.
1036 @itemx --radix=@var{number}
1037 @cindex @code{size} number format
1038 @cindex radix for section sizes
1039 Using one of these options, you can control whether the size of each
1040 section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1041 (@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1042 @samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
1043 values (8, 10, 16) are supported. The total size is always given in two
1044 radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1045 octal and hexadecimal if you're using @samp{-o}.
1047 @item --target=@var{bfdname}
1048 @cindex object code format
1049 Specify that the object-code format for @var{objfile} is
1050 @var{bfdname}. This option may not be necessary; @code{size} can
1051 automatically recognize many formats. @xref{objdump}, for information
1052 on listing available formats.
1056 Display the version number of @code{size}.
1059 @node strings, strip, size, Top
1062 @cindex listings strings
1063 @cindex printing strings
1064 @cindex strings, printing
1067 strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
1068 [--all] [--print-file-name] [--bytes=@var{min-len}]
1069 [--radix=@var{radix}] [--help] [--version] @var{file}@dots{}
1072 For each @var{file} given, GNU @code{strings} prints the printable
1073 character sequences that are at least 4 characters long (or the number
1074 given with the options below) and are followed by a NUL or newline
1075 character. By default, it only prints the strings from the initialized
1076 data sections of object files; for other types of files, it prints the
1077 strings from the whole file.
1079 @code{strings} is mainly useful for determining the contents of non-text
1086 Do not scan only the initialized data section of object files; scan
1090 @itemx --print-file-name
1091 Print the name of the file before each string.
1094 Print a summary of the program usage on the standard output and exit.
1096 @itemx -@var{min-len}
1097 @item -n @var{min-len}
1098 @itemx --bytes=@var{min-len}
1099 Print sequences of characters that are at least @var{min-len} characters
1100 long, instead of the default 4.
1103 Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1104 act like @samp{-t d} instead. Since we can not be compatible with both
1105 ways, we simply chose one.
1107 @item -t @var{radix}
1108 @itemx --radix=@var{radix}
1109 Print the offset within the file before each string. The single
1110 character argument specifies the radix of the offset---@samp{o} for
1111 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1115 Print the program version number on the standard output and exit.
1118 @node strip, c++filt, strings, Top
1122 @cindex removing symbols
1123 @cindex discarding symbols
1124 @cindex symbols, discarding
1127 strip [ -F @var{format} | --format=@var{format} | --target=@var{format} ]
1128 [ -I @var{format} | --input-format=@var{format} ]
1129 [ -O @var{format} | --output-format=@var{format} ]
1130 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
1131 [ -x | --discard-all ] [ -X | --discard-locals ]
1132 [ -v | --verbose ] [ -V | --version ] [ --help ]
1133 @var{objfile}@dots{}
1136 GNU @code{strip} discards all symbols from object files
1137 @var{objfile}. The list of object files may include archives.
1138 At least one object file must be given.
1140 @code{strip} modifies the files named in its argument,
1141 rather than writing modified copies under different names.
1144 @item -F @var{format}
1145 @itemx --format=@var{format}
1146 @itemx --target=@var{format}
1147 Treat the original @var{objfile} as a file with the object
1148 code format @var{format}, and rewrite it in the same format.
1151 Show a summary of the options to @code{strip} and exit.
1153 @item -I @var{format}
1154 @itemx --input-format=@var{format}
1155 Treat the original @var{objfile} as a file with the object
1156 code format @var{format}.
1158 @item -O @var{format}
1159 @itemx --output-format=@var{format}
1160 Replace @var{objfile} with a file in the output format @var{format}.
1168 @itemx --strip-debug
1169 Remove debugging symbols only.
1172 @itemx --discard-all
1173 Remove non-global symbols.
1176 @itemx --discard-locals
1177 Remove compiler-generated local symbols.
1178 (These usually start with @samp{L} or @samp{.}.)
1182 Show the version number for @code{strip}.
1186 Verbose output: list all object files modified. In the case of
1187 archives, @samp{strip -v} lists all members of the archive.
1190 @node c++filt, nlmconv, strip, Top
1194 @cindex demangling C++ symbols
1197 c++filt [ -_ | --strip-underscores ]
1198 [ -s @var{format} | --format=@var{format} ]
1199 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
1202 The C++ language provides function overloading, which means that you can
1203 write many functions with the same name (providing each takes parameters
1204 of different types). All C++ function names are encoded into a
1205 low-level assembly label (this process is known as
1206 @dfn{mangling}). The @code{c++filt} program does the inverse mapping: it
1207 decodes (@dfn{demangles}) low-level names into user-level names so that
1208 the linker can keep these overloaded functions from clashing.
1210 Every alphanumeric word (consisting of letters, digits, underscores,
1211 dollars, or periods) seen in the input is a potential label. If the
1212 label decodes into a C++ name, the C++ name replaces the low-level
1215 You can use @code{c++filt} to decipher individual symbols:
1218 c++filt @var{symbol}
1221 If no @var{symbol} arguments are given, @code{c++filt} reads symbol
1222 names from the standard input and writes the demangled names to the
1223 standard output. All results are printed on the standard output.
1227 @itemx --strip-underscores
1228 On some systems, both the C and C++ compilers put an underscore in front
1229 of every name. For example, the C name @code{foo} gets the low-level
1230 name @code{_foo}. This option removes the initial underscore.
1232 @item -s @var{format}
1233 @itemx --format=@var{format}
1234 GNU @code{nm} can decode three different methods of mangling, used by
1235 different C++ compilers. The argument to this option selects which
1240 the one used by the GNU compiler (the default method)
1242 the one used by the Lucid compiler
1244 the one specified by the C++ Annotated Reference Manual
1248 Print a summary of the options to @code{c++filt} and exit.
1251 Print the version number of @code{c++filt} and exit.
1255 @emph{Warning:} @code{c++filt} is a new utility, and the details of its
1256 user interface are subject to change in future releases. In particular,
1257 a command-line option may be required in the the future to decode a name
1258 passed as an argument on the command line; in other words,
1261 c++filt @var{symbol}
1265 may in a future release become
1268 c++filt @var{option} @var{symbol}
1272 @node nlmconv, Index, c++filt, Top
1275 @code{nlmconv} converts a relocatable object file into a NetWare
1276 Loadable Module. @code{nlmconv} currently only works with @samp{i386}
1277 object files in @code{coff}, @sc{elf}, or @code{a.out} format.
1280 nlmconv [ -I @var{format} | --input-format=@var{format} ]
1281 [ -O @var{format} | --output-format=@var{format} ]
1282 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
1283 [ -h | --help ] [ -V | --version ]
1284 @var{infile} @var{outfile}
1287 @code{nlmconv} converts the relocatable @samp{i386} object file
1288 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
1289 reading @var{headerfile} for NLM header information. For instructions
1290 on writing the NLM command file language used in header files, see
1291 @cite{The NetWare Tool Maker Specification Manual}, available from
1292 Novell, Inc. @code{nlmconv} uses the @sc{gnu} Binary File Descriptor
1293 library to read @var{infile}; see @ref{BFD,,BFD,ld.info,Using LD, the
1294 GNU linker}, for more information.
1297 @item -I @var{format}
1298 @itemx --input-format=@var{format}
1299 Object format of the input file. @code{nlmconv} can usually determine
1300 the format of a given file (so no default is necessary). @var{format}
1301 arguments are normal BFD names; for a list of these, run
1302 @w{@samp{objdump -i}}.
1304 @item -O @var{format}
1305 @itemx --output-format=@var{format}
1306 Object format of the output file. @code{nlmconv} infers the output
1307 format based on the input format, e.g. for a @samp{i386} input file the
1308 output format is @samp{nlm32-i386}. @var{format} arguments are normal
1309 BFD names; for a list of these, run @w{@samp{objdump -i}}.
1311 @item -T @var{headerfile}
1312 @itemx --header-file=@var{headerfile}
1313 Reads @var{headerfile} for NLM header information. For instructions on
1314 writing the NLM command file language used in header files, see
1315 @cite{The NetWare Tool Maker Specification Manual}, available from
1320 Prints a usage summary.
1324 Prints the version number for @code{nlmconv}.
1327 @node Index, , nlmconv, Top