* objcopy.c (change_leading_char): New static variable.
[binutils-gdb.git] / binutils / binutils.texi
1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @include config.texi
4
5 @ifinfo
6 @format
7 START-INFO-DIR-ENTRY
8 * Binutils: (binutils). The GNU binary utilities "ar", "objcopy",
9 "objdump", "nm", "nlmconv", "size",
10 "strings", "strip", and "ranlib".
11 END-INFO-DIR-ENTRY
12 @end format
13 @end ifinfo
14
15 @ifinfo
16 Copyright @copyright{} 1991, 92, 93, 94, 95, 1996 Free Software Foundation, Inc.
17
18 Permission is granted to make and distribute verbatim copies of
19 this manual provided the copyright notice and this permission notice
20 are preserved on all copies.
21
22 @ignore
23 Permission is granted to process this file through TeX and print the
24 results, provided the printed document carries a copying permission
25 notice identical to this one except for the removal of this paragraph
26 (this paragraph not being relevant to the printed manual).
27
28 @end ignore
29
30 Permission is granted to copy and distribute modified versions of this
31 manual under the conditions for verbatim copying, provided also that
32 the entire resulting derived work is distributed under the terms of a
33 permission notice identical to this one.
34
35 Permission is granted to copy and distribute translations of this manual
36 into another language, under the above conditions for modified versions.
37 @end ifinfo
38
39 @synindex ky cp
40 @c
41 @c This file documents the GNU binary utilities "ar", "ld", "objcopy",
42 @c "objdump", "nm", "size", "strings", "strip", and "ranlib".
43 @c
44 @c Copyright (C) 1991, 92, 93, 94, 95, 1996 Free Software Foundation, Inc.
45 @c
46 @c This text may be freely distributed under the terms of the GNU
47 @c General Public License.
48 @c
49
50 @setchapternewpage odd
51 @settitle @sc{gnu} Binary Utilities
52 @titlepage
53 @finalout
54 @title The @sc{gnu} Binary Utilities
55 @subtitle Version @value{VERSION}
56 @sp 1
57 @subtitle May 1993
58 @author Roland H. Pesch
59 @author Jeffrey M. Osier
60 @author Cygnus Support
61 @page
62
63 @tex
64 {\parskip=0pt \hfill Cygnus Support\par \hfill
65 \TeX{}info \texinfoversion\par }
66 @end tex
67
68 @vskip 0pt plus 1filll
69 Copyright @copyright{} 1991, 92, 93, 94, 95, 1996 Free Software Foundation, Inc.
70
71 Permission is granted to make and distribute verbatim copies of
72 this manual provided the copyright notice and this permission notice
73 are preserved on all copies.
74
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.
79
80 Permission is granted to copy and distribute translations of this manual
81 into another language, under the above conditions for modified versions.
82 @end titlepage
83
84 @node Top
85 @top Introduction
86
87 @cindex version
88 This brief manual contains preliminary documentation for the @sc{gnu} binary
89 utilities (collectively version @value{VERSION}):
90
91 @iftex
92 @table @code
93 @item ar
94 Create, modify, and extract from archives
95
96 @item nm
97 List symbols from object files
98
99 @item objcopy
100 Copy and translate object files
101
102 @item objdump
103 Display information from object files
104
105 @item ranlib
106 Generate index to archive contents
107
108 @item size
109 List file section sizes and total size
110
111 @item strings
112 List printable strings from files
113
114 @item strip
115 Discard symbols
116
117 @item c++filt
118 Demangle encoded C++ symbols
119
120 @item nlmconv
121 Convert object code into a Netware Loadable Module
122 @end table
123 @end iftex
124
125 @menu
126 * ar:: Create, modify, and extract from archives
127 * nm:: List symbols from object files
128 * objcopy:: Copy and translate object files
129 * objdump:: Display information from object files
130 * ranlib:: Generate index to archive contents
131 * size:: List section sizes and total size
132 * strings:: List printable strings from files
133 * strip:: Discard symbols
134 * c++filt:: Filter to demangle encoded C++ symbols
135 * nlmconv:: Converts object code into an NLM
136 * Selecting The Target System:: How these utilities determine the target.
137 * Index::
138 @end menu
139
140 @node ar
141 @chapter ar
142
143 @kindex ar
144 @cindex archives
145 @cindex collections of files
146 @smallexample
147 ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
148 ar -M [ <mri-script ]
149 @end smallexample
150
151 The @sc{gnu} @code{ar} program creates, modifies, and extracts from
152 archives. An @dfn{archive} is a single file holding a collection of
153 other files in a structure that makes it possible to retrieve
154 the original individual files (called @dfn{members} of the archive).
155
156 The original files' contents, mode (permissions), timestamp, owner, and
157 group are preserved in the archive, and can be restored on
158 extraction.
159
160 @cindex name length
161 @sc{gnu} @code{ar} can maintain archives whose members have names of any
162 length; however, depending on how @code{ar} is configured on your
163 system, a limit on member-name length may be imposed for compatibility
164 with archive formats maintained with other tools. If it exists, the
165 limit is often 15 characters (typical of formats related to a.out) or 16
166 characters (typical of formats related to coff).
167
168 @cindex libraries
169 @code{ar} is considered a binary utility because archives of this sort
170 are most often used as @dfn{libraries} holding commonly needed
171 subroutines.
172
173 @cindex symbol index
174 @code{ar} creates an index to the symbols defined in relocatable
175 object modules in the archive when you specify the modifier @samp{s}.
176 Once created, this index is updated in the archive whenever @code{ar}
177 makes a change to its contents (save for the @samp{q} update operation).
178 An archive with such an index speeds up linking to the library, and
179 allows routines in the library to call each other without regard to
180 their placement in the archive.
181
182 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
183 table. If an archive lacks the table, another form of @code{ar} called
184 @code{ranlib} can be used to add just the table.
185
186 @cindex compatibility, @code{ar}
187 @cindex @code{ar} compatibility
188 @sc{gnu} @code{ar} is designed to be compatible with two different
189 facilities. You can control its activity using command-line options,
190 like the different varieties of @code{ar} on Unix systems; or, if you
191 specify the single command-line option @samp{-M}, you can control it
192 with a script supplied via standard input, like the MRI ``librarian''
193 program.
194
195 @menu
196 * ar cmdline:: Controlling @code{ar} on the command line
197 * ar scripts:: Controlling @code{ar} with a script
198 @end menu
199
200 @page
201 @node ar cmdline
202 @section Controlling @code{ar} on the command line
203
204 @smallexample
205 ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
206 @end smallexample
207
208 @cindex Unix compatibility, @code{ar}
209 When you use @code{ar} in the Unix style, @code{ar} insists on at least two
210 arguments to execute: one keyletter specifying the @emph{operation}
211 (optionally accompanied by other keyletters specifying
212 @emph{modifiers}), and the archive name to act on.
213
214 Most operations can also accept further @var{member} arguments,
215 specifying particular files to operate on.
216
217 @sc{gnu} @code{ar} allows you to mix the operation code @var{p} and modifier
218 flags @var{mod} in any order, within the first command-line argument.
219
220 If you wish, you may begin the first command-line argument with a
221 dash.
222
223 @cindex operations on archive
224 The @var{p} keyletter specifies what operation to execute; it may be
225 any of the following, but you must specify only one of them:
226
227 @table @code
228 @item d
229 @cindex deleting from archive
230 @emph{Delete} modules from the archive. Specify the names of modules to
231 be deleted as @var{member}@dots{}; the archive is untouched if you
232 specify no files to delete.
233
234 If you specify the @samp{v} modifier, @code{ar} lists each module
235 as it is deleted.
236
237 @item m
238 @cindex moving in archive
239 Use this operation to @emph{move} members in an archive.
240
241 The ordering of members in an archive can make a difference in how
242 programs are linked using the library, if a symbol is defined in more
243 than one member.
244
245 If no modifiers are used with @code{m}, any members you name in the
246 @var{member} arguments are moved to the @emph{end} of the archive;
247 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
248 specified place instead.
249
250 @item p
251 @cindex printing from archive
252 @emph{Print} the specified members of the archive, to the standard
253 output file. If the @samp{v} modifier is specified, show the member
254 name before copying its contents to standard output.
255
256 If you specify no @var{member} arguments, all the files in the archive are
257 printed.
258
259 @item q
260 @cindex quick append to archive
261 @emph{Quick append}; add the files @var{member}@dots{} to the end of
262 @var{archive}, without checking for replacement.
263
264 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
265 operation; new members are always placed at the end of the archive.
266
267 The modifier @samp{v} makes @code{ar} list each file as it is appended.
268
269 Since the point of this operation is speed, the archive's symbol table
270 index is not updated, even if it already existed; you can use @samp{ar s} or
271 @code{ranlib} explicitly to update the symbol table index.
272
273 @item r
274 @cindex replacement in archive
275 Insert the files @var{member}@dots{} into @var{archive} (with
276 @emph{replacement}). This operation differs from @samp{q} in that any
277 previously existing members are deleted if their names match those being
278 added.
279
280 If one of the files named in @var{member}@dots{} does not exist, @code{ar}
281 displays an error message, and leaves undisturbed any existing members
282 of the archive matching that name.
283
284 By default, new members are added at the end of the file; but you may
285 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
286 placement relative to some existing member.
287
288 The modifier @samp{v} used with this operation elicits a line of
289 output for each file inserted, along with one of the letters @samp{a} or
290 @samp{r} to indicate whether the file was appended (no old member
291 deleted) or replaced.
292
293 @item t
294 @cindex contents of archive
295 Display a @emph{table} listing the contents of @var{archive}, or those
296 of the files listed in @var{member}@dots{} that are present in the
297 archive. Normally only the member name is shown; if you also want to
298 see the modes (permissions), timestamp, owner, group, and size, you can
299 request that by also specifying the @samp{v} modifier.
300
301 If you do not specify a @var{member}, all files in the archive
302 are listed.
303
304 @cindex repeated names in archive
305 @cindex name duplication in archive
306 If there is more than one file with the same name (say, @samp{fie}) in
307 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
308 first instance; to see them all, you must ask for a complete
309 listing---in our example, @samp{ar t b.a}.
310 @c WRS only; per Gumby, this is implementation-dependent, and in a more
311 @c recent case in fact works the other way.
312
313 @item x
314 @cindex extract from archive
315 @emph{Extract} members (named @var{member}) from the archive. You can
316 use the @samp{v} modifier with this operation, to request that
317 @code{ar} list each name as it extracts it.
318
319 If you do not specify a @var{member}, all files in the archive
320 are extracted.
321
322 @end table
323
324 A number of modifiers (@var{mod}) may immediately follow the @var{p}
325 keyletter, to specify variations on an operation's behavior:
326
327 @table @code
328 @item a
329 @cindex relative placement in archive
330 Add new files @emph{after} an existing member of the
331 archive. If you use the modifier @samp{a}, the name of an existing archive
332 member must be present as the @var{relpos} argument, before the
333 @var{archive} specification.
334
335 @item b
336 Add new files @emph{before} an existing member of the
337 archive. If you use the modifier @samp{b}, the name of an existing archive
338 member must be present as the @var{relpos} argument, before the
339 @var{archive} specification. (same as @samp{i}).
340
341 @item c
342 @cindex creating archives
343 @emph{Create} the archive. The specified @var{archive} is always
344 created if it did not exist, when you request an update. But a warning is
345 issued unless you specify in advance that you expect to create it, by
346 using this modifier.
347
348 @item f
349 Truncate names in the archive. @sc{gnu} @code{ar} will normally permit file
350 names of any length. This will cause it to create archives which are
351 not compatible with the native @code{ar} program on some systems. If
352 this is a concern, the @samp{f} modifier may be used to truncate file
353 names when putting them in the archive.
354
355 @item i
356 Insert new files @emph{before} an existing member of the
357 archive. If you use the modifier @samp{i}, the name of an existing archive
358 member must be present as the @var{relpos} argument, before the
359 @var{archive} specification. (same as @samp{b}).
360
361 @item l
362 This modifier is accepted but not used.
363 @c whaffor ar l modifier??? presumably compat; with
364 @c what???---doc@@cygnus.com, 25jan91
365
366 @item o
367 @cindex dates in archive
368 Preserve the @emph{original} dates of members when extracting them. If
369 you do not specify this modifier, files extracted from the archive
370 are stamped with the time of extraction.
371
372 @item s
373 @cindex writing archive index
374 Write an object-file index into the archive, or update an existing one,
375 even if no other change is made to the archive. You may use this modifier
376 flag either with any operation, or alone. Running @samp{ar s} on an
377 archive is equivalent to running @samp{ranlib} on it.
378
379 @item u
380 @cindex updating an archive
381 Normally, @samp{ar r}@dots{} inserts all files
382 listed into the archive. If you would like to insert @emph{only} those
383 of the files you list that are newer than existing members of the same
384 names, use this modifier. The @samp{u} modifier is allowed only for the
385 operation @samp{r} (replace). In particular, the combination @samp{qu} is
386 not allowed, since checking the timestamps would lose any speed
387 advantage from the operation @samp{q}.
388
389 @item v
390 This modifier requests the @emph{verbose} version of an operation. Many
391 operations display additional information, such as filenames processed,
392 when the modifier @samp{v} is appended.
393
394 @item V
395 This modifier shows the version number of @code{ar}.
396 @end table
397
398 @node ar scripts
399 @section Controlling @code{ar} with a script
400
401 @smallexample
402 ar -M [ <@var{script} ]
403 @end smallexample
404
405 @cindex MRI compatibility, @code{ar}
406 @cindex scripts, @code{ar}
407 If you use the single command-line option @samp{-M} with @code{ar}, you
408 can control its operation with a rudimentary command language. This
409 form of @code{ar} operates interactively if standard input is coming
410 directly from a terminal. During interactive use, @code{ar} prompts for
411 input (the prompt is @samp{AR >}), and continues executing even after
412 errors. If you redirect standard input to a script file, no prompts are
413 issued, and @code{ar} abandons execution (with a nonzero exit code)
414 on any error.
415
416 The @code{ar} command language is @emph{not} designed to be equivalent
417 to the command-line options; in fact, it provides somewhat less control
418 over archives. The only purpose of the command language is to ease the
419 transition to @sc{gnu} @code{ar} for developers who already have scripts
420 written for the MRI ``librarian'' program.
421
422 The syntax for the @code{ar} command language is straightforward:
423 @itemize @bullet
424 @item
425 commands are recognized in upper or lower case; for example, @code{LIST}
426 is the same as @code{list}. In the following descriptions, commands are
427 shown in upper case for clarity.
428
429 @item
430 a single command may appear on each line; it is the first word on the
431 line.
432
433 @item
434 empty lines are allowed, and have no effect.
435
436 @item
437 comments are allowed; text after either of the characters @samp{*}
438 or @samp{;} is ignored.
439
440 @item
441 Whenever you use a list of names as part of the argument to an @code{ar}
442 command, you can separate the individual names with either commas or
443 blanks. Commas are shown in the explanations below, for clarity.
444
445 @item
446 @samp{+} is used as a line continuation character; if @samp{+} appears
447 at the end of a line, the text on the following line is considered part
448 of the current command.
449 @end itemize
450
451 Here are the commands you can use in @code{ar} scripts, or when using
452 @code{ar} interactively. Three of them have special significance:
453
454 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
455 a temporary file required for most of the other commands.
456
457 @code{SAVE} commits the changes so far specified by the script. Prior
458 to @code{SAVE}, commands affect only the temporary copy of the current
459 archive.
460
461 @table @code
462 @item ADDLIB @var{archive}
463 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
464 Add all the contents of @var{archive} (or, if specified, each named
465 @var{module} from @var{archive}) to the current archive.
466
467 Requires prior use of @code{OPEN} or @code{CREATE}.
468
469 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
470 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
471 @c else like "ar q..."
472 Add each named @var{member} as a module in the current archive.
473
474 Requires prior use of @code{OPEN} or @code{CREATE}.
475
476 @item CLEAR
477 Discard the contents of the current archive, cancelling the effect of
478 any operations since the last @code{SAVE}. May be executed (with no
479 effect) even if no current archive is specified.
480
481 @item CREATE @var{archive}
482 Creates an archive, and makes it the current archive (required for many
483 other commands). The new archive is created with a temporary name; it
484 is not actually saved as @var{archive} until you use @code{SAVE}.
485 You can overwrite existing archives; similarly, the contents of any
486 existing file named @var{archive} will not be destroyed until @code{SAVE}.
487
488 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
489 Delete each listed @var{module} from the current archive; equivalent to
490 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
491
492 Requires prior use of @code{OPEN} or @code{CREATE}.
493
494 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
495 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
496 List each named @var{module} present in @var{archive}. The separate
497 command @code{VERBOSE} specifies the form of the output: when verbose
498 output is off, output is like that of @samp{ar -t @var{archive}
499 @var{module}@dots{}}. When verbose output is on, the listing is like
500 @samp{ar -tv @var{archive} @var{module}@dots{}}.
501
502 Output normally goes to the standard output stream; however, if you
503 specify @var{outputfile} as a final argument, @code{ar} directs the
504 output to that file.
505
506 @item END
507 Exit from @code{ar}, with a @code{0} exit code to indicate successful
508 completion. This command does not save the output file; if you have
509 changed the current archive since the last @code{SAVE} command, those
510 changes are lost.
511
512 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
513 Extract each named @var{module} from the current archive, writing them
514 into the current directory as separate files. Equivalent to @samp{ar -x
515 @var{archive} @var{module}@dots{}}.
516
517 Requires prior use of @code{OPEN} or @code{CREATE}.
518
519 @ignore
520 @c FIXME Tokens but no commands???
521 @item FULLDIR
522
523 @item HELP
524 @end ignore
525
526 @item LIST
527 Display full contents of the current archive, in ``verbose'' style
528 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
529 tv @var{archive}}). (This single command is a @sc{gnu} @code{ld}
530 enhancement, rather than present for MRI compatibility.)
531
532 Requires prior use of @code{OPEN} or @code{CREATE}.
533
534 @item OPEN @var{archive}
535 Opens an existing archive for use as the current archive (required for
536 many other commands). Any changes as the result of subsequent commands
537 will not actually affect @var{archive} until you next use @code{SAVE}.
538
539 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
540 In the current archive, replace each existing @var{module} (named in
541 the @code{REPLACE} arguments) from files in the current working directory.
542 To execute this command without errors, both the file, and the module in
543 the current archive, must exist.
544
545 Requires prior use of @code{OPEN} or @code{CREATE}.
546
547 @item VERBOSE
548 Toggle an internal flag governing the output from @code{DIRECTORY}.
549 When the flag is on, @code{DIRECTORY} output matches output from
550 @samp{ar -tv }@dots{}.
551
552 @item SAVE
553 Commit your changes to the current archive, and actually save it as a
554 file with the name specified in the last @code{CREATE} or @code{OPEN}
555 command.
556
557 Requires prior use of @code{OPEN} or @code{CREATE}.
558
559 @end table
560
561 @iftex
562 @node ld
563 @chapter ld
564 @cindex linker
565 @kindex ld
566 The @sc{gnu} linker @code{ld} is now described in a separate manual.
567 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
568 @end iftex
569
570 @node nm
571 @chapter nm
572 @cindex symbols
573 @kindex nm
574
575 @smallexample
576 nm [ -a | --debug-syms ] [ -g | --extern-only ]
577 [ -B ] [ -C | --demangle ] [ -D | --dynamic ]
578 [ -s | --print-armap ] [ -A | -o | --print-file-name ]
579 [ -n | -v | --numeric-sort ] [ -p | --no-sort ]
580 [ -r | --reverse-sort ] [ --size-sort ] [ -u | --undefined-only ]
581 [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ]
582 [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ]
583 [ --defined-only ] [-l | --line-numbers ]
584 [ --no-demangle ] [ -V | --version ] [ --help ] [ @var{objfile}@dots{} ]
585 @end smallexample
586
587 @sc{gnu} @code{nm} lists the symbols from object files @var{objfile}@dots{}.
588 If no object files are listed as arguments, @code{nm} assumes
589 @file{a.out}.
590
591 For each symbol, @code{nm} shows:
592
593 @itemize @bullet
594 @item
595 The symbol value, in the radix selected by options (see below), or
596 hexadecimal by default.
597
598 @item
599 The symbol type. At least the following types are used; others are, as
600 well, depending on the object file format. If lowercase, the symbol is
601 local; if uppercase, the symbol is global (external).
602
603 @c Some more detail on exactly what these symbol types are used for
604 @c would be nice.
605 @table @code
606 @item A
607 The symbol's value is absolute, and will not be changed by further
608 linking.
609
610 @item B
611 The symbol is in the uninitialized data section (known as BSS).
612
613 @item C
614 The symbol is common. Common symbols are uninitialized data. When
615 linking, multiple common symbols may appear with the same name. If the
616 symbol is defined anywhere, the common symbols are treated as undefined
617 references. For more details on common symbols, see the discussion of
618 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
619
620 @item D
621 The symbol is in the initialized data section.
622
623 @item G
624 The symbol is in an initialized data section for small objects. Some
625 object file formats permit more efficient access to small data objects,
626 such as a global int variable as opposed to a large global array.
627
628 @item I
629 The symbol is an indirect reference to another symbol. This is a GNU
630 extension to the a.out object file format which is rarely used.
631
632 @item N
633 The symbol is a debugging symbol.
634
635 @item R
636 The symbol is in a read only data section.
637
638 @item S
639 The symbol is in an uninitialized data section for small objects.
640
641 @item T
642 The symbol is in the text (code) section.
643
644 @item U
645 The symbol is undefined.
646
647 @item W
648 The symbol is weak. When a weak defined symbol is linked with a normal
649 defined symbol, the normal defined symbol is used with no error. When a
650 weak undefined symbol is linked and the symbol is not defined, the value
651 of the weak symbol becomes zero with no error.
652
653 @item -
654 The symbol is a stabs symbol in an a.out object file. In this case, the
655 next values printed are the stabs other field, the stabs desc field, and
656 the stab type. Stabs symbols are used to hold debugging information;
657 for more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
658 ``stabs'' debug format}.
659
660 @item ?
661 The symbol type is unknown, or object file format specific.
662 @end table
663
664 @item
665 The symbol name.
666 @end itemize
667
668 The long and short forms of options, shown here as alternatives, are
669 equivalent.
670
671 @table @code
672 @item -A
673 @itemx -o
674 @itemx --print-file-name
675 @cindex input file name
676 @cindex file name
677 @cindex source file name
678 Precede each symbol by the name of the input file (or archive element)
679 in which it was found, rather than identifying the input file once only,
680 before all of its symbols.
681
682 @item -a
683 @itemx --debug-syms
684 @cindex debugging symbols
685 Display all symbols, even debugger-only symbols; normally these are not
686 listed.
687
688 @item -B
689 @cindex @code{nm} format
690 @cindex @code{nm} compatibility
691 The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}).
692
693 @item -C
694 @itemx --demangle
695 @cindex demangling C++ symbols
696 Decode (@dfn{demangle}) low-level symbol names into user-level names.
697 Besides removing any initial underscore prepended by the system, this
698 makes C++ function names readable. @xref{c++filt}, for more information
699 on demangling.
700
701 @item --no-demangle
702 Do not demangle low-level symbol names. This is the default.
703
704 @item -D
705 @itemx --dynamic
706 @cindex dynamic symbols
707 Display the dynamic symbols rather than the normal symbols. This is
708 only meaningful for dynamic objects, such as certain types of shared
709 libraries.
710
711 @item -f @var{format}
712 @itemx --format=@var{format}
713 @cindex @code{nm} format
714 @cindex @code{nm} compatibility
715 Use the output format @var{format}, which can be @code{bsd},
716 @code{sysv}, or @code{posix}. The default is @code{bsd}.
717 Only the first character of @var{format} is significant; it can be
718 either upper or lower case.
719
720 @item -g
721 @itemx --extern-only
722 @cindex external symbols
723 Display only external symbols.
724
725 @item -l
726 @itemx --line-numbers
727 @cindex symbol line numbers
728 For each symbol, use debugging information to try to find a filename and
729 line number. For a defined symbol, look for the line number of the
730 address of the symbol. For an undefined symbol, look for the line
731 number of a relocation entry which refers to the symbol. If line number
732 information can be found, print it after the other symbol information.
733
734 @item -n
735 @itemx -v
736 @itemx --numeric-sort
737 Sort symbols numerically by their addresses, rather than alphabetically
738 by their names.
739
740 @item -p
741 @itemx --no-sort
742 @cindex sorting symbols
743 Do not bother to sort the symbols in any order; print them in the order
744 encountered.
745
746 @item -P
747 @itemx --portability
748 Use the POSIX.2 standard output format instead of the default format.
749 Equivalent to @samp{-f posix}.
750
751 @item -s
752 @itemx --print-armap
753 @cindex symbol index, listing
754 When listing symbols from archive members, include the index: a mapping
755 (stored in the archive by @code{ar} or @code{ranlib}) of which modules
756 contain definitions for which names.
757
758 @item -r
759 @itemx --reverse-sort
760 Reverse the order of the sort (whether numeric or alphabetic); let the
761 last come first.
762
763 @item --size-sort
764 Sort symbols by size. The size is computed as the difference between
765 the value of the symbol and the value of the symbol with the next higher
766 value. The size of the symbol is printed, rather than the value.
767
768 @item -t @var{radix}
769 @itemx --radix=@var{radix}
770 Use @var{radix} as the radix for printing the symbol values. It must be
771 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
772
773 @item --target=@var{bfdname}
774 @cindex object code format
775 Specify an object code format other than your system's default format.
776 @xref{Target Selection}, for more information.
777
778 @item -u
779 @itemx --undefined-only
780 @cindex external symbols
781 @cindex undefined symbols
782 Display only undefined symbols (those external to each object file).
783
784 @item --defined-only
785 @cindex external symbols
786 @cindex undefined symbols
787 Display only defined symbols for each object file.
788
789 @item -V
790 @itemx --version
791 Show the version number of @code{nm} and exit.
792
793 @item --help
794 Show a summary of the options to @code{nm} and exit.
795 @end table
796
797 @node objcopy
798 @chapter objcopy
799
800 @smallexample
801 objcopy [ -F @var{bfdname} | --target=@var{bfdname} ]
802 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
803 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
804 [ -S | --strip-all ] [ -g | --strip-debug ]
805 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
806 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
807 [ -x | --discard-all ] [ -X | --discard-locals ]
808 [ -b @var{byte} | --byte=@var{byte} ]
809 [ -i @var{interleave} | --interleave=@var{interleave} ]
810 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
811 [ --debugging ]
812 [ --gap-fill=@var{val} ] [ --pad-to=@var{address} ]
813 [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ]
814 [ --adjust-vma=@var{incr} ]
815 [ --adjust-section-vma=@var{section}@{=,+,-@}@var{val} ]
816 [ --adjust-warnings ] [ --no-adjust-warnings ]
817 [ --set-section-flags=@var{section}=@var{flags} ]
818 [ --add-section=@var{sectionname}=@var{filename} ]
819 [ --change-leading-char ] [ --remove-leading-char ]
820 [ -v | --verbose ] [ -V | --version ] [ --help ]
821 @var{infile} [@var{outfile}]
822 @end smallexample
823
824 The @sc{gnu} @code{objcopy} utility copies the contents of an object
825 file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to
826 read and write the object files. It can write the destination object
827 file in a format different from that of the source object file. The
828 exact behavior of @code{objcopy} is controlled by command-line options.
829
830 @code{objcopy} creates temporary files to do its translations and
831 deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its
832 translation work; it has access to all the formats described in @sc{bfd}
833 and thus is able to recognize most formats without being told
834 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
835
836 @code{objcopy} can be used to generate S-records by using an output
837 target of @samp{srec} (e.g., use @samp{-O srec}).
838
839 @code{objcopy} can be used to generate a raw binary file by using an
840 output target of @samp{binary} (e.g., use @samp{-O binary}). When
841 @code{objcopy} generates a raw binary file, it will essentially produce
842 a memory dump of the contents of the input object file. All symbols and
843 relocation information will be discarded. The memory dump will start at
844 the load address of the lowest section copied into the output file.
845
846 When generating an S-record or a raw binary file, it may be helpful to
847 use @samp{-S} to remove sections containing debugging information. In
848 some cases @samp{-R} will be useful to remove sections which contain
849 information which is not needed by the binary file.
850
851 @table @code
852 @item @var{infile}
853 @itemx @var{outfile}
854 The source and output files, respectively.
855 If you do not specify @var{outfile}, @code{objcopy} creates a
856 temporary file and destructively renames the result with
857 the name of @var{infile}.
858
859 @item -I @var{bfdname}
860 @itemx --input-target=@var{bfdname}
861 Consider the source file's object format to be @var{bfdname}, rather than
862 attempting to deduce it. @xref{Target Selection}, for more information.
863
864 @item -O @var{bfdname}
865 @itemx --output-target=@var{bfdname}
866 Write the output file using the object format @var{bfdname}.
867 @xref{Target Selection}, for more information.
868
869 @item -F @var{bfdname}
870 @itemx --target=@var{bfdname}
871 Use @var{bfdname} as the object format for both the input and the output
872 file; i.e., simply transfer data from source to destination with no
873 translation. @xref{Target Selection}, for more information.
874
875 @item -R @var{sectionname}
876 @itemx --remove-section=@var{sectionname}
877 Remove any section named @var{sectionname} from the output file. This
878 option may be given more than once. Note that using this option
879 inappropriately may make the output file unusable.
880
881 @item -S
882 @itemx --strip-all
883 Do not copy relocation and symbol information from the source file.
884
885 @item -g
886 @itemx --strip-debug
887 Do not copy debugging symbols from the source file.
888
889 @item --strip-unneeded
890 Strip all symbols that are not needed for relocation processing.
891
892 @item -K @var{symbolname}
893 @itemx --keep-symbol=@var{symbolname}
894 Copy only symbol @var{symbolname} from the source file. This option may
895 be given more than once.
896
897 @item -N @var{symbolname}
898 @itemx --strip-symbol=@var{symbolname}
899 Do not copy symbol @var{symbolname} from the source file. This option
900 may be given more than once, and may be combined with strip options
901 other than @code{-K}.
902
903 @item -x
904 @itemx --discard-all
905 Do not copy non-global symbols from the source file.
906 @c FIXME any reason to prefer "non-global" to "local" here?
907
908 @item -X
909 @itemx --discard-locals
910 Do not copy compiler-generated local symbols.
911 (These usually start with @samp{L} or @samp{.}.)
912
913 @item -b @var{byte}
914 @itemx --byte=@var{byte}
915 Keep only every @var{byte}th byte of the input file (header data is not
916 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
917 where @var{interleave} is given by the @samp{-i} or @samp{--interleave}
918 option, or the default of 4. This option is useful for creating files
919 to program @sc{rom}. It is typically used with an @code{srec} output
920 target.
921
922 @item -i @var{interleave}
923 @itemx --interleave=@var{interleave}
924 Only copy one out of every @var{interleave} bytes. Select which byte to
925 copy with the @var{-b} or @samp{--byte} option. The default is 4.
926 @code{objcopy} ignores this option if you do not specify either @samp{-b} or
927 @samp{--byte}.
928
929 @item --debugging
930 Convert debugging information, if possible. This is not the default
931 because only certain debugging formats are supported, and the
932 conversion process can be time consuming.
933
934 @item --gap-fill @var{val}
935 Fill gaps between sections with @var{val}. This is done by increasing
936 the size of the section with the lower address, and filling in the extra
937 space created with @var{val}.
938
939 @item --pad-to @var{address}
940 Pad the output file up to the virtual address @var{address}. This is
941 done by increasing the size of the last section. The extra space is
942 filled in with the value specified by @samp{--gap-fill} (default zero).
943
944 @item --set-start @var{val}
945 Set the address of the new file to @var{val}. Not all object file
946 formats support setting the start address.
947
948 @item --adjust-start @var{incr}
949 Adjust the start address by adding @var{incr}. Not all object file
950 formats support setting the start address.
951
952 @item --adjust-vma @var{incr}
953 Adjust the address of all sections, as well as the start address, by
954 adding @var{incr}. Some object file formats do not permit section
955 addresses to be changed arbitrarily. Note that this does not relocate
956 the sections; if the program expects sections to be loaded at a certain
957 address, and this option is used to change the sections such that they
958 are loaded at a different address, the program may fail.
959
960 @item --adjust-section-vma @var{section}@{=,+,-@}@var{val}
961 Set or adjust the address of the named @var{section}. If @samp{=} is
962 used, the section address is set to @var{val}. Otherwise, @var{val} is
963 added to or subtracted from the section address. See the comments under
964 @samp{--adjust-vma}, above. If @var{section} does not exist in the
965 input file, a warning will be issued, unless @samp{--no-adjust-warnings}
966 is used.
967
968 @item --adjust-warnings
969 If @samp{--adjust-section-vma} is used, and the named section does not
970 exist, issue a warning. This is the default.
971
972 @item --no-adjust-warnings
973 Do not issue a warning if @samp{--adjust-section-vma} is used, even if
974 the named section does not exist.
975
976 @item --set-section-flags @var{section}=@var{flags}
977 Set the flags for the named section. The @var{flags} argument is a
978 comma separated string of flag names. The recognized names are
979 @samp{alloc}, @samp{load}, @samp{readonly}, @samp{code}, @samp{data},
980 and @samp{rom}. Not all flags are meaningful for all object file
981 formats.
982
983 @item --add-section @var{sectionname}=@var{filename}
984 Add a new section named @var{sectionname} while copying the file. The
985 contents of the new section are taken from the file @var{filename}. The
986 size of the section will be the size of the file. This option only
987 works on file formats which can support sections with arbitrary names.
988
989 @item --change-leading-char
990 Some object file formats use special characters at the start of
991 symbols. The most common such character is underscore, which compilers
992 often add before every symbol. This option tells @code{objcopy} to
993 change the leading character of every symbol when it converts between
994 object file formats. If the object file formats use the same leading
995 character, this option has no effect. Otherwise, it will add a
996 character, or remove a character, or change a character, as
997 appropriate.
998
999 @item --remove-leading-char
1000 If the first character of a global symbol is a special symbol leading
1001 character used by the object file format, remove the character. The
1002 most common symbol leading character is underscore. This option will
1003 remove a leading underscore from all global symbols. This can be useful
1004 if you want to link together objects of different file formats with
1005 different conventions for symbol names. This is different from
1006 @code{--change-leading-char} because it always changes the symbol name
1007 when appropriate, regardless of the object file format of the output
1008 file.
1009
1010 @item -V
1011 @itemx --version
1012 Show the version number of @code{objcopy}.
1013
1014 @item -v
1015 @itemx --verbose
1016 Verbose output: list all object files modified. In the case of
1017 archives, @samp{objcopy -V} lists all members of the archive.
1018
1019 @item --help
1020 Show a summary of the options to @code{objcopy}.
1021 @end table
1022
1023 @node objdump
1024 @chapter objdump
1025
1026 @cindex object file information
1027 @kindex objdump
1028
1029 @smallexample
1030 objdump [ -a | --archive-headers ]
1031 [ -b @var{bfdname} | --target=@var{bfdname} ] [ --debugging ]
1032 [ -d | --disassemble ] [ -D | --disassemble-all ]
1033 [ -EB | -EL | --endian=@{big | little @} ]
1034 [ -f | --file-headers ]
1035 [ -h | --section-headers | --headers ] [ -i | --info ]
1036 [ -j @var{section} | --section=@var{section} ]
1037 [ -l | --line-numbers ] [ -S | --source ]
1038 [ -m @var{machine} | --architecture=@var{machine} ]
1039 [ -r | --reloc ] [ -R | --dynamic-reloc ]
1040 [ -s | --full-contents ] [ --stabs ]
1041 [ -t | --syms ] [ -T | --dynamic-syms ] [ -x | --all-headers ]
1042 [ -w | --wide ] [ --start-address=@var{address} ]
1043 [ --stop-address=@var{address} ] [ --show-raw-insn ]
1044 [ --version ] [ --help ]
1045 @var{objfile}@dots{}
1046 @end smallexample
1047
1048 @code{objdump} displays information about one or more object files.
1049 The options control what particular information to display. This
1050 information is mostly useful to programmers who are working on the
1051 compilation tools, as opposed to programmers who just want their
1052 program to compile and work.
1053
1054 @var{objfile}@dots{} are the object files to be examined. When you
1055 specify archives, @code{objdump} shows information on each of the member
1056 object files.
1057
1058 The long and short forms of options, shown here as alternatives, are
1059 equivalent. At least one option besides @samp{-l} must be given.
1060
1061 @table @code
1062 @item -a
1063 @itemx --archive-header
1064 @cindex archive headers
1065 If any of the @var{objfile} files are archives, display the archive
1066 header information (in a format similar to @samp{ls -l}). Besides the
1067 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1068 the object file format of each archive member.
1069
1070 @item -b @var{bfdname}
1071 @itemx --target=@var{bfdname}
1072 @cindex object code format
1073 Specify that the object-code format for the object files is
1074 @var{bfdname}. This option may not be necessary; @var{objdump} can
1075 automatically recognize many formats.
1076
1077 For example,
1078 @example
1079 objdump -b oasys -m vax -h fu.o
1080 @end example
1081 @noindent
1082 displays summary information from the section headers (@samp{-h}) of
1083 @file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
1084 file in the format produced by Oasys compilers. You can list the
1085 formats available with the @samp{-i} option.
1086 @xref{Target Selection}, for more information.
1087
1088 @item --debugging
1089 Display debugging information. This attempts to parse debugging
1090 information stored in the file and print it out using a C like syntax.
1091 Only certain types of debugging information have been implemented.
1092
1093 @item -d
1094 @itemx --disassemble
1095 @cindex disassembling object code
1096 @cindex machine instructions
1097 Display the assembler mnemonics for the machine instructions from
1098 @var{objfile}. This option only disassembles those sections which are
1099 expected to contain instructions.
1100
1101 @item -D
1102 @itemx --disassemble-all
1103 Like @samp{-d}, but disassemble the contents of all sections, not just
1104 those expected to contain instructions.
1105
1106 @item -EB
1107 @itemx -EL
1108 @itemx --endian=@{big|little@}
1109 @cindex endianness
1110 @cindex disassembly endianness
1111 Specify the endianness of the object files. This only affects
1112 disassembly. This can be useful when disassembling a file format which
1113 does not describe endianness information, such as S-records.
1114
1115 @item -f
1116 @itemx --file-header
1117 @cindex object file header
1118 Display summary information from the overall header of
1119 each of the @var{objfile} files.
1120
1121 @item -h
1122 @itemx --section-header
1123 @itemx --header
1124 @cindex section headers
1125 Display summary information from the section headers of the
1126 object file.
1127
1128 File segments may be relocated to nonstandard addresses, for example by
1129 using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
1130 @code{ld}. However, some object file formats, such as a.out, do not
1131 store the starting address of the file segments. In those situations,
1132 although @code{ld} relocates the sections correctly, using @samp{objdump
1133 -h} to list the file section headers cannot show the correct addresses.
1134 Instead, it shows the usual addresses, which are implicit for the
1135 target.
1136
1137 @item --help
1138 Print a summary of the options to @code{objdump} and exit.
1139
1140 @item -i
1141 @itemx --info
1142 @cindex architectures available
1143 @cindex object formats available
1144 Display a list showing all architectures and object formats available
1145 for specification with @samp{-b} or @samp{-m}.
1146
1147 @item -j @var{name}
1148 @itemx --section=@var{name}
1149 @cindex section information
1150 Display information only for section @var{name}.
1151
1152 @item -l
1153 @itemx --line-numbers
1154 @cindex source filenames for object files
1155 Label the display (using debugging information) with the filename and
1156 source line numbers corresponding to the object code or relocs shown.
1157 Only useful with @samp{-d}, @samp{-D}, or @samp{-r}.
1158
1159 @item -m @var{machine}
1160 @itemx --architecture=@var{machine}
1161 @cindex architecture
1162 @cindex disassembly architecture
1163 Specify the architecture to use when disassembling object files. This
1164 can be useful when disasembling object files which do not describe
1165 architecture information, such as S-records. You can list the available
1166 architectures with the @samp{-i} option.
1167
1168 @item -r
1169 @itemx --reloc
1170 @cindex relocation entries, in object file
1171 Print the relocation entries of the file. If used with @samp{-d} or
1172 @samp{-D}, the relocations are printed interspersed with the
1173 disassembly.
1174
1175 @item -R
1176 @itemx --dynamic-reloc
1177 @cindex dynamic relocation entries, in object file
1178 Print the dynamic relocation entries of the file. This is only
1179 meaningful for dynamic objects, such as certain types of shared
1180 libraries.
1181
1182 @item -s
1183 @itemx --full-contents
1184 @cindex sections, full contents
1185 @cindex object file sections
1186 Display the full contents of any sections requested.
1187
1188 @item -S
1189 @itemx --source
1190 @cindex source disassembly
1191 @cindex disassembly, with source
1192 Display source code intermixed with disassembly, if possible. Implies
1193 @samp{-d}.
1194
1195 @item --show-raw-insn
1196 When disassembling instructions, print the instruction in hex as well as
1197 in symbolic form. Not all targets handle this correctly yet.
1198
1199 @item --stabs
1200 @cindex stab
1201 @cindex .stab
1202 @cindex debug symbols
1203 @cindex ELF object file format
1204 Display the full contents of any sections requested. Display the
1205 contents of the .stab and .stab.index and .stab.excl sections from an
1206 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1207 @code{.stab} debugging symbol-table entries are carried in an ELF
1208 section. In most other file formats, debugging symbol-table entries are
1209 interleaved with linkage symbols, and are visible in the @samp{--syms}
1210 output. For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1211 Overview,stabs.info, The ``stabs'' debug format}.
1212
1213 @item --start-address=@var{address}
1214 @cindex start-address
1215 Start displaying data at the specified address. This affects the output
1216 of the @code{-d}, @code{-r} and @code{-s} options.
1217
1218 @item --stop-address=@var{address}
1219 @cindex stop-address
1220 Stop displaying data at the specified address. This affects the output
1221 of the @code{-d}, @code{-r} and @code{-s} options.
1222
1223 @item -t
1224 @itemx --syms
1225 @cindex symbol table entries, printing
1226 Print the symbol table entries of the file.
1227 This is similar to the information provided by the @samp{nm} program.
1228
1229 @item -T
1230 @itemx --dynamic-syms
1231 @cindex dynamic symbol table entries, printing
1232 Print the dynamic symbol table entries of the file. This is only
1233 meaningful for dynamic objects, such as certain types of shared
1234 libraries. This is similar to the information provided by the @samp{nm}
1235 program when given the @samp{-D} (@samp{--dynamic}) option.
1236
1237 @item --version
1238 Print the version number of @code{objdump} and exit.
1239
1240 @item -x
1241 @itemx --all-header
1242 @cindex all header information, object file
1243 @cindex header information, all
1244 Display all available header information, including the symbol table and
1245 relocation entries. Using @samp{-x} is equivalent to specifying all of
1246 @samp{-a -f -h -r -t}.
1247
1248 @item -w
1249 @item --wide
1250 @cindex wide output, printing
1251 Format some lines for output devices that have more than 80 columns.
1252 @end table
1253
1254 @node ranlib
1255 @chapter ranlib
1256
1257 @kindex ranlib
1258 @cindex archive contents
1259 @cindex symbol index
1260
1261 @smallexample
1262 ranlib [-vV] @var{archive}
1263 @end smallexample
1264
1265 @code{ranlib} generates an index to the contents of an archive and
1266 stores it in the archive. The index lists each symbol defined by a
1267 member of an archive that is a relocatable object file.
1268
1269 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
1270
1271 An archive with such an index speeds up linking to the library and
1272 allows routines in the library to call each other without regard to
1273 their placement in the archive.
1274
1275 The @sc{gnu} @code{ranlib} program is another form of @sc{gnu} @code{ar}; running
1276 @code{ranlib} is completely equivalent to executing @samp{ar -s}.
1277 @xref{ar}.
1278
1279 @table @code
1280 @item -v
1281 @itemx -V
1282 Show the version number of @code{ranlib}.
1283 @end table
1284
1285 @node size
1286 @chapter size
1287
1288 @kindex size
1289 @cindex section sizes
1290
1291 @smallexample
1292 size [ -A | -B | --format=@var{compatibility} ]
1293 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
1294 [ --target=@var{bfdname} ] [ -V | --version ]
1295 @var{objfile}@dots{}
1296 @end smallexample
1297
1298 The @sc{gnu} @code{size} utility lists the section sizes---and the total
1299 size---for each of the object or archive files @var{objfile} in its
1300 argument list. By default, one line of output is generated for each
1301 object file or each module in an archive.
1302
1303 @var{objfile}@dots{} are the object files to be examined.
1304
1305 The command line options have the following meanings:
1306
1307 @table @code
1308 @item -A
1309 @itemx -B
1310 @itemx --format=@var{compatibility}
1311 @cindex @code{size} display format
1312 Using one of these options, you can choose whether the output from @sc{gnu}
1313 @code{size} resembles output from System V @code{size} (using @samp{-A},
1314 or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
1315 @samp{--format=berkeley}). The default is the one-line format similar to
1316 Berkeley's.
1317 @c Bonus for doc-source readers: you can also say --format=strange (or
1318 @c anything else that starts with 's') for sysv, and --format=boring (or
1319 @c anything else that starts with 'b') for Berkeley.
1320
1321 Here is an example of the Berkeley (default) format of output from
1322 @code{size}:
1323 @smallexample
1324 size --format=Berkeley ranlib size
1325 text data bss dec hex filename
1326 294880 81920 11592 388392 5ed28 ranlib
1327 294880 81920 11888 388688 5ee50 size
1328 @end smallexample
1329
1330 @noindent
1331 This is the same data, but displayed closer to System V conventions:
1332
1333 @smallexample
1334 size --format=SysV ranlib size
1335 ranlib :
1336 section size addr
1337 .text 294880 8192
1338 .data 81920 303104
1339 .bss 11592 385024
1340 Total 388392
1341
1342
1343 size :
1344 section size addr
1345 .text 294880 8192
1346 .data 81920 303104
1347 .bss 11888 385024
1348 Total 388688
1349 @end smallexample
1350
1351 @item --help
1352 Show a summary of acceptable arguments and options.
1353
1354 @item -d
1355 @itemx -o
1356 @itemx -x
1357 @itemx --radix=@var{number}
1358 @cindex @code{size} number format
1359 @cindex radix for section sizes
1360 Using one of these options, you can control whether the size of each
1361 section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1362 (@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1363 @samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
1364 values (8, 10, 16) are supported. The total size is always given in two
1365 radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1366 octal and hexadecimal if you're using @samp{-o}.
1367
1368 @item --target=@var{bfdname}
1369 @cindex object code format
1370 Specify that the object-code format for @var{objfile} is
1371 @var{bfdname}. This option may not be necessary; @code{size} can
1372 automatically recognize many formats.
1373 @xref{Target Selection}, for more information.
1374
1375 @item -V
1376 @itemx --version
1377 Display the version number of @code{size}.
1378 @end table
1379
1380 @node strings
1381 @chapter strings
1382 @kindex strings
1383 @cindex listings strings
1384 @cindex printing strings
1385 @cindex strings, printing
1386
1387 @smallexample
1388 strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
1389 [--all] [--print-file-name] [--bytes=@var{min-len}]
1390 [--radix=@var{radix}] [--target=@var{bfdname}]
1391 [--help] [--version] @var{file}@dots{}
1392 @end smallexample
1393
1394 For each @var{file} given, @sc{gnu} @code{strings} prints the printable
1395 character sequences that are at least 4 characters long (or the number
1396 given with the options below) and are followed by an unprintable
1397 character. By default, it only prints the strings from the initialized
1398 and loaded sections of object files; for other types of files, it prints
1399 the strings from the whole file.
1400
1401 @code{strings} is mainly useful for determining the contents of non-text
1402 files.
1403
1404 @table @code
1405 @item -a
1406 @itemx --all
1407 @itemx -
1408 Do not scan only the initialized and loaded sections of object files;
1409 scan the whole files.
1410
1411 @item -f
1412 @itemx --print-file-name
1413 Print the name of the file before each string.
1414
1415 @item --help
1416 Print a summary of the program usage on the standard output and exit.
1417
1418 @itemx -@var{min-len}
1419 @item -n @var{min-len}
1420 @itemx --bytes=@var{min-len}
1421 Print sequences of characters that are at least @var{min-len} characters
1422 long, instead of the default 4.
1423
1424 @item -o
1425 Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1426 act like @samp{-t d} instead. Since we can not be compatible with both
1427 ways, we simply chose one.
1428
1429 @item -t @var{radix}
1430 @itemx --radix=@var{radix}
1431 Print the offset within the file before each string. The single
1432 character argument specifies the radix of the offset---@samp{o} for
1433 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1434
1435 @item --target=@var{bfdname}
1436 @cindex object code format
1437 Specify an object code format other than your system's default format.
1438 @xref{Target Selection}, for more information.
1439
1440 @item -v
1441 @itemx --version
1442 Print the program version number on the standard output and exit.
1443 @end table
1444
1445 @node strip
1446 @chapter strip
1447
1448 @kindex strip
1449 @cindex removing symbols
1450 @cindex discarding symbols
1451 @cindex symbols, discarding
1452
1453 @smallexample
1454 strip [ -F @var{bfdname} | --target=@var{bfdname} | --target=@var{bfdname} ]
1455 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1456 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
1457 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
1458 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
1459 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
1460 [ -x | --discard-all ] [ -X | --discard-locals ]
1461 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
1462 [ -o @var{file} ]
1463 [ -v | --verbose ] [ -V | --version ] [ --help ]
1464 @var{objfile}@dots{}
1465 @end smallexample
1466
1467 @sc{gnu} @code{strip} discards all symbols from object files
1468 @var{objfile}. The list of object files may include archives.
1469 At least one object file must be given.
1470
1471 @code{strip} modifies the files named in its argument,
1472 rather than writing modified copies under different names.
1473
1474 @table @code
1475 @item -F @var{bfdname}
1476 @itemx --target=@var{bfdname}
1477 Treat the original @var{objfile} as a file with the object
1478 code format @var{bfdname}, and rewrite it in the same format.
1479 @xref{Target Selection}, for more information.
1480
1481 @item --help
1482 Show a summary of the options to @code{strip} and exit.
1483
1484 @item -I @var{bfdname}
1485 @itemx --input-target=@var{bfdname}
1486 Treat the original @var{objfile} as a file with the object
1487 code format @var{bfdname}.
1488 @xref{Target Selection}, for more information.
1489
1490 @item -O @var{bfdname}
1491 @itemx --output-target=@var{bfdname}
1492 Replace @var{objfile} with a file in the output format @var{bfdname}.
1493 @xref{Target Selection}, for more information.
1494
1495 @item -R @var{sectionname}
1496 @itemx --remove-section=@var{sectionname}
1497 Remove any section named @var{sectionname} from the output file. This
1498 option may be given more than once. Note that using this option
1499 inappropriately may make the output file unusable.
1500
1501 @item -s
1502 @itemx --strip-all
1503 Remove all symbols.
1504
1505 @item -g
1506 @itemx -S
1507 @itemx --strip-debug
1508 Remove debugging symbols only.
1509
1510 @item --strip-unneeded
1511 Remove all symbols that are not needed for relocation processing.
1512
1513 @item -K @var{symbolname}
1514 @itemx --keep-symbol=@var{symbolname}
1515 Keep only symbol @var{symbolname} from the source file. This option may
1516 be given more than once.
1517
1518 @item -N @var{symbolname}
1519 @itemx --strip-symbol=@var{symbolname}
1520 Remove symbol @var{symbolname} from the source file. This option may be
1521 given more than once, and may be combined with strip options other than
1522 @code{-K}.
1523
1524 @item -o @var{file}
1525 Put the stripped output in @var{file}, rather than replacing the
1526 existing file. When this argument is used, only one @var{objfile}
1527 argument may be specified.
1528
1529 @item -x
1530 @itemx --discard-all
1531 Remove non-global symbols.
1532
1533 @item -X
1534 @itemx --discard-locals
1535 Remove compiler-generated local symbols.
1536 (These usually start with @samp{L} or @samp{.}.)
1537
1538 @item -V
1539 @itemx --version
1540 Show the version number for @code{strip}.
1541
1542 @item -v
1543 @itemx --verbose
1544 Verbose output: list all object files modified. In the case of
1545 archives, @samp{strip -v} lists all members of the archive.
1546 @end table
1547
1548 @node c++filt
1549 @chapter c++filt
1550
1551 @kindex c++filt
1552 @cindex demangling C++ symbols
1553
1554 @smallexample
1555 c++filt [ -_ | --strip-underscores ]
1556 [ -n | --no-strip-underscores ]
1557 [ -s @var{format} | --format=@var{format} ]
1558 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
1559 @end smallexample
1560
1561 The C++ language provides function overloading, which means that you can
1562 write many functions with the same name (providing each takes parameters
1563 of different types). All C++ function names are encoded into a
1564 low-level assembly label (this process is known as
1565 @dfn{mangling}). The @code{c++filt} program does the inverse mapping: it
1566 decodes (@dfn{demangles}) low-level names into user-level names so that
1567 the linker can keep these overloaded functions from clashing.
1568
1569 Every alphanumeric word (consisting of letters, digits, underscores,
1570 dollars, or periods) seen in the input is a potential label. If the
1571 label decodes into a C++ name, the C++ name replaces the low-level
1572 name in the output.
1573
1574 You can use @code{c++filt} to decipher individual symbols:
1575
1576 @example
1577 c++filt @var{symbol}
1578 @end example
1579
1580 If no @var{symbol} arguments are given, @code{c++filt} reads symbol
1581 names from the standard input and writes the demangled names to the
1582 standard output. All results are printed on the standard output.
1583
1584 @table @code
1585 @item -_
1586 @itemx --strip-underscores
1587 On some systems, both the C and C++ compilers put an underscore in front
1588 of every name. For example, the C name @code{foo} gets the low-level
1589 name @code{_foo}. This option removes the initial underscore. Whether
1590 @code{c++filt} removes the underscore by default is target dependent.
1591
1592 @item -n
1593 @itemx --no-strip-underscores
1594 Do not remove the initial underscore.
1595
1596 @item -s @var{format}
1597 @itemx --format=@var{format}
1598 @sc{gnu} @code{nm} can decode three different methods of mangling, used by
1599 different C++ compilers. The argument to this option selects which
1600 method it uses:
1601
1602 @table @code
1603 @item gnu
1604 the one used by the @sc{gnu} compiler (the default method)
1605 @item lucid
1606 the one used by the Lucid compiler
1607 @item arm
1608 the one specified by the C++ Annotated Reference Manual
1609 @end table
1610
1611 @item --help
1612 Print a summary of the options to @code{c++filt} and exit.
1613
1614 @item --version
1615 Print the version number of @code{c++filt} and exit.
1616 @end table
1617
1618 @quotation
1619 @emph{Warning:} @code{c++filt} is a new utility, and the details of its
1620 user interface are subject to change in future releases. In particular,
1621 a command-line option may be required in the the future to decode a name
1622 passed as an argument on the command line; in other words,
1623
1624 @example
1625 c++filt @var{symbol}
1626 @end example
1627
1628 @noindent
1629 may in a future release become
1630
1631 @example
1632 c++filt @var{option} @var{symbol}
1633 @end example
1634 @end quotation
1635
1636 @node nlmconv
1637 @chapter nlmconv
1638
1639 @code{nlmconv} converts a relocatable object file into a NetWare
1640 Loadable Module.
1641
1642 @ignore
1643 @code{nlmconv} currently works with @samp{i386} object
1644 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
1645 object files in @sc{elf}, or @code{a.out} format@footnote{
1646 @code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
1647 format in the Binary File Descriptor library. It has only been tested
1648 with the above formats.}.
1649 @end ignore
1650
1651 @quotation
1652 @emph{Warning:} @code{nlmconv} is not always built as part of the binary
1653 utilities, since it is only useful for NLM targets.
1654 @end quotation
1655
1656 @smallexample
1657 nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1658 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
1659 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
1660 [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
1661 [ -h | --help ] [ -V | --version ]
1662 @var{infile} @var{outfile}
1663 @end smallexample
1664
1665 @code{nlmconv} converts the relocatable @samp{i386} object file
1666 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
1667 reading @var{headerfile} for NLM header information. For instructions
1668 on writing the NLM command file language used in header files, see the
1669 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
1670 Development and Tools Overview}, which is part of the NLM Software
1671 Developer's Kit (``NLM SDK''), available from Novell, Inc.
1672 @code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
1673 @var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for
1674 more information.
1675
1676 @code{nlmconv} can perform a link step. In other words, you can list
1677 more than one object file for input if you list them in the definitions
1678 file (rather than simply specifying one input file on the command line).
1679 In this case, @code{nlmconv} calls the linker for you.
1680
1681 @table @code
1682 @item -I @var{bfdname}
1683 @itemx --input-target=@var{bfdname}
1684 Object format of the input file. @code{nlmconv} can usually determine
1685 the format of a given file (so no default is necessary).
1686 @xref{Target Selection}, for more information.
1687
1688 @item -O @var{bfdname}
1689 @itemx --output-target=@var{bfdname}
1690 Object format of the output file. @code{nlmconv} infers the output
1691 format based on the input format, e.g. for a @samp{i386} input file the
1692 output format is @samp{nlm32-i386}.
1693 @xref{Target Selection}, for more information.
1694
1695 @item -T @var{headerfile}
1696 @itemx --header-file=@var{headerfile}
1697 Reads @var{headerfile} for NLM header information. For instructions on
1698 writing the NLM command file language used in header files, see@ see the
1699 @samp{linkers} section, of the @cite{NLM Development and Tools
1700 Overview}, which is part of the NLM Software Developer's Kit, available
1701 from Novell, Inc.
1702
1703 @item -d
1704 @itemx --debug
1705 Displays (on standard error) the linker command line used by @code{nlmconv}.
1706
1707 @item -l @var{linker}
1708 @itemx --linker=@var{linker}
1709 Use @var{linker} for any linking. @var{linker} can be an abosolute or a
1710 relative pathname.
1711
1712 @item -h
1713 @itemx --help
1714 Prints a usage summary.
1715
1716 @item -V
1717 @itemx --version
1718 Prints the version number for @code{nlmconv}.
1719 @end table
1720
1721 @node Selecting The Target System
1722 @chapter Selecting the target system
1723
1724 You can specify three aspects of the target system to the @sc{gnu}
1725 binary file utilities, each in several ways:
1726
1727 @itemize @bullet
1728 @item
1729 the target
1730
1731 @item
1732 the architecture
1733
1734 @item
1735 the linker emulation (which applies to the linker only)
1736 @end itemize
1737
1738 In the following summaries, the lists of ways to specify values are in
1739 order of decreasing precedence. The ways listed first override those
1740 listed later.
1741
1742 The commands to list valid values only list the values for which the
1743 programs you are running were configured. If they were configured with
1744 @samp{--enable-targets=all}, the commands list most of the available
1745 values, but a few are left out; not all targets can be configured in at
1746 once because some of them can only be configured @dfn{native} (on hosts
1747 with the same type as the target system).
1748
1749 @menu
1750 * Target Selection::
1751 * Architecture Selection::
1752 * Linker Emulation Selection::
1753 @end menu
1754
1755 @node Target Selection
1756 @section Target Selection
1757
1758 A @dfn{target} is an object file format. A given target may be
1759 supported for multiple architectures (@pxref{Architecture Selection}).
1760 A target selection may also have variations for different operating
1761 systems or architectures.
1762
1763 The command to list valid target values is @samp{objdump -i}
1764 (the first column of output contains the relevant information).
1765
1766 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
1767 @samp{a.out-sunos-big}.
1768
1769 @subheading @code{objdump} Target
1770
1771 Ways to specify:
1772
1773 @enumerate
1774 @item
1775 command line option: @samp{-b} or @samp{--target}
1776
1777 @item
1778 environment variable @code{GNUTARGET}
1779
1780 @item
1781 deduced from the input file
1782 @end enumerate
1783
1784 @subheading @code{objcopy} and @code{strip} Input Target
1785
1786 Ways to specify:
1787
1788 @enumerate
1789 @item
1790 command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
1791
1792 @item
1793 environment variable @code{GNUTARGET}
1794
1795 @item
1796 deduced from the input file
1797 @end enumerate
1798
1799 @subheading @code{objcopy} and @code{strip} Output Target
1800
1801 Ways to specify:
1802
1803 @enumerate
1804 @item
1805 command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
1806
1807 @item
1808 the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
1809
1810 @item
1811 environment variable @code{GNUTARGET}
1812
1813 @item
1814 deduced from the input file
1815 @end enumerate
1816
1817 @subheading @code{nm}, @code{size}, and @code{strings} Target
1818
1819 Ways to specify:
1820
1821 @enumerate
1822 @item
1823 command line option: @samp{--target}
1824
1825 @item
1826 environment variable @code{GNUTARGET}
1827
1828 @item
1829 deduced from the input file
1830 @end enumerate
1831
1832 @subheading Linker Input Target
1833
1834 Ways to specify:
1835
1836 @enumerate
1837 @item
1838 command line option: @samp{-b} or @samp{--format}
1839 (@pxref{Options,,Options,ld.info,Using LD})
1840
1841 @item
1842 script command @code{TARGET}
1843 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1844
1845 @item
1846 environment variable @code{GNUTARGET}
1847 (@pxref{Environment,,Environment,ld.info,Using LD})
1848
1849 @item
1850 the default target of the selected linker emulation
1851 (@pxref{Linker Emulation Selection})
1852 @end enumerate
1853
1854 @subheading Linker Output Target
1855
1856 Ways to specify:
1857
1858 @enumerate
1859 @item
1860 command line option: @samp{-oformat}
1861 (@pxref{Options,,Options,ld.info,Using LD})
1862
1863 @item
1864 script command @code{OUTPUT_FORMAT}
1865 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1866
1867 @item
1868 the linker input target (see ``Linker Input Target'' above)
1869 @end enumerate
1870
1871 @node Architecture Selection
1872 @section Architecture selection
1873
1874 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
1875 to run. Its name may contain a colon, separating the name of the
1876 processor family from the name of the particular @sc{cpu}.
1877
1878 The command to list valid architecture values is @samp{objdump -i} (the
1879 second column contains the relevant information).
1880
1881 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
1882
1883 @subheading @code{objdump} Architecture
1884
1885 Ways to specify:
1886
1887 @enumerate
1888 @item
1889 command line option: @samp{-m} or @samp{--architecture}
1890
1891 @item
1892 deduced from the input file
1893 @end enumerate
1894
1895 @subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
1896
1897 Ways to specify:
1898
1899 @enumerate
1900 @item
1901 deduced from the input file
1902 @end enumerate
1903
1904 @subheading Linker Input Architecture
1905
1906 Ways to specify:
1907
1908 @enumerate
1909 @item
1910 deduced from the input file
1911 @end enumerate
1912
1913 @subheading Linker Output Architecture
1914
1915 Ways to specify:
1916
1917 @enumerate
1918 @item
1919 script command @code{OUTPUT_ARCH}
1920 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1921
1922 @item
1923 the default architecture from the linker output target
1924 (@pxref{Target Selection})
1925 @end enumerate
1926
1927 @node Linker Emulation Selection
1928 @section Linker emulation selection
1929
1930 A linker @dfn{emulation} is a ``personality'' of the linker, which gives
1931 the linker default values for the other aspects of the target system.
1932 In particular, it consists of
1933
1934 @itemize @bullet
1935 @item
1936 the linker script
1937
1938 @item
1939 the target
1940
1941 @item
1942 several ``hook'' functions that are run at certain stages of the linking
1943 process to do special things that some targets require
1944 @end itemize
1945
1946 The command to list valid linker emulation values is @samp{ld -V}.
1947
1948 Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
1949
1950 Ways to specify:
1951
1952 @enumerate
1953 @item
1954 command line option: @samp{-m}
1955 (@pxref{Options,,Options,ld.info,Using LD})
1956
1957 @item
1958 environment variable @code{LDEMULATION}
1959
1960 @item
1961 compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
1962 which comes from @code{EMUL} in @file{config/@var{target}.mt}
1963 @end enumerate
1964
1965 @node Index
1966 @unnumbered Index
1967
1968 @printindex cp
1969
1970 @contents
1971 @bye