Move "@c @smallbook" and "@c @cropmarks" out of titlepage, so if someone
[binutils-gdb.git] / binutils / binutils.texi
1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3
4 @ifinfo
5 @format
6 START-INFO-DIR-ENTRY
7 * Binutils: (binutils). The GNU binary utilities "ar", "ld", "copy",
8 "objdump", "nm", "size", "strip", and "ranlib".
9 END-INFO-DIR-ENTRY
10 @end format
11 @end ifinfo
12
13 @ifinfo
14 Copyright @copyright{} 1991 Free Software Foundation, Inc.
15
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.
19
20 @ignore
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).
25
26 @end ignore
27
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.
32
33 Permission is granted to copy and distribute translations of this manual
34 into another language, under the above conditions for modified versions.
35 @end ifinfo
36
37 @synindex ky cp
38 @c
39 @c This file documents the GNU binary utilities "ar", "ld", "copy", "objdump",
40 @c "nm", "size", "strip", and "ranlib".
41 @c
42 @c Copyright (C) 1991 Free Software Foundation, Inc.
43 @c
44 @c This text may be freely distributed under the terms of the GNU
45 @c General Public License.
46 @c
47
48 @setchapternewpage odd
49 @settitle GNU Binary Utilities
50 @c @smallbook
51 @c @cropmarks
52 @titlepage
53 @finalout
54 @title The GNU Binary Utilities
55 @subtitle Version 1.97
56 @sp 1
57 @subtitle October 1991
58 @author Roland H. Pesch
59 @author Cygnus Support
60 @page
61
62 @tex
63 \def\$#1${{#1}} % Kluge: collect RCS revision info without $...$
64 \xdef\manvers{\$Revision$} % For use in headers, footers too
65 {\parskip=0pt \hfill Cygnus Support\par \hfill \manvers\par \hfill
66 \TeX{}info \texinfoversion\par }
67 @end tex
68
69 @vskip 0pt plus 1filll
70 Copyright @copyright{} 1991 Free Software Foundation, Inc.
71
72 Permission is granted to make and distribute verbatim copies of
73 this manual provided the copyright notice and this permission notice
74 are preserved on all copies.
75
76 Permission is granted to copy and distribute modified versions of this
77 manual under the conditions for verbatim copying, provided also that
78 the entire resulting derived work is distributed under the terms of a
79 permission notice identical to this one.
80
81 Permission is granted to copy and distribute translations of this manual
82 into another language, under the above conditions for modified versions.
83 @end titlepage
84
85 @node Top, ar, (dir), (dir)
86 @chapter Introduction
87
88 @cindex version
89 This brief manual contains preliminary documentation for the GNU binary
90 utilities (collectively version 1.97):
91
92 @iftex
93 @table @code
94 @item ar
95 Create, modify, and extract from archives
96
97 @item copy
98 Copy and translate object files
99
100 @item nm
101 List symbols from object files
102
103 @item objdump
104 Display information from object files
105
106 @item ranlib
107 Generate index to archive contents
108
109 @item size
110 List section sizes and total size
111
112 @item strip
113 Discard symbols
114 @end table
115 @end iftex
116
117 @menu
118 * ar:: Create, modify, and extract from archives
119 * copy:: Copy and translate object files
120 * ld:(ld)Overview. Combine object and archive files
121 * nm:: List symbols from object files
122 * objdump:: Display information from object files
123 * ranlib:: Generate index to archive contents
124 * size:: List section sizes and total size
125 * strip:: Discard symbols
126 * Index::
127 @end menu
128
129 @node ar, copy, Top, Top
130 @chapter ar
131
132 @kindex ar
133 @cindex archives
134 @cindex collections of files
135 @smallexample
136 ar [-]@var{p}@var{mod} [ @var{membername} ] @var{archive} @var{files}@dots{}
137 ar -M [ <mri-script ]
138 @end smallexample
139
140 The GNU @code{ar} program creates, modifies, and extracts from
141 archives. An @dfn{archive} is a single file holding a collection of
142 other files in a structure that makes it possible to retrieve
143 the original individual files (called @dfn{members} of the archive).
144
145 The original files' contents, mode (permissions), timestamp, owner, and
146 group are preserved in the archive, and may be reconstituted on
147 extraction.
148
149 @cindex name length
150 GNU @code{ar} can maintain archives whose members have names of any
151 length; however, depending on how @code{ar} is configured on your
152 system, a limit on member-name length may be imposed (for compatibility
153 with archive formats maintained with other tools). If it exists, the
154 limit is often 15 characters (typical of formats related to a.out) or 16
155 characters (typical of formats related to coff).
156
157 @cindex libraries
158 @code{ar} is considered a binary utility because archives of this sort
159 are most often used as @dfn{libraries} holding commonly needed
160 subroutines.
161
162 @cindex symbol index
163 @code{ar} creates an index to the symbols defined in relocatable
164 object modules in the archive when you specify the modifier @samp{s}.
165 Once created, this index is updated in the archive whenever @code{ar}
166 makes a change to its contents (save for the @samp{q} update operation).
167 An archive with such an index speeds up linking to the library, and
168 allows routines in the library to call each other without regard to
169 their placement in the archive.
170
171 You may use @samp{nm -s} or @samp{nm +print-armap} to list this index
172 table. If an archive lacks the table, another form of @code{ar} called
173 @code{ranlib} can be used to add just the table.
174
175 @cindex compatibility, @code{ar}
176 @cindex @code{ar} compatibility
177 GNU @code{ar} is designed to be compatible with two different
178 facilities. You can control its activity using command-line options,
179 like the different varieties of @code{ar} on Unix systems; or, if you
180 specify the single command-line option @samp{-M}, you can control it
181 with a script supplied via standard input, like the MRI ``librarian''
182 program.
183
184 @menu
185 * ar-cmdline:: Controlling @code{ar} on the command line
186 * ar-scripts:: Controlling @code{ar} with a script
187 @end menu
188
189 @page
190 @node ar-cmdline, ar-scripts, ar, ar
191 @section Controlling @code{ar} on the command line
192
193 @smallexample
194 ar [-]@var{p}@var{mod} [ @var{membername} ] @var{archive} @var{files}@dots{}
195 @end smallexample
196
197 @cindex Unix compatibility, @code{ar}
198 When you use @code{ar} in the Unix style, @code{ar} insists on at least two
199 arguments to execute: one keyletter specifying the @emph{operation}
200 (optionally accompanied by other keyletters specifying
201 @emph{modifiers}), and the archive name to act on.
202
203 Most operations can also accept further @var{files} arguments,
204 specifying particular files to operate on.
205
206 GNU @code{ar} allows you to mix the operation code @var{p} and modifier
207 flags @var{mod} in any order, within the first command-line argument.
208
209 If you wish, you may begin the first command-line argument with a
210 dash.
211
212 @cindex operations on archive
213 The @var{p} keyletter specifies what operation to execute; it may be
214 any of the following, but you must specify only one of them:
215
216 @table @code
217 @item d
218 @cindex deleting from archive
219 @emph{Delete} modules from the archive. Specify the names of modules to
220 be deleted as @var{files}; the archive is untouched if you
221 specify no files to delete.
222
223 If you specify the @samp{v} modifier, @code{ar} lists each module
224 as it is deleted.
225
226 @item m
227 @cindex moving in archive
228 Use this operation to @emph{move} members in an archive.
229
230 The ordering of members in an archive can make a difference in how
231 programs are linked using the library, if a symbol is defined in more
232 than one member.
233
234 If no modifiers are used with @code{m}, any members you name in the
235 @var{files} arguments are moved to the @emph{end} of the archive;
236 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
237 specified place instead.
238
239 @item p
240 @cindex printing from archive
241 @emph{Print} the specified members of the archive, to the standard
242 output file. If the @samp{v} modifier is specified, show the member
243 name before copying its contents to standard output.
244
245 If you specify no @var{files}, all the files in the archive are printed.
246
247 @item q
248 @cindex quick append to archive
249 @emph{Quick append}; add @var{files} to the end of @var{archive},
250 without checking for replacement.
251
252 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
253 operation; new members are always placed at the end of the archive.
254
255 The modifier @samp{v} makes @code{ar} list each file as it is appended.
256
257 Since the point of this operation is speed, the archive's symbol table
258 index is not updated, even if it already existed; you can use @samp{ar s} or
259 @code{ranlib} explicitly to update the symbol table index.
260
261 @item r
262 @cindex replacement in archive
263 Insert @var{files} into @var{archive} (with @emph{replacement}). This
264 operation differs from @samp{q} in that any previously existing members
265 are deleted if their names match those being added.
266
267 If one of the files named in @var{files} doesn't exist, @code{ar}
268 displays an error message, and leaves undisturbed any existing members
269 of the archive matching that name.
270
271 By default, new members are added at the end of the file; but you may
272 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
273 placement relative to some existing member.
274
275 The modifier @samp{v} used with this operation elicits a line of
276 output for each file inserted, along with one of the letters @samp{a} or
277 @samp{r} to indicate whether the file was appended (no old member
278 deleted) or replaced.
279
280 @item t
281 @cindex contents of archive
282 Display a @emph{table} listing the contents of @var{archive}, or those
283 of the files listed in @var{files} that are present in the
284 archive. Normally only the member name is shown; if you also want to
285 see the modes (permissions), timestamp, owner, group, and size, you can
286 request that by also specifying the @samp{v} modifier.
287
288 If you do not specify any @var{files}, all files in the archive
289 are listed.
290
291 @cindex repeated names in archive
292 @cindex name duplication in archive
293 If there is more than one file with the same name (say, @samp{fie}) in
294 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
295 first instance; to see them all, you must ask for a complete
296 listing---in our example, @samp{ar t b.a}.
297 @c WRS only; per Gumby, this is implementation-dependent, and in a more
298 @c recent case in fact works the other way.
299
300 @item x
301 @cindex extract from archive
302 @emph{Extract} members (named @var{files}) from the archive. You can
303 use the @samp{v} modifier with this operation, to request that
304 @code{ar} list each name as it extracts it.
305
306 If you do not specify any @var{files}, all files in the archive
307 are extracted.
308
309 @end table
310
311 A number of modifiers (@var{mod}) may immediately follow the @var{p}
312 keyletter, to specify variations on an operation's behavior:
313
314 @table @code
315 @item a
316 @cindex relative placement in archive
317 Add new files @emph{after} an existing member of the
318 archive. If you use the modifier @code{a}, the name of an existing archive
319 member must be present as the @var{membername} argument, before the
320 @var{archive} specification.
321
322 @item b
323 Add new files @emph{before} an existing member of the
324 archive. If you use the modifier @code{b}, the name of an existing archive
325 member must be present as the @var{membername} argument, before the
326 @var{archive} specification. (same as @samp{i}).
327
328 @item c
329 @cindex creating archives
330 @emph{Create} the archive. The specified @var{archive} is always
331 created if it didn't exist, when you request an update. But a warning is
332 issued unless you specify in advance that you expect to create it, by
333 using this modifier.
334
335 @item i
336 Insert new files @emph{before} an existing member of the
337 archive. If you use the modifier @code{i}, the name of an existing archive
338 member must be present as the @var{membername} argument, before the
339 @var{archive} specification. (same as @samp{b}).
340
341 @item l
342 This modifier is accepted but not used.
343 @c whaffor ar l modifier??? presumably compat; with
344 @c what???---pesch@@cygnus.com, 25jan91
345
346 @item o
347 @cindex dates in archive
348 Preserve the @emph{original} dates of members when extracting them. If
349 you do not specify this modifier, files extracted from the archive
350 are stamped with the time of extraction.
351
352 @item s
353 @cindex writing archive index
354 Write an object-file index into the archive, or update an existing one,
355 even if no other change is made to the archive. You may use this modifier
356 flag either with any operation, or alone. Running @samp{ar s} on an
357 archive is equivalent to running @samp{ranlib} on it.
358
359 @item u
360 @cindex updating an archive
361 Normally, @code{ar r}@dots{} inserts all files
362 listed into the archive. If you would like to insert @emph{only} those
363 of the files you list that are newer than existing members of the same
364 names, use this modifier. The @samp{u} modifier is allowed only for the
365 operation @samp{r} (replace). In particular, the combination @samp{qu} is
366 not allowed, since checking the timestamps would lose any speed
367 advantage from the operation @samp{q}.
368
369 @item v
370 This modifier requests the @emph{verbose} version of an operation. Many
371 operations display additional information, such as filenames processed,
372 when the modifier @samp{v} is appended.
373 @end table
374
375 @node ar-scripts, , ar-cmdline, ar
376 @section Controlling @code{ar} with a script
377
378 @smallexample
379 ar -M [ <@var{script} ]
380 @end smallexample
381
382 @cindex MRI compatibility, @code{ar}
383 @cindex scripts, @code{ar}
384 If you use the single command-line option @samp{-M} with @code{ar}, you
385 can control its operation with a rudimentary command language. This
386 form of @code{ar} operates interactively if standard input is coming
387 directly from a terminal. During interactive use, @code{ar} prompts for
388 input (the prompt is @samp{AR >}), and continues executing even after
389 errors. If you redirect standard input to a script file, no prompts are
390 issued, and @code{ar} abandons execution (with a nonzero exit code)
391 on any error.
392
393 The @code{ar} command language is @emph{not} designed to be equivalent
394 to the command-line options; in fact, it provides somewhat less control
395 over archives. The only purpose of the command language is to ease the
396 transition to GNU @code{ar} for developers who already have scripts
397 written for the MRI ``librarian'' program.
398
399 The syntax for the @code{ar} command language is straightforward:
400 @itemize @bullet
401 @item
402 commands are recognized in upper or lower case; for example, @code{LIST}
403 is the same as @code{list}. In the following descriptions, commands are
404 shown in upper case for clarity.
405
406 @item
407 a single command may appear on each line; it is the first word on the
408 line.
409
410 @item
411 empty lines are allowed, and have no effect.
412
413 @item
414 comments are allowed; text after either of the characters @samp{*}
415 or @samp{;} is ignored.
416
417 @item
418 Whenever you use a list of names as part of the argument to an @code{ar}
419 command, you can separate the individual names with either commas or
420 blanks. Commas are shown in the explanations below, for clarity.
421
422 @item
423 @samp{+} is used as a line continuation character; if @samp{+} appears
424 at the end of a line, the text on the following line is considered part
425 of the current command.
426 @end itemize
427
428 Here are the commands you can use in @code{ar} scripts, or when using
429 @code{ar} interactively. Three of them have special significance:
430
431 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
432 a temporary file required for most of the other commands.
433
434 @code{SAVE} commits the changes so far specified by the script. Prior
435 to @code{SAVE}, commands affect only the temporary copy of the current
436 archive.
437
438 @table @code
439 @item ADDLIB @var{archive}
440 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
441 Add all the contents of @var{archive} (or, if specified, each named
442 @var{module} from @var{archive}) to the current archive.
443
444 Requires prior use of @code{OPEN} or @code{CREATE}.
445
446 @item ADDMOD @var{file}, @var{file}, @dots{} @var{file}
447 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
448 @c else like "ar q..."
449 Add each named @var{file} as a module in the current archive.
450
451 Requires prior use of @code{OPEN} or @code{CREATE}.
452
453 @item CLEAR
454 Discard the contents of the current archive, cancelling the effect of
455 any operations since the last @code{SAVE}. May be executed (with no
456 effect) even if no current archive is specified.
457
458 @item CREATE @var{archive}
459 Creates an archive, and makes it the current archive (required for many
460 other commands). The new archive is created with a temporary name; it
461 is not actually saved as @var{archive} until you use @code{SAVE}.
462 You can overwrite existing archives; similarly, the contents of any
463 existing file named @var{archive} will not be destroyed until @code{SAVE}.
464
465 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
466 Delete each listed @var{module} from the current archive; equivalent to
467 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
468
469 Requires prior use of @code{OPEN} or @code{CREATE}.
470
471 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
472 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
473 List each named @var{module} present in @var{archive}. The separate
474 command @code{VERBOSE} specifies the form of the output: when verbose
475 output is off, output is like that of @samp{ar -t @var{archive}
476 @var{module}@dots{}}. When verbose output is on, the listing is like
477 @samp{ar -tv @var{archive} @var{module}@dots{}}.
478
479 Output normally goes to the standard output stream; however, if you
480 specify @var{outputfile} as a final argument, @code{ar} directs the
481 output to that file.
482
483 @item END
484 Exit from @code{ar}, with a @code{0} exit code to indicate successful
485 completion. This command does not save the output file; if you have
486 changed the current archive since the last @code{SAVE} command, those
487 changes are lost.
488
489 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
490 Extract each named @var{module} from the current archive, writing them
491 into the current directory as separate files. Equivalent to @samp{ar -x
492 @var{archive} @var{module}@dots{}}.
493
494 Requires prior use of @code{OPEN} or @code{CREATE}.
495
496 @ignore
497 @c FIXME Tokens but no commands???
498 @item FULLDIR
499
500 @item HELP
501 @end ignore
502
503 @item LIST
504 Display full contents of the current archive, in ``verbose'' style
505 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
506 tv @var{archive}}). (This single command is a GNU @code{ld}
507 enhancement, rather than present for MRI compatibility.)
508
509 Requires prior use of @code{OPEN} or @code{CREATE}.
510
511 @item OPEN @var{archive}
512 Opens an existing archive for use as the current archive (required for
513 many other commands). Any changes as the result of subsequent commands
514 will not actually affect @var{archive} until you next use @code{SAVE}.
515
516 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
517 In the current archive, replace each existing @var{module} (named in
518 the @code{REPLACE} arguments) from files in the current working directory.
519 To execute this command without errors, both the file, and the module in
520 the current archive, must exist.
521
522 Requires prior use of @code{OPEN} or @code{CREATE}.
523
524 @item VERBOSE
525 Toggle an internal flag governing the output from @code{DIRECTORY}.
526 When the flag is on, @code{DIRECTORY} output matches output from
527 @samp{ar -tv @dots{}}.
528
529 @item SAVE
530 Commit your changes to the current archive, and actually save it as a
531 file with the name specified in the last @code{CREATE} or @code{OPEN}
532 command.
533
534 Requires prior use of @code{OPEN} or @code{CREATE}.
535
536 @end table
537
538 @node copy, nm, ar, Top
539
540 @chapter copy
541
542 @smallexample
543 copy [-S] [-s srcfmt] [-d dtfmt] [-b bothfmts] infile [outfile] [-vV]
544 @end smallexample
545
546 The Gnu @code{copy} utility copies the contents of object files. @code{copy}
547 uses the Gnu BFD Library to read and write the object files. It
548 can write the destination object file in a format different from that
549 of the source object file. The exact behavior of @code{copy} is controlled
550 by command-line options.
551
552 @code{copy} creates temporary files to do its translations and
553 deletes them afterward. If no destination file is specified, a
554 temporary file is created and the result is destructively renamed with
555 the name of the input file. @code{copy} uses BFD to do all its
556 translation work; it knows about all the formats BFD knows about, and
557 thus is able to recognize most formats without being told explicitly.
558 @xref{BFD,,BFD,ld.info,Using LD, the GNU linker}.
559
560 @table @code
561 @item -S
562 @cindex calls @samp{strip}
563 Causes @code{copy} to strip relocation and symbol information from the
564 source file as the file is copied.
565
566 @item -s @var{format}
567 Explicitly specifies the object format of the source file.
568
569 @item -d @var{format}
570 Explicitly specifies the object format of the desired output file.
571
572 @item -b @var{format}
573 Explicitly specifies that the object format of the output should be the
574 same as the input, i.e. a simple data transfer from source to
575 destination with no translation involved.
576
577 @item -v
578 Show version number.
579
580 @item -V
581 Requests verbose output.
582
583 @end table
584
585 @iftex
586 @node ld
587 @chapter ld
588 @cindex linker
589 @kindex ld
590 The GNU linker @code{ld} is now described in a separate manual.
591 @xref{Top,, Overview,, Using LD: the GNU linker}.
592 @end iftex
593
594 @node nm, objdump, copy, Top
595 @chapter nm
596 @cindex symbols
597 @kindex nm
598
599 @smallexample
600 nm [ -a | +debug-syms ] [ -g | +extern-only ]
601 [ -s | +print-armap ] [ -o | +print-file-name ]
602 [ -n | +numeric-sort ] [ -p | +no-sort ]
603 [ -r | +reverse-sort ] [ -u | +undefined-only ]
604 [ +target @var{bfdname} ]
605 [ @var{objfiles}@dots{} ]
606 @end smallexample
607
608 GNU @code{nm} lists the symbols from object files @var{objfiles}.
609
610 The long and short forms of options, shown here as alternatives, are
611 equivalent.
612
613 @table @code
614 @item @var{objfiles}@dots{}
615 @kindex a.out
616 Object files whose symbols are to be listed. If no object files are
617 listed as arguments, @code{nm} assumes @samp{a.out}.
618
619 @item -a
620 @itemx +debug-syms
621 @cindex debugging symbols
622 Display debugger-only symbols; normally these are not listed.
623
624 @item -g
625 @itemx +extern-only
626 @cindex external symbols
627 Display only external symbols.
628
629 @item -p
630 @itemx +no-sort
631 @cindex sorting symbols
632 Don't bother to sort the symbols in any order; just print them in the
633 order encountered.
634
635 @item -n
636 @itemx +numeric-sort
637 Sort symbols numerically by their addresses, not alphabetically by their
638 names.
639
640 @item -s
641 @itemx +print-armap
642 @cindex symbol index, listing
643 When listing symbols from archive members, include the index: a mapping
644 (stored in the archive by @code{ar} or @code{ranlib}) of what modules
645 contain definitions for what names.
646
647 @item -o
648 @itemx +print-file-name
649 @cindex input file name
650 @cindex file name
651 @cindex source file name
652 Precede each symbol by the name of the input file where it was found,
653 rather than identifying the input file once only before all of its
654 symbols.
655
656 @item -r
657 @itemx +reverse-sort
658 Reverse the sense of the sort (whether numeric or alphabetic); let the
659 last come first.
660
661 @item +target @var{bfdname}
662 @c @item +target
663 @cindex object code format
664 Specify an object code format other than your system's default format.
665 @xref{objdump}, for information on listing available formats.
666 @c FIXME what *does* +target/no arg do?
667
668 @item -u
669 @itemx +undefined-only
670 @cindex external symbols
671 @cindex undefined symbols
672 Display only undefined symbols (those external to each object file).
673
674 @end table
675
676 @node objdump, ranlib, nm, Top
677 @chapter objdump
678
679 @cindex object file information
680 @kindex objdump
681
682 @smallexample
683 objdump [ -a ] [ -b @var{bfdname} ] [ -d ] [ -f ]
684 [ -h | --header ] [ -i ] [ -j @var{section} ] [ -l ]
685 [ -m @var{machine} ] [ -r | --reloc ] [ -s ]
686 [ --stabs ] [ -t | --syms ] [ -x ]
687 @var{objfiles}@dots{}
688 @end smallexample
689
690 @code{objdump} displays information about one or more object files.
691 The options control what particular information to display. This
692 information is mostly useful to programmers who are working on the
693 compilation tools, as opposed to programmers who just want their
694 program to compile and work.
695
696 The long and short forms of options, shown here as alternatives, are
697 equivalent.
698
699 @table @code
700 @item @var{objfiles}@dots{}
701 The object files to be examined. When you specify archives,
702 @code{objdump} shows information on each of the member object files.
703
704 @item -a
705 @c print_arelt_descr
706 @cindex archive headers
707 If any files from @var{objfiles} are archives, display the archive
708 header information (in a format similar to @samp{ls -l}). Besides the
709 information you could list with @samp{ar tv}, @samp{objdump -a} shows
710 the object file format of each archive member.
711
712 @c suggest longname --target or --format or --bfd
713 @item -b @var{bfdname}
714 @cindex object code format
715 You can specify a particular object-code format for your object files as
716 @var{bfdname}. This may not be necessary; @var{objdump} can
717 automatically recognize many formats. For example,
718 @example
719 objdump -b oasys -m vax -h fu.o
720 @end example
721 @noindent
722 Displays summary information from the section headers (@samp{-h}) of
723 @file{fu.o}, which is explicitly identified (@samp{-m}) as a Vax object
724 file in the format produced by Oasys compilers. You can list the
725 formats available with the @samp{-i} option.
726
727 @item -d
728 @cindex disassembling object code
729 @cindex machine instructions
730 Disassemble. Display the assembler mnemonics for the machine
731 instructions from @var{objfiles}.
732
733 @item -f
734 @cindex object file header
735 File header. Display summary information from the overall header of
736 each file in @var{objfiles}.
737
738 @item -h
739 @itemx --header
740 @cindex section headers
741 Header. Display summary information from the section headers of the
742 object file.
743
744 @item -i
745 @cindex architectures available
746 @cindex object formats available
747 Display a list showing all architectures and object formats available
748 for specification with @code{-b} or @code{-m}.
749
750 @c suggest longname --section
751 @item -j @var{name}
752 @cindex section information
753 Display information only for section @var{name}
754
755 @c suggest longname --label or --linespec
756 @item -l
757 @cindex source filenames for object files
758 Label the display (using debugging information) with the source filename
759 and line numbers corresponding to the object code shown.
760
761 @c suggest longname --architecture
762 @item -m @var{machine}
763 @cindex architecture
764 Specify the object files @var{objfiles} are for architecture
765 @var{machine}. You can list available architectures using the @samp{-i}
766 option.
767
768 @item -r
769 @itemx --reloc
770 @cindex relocation entries, in object file
771 Relocation. Print the relocation entries of the file.
772
773 @item -s
774 @cindex sections, full contents
775 @cindex object file sections
776 Display the full contents of any sections requested.
777
778 @item --stabs
779 @cindex stab
780 @cindex .stab
781 @cindex debug symbols
782 @cindex ELF object file format
783 Display the full contents of any sections requested. Display the
784 contents of the .stab and .stab.index and .stab.excl sections from an
785 ELF file. This is only useful on systems (such as Solaris 2.0) in which
786 @code{.stab} debugging symbol-table entries are carried in an ELF
787 section. In most other file formats, debugging symbol-table entries are
788 interleaved with linkage symbols, and are visible in the @samp{--syms}
789 output.
790
791 @item -t
792 @itemx --syms
793 @cindex symbol table entries, printing
794 Symbol Table. Print the symbol table entries of the file.
795 This is similar to the information provided by the @samp{nm} program.
796
797 @item -x
798 @cindex all header information, object file
799 @cindex header information, all
800 Display all available header information, including the symbol table and
801 relocation entries. Using @samp{-x} is equivalent to specifying all of
802 @samp{-a -f -h -r -t}.
803
804 @end table
805
806 @node ranlib, size, objdump, Top
807 @chapter ranlib
808
809 @kindex ranlib
810 @cindex archive contents
811 @cindex symbol index
812
813 @smallexample
814 ranlib @var{archive}
815 @end smallexample
816
817 @code{ranlib} generates an index to the contents of an archive, and
818 stores it in the archive. The index lists each symbol defined by a
819 member of an archive that is a relocatable object file.
820
821 You may use @samp{nm -s} or @samp{nm +print-armap} to list this index.
822
823 An archive with such an index speeds up linking to the library, and
824 allows routines in the library to call each other without regard to
825 their placement in the archive.
826
827 The GNU @code{ranlib} program is another form of GNU @code{ar}; running
828 @code{ranlib} is completely equivalent to executing @samp{ar -s}.
829 @xref{ar}.
830
831 @node size, strip, ranlib, Top
832 @chapter size
833
834 @kindex size
835 @cindex section sizes
836
837 @smallexample
838 size [ -A | -B | +format @var{compatibility} ]
839 [ +help ] [ -d | -o | -x | +radix @var{number} ]
840 [ +target @var{bfdname} ] [ -V | +version ]
841 @var{objfiles}@dots{}
842 @end smallexample
843
844 The GNU @code{size} utility lists the section sizes---and the total
845 size---for each of the object files @var{objfiles} in its argument list.
846 By default, one line of output is generated for each object file or each
847 module in an archive.
848
849 The command line options have the following meanings:
850 @table @code
851 @item @var{objfiles}@dots{}
852 The object files to be examined.
853
854 @item -A
855 @itemx -B
856 @itemx +format @var{compatibility}
857 @cindex size display format
858 Using one of these options, you can choose whether the output from GNU
859 @code{size} resembles output from System V @code{size} (using @samp{-A},
860 or @samp{+format sysv}), or Berkeley @code{size} (using @samp{-B}, or
861 @samp{+format berkeley}). The default is the one-line format similar to
862 Berkeley's.
863 @c Bonus for doc-source readers: you can also say +format=strange (or
864 @c anything else that starts with 's') for sysv, and +format=boring (or
865 @c anything else that starts with 'b') for Berkeley.
866
867 Here is an example of the Berkeley (default) format of output from
868 @code{size}:
869 @smallexample
870 eg$ size +format Berkeley ranlib size
871 text data bss dec hex filename
872 294880 81920 11592 388392 5ed28 ranlib
873 294880 81920 11888 388688 5ee50 size
874 @end smallexample
875
876 @noindent
877 This is the same data, but displayed closer to System V conventions:
878
879 @smallexample
880 eg$ size +format SysV ranlib size
881 ranlib :
882 section size addr
883 .text 294880 8192
884 .data 81920 303104
885 .bss 11592 385024
886 Total 388392
887
888
889 size :
890 section size addr
891 .text 294880 8192
892 .data 81920 303104
893 .bss 11888 385024
894 Total 388688
895 @end smallexample
896
897 @item +help
898 Show a summary of acceptable arguments and options.
899
900 @item -d
901 @itemx -o
902 @itemx -x
903 @itemx +radix @var{number}
904 @cindex size number format
905 @cindex radix for section sizes
906 Using one of these options, you can control whether the size of each
907 section is given in decimal (@samp{-d}, or @samp{+radix 10}); octal
908 (@samp{-o}, or @samp{+radix 8}); or hexadecimal (@samp{-x}, or
909 @samp{+radix 16}). In @samp{+radix @var{number}}, only the three
910 values (8, 10, 16) are supported. The total size is always given in two
911 radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
912 octal and hexadecimal if you're using @samp{-o}.
913
914 @item +target @var{bfdname}
915 @cindex object code format
916 You can specify a particular object-code format for @var{objfiles} as
917 @var{bfdname}. This may not be necessary; @var{size} can
918 automatically recognize many formats. @xref{objdump}, for information
919 on listing available formats.
920
921 @item -V
922 @itemx +version
923 Display version number information on @code{size} itself.
924
925 @end table
926
927 @node strip, Index, size, Top
928 @chapter strip
929
930 @kindex strip
931 @cindex removing symbols
932 @cindex discarding symbols
933 @cindex symbols, discarding
934
935 @smallexample
936 strip [ -v ] @var{objfiles}@dots{}
937 @end smallexample
938
939 GNU @code{strip} discards all symbols from object files
940 @var{objfiles}. The list of object files may include archives.
941
942 @code{strip} will not execute unless at least one object file is listed.
943
944 @quotation
945 @emph{WARNING:} @code{strip} modifies the files named in its argument,
946 rather than writing modified copies under different names.
947 @end quotation
948
949 @table @code
950 @item -v
951 Verbose operation: list all object files modified. In the case of
952 archives, @samp{strip -v} lists all members of the archive.
953 @end table
954
955 @node Index, , strip, Top
956 @unnumbered Index
957
958 @printindex cp
959
960 @contents
961 @bye