2 @setfilename binutils.info
5 @c This file documents the GNU binary utilities "ar", "ld", "objdump", "nm",
6 @c "size", "strip", and "ranlib".
8 @c Copyright (C) 1991 Free Software Foundation, Inc.
10 @c This text may be freely distributed under the terms of the GNU
11 @c General Public License.
19 @setchapternewpage odd
20 @settitle GNU Binary Utilities
22 @title{The GNU Binary Utilities}
23 @subtitle{Version 1.9}
25 @subtitle October 1991
26 @author{Roland H. Pesch}
27 @author{Cygnus Support}
31 \def\$#1${{#1}} % Kluge: collect RCS revision info without $...$
32 \xdef\manvers{\$Revision$} % For use in headers, footers too
33 {\parskip=0pt \hfill Cygnus Support\par \hfill \manvers\par \hfill
34 \TeX{}info \texinfoversion\par }
37 @vskip 0pt plus 1filll
38 Copyright @copyright{} 1991 Free Software Foundation, Inc.
40 Permission is granted to make and distribute verbatim copies of
41 this manual provided the copyright notice and this permission notice
42 are preserved on all copies.
44 Permission is granted to copy and distribute modified versions of this
45 manual under the conditions for verbatim copying, provided also that
46 the entire resulting derived work is distributed under the terms of a
47 permission notice identical to this one.
49 Permission is granted to copy and distribute translations of this manual
50 into another language, under the above conditions for modified versions.
53 @node Top, ar, (dir), (dir)
56 This brief manual contains preliminary documentation for the GNU binary
57 utilities (collectively version 1.9): @samp{ar}, @samp{objdump},
58 @samp{nm}, @samp{size}, @samp{strip}, and @samp{ranlib}. @refill
61 Copyright @copyright{} 1991 Free Software Foundation, Inc.
63 Permission is granted to make and distribute verbatim copies of
64 this manual provided the copyright notice and this permission notice
65 are preserved on all copies.
68 Permission is granted to process this file through TeX and print the
69 results, provided the printed document carries a copying permission
70 notice identical to this one except for the removal of this paragraph
71 (this paragraph not being relevant to the printed manual).
75 Permission is granted to copy and distribute modified versions of this
76 manual under the conditions for verbatim copying, provided also that
77 the entire resulting derived work is distributed under the terms of a
78 permission notice identical to this one.
80 Permission is granted to copy and distribute translations of this manual
81 into another language, under the above conditions for modified versions.
94 @node ar, ld, Top, Top
98 ar [-]@var{p}@var{mod} [ @var{membername} ] @var{archive} @var{files}@dots{}
101 The GNU @code{ar} program creates, modifies, and extracts
102 archives. An @dfn{archive} is a single file holding a collection of
103 other files in a structure that makes it possible to retrieve
104 the original individual files (called @dfn{members} of the archive).
106 The original files' contents, mode (permissions), timestamp, owner, and
107 group are preserved in the archive, and may be reconstituted on
110 GNU @code{ar} can maintain archives whose members have names of any
111 length; however, depending on how @code{ar} is configured on your
112 system, a limit on member-name length may be imposed (for compatibility
113 with archive formats maintained with other tools). If it exists, the
114 limit is often 15 characters (typical of formats related to a.out) or 16
115 characters (typical of formats related to coff).
117 @code{ar} is considered a binary utility because archives of this sort
118 are most often used as @dfn{libraries} holding commonly needed
121 @code{ar} will create an index to the symbols defined in relocatable
122 object modules in the archive when you specify the modifier @samp{s}.
123 Once created, this index is updated in the archive whenever @code{ar}
124 makes a change to its contents. An archive with such an index speeds up
125 linking to the library, and allows routines in the library to call each
126 other without regard to their placement in the archive.
127 @c FIXME This auto-update may happen-always only for WRS version; Gumby
128 @c says, for instance, that it doesn't happen with 'q' updates elsewhere.
130 You may use @samp{nm -s} or @samp{nm +print-armap} to list this index
131 table. If an archive lacks the table, another form of @code{ar} called
132 @code{ranlib} can be used to add just the table.
134 @code{ar} insists on at least two arguments to execute: one
135 keyletter specifying the @emph{operation} (optionally accompanied by other
136 keyletters specifying @emph{modifiers}), and the archive name to act on.
138 Most operations can also accept further @var{files} arguments,
139 specifying particular files to operate on.
141 GNU @code{ar} allows you to mix the operation code @var{p} and modifier
142 flags @var{mod} in any order, within the first command-line argument.
144 If you wish, you may prefix the first command-line argument with a
147 The @var{p} keyletter specifies what operation to execute; it may be
148 any of the following, but you must specify only one of them:
152 @emph{Delete} modules from the archive. Specify the names of modules to
153 be deleted as @var{files}; the archive is untouched if you
154 specify no files to delete.
156 If you specify the @samp{v} modifier, @code{ar} will list each module
160 Use this operation to @emph{move} members in an archive.
162 The ordering of members in an archive can make a difference in how
163 programs are linked using the library, if a symbol is defined in more
166 If no modifiers are used with @code{m}, any members you name in the
167 @var{files} arguments are moved to the @emph{end} of the archive;
168 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
169 specified place instead.
172 @emph{Print} the specified members of the archive, to the standard
173 output file. If the @samp{v} modifier is specified, show the member
174 name before copying its contents to standard output.
176 If you specify no @var{files}, all the files in the archive are printed.
179 @emph{Quick append}; add @var{files} to the end of @var{archive},
180 without checking for replacement.
182 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
183 operation; new members are always placed at the end of the archive.
185 The modifier @samp{v} makes @code{ar} list each file as it is appended.
187 @c FIXME: per Gumby, versions other than WRS of this will *not* auto-update
188 @c SYMDEF index on 'q' updates.
191 Insert @var{files} into @var{archive} (with @emph{replacement}). This
192 operation differs from @samp{q} in that any previously existing members
193 are deleted if their names match those being added.
195 If one of the files named in @var{files} doesn't exist, @code{ar}
196 displays an error message, and leaves undisturbed any existing members
197 of the archive matching that name.
199 By default, new members are added at the end of the file; but you may
200 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
201 placement relative to some existing member.
203 The modifier @samp{v} used with this operation elicits a line of
204 output for each file inserted, along with one of the letters @samp{a} or
205 @samp{r} to indicate whether the file was appended (no old member
206 deleted) or replaced.
209 Display a @emph{table} listing the contents of @var{archive}, or those
210 of the files listed in @var{files} that are present in the
211 archive. Normally only the member name is shown; if you also want to
212 see the modes (permissions), timestamp, owner, group, and size, you can
213 request that by also specifying the @samp{v} modifier.
215 If you do not specify any @var{files}, all files in the archive
218 If there is more than one file with the same name (say, @samp{fie}) in
219 an archive (say @samp{b.a}), @samp{ar t b.a fie} will list only the
220 first instance; to see them all, you must ask for a complete
221 listing---in our example, @samp{ar t b.a}.
222 @c WRS only; per Gumby, this is implementation-dependent, and in a more
223 @c recent case in fact works the other way.
226 @emph{Extract} members (named @var{files}) from the archive. You can
227 use the @samp{v} modifier with this operation, to request that
228 @code{ar} list each name as it extracts it.
230 If you do not specify any @var{files}, all files in the archive
235 A number of modifiers (@var{mod}) may immediately follow the @var{p}
236 keyletter, to specify variations on an operation's behavior:
240 Add new files @emph{after} an existing member of the
241 archive. If you use the modifier @code{a}, the name of an existing archive
242 member must be present as the @var{membername} argument, before the
243 @var{archive} specification.
246 Add new files @emph{before} an existing member of the
247 archive. If you use the modifier @code{b}, the name of an existing archive
248 member must be present as the @var{membername} argument, before the
249 @var{archive} specification. (same as @samp{i}).
252 @emph{Create} the archive. The specified @var{archive} is always
253 created if it didn't exist, when you request an update. But a warning is
254 issued unless you specify in advance that you expect to create it, by
258 Insert new files @emph{before} an existing member of the
259 archive. If you use the modifier @code{i}, the name of an existing archive
260 member must be present as the @var{membername} argument, before the
261 @var{archive} specification. (same as @samp{b}).
264 This modifier is accepted but not used.
265 @c whaffor ar l modifier??? presumably compat; with
266 @c what???---pesch@@cygnus.com, 25jan91
269 Preserve the @emph{original} dates of members when extracting them. If
270 you do not specify this modifier, files extracted from the archive
271 will be stamped with the time of extraction.
274 Write an object-file index into the archive, or update an existing one,
275 even if no other change is made to the archive. You may use this modifier
276 flag either with any operation, or alone. Running @samp{ar s} on an
277 archive is equivalent to running @samp{ranlib} on it.
280 Normally, @code{ar r}@dots{} inserts all files
281 listed into the archive. If you would like to insert @emph{only} those
282 of the files you list that are newer than existing members of the same
283 names, use this modifier. The @samp{u} modifier is allowed only for the
284 operation @samp{r} (replace). In particular, the combination @samp{qu} is
285 not allowed, since checking the timestamps would lose any speed
286 advantage from the operation @samp{q}.
289 This modifier requests the @emph{verbose} version of an operation. Many
290 operations display additional information, such as filenames processed,
291 when the modifier @samp{v} is appended.
295 @node ld, nm, ar, Top
297 The GNU linker @code{ld} is now described in a separate manual.
298 @xref{Top, , Overview, , GLD: the GNU linker}.
300 @node nm, objdump, ld, Top
304 nm [ -a | +debug-syms ] [ -g | +extern-only ]
305 [ -s | +print-armap ] [ -o | +print-file-name ]
306 [ -n | +numeric-sort ] [ -p | +no-sort ]
307 [ -r | +reverse-sort ] [ -u | +undefined-only ]
308 [ +target @var{bfdname} ]
309 [ @var{objfiles}@dots{} ]
312 GNU @code{nm} will list the symbols from object files @var{objfiles}.
314 The long and short forms of options, shown here as alternatives, are
318 @item @var{objfiles}@dots{}
319 Object files whose symbols are to be listed. If no object files are
320 listed as arguments, @code{nm} assumes @samp{a.out}.
324 Display debugger-only symbols; normally these are not listed.
328 Display only external symbols.
332 Don't bother to sort the symbols in any order; just print them in the
337 Sort symbols numerically by their addresses, not alphabetically by their
342 When listing symbols from archives, list the index: a mapping (stored in
343 the archive by @code{ar} or @code{ranlib}) of what modules contain
344 definitions for what names.
346 @item +print-file-name
348 Precede each symbol by the name of the input file where it was found,
349 rather than identifying the input file once only before all of its
354 Reverse the sense of the sort (whether numeric or alphabetic); let the
357 @item +target @var{bfdname}
359 Specify an object code format other than your system's default format.
360 @xref{objdump}, for information on listing available formats.
361 @c FIXME what *does* +target/no arg do?
364 @item +undefined-only
366 Display only undefined symbols (those external to each object file).
370 @node objdump, ranlib, nm, Top
374 objdump [ -a ] [ -b @var{bfdname} ] [ -d ] [ -f ]
375 [ -h | +header ] [ -i ] [ -j @var{section} ] [ -l ]
376 [ -m @var{machine} ] [ -r | +reloc ] [ -s ]
377 [ -t | +syms ] [ -x ]
378 @var{objfiles}@dots{}
381 @code{objdump} displays information about one or more object files.
382 The options control what particular information to display. This
383 information is mostly useful to programmers who are working on the
384 compilation tools, as opposed to programmers who just want their
385 program to compile and work.
387 The long and short forms of options, shown here as alternatives, are
391 @item @var{objfiles}@dots{}
392 The object files to be examined.
396 If any files from @var{objfiles} are archives, display the archive
397 header information (in a format similar to @samp{ls -l}).
399 @c suggest longname +target or +format or +bfd
400 @item -b @var{bfdname}
401 You can specify a particular object-code format for your object files as
402 @var{bfdname}. This may not be necessary; @var{objdump} can
403 automatically recognize many formats. For example,
405 objdump -b oasys -m vax -h fu.o
408 Displays summary information from the section headers (@samp{-h}) of
409 @file{fu.o}, which is explicitly identified (@samp{-m}) as a Vax object
410 file in the format produced by Oasys compilers. You can list the
411 formats available with the @samp{-i} option.
414 Disassemble. Display the assembler mnemonics for the machine
415 instructions from @var{objfiles}.
418 File header. Display summary information from the overall header of
419 each file in @var{objfiles}.
423 Header. Display summary information from the section headers of the
427 Display a list showing all architectures and object formats available
428 for specification with @code{-b} or @code{-m}.
430 @c suggest longname +section
432 Display information only for section @var{name}
434 @c suggest longname +label or +linespec
436 Label the display (using debugging information) with the source filename
437 and line numbers corresponding to the object code shown.
439 @c suggest longname +architecture
440 @item -m @var{machine}
441 Specify the object files @var{objfiles} are for architecture
442 @var{machine}. You can list available architectures using the @samp{-i}
447 Relocation. Print the relocation entries of the file.
450 Display the full contents of any sections requested.
454 Symbol Table. Print the symbol table entries of the file.
455 This is similar to the information provided by the @samp{nm} program.
458 Display all available header information, including the symbol table and
459 relocation entries. Using @samp{-x} is equivalent to specifying all of
460 @samp{-f -a -h -r -t}.
464 @node ranlib, size, objdump, Top
471 @code{ranlib} generates an index to the contents of an archive, and
472 stores it in the archive. The index lists each symbol defined by a
473 member of an archive that is a relocatable object file.
475 You may use @code{nm -s} or @code{nm +print-armap} to list this index.
477 An archive with such an index speeds up linking to the library, and
478 allows routines in the library to call each other without regard to
479 their placement in the archive.
481 The GNU @code{ranlib} program is another form of GNU @code{ar}; running
482 @code{ranlib} is completely equivalent to executing @samp{ar -s}.
487 @c FIXME vintage ranlib had options [ -t | +touch ] [ -v | +verbose ]
488 @c which are gone here. Good or evil?
490 @code{ranlib}'s options make it report on what it's doing and fake an
491 update of a particular archive's index.
493 Any command-line options must precede the archive name.
495 The long and short forms of options, shown here as alternatives, are
501 You can use the ``touch'' option to fake an update of the index
502 table in archives; @code{ranlib} will first set the current date for the
503 index object module in the archive (to make it appear to have changed).
506 Use this option if you'd like informational messages about what
507 @code{ranlib} is up to, while it loops through the specified archives.
512 @node size, strip, ranlib, Top
516 size [ -A | -B | +format @var{compatibility} ]
517 [ +help ] [ -d | -o | -x | +radix @var{number} ]
518 [ +target @var{bfdname} [ -V | +version ]
519 @var{objfiles}@dots{}
522 The GNU @code{size} utility lists the section sizes---and the total
523 size---for each of the object files @var{objfiles} in its argument list.
524 By default, one line of output is generated for each object file or each
525 module in an archive.
527 The command line options have the following meanings:
529 @item @var{objfiles}@dots{}
530 The object files to be examined.
532 @item +format @var{compatibility}
535 Using one of these options, you can choose whether the output from GNU
536 @code{size} resembles output from System V @code{size} (using @samp{-A},
537 or @samp{+format sysv}, or Berkeley @code{size} (using @samp{-B}, or
538 @samp{+format berkeley}. The default is the one-line format similar to
540 @c Bonus for doc-source readers: you can also say +format=strange (or
541 @c anything else that starts with 's') for sysv, and +format=boring (or
542 @c anything else that starts with 'b') for Berkeley.
544 Here is an example of the Berkeley (default) format of output from
547 eg$ size +format Berkeley ranlib size
548 text data bss dec hex filename
549 294880 81920 11592 388392 5ed28 ranlib
550 294880 81920 11888 388688 5ee50 size
554 This is the same data, but displayed closer to System V conventions:
557 eg$ size +format SysV ranlib size
575 Show a summary of acceptable arguments and options.
577 @item +radix @var{number}
581 Using one of these options, you can control whether the size of each
582 section is given in decimal (@samp{-d}, or @samp{+radix 10}); octal
583 (@samp{-o}, or @samp{+radix 8}); or hexadecimal (@samp{-x}, or
584 @samp{+radix 16}). In @samp{+radix @var{number}}, only the three
585 values (8, 10, 16) are supported. The total size is always given in two
586 radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
587 octal and hexadecimal if you're using @samp{-o}.
589 @item +target @var{bfdname}
590 You can specify a particular object-code format for @var{objfiles} as
591 @var{bfdname}. This may not be necessary; @var{size} can
592 automatically recognize many formats. @xref{objdump}, for information
593 on listing available formats.
597 Display version number information on @code{size} itself.
602 @node strip, , size, Top
606 strip [ -s | +strip-all ] [ -g | -S | +strip-debug ]
607 [ -x | +discard-all ] [ -X | +discard-locals ]
609 @var{objfiles}@dots{}
612 GNU @code{strip} will discard all symbols from object files
613 @var{objfiles}, if no options are specified; or only certain symbols,
614 depending on its command-line options.
616 @code{strip} will not execute unless at least one object file is listed.
619 @emph{WARNING:} @code{strip} modifies the files named in its argument,
620 rather than writing modified copies under different names.
623 The long and short forms of options, shown here as alternatives, are
629 This is the default case: strip all symbol entries from @var{objfiles}.
634 Discard only debugging symbol information from @var{objfiles}.
638 Discard all symbols local to each file in @var{objfiles}.
639 @emph{WARNING:} Note that @code{+discard-all} discards only @emph{local}
640 symbols, in spite of its name.
642 @item +discard-locals
644 Discard local symbols starting with @samp{L} from each file in
645 @var{objfiles}. (Some compilers produce internally-used symbols that
646 begin with @samp{L}.)
648 @item -T @var{bfdname}
649 You can specify a particular object-code format @var{bfdname} for
650 @var{objfiles}. This may not be necessary; @var{strip} can automatically
651 recognize many formats. @xref{objdump}, for information on listing