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