]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - binutils/binutils.texi
* objcopy.c (copy_object): If the output file format is `binary',
[thirdparty/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 [ -x | --discard-all ] [ -X | --discard-locals ]
747 [ -b @var{byte} | --byte=@var{byte} ]
748 [ -i @var{interleave} | --interleave=@var{interleave} ]
749 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
750 [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ]
751 [ --adjust-vma=@var{incr} ]
752 [ --adjust-section-vma=@var{section}@{=,+,-@}@var{val} ]
753 [ --adjust-warnings ] [ --no-adjust-warnings ]
754 [ -v | --verbose ] [ -V | --version ] [ --help ]
755 @var{infile} [@var{outfile}]
756 @end smallexample
757
758 The @sc{gnu} @code{objcopy} utility copies the contents of an object
759 file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to
760 read and write the object files. It can write the destination object
761 file in a format different from that of the source object file. The
762 exact behavior of @code{objcopy} is controlled by command-line options.
763
764 @code{objcopy} creates temporary files to do its translations and
765 deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its
766 translation work; it has access to all the formats described in @sc{bfd}
767 and thus is able to recognize most formats without being told
768 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
769
770 @code{objcopy} can be used to generate S-records by using an output
771 target of @samp{srec} (e.g., use @samp{-O srec}).
772
773 @code{objcopy} can be used to generate a raw binary file by using an
774 output target of @samp{binary} (e.g., use @samp{-O binary}). When
775 @code{objcopy} generates a raw binary file, it will essentially produce
776 a memory dump of the contents of the input object file. All symbols and
777 relocation information will be discarded. By default, the memory dump
778 will start at virtual address zero; the @samp{--set-start} option may be
779 used to specify a different starting point.
780
781 When generating an S-record or a raw binary file, it may be helpful to
782 use @samp{-S} to remove sections containing debugging information. In
783 some cases @samp{-R} will be useful to remove sections which contain
784 information which is not needed by the binary file.
785
786 @table @code
787 @item @var{infile}
788 @itemx @var{outfile}
789 The source and output files, respectively.
790 If you do not specify @var{outfile}, @code{objcopy} creates a
791 temporary file and destructively renames the result with
792 the name of @var{infile}.
793
794 @item -I @var{bfdname}
795 @itemx --input-target=@var{bfdname}
796 Consider the source file's object format to be @var{bfdname}, rather than
797 attempting to deduce it. @xref{Target Selection}, for more information.
798
799 @item -O @var{bfdname}
800 @itemx --output-target=@var{bfdname}
801 Write the output file using the object format @var{bfdname}.
802 @xref{Target Selection}, for more information.
803
804 @item -F @var{bfdname}
805 @itemx --target=@var{bfdname}
806 Use @var{bfdname} as the object format for both the input and the output
807 file; i.e., simply transfer data from source to destination with no
808 translation. @xref{Target Selection}, for more information.
809
810 @item -R @var{sectionname}
811 @itemx --remove-section=@var{sectionname}
812 Remove any section named @var{sectionname} from the output file. This
813 option may be given more than once. Note that using this option
814 inappropriately may make the output file unusable.
815
816 @item -S
817 @itemx --strip-all
818 Do not copy relocation and symbol information from the source file.
819
820 @item -g
821 @itemx --strip-debug
822 Do not copy debugging symbols from the source file.
823
824 @item -x
825 @itemx --discard-all
826 Do not copy non-global symbols from the source file.
827 @c FIXME any reason to prefer "non-global" to "local" here?
828
829 @item -X
830 @itemx --discard-locals
831 Do not copy compiler-generated local symbols.
832 (These usually start with @samp{L} or @samp{.}.)
833
834 @item -b @var{byte}
835 @itemx --byte=@var{byte}
836 Keep only every @var{byte}th byte of the input file (header data is not
837 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
838 where @var{interleave} is given by the @samp{-i} or @samp{--interleave}
839 option, or the default of 4. This option is useful for creating files
840 to program @sc{rom}. It is typically used with an @code{srec} output
841 target.
842
843 @item -i @var{interleave}
844 @itemx --interleave=@var{interleave}
845 Only copy one out of every @var{interleave} bytes. Select which byte to
846 copy with the @var{-b} or @samp{--byte} option. The default is 4.
847 @code{objcopy} ignores this option if you do not specify either @samp{-b} or
848 @samp{--byte}.
849
850 @item --set-start @var{val}
851 Set the address of the new file to @var{val}. Not all object file
852 formats support setting the start address. When using the @samp{binary}
853 output file format, the start address sets the virtual address of the
854 first byte in the binary output file.
855
856 @item --adjust-start @var{incr}
857 Adjust the start address by adding @var{incr}. Not all object file
858 formats support setting the start address.
859
860 @item --adjust-vma @var{incr}
861 Adjust the address of all sections, as well as the start address, by
862 adding @var{incr}. Some object file formats do not permit section
863 addresses to be changed arbitrarily. Note that this does not relocate
864 the sections; if the program expects sections to be loaded at a certain
865 address, and this option is used to change the sections such that they
866 are loaded at a different address, the program may fail.
867
868 @item --adjust-section-vma @var{section}@{=,+,-@}@var{val}
869 Set or adjust the address of the named @var{section}. If @samp{=} is
870 used, the section address is set to @var{val}. Otherwise, @var{val} is
871 added to or subtracted from the section address. See the comments under
872 @samp{--adjust-vma}, above. If @var{section} does not exist in the
873 input file, a warning will be issued, unless @samp{--no-adjust-warnings}
874 is used.
875
876 @item --adjust-warnings
877 If @samp{--adjust-section-vma} is used, and the named section does not
878 exist, issue a warning. This is the default.
879
880 @item --no-adjust-warnings
881 Do not issue a warning if @samp{--adjust-section-vma} is used, even if
882 the named section does not exist.
883
884 @item -V
885 @itemx --version
886 Show the version number of @code{objcopy}.
887
888 @item -v
889 @itemx --verbose
890 Verbose output: list all object files modified. In the case of
891 archives, @samp{objcopy -V} lists all members of the archive.
892
893 @item --help
894 Show a summary of the options to @code{objcopy}.
895 @end table
896
897 @node objdump
898 @chapter objdump
899
900 @cindex object file information
901 @kindex objdump
902
903 @smallexample
904 objdump [ -a | --archive-headers ]
905 [ -b @var{bfdname} | --target=@var{bfdname} ]
906 [ -d | --disassemble ] [ -D | --disassemble-all ]
907 [ -f | --file-headers ]
908 [ -h | --section-headers | --headers ] [ -i | --info ]
909 [ -j @var{section} | --section=@var{section} ]
910 [ -l | --line-numbers ]
911 [ -m @var{machine} | --architecture=@var{machine} ]
912 [ -r | --reloc ] [ -R | --dynamic-reloc ]
913 [ -s | --full-contents ] [ --stabs ]
914 [ -t | --syms ] [ -T | --dynamic-syms ] [ -x | --all-headers ]
915 [ --version ] [ --help ] @var{objfile}@dots{}
916 @end smallexample
917
918 @code{objdump} displays information about one or more object files.
919 The options control what particular information to display. This
920 information is mostly useful to programmers who are working on the
921 compilation tools, as opposed to programmers who just want their
922 program to compile and work.
923
924 @var{objfile}@dots{} are the object files to be examined. When you
925 specify archives, @code{objdump} shows information on each of the member
926 object files.
927
928 The long and short forms of options, shown here as alternatives, are
929 equivalent. At least one option besides @samp{-l} must be given.
930
931 @table @code
932 @item -a
933 @itemx --archive-header
934 @cindex archive headers
935 If any of the @var{objfile} files are archives, display the archive
936 header information (in a format similar to @samp{ls -l}). Besides the
937 information you could list with @samp{ar tv}, @samp{objdump -a} shows
938 the object file format of each archive member.
939
940 @item -b @var{bfdname}
941 @itemx --target=@var{bfdname}
942 @cindex object code format
943 Specify that the object-code format for the object files is
944 @var{bfdname}. This option may not be necessary; @var{objdump} can
945 automatically recognize many formats.
946
947 For example,
948 @example
949 objdump -b oasys -m vax -h fu.o
950 @end example
951 @noindent
952 displays summary information from the section headers (@samp{-h}) of
953 @file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
954 file in the format produced by Oasys compilers. You can list the
955 formats available with the @samp{-i} option.
956 @xref{Target Selection}, for more information.
957
958 @item -d
959 @itemx --disassemble
960 @cindex disassembling object code
961 @cindex machine instructions
962 Display the assembler mnemonics for the machine instructions from
963 @var{objfile}. This option only disassembles those sections which are
964 expected to contain instructions.
965
966 @item -D
967 @itemx --disassemble-all
968 Like @samp{-d}, but disassemble the contents of all sections, not just
969 those expected to contain instructions.
970
971 @item -f
972 @itemx --file-header
973 @cindex object file header
974 Display summary information from the overall header of
975 each of the @var{objfile} files.
976
977 @item -h
978 @itemx --section-header
979 @itemx --header
980 @cindex section headers
981 Display summary information from the section headers of the
982 object file.
983
984 File segments may be relocated to nonstandard addresses, for example by
985 using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
986 @code{ld}. However, some object file formats, such as a.out, do not
987 store the starting address of the file segments. In those situations,
988 although @code{ld} relocates the sections correctly, using @samp{objdump
989 -h} to list the file section headers cannot show the correct addresses.
990 Instead, it shows the usual addresses, which are implicit for the
991 target.
992
993 @item --help
994 Print a summary of the options to @code{objdump} and exit.
995
996 @item -i
997 @itemx --info
998 @cindex architectures available
999 @cindex object formats available
1000 Display a list showing all architectures and object formats available
1001 for specification with @samp{-b} or @samp{-m}.
1002
1003 @item -j @var{name}
1004 @itemx --section=@var{name}
1005 @cindex section information
1006 Display information only for section @var{name}.
1007
1008 @item -l
1009 @itemx --line-numbers
1010 @cindex source filenames for object files
1011 Label the display (using debugging information) with the filename
1012 and source line numbers corresponding to the object code shown.
1013 Only useful with @samp{-d} or @samp{-D}.
1014
1015 @item -m @var{machine}
1016 @itemx --architecture=@var{machine}
1017 @cindex architecture
1018 Specify that the object files @var{objfile} are for architecture
1019 @var{machine}. You can list available architectures using the @samp{-i}
1020 option.
1021
1022 @item -r
1023 @itemx --reloc
1024 @cindex relocation entries, in object file
1025 Print the relocation entries of the file. If used with @samp{-d} or
1026 @samp{-D}, the relocations are printed interspersed with the
1027 disassembly.
1028
1029 @item -R
1030 @itemx --dynamic-reloc
1031 @cindex dynamic relocation entries, in object file
1032 Print the dynamic relocation entries of the file. This is only
1033 meaningful for dynamic objects, such as certain types of shared
1034 libraries.
1035
1036 @item -s
1037 @itemx --full-contents
1038 @cindex sections, full contents
1039 @cindex object file sections
1040 Display the full contents of any sections requested.
1041
1042 @item --stabs
1043 @cindex stab
1044 @cindex .stab
1045 @cindex debug symbols
1046 @cindex ELF object file format
1047 Display the full contents of any sections requested. Display the
1048 contents of the .stab and .stab.index and .stab.excl sections from an
1049 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1050 @code{.stab} debugging symbol-table entries are carried in an ELF
1051 section. In most other file formats, debugging symbol-table entries are
1052 interleaved with linkage symbols, and are visible in the @samp{--syms}
1053 output.
1054
1055 @item -t
1056 @itemx --syms
1057 @cindex symbol table entries, printing
1058 Print the symbol table entries of the file.
1059 This is similar to the information provided by the @samp{nm} program.
1060
1061 @item -T
1062 @itemx --dynamic-syms
1063 @cindex dynamic symbol table entries, printing
1064 Print the dynamic symbol table entries of the file. This is only
1065 meaningful for dynamic objects, such as certain types of shared
1066 libraries. This is similar to the information provided by the @samp{nm}
1067 program when given the @samp{-D} (@samp{--dynamic}) option.
1068
1069 @item --version
1070 Print the version number of @code{objdump} and exit.
1071
1072 @item -x
1073 @itemx --all-header
1074 @cindex all header information, object file
1075 @cindex header information, all
1076 Display all available header information, including the symbol table and
1077 relocation entries. Using @samp{-x} is equivalent to specifying all of
1078 @samp{-a -f -h -r -t}.
1079 @end table
1080
1081 @node ranlib
1082 @chapter ranlib
1083
1084 @kindex ranlib
1085 @cindex archive contents
1086 @cindex symbol index
1087
1088 @smallexample
1089 ranlib [-vV] @var{archive}
1090 @end smallexample
1091
1092 @code{ranlib} generates an index to the contents of an archive and
1093 stores it in the archive. The index lists each symbol defined by a
1094 member of an archive that is a relocatable object file.
1095
1096 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
1097
1098 An archive with such an index speeds up linking to the library and
1099 allows routines in the library to call each other without regard to
1100 their placement in the archive.
1101
1102 The GNU @code{ranlib} program is another form of GNU @code{ar}; running
1103 @code{ranlib} is completely equivalent to executing @samp{ar -s}.
1104 @xref{ar}.
1105
1106 @table @code
1107 @item -v
1108 @itemx -V
1109 Show the version number of @code{ranlib}.
1110 @end table
1111
1112 @node size
1113 @chapter size
1114
1115 @kindex size
1116 @cindex section sizes
1117
1118 @smallexample
1119 size [ -A | -B | --format=@var{compatibility} ]
1120 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
1121 [ --target=@var{bfdname} ] [ -V | --version ]
1122 @var{objfile}@dots{}
1123 @end smallexample
1124
1125 The GNU @code{size} utility lists the section sizes---and the total
1126 size---for each of the object or archive files @var{objfile} in its
1127 argument list. By default, one line of output is generated for each
1128 object file or each module in an archive.
1129
1130 @var{objfile}@dots{} are the object files to be examined.
1131
1132 The command line options have the following meanings:
1133
1134 @table @code
1135 @item -A
1136 @itemx -B
1137 @itemx --format=@var{compatibility}
1138 @cindex @code{size} display format
1139 Using one of these options, you can choose whether the output from GNU
1140 @code{size} resembles output from System V @code{size} (using @samp{-A},
1141 or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
1142 @samp{--format=berkeley}). The default is the one-line format similar to
1143 Berkeley's.
1144 @c Bonus for doc-source readers: you can also say --format=strange (or
1145 @c anything else that starts with 's') for sysv, and --format=boring (or
1146 @c anything else that starts with 'b') for Berkeley.
1147
1148 Here is an example of the Berkeley (default) format of output from
1149 @code{size}:
1150 @smallexample
1151 size --format=Berkeley ranlib size
1152 text data bss dec hex filename
1153 294880 81920 11592 388392 5ed28 ranlib
1154 294880 81920 11888 388688 5ee50 size
1155 @end smallexample
1156
1157 @noindent
1158 This is the same data, but displayed closer to System V conventions:
1159
1160 @smallexample
1161 size --format=SysV ranlib size
1162 ranlib :
1163 section size addr
1164 .text 294880 8192
1165 .data 81920 303104
1166 .bss 11592 385024
1167 Total 388392
1168
1169
1170 size :
1171 section size addr
1172 .text 294880 8192
1173 .data 81920 303104
1174 .bss 11888 385024
1175 Total 388688
1176 @end smallexample
1177
1178 @item --help
1179 Show a summary of acceptable arguments and options.
1180
1181 @item -d
1182 @itemx -o
1183 @itemx -x
1184 @itemx --radix=@var{number}
1185 @cindex @code{size} number format
1186 @cindex radix for section sizes
1187 Using one of these options, you can control whether the size of each
1188 section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1189 (@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1190 @samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
1191 values (8, 10, 16) are supported. The total size is always given in two
1192 radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1193 octal and hexadecimal if you're using @samp{-o}.
1194
1195 @item --target=@var{bfdname}
1196 @cindex object code format
1197 Specify that the object-code format for @var{objfile} is
1198 @var{bfdname}. This option may not be necessary; @code{size} can
1199 automatically recognize many formats.
1200 @xref{Target Selection}, for more information.
1201
1202 @item -V
1203 @itemx --version
1204 Display the version number of @code{size}.
1205 @end table
1206
1207 @node strings
1208 @chapter strings
1209 @kindex strings
1210 @cindex listings strings
1211 @cindex printing strings
1212 @cindex strings, printing
1213
1214 @smallexample
1215 strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
1216 [--all] [--print-file-name] [--bytes=@var{min-len}]
1217 [--radix=@var{radix}] [--target=@var{bfdname}]
1218 [--help] [--version] @var{file}@dots{}
1219 @end smallexample
1220
1221 For each @var{file} given, GNU @code{strings} prints the printable
1222 character sequences that are at least 4 characters long (or the number
1223 given with the options below) and are followed by a NUL or newline
1224 character. By default, it only prints the strings from the initialized
1225 data sections of object files; for other types of files, it prints the
1226 strings from the whole file.
1227
1228 @code{strings} is mainly useful for determining the contents of non-text
1229 files.
1230
1231 @table @code
1232 @item -a
1233 @itemx --all
1234 @itemx -
1235 Do not scan only the initialized data section of object files; scan
1236 the whole files.
1237
1238 @item -f
1239 @itemx --print-file-name
1240 Print the name of the file before each string.
1241
1242 @item --help
1243 Print a summary of the program usage on the standard output and exit.
1244
1245 @itemx -@var{min-len}
1246 @item -n @var{min-len}
1247 @itemx --bytes=@var{min-len}
1248 Print sequences of characters that are at least @var{min-len} characters
1249 long, instead of the default 4.
1250
1251 @item -o
1252 Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1253 act like @samp{-t d} instead. Since we can not be compatible with both
1254 ways, we simply chose one.
1255
1256 @item -t @var{radix}
1257 @itemx --radix=@var{radix}
1258 Print the offset within the file before each string. The single
1259 character argument specifies the radix of the offset---@samp{o} for
1260 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1261
1262 @item --target=@var{bfdname}
1263 @cindex object code format
1264 Specify an object code format other than your system's default format.
1265 @xref{Target Selection}, for more information.
1266
1267 @item -v
1268 @itemx --version
1269 Print the program version number on the standard output and exit.
1270 @end table
1271
1272 @node strip
1273 @chapter strip
1274
1275 @kindex strip
1276 @cindex removing symbols
1277 @cindex discarding symbols
1278 @cindex symbols, discarding
1279
1280 @smallexample
1281 strip [ -F @var{bfdname} | --target=@var{bfdname} | --target=@var{bfdname} ]
1282 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1283 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
1284 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
1285 [ -x | --discard-all ] [ -X | --discard-locals ]
1286 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
1287 [ -v | --verbose ] [ -V | --version ] [ --help ]
1288 @var{objfile}@dots{}
1289 @end smallexample
1290
1291 GNU @code{strip} discards all symbols from object files
1292 @var{objfile}. The list of object files may include archives.
1293 At least one object file must be given.
1294
1295 @code{strip} modifies the files named in its argument,
1296 rather than writing modified copies under different names.
1297
1298 @table @code
1299 @item -F @var{bfdname}
1300 @itemx --target=@var{bfdname}
1301 Treat the original @var{objfile} as a file with the object
1302 code format @var{bfdname}, and rewrite it in the same format.
1303 @xref{Target Selection}, for more information.
1304
1305 @item --help
1306 Show a summary of the options to @code{strip} and exit.
1307
1308 @item -I @var{bfdname}
1309 @itemx --input-target=@var{bfdname}
1310 Treat the original @var{objfile} as a file with the object
1311 code format @var{bfdname}.
1312 @xref{Target Selection}, for more information.
1313
1314 @item -O @var{bfdname}
1315 @itemx --output-target=@var{bfdname}
1316 Replace @var{objfile} with a file in the output format @var{bfdname}.
1317 @xref{Target Selection}, for more information.
1318
1319 @item -R @var{sectionname}
1320 @itemx --remove-section=@var{sectionname}
1321 Remove any section named @var{sectionname} from the output file. This
1322 option may be given more than once. Note that using this option
1323 inappropriately may make the output file unusable.
1324
1325 @item -s
1326 @itemx --strip-all
1327 Remove all symbols.
1328
1329 @item -g
1330 @itemx -S
1331 @itemx --strip-debug
1332 Remove debugging symbols only.
1333
1334 @item -x
1335 @itemx --discard-all
1336 Remove non-global symbols.
1337
1338 @item -X
1339 @itemx --discard-locals
1340 Remove compiler-generated local symbols.
1341 (These usually start with @samp{L} or @samp{.}.)
1342
1343 @item -V
1344 @itemx --version
1345 Show the version number for @code{strip}.
1346
1347 @item -v
1348 @itemx --verbose
1349 Verbose output: list all object files modified. In the case of
1350 archives, @samp{strip -v} lists all members of the archive.
1351 @end table
1352
1353 @node c++filt
1354 @chapter c++filt
1355
1356 @kindex c++filt
1357 @cindex demangling C++ symbols
1358
1359 @smallexample
1360 c++filt [ -_ | --strip-underscores ]
1361 [ -n | --no-strip-underscores ]
1362 [ -s @var{format} | --format=@var{format} ]
1363 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
1364 @end smallexample
1365
1366 The C++ language provides function overloading, which means that you can
1367 write many functions with the same name (providing each takes parameters
1368 of different types). All C++ function names are encoded into a
1369 low-level assembly label (this process is known as
1370 @dfn{mangling}). The @code{c++filt} program does the inverse mapping: it
1371 decodes (@dfn{demangles}) low-level names into user-level names so that
1372 the linker can keep these overloaded functions from clashing.
1373
1374 Every alphanumeric word (consisting of letters, digits, underscores,
1375 dollars, or periods) seen in the input is a potential label. If the
1376 label decodes into a C++ name, the C++ name replaces the low-level
1377 name in the output.
1378
1379 You can use @code{c++filt} to decipher individual symbols:
1380
1381 @example
1382 c++filt @var{symbol}
1383 @end example
1384
1385 If no @var{symbol} arguments are given, @code{c++filt} reads symbol
1386 names from the standard input and writes the demangled names to the
1387 standard output. All results are printed on the standard output.
1388
1389 @table @code
1390 @item -_
1391 @itemx --strip-underscores
1392 On some systems, both the C and C++ compilers put an underscore in front
1393 of every name. For example, the C name @code{foo} gets the low-level
1394 name @code{_foo}. This option removes the initial underscore. Whether
1395 @code{c++filt} removes the underscore by default is target dependent.
1396
1397 @item -n
1398 @itemx --no-strip-underscores
1399 Do not remove the initial underscore.
1400
1401 @item -s @var{format}
1402 @itemx --format=@var{format}
1403 GNU @code{nm} can decode three different methods of mangling, used by
1404 different C++ compilers. The argument to this option selects which
1405 method it uses:
1406
1407 @table @code
1408 @item gnu
1409 the one used by the GNU compiler (the default method)
1410 @item lucid
1411 the one used by the Lucid compiler
1412 @item arm
1413 the one specified by the C++ Annotated Reference Manual
1414 @end table
1415
1416 @item --help
1417 Print a summary of the options to @code{c++filt} and exit.
1418
1419 @item --version
1420 Print the version number of @code{c++filt} and exit.
1421 @end table
1422
1423 @quotation
1424 @emph{Warning:} @code{c++filt} is a new utility, and the details of its
1425 user interface are subject to change in future releases. In particular,
1426 a command-line option may be required in the the future to decode a name
1427 passed as an argument on the command line; in other words,
1428
1429 @example
1430 c++filt @var{symbol}
1431 @end example
1432
1433 @noindent
1434 may in a future release become
1435
1436 @example
1437 c++filt @var{option} @var{symbol}
1438 @end example
1439 @end quotation
1440
1441 @node nlmconv
1442 @chapter nlmconv
1443
1444 @code{nlmconv} converts a relocatable object file into a NetWare
1445 Loadable Module.
1446
1447 @ignore
1448 @code{nlmconv} currently works with @samp{i386} object
1449 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
1450 object files in @sc{elf}, or @code{a.out} format@footnote{
1451 @code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
1452 format in the Binary File Descriptor library. It has only been tested
1453 with the above formats.}.
1454 @end ignore
1455
1456 @quotation
1457 @emph{Warning:} @code{nlmconv} is not always built as part of the binary
1458 utilities, since it is only useful for NLM targets.
1459 @end quotation
1460
1461 @smallexample
1462 nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1463 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
1464 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
1465 [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
1466 [ -h | --help ] [ -V | --version ]
1467 @var{infile} @var{outfile}
1468 @end smallexample
1469
1470 @code{nlmconv} converts the relocatable @samp{i386} object file
1471 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
1472 reading @var{headerfile} for NLM header information. For instructions
1473 on writing the NLM command file language used in header files, see the
1474 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
1475 Development and Tools Overview}, which is part of the NLM Software
1476 Developer's Kit (``NLM SDK''), available from Novell, Inc.
1477 @code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
1478 @var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for
1479 more information.
1480
1481 @code{nlmconv} can perform a link step. In other words, you can list
1482 more than one object file for input if you list them in the definitions
1483 file (rather than simply specifying one input file on the command line).
1484 In this case, @code{nlmconv} calls the linker for you.
1485
1486 @table @code
1487 @item -I @var{bfdname}
1488 @itemx --input-target=@var{bfdname}
1489 Object format of the input file. @code{nlmconv} can usually determine
1490 the format of a given file (so no default is necessary).
1491 @xref{Target Selection}, for more information.
1492
1493 @item -O @var{bfdname}
1494 @itemx --output-target=@var{bfdname}
1495 Object format of the output file. @code{nlmconv} infers the output
1496 format based on the input format, e.g. for a @samp{i386} input file the
1497 output format is @samp{nlm32-i386}.
1498 @xref{Target Selection}, for more information.
1499
1500 @item -T @var{headerfile}
1501 @itemx --header-file=@var{headerfile}
1502 Reads @var{headerfile} for NLM header information. For instructions on
1503 writing the NLM command file language used in header files, see@ see the
1504 @samp{linkers} section, of the @cite{NLM Development and Tools
1505 Overview}, which is part of the NLM Software Developer's Kit, available
1506 from Novell, Inc.
1507
1508 @item -d
1509 @itemx --debug
1510 Displays (on standard error) the linker command line used by @code{nlmconv}.
1511
1512 @item -l @var{linker}
1513 @itemx --linker=@var{linker}
1514 Use @var{linker} for any linking. @var{linker} can be an abosolute or a
1515 relative pathname.
1516
1517 @item -h
1518 @itemx --help
1519 Prints a usage summary.
1520
1521 @item -V
1522 @itemx --version
1523 Prints the version number for @code{nlmconv}.
1524 @end table
1525
1526 @node Selecting The Target System
1527 @chapter Selecting the target system
1528
1529 You can specify three aspects of the target system to the @sc{gnu}
1530 binary file utilities, each in several ways:
1531
1532 @itemize @bullet
1533 @item
1534 the target
1535
1536 @item
1537 the architecture
1538
1539 @item
1540 the linker emulation (which applies to the linker only)
1541 @end itemize
1542
1543 In the following summaries, the lists of ways to specify values are in
1544 order of decreasing precedence. The ways listed first override those
1545 listed later.
1546
1547 The commands to list valid values only list the values for which the
1548 programs you are running were configured. If they were configured with
1549 @samp{--with-targets=all}, the commands list most of the available
1550 values, but a few are left out; not all targets can be configured in at
1551 once because some of them can only be configured @dfn{native} (on hosts
1552 with the same type as the target system).
1553
1554 @menu
1555 * Target Selection::
1556 * Architecture Selection::
1557 * Linker Emulation Selection::
1558 @end menu
1559
1560 @node Target Selection
1561 @section Target Selection
1562
1563 A @dfn{target} is an object file format. A given target may be
1564 supported for multiple architectures (@pxref{Architecture Selection}).
1565 A target selection may also have variations for different operating
1566 systems or architectures.
1567
1568 The command to list valid target values is @samp{objdump -i}
1569 (the first column of output contains the relevant information).
1570
1571 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
1572 @samp{a.out-sunos-big}.
1573
1574 @subheading @code{objdump} Target
1575
1576 Ways to specify:
1577
1578 @enumerate
1579 @item
1580 command line option: @samp{-b} or @samp{--target}
1581
1582 @item
1583 environment variable @code{GNUTARGET}
1584
1585 @item
1586 deduced from the input file
1587 @end enumerate
1588
1589 @subheading @code{objcopy} and @code{strip} Input Target
1590
1591 Ways to specify:
1592
1593 @enumerate
1594 @item
1595 command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
1596
1597 @item
1598 environment variable @code{GNUTARGET}
1599
1600 @item
1601 deduced from the input file
1602 @end enumerate
1603
1604 @subheading @code{objcopy} and @code{strip} Output Target
1605
1606 Ways to specify:
1607
1608 @enumerate
1609 @item
1610 command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
1611
1612 @item
1613 the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
1614
1615 @item
1616 environment variable @code{GNUTARGET}
1617
1618 @item
1619 deduced from the input file
1620 @end enumerate
1621
1622 @subheading @code{nm}, @code{size}, and @code{strings} Target
1623
1624 Ways to specify:
1625
1626 @enumerate
1627 @item
1628 command line option: @samp{--target}
1629
1630 @item
1631 environment variable @code{GNUTARGET}
1632
1633 @item
1634 deduced from the input file
1635 @end enumerate
1636
1637 @subheading Linker Input Target
1638
1639 Ways to specify:
1640
1641 @enumerate
1642 @item
1643 command line option: @samp{-b} or @samp{--format}
1644 (@pxref{Options,,Options,ld.info,Using LD})
1645
1646 @item
1647 script command @code{TARGET}
1648 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1649
1650 @item
1651 environment variable @code{GNUTARGET}
1652 (@pxref{Environment,,Environment,ld.info,Using LD})
1653
1654 @item
1655 the default target of the selected linker emulation
1656 (@pxref{Linker Emulation Selection})
1657 @end enumerate
1658
1659 @subheading Linker Output Target
1660
1661 Ways to specify:
1662
1663 @enumerate
1664 @item
1665 command line option: @samp{-oformat}
1666 (@pxref{Options,,Options,ld.info,Using LD})
1667
1668 @item
1669 script command @code{OUTPUT_FORMAT}
1670 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1671
1672 @item
1673 the linker input target (see ``Linker Input Target'' above)
1674 @end enumerate
1675
1676 @node Architecture Selection
1677 @section Architecture selection
1678
1679 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
1680 to run. Its name may contain a colon, separating the name of the
1681 processor family from the name of the particular @sc{cpu}.
1682
1683 The command to list valid architecture values is @samp{objdump -i} (the
1684 second column contains the relevant information).
1685
1686 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
1687
1688 @subheading @code{objdump} Architecture
1689
1690 Ways to specify:
1691
1692 @enumerate
1693 @item
1694 command line option: @samp{-m} or @samp{--architecture}
1695
1696 @item
1697 deduced from the input file
1698 @end enumerate
1699
1700 @subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
1701
1702 Ways to specify:
1703
1704 @enumerate
1705 @item
1706 deduced from the input file
1707 @end enumerate
1708
1709 @subheading Linker Input Architecture
1710
1711 Ways to specify:
1712
1713 @enumerate
1714 @item
1715 deduced from the input file
1716 @end enumerate
1717
1718 @subheading Linker Output Architecture
1719
1720 Ways to specify:
1721
1722 @enumerate
1723 @item
1724 script command @code{OUTPUT_ARCH}
1725 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1726
1727 @item
1728 the default architecture from the linker output target
1729 (@pxref{Target Selection})
1730 @end enumerate
1731
1732 @node Linker Emulation Selection
1733 @section Linker emulation selection
1734
1735 A linker @dfn{emulation} is a ``personality'' of the linker, which gives
1736 the linker default values for the other aspects of the target system.
1737 In particular, it consists of
1738
1739 @itemize @bullet
1740 @item
1741 the linker script
1742
1743 @item
1744 the target
1745
1746 @item
1747 several ``hook'' functions that are run at certain stages of the linking
1748 process to do special things that some targets require
1749 @end itemize
1750
1751 The command to list valid linker emulation values is @samp{ld -V}.
1752
1753 Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
1754
1755 Ways to specify:
1756
1757 @enumerate
1758 @item
1759 command line option: @samp{-m}
1760 (@pxref{Options,,Options,ld.info,Using LD})
1761
1762 @item
1763 environment variable @code{LDEMULATION}
1764
1765 @item
1766 compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
1767 which comes from @code{EMUL} in @file{config/@var{target}.mt}
1768 @end enumerate
1769
1770 @node Index
1771 @unnumbered Index
1772
1773 @printindex cp
1774
1775 @contents
1776 @bye