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