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