TX19 uses igen by default.
[deliverable/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, 96, 97, 1998 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, 96, 97, 1998 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, 96, 97, 1998 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 addr2line
121 Convert addresses into file names and line numbers
122
123 @item nlmconv
124 Convert object code into a Netware Loadable Module
125
126 @item windres
127 Manipulate Windows resources
128 @end table
129 @end iftex
130
131 @menu
132 * ar:: Create, modify, and extract from archives
133 * nm:: List symbols from object files
134 * objcopy:: Copy and translate object files
135 * objdump:: Display information from object files
136 * ranlib:: Generate index to archive contents
137 * size:: List section sizes and total size
138 * strings:: List printable strings from files
139 * strip:: Discard symbols
140 * c++filt:: Filter to demangle encoded C++ symbols
141 * addr2line:: Convert addresses to file and line
142 * nlmconv:: Converts object code into an NLM
143 * windres:: Manipulate Windows resources
144 * Selecting The Target System:: How these utilities determine the target.
145 * Reporting Bugs:: Reporting Bugs
146 * Index:: Index
147 @end menu
148
149 @node ar
150 @chapter ar
151
152 @kindex ar
153 @cindex archives
154 @cindex collections of files
155 @smallexample
156 ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
157 ar -M [ <mri-script ]
158 @end smallexample
159
160 The @sc{gnu} @code{ar} program creates, modifies, and extracts from
161 archives. An @dfn{archive} is a single file holding a collection of
162 other files in a structure that makes it possible to retrieve
163 the original individual files (called @dfn{members} of the archive).
164
165 The original files' contents, mode (permissions), timestamp, owner, and
166 group are preserved in the archive, and can be restored on
167 extraction.
168
169 @cindex name length
170 @sc{gnu} @code{ar} can maintain archives whose members have names of any
171 length; however, depending on how @code{ar} is configured on your
172 system, a limit on member-name length may be imposed for compatibility
173 with archive formats maintained with other tools. If it exists, the
174 limit is often 15 characters (typical of formats related to a.out) or 16
175 characters (typical of formats related to coff).
176
177 @cindex libraries
178 @code{ar} is considered a binary utility because archives of this sort
179 are most often used as @dfn{libraries} holding commonly needed
180 subroutines.
181
182 @cindex symbol index
183 @code{ar} creates an index to the symbols defined in relocatable
184 object modules in the archive when you specify the modifier @samp{s}.
185 Once created, this index is updated in the archive whenever @code{ar}
186 makes a change to its contents (save for the @samp{q} update operation).
187 An archive with such an index speeds up linking to the library, and
188 allows routines in the library to call each other without regard to
189 their placement in the archive.
190
191 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
192 table. If an archive lacks the table, another form of @code{ar} called
193 @code{ranlib} can be used to add just the table.
194
195 @cindex compatibility, @code{ar}
196 @cindex @code{ar} compatibility
197 @sc{gnu} @code{ar} is designed to be compatible with two different
198 facilities. You can control its activity using command-line options,
199 like the different varieties of @code{ar} on Unix systems; or, if you
200 specify the single command-line option @samp{-M}, you can control it
201 with a script supplied via standard input, like the MRI ``librarian''
202 program.
203
204 @menu
205 * ar cmdline:: Controlling @code{ar} on the command line
206 * ar scripts:: Controlling @code{ar} with a script
207 @end menu
208
209 @page
210 @node ar cmdline
211 @section Controlling @code{ar} on the command line
212
213 @smallexample
214 ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
215 @end smallexample
216
217 @cindex Unix compatibility, @code{ar}
218 When you use @code{ar} in the Unix style, @code{ar} insists on at least two
219 arguments to execute: one keyletter specifying the @emph{operation}
220 (optionally accompanied by other keyletters specifying
221 @emph{modifiers}), and the archive name to act on.
222
223 Most operations can also accept further @var{member} arguments,
224 specifying particular files to operate on.
225
226 @sc{gnu} @code{ar} allows you to mix the operation code @var{p} and modifier
227 flags @var{mod} in any order, within the first command-line argument.
228
229 If you wish, you may begin the first command-line argument with a
230 dash.
231
232 @cindex operations on archive
233 The @var{p} keyletter specifies what operation to execute; it may be
234 any of the following, but you must specify only one of them:
235
236 @table @code
237 @item d
238 @cindex deleting from archive
239 @emph{Delete} modules from the archive. Specify the names of modules to
240 be deleted as @var{member}@dots{}; the archive is untouched if you
241 specify no files to delete.
242
243 If you specify the @samp{v} modifier, @code{ar} lists each module
244 as it is deleted.
245
246 @item m
247 @cindex moving in archive
248 Use this operation to @emph{move} members in an archive.
249
250 The ordering of members in an archive can make a difference in how
251 programs are linked using the library, if a symbol is defined in more
252 than one member.
253
254 If no modifiers are used with @code{m}, any members you name in the
255 @var{member} arguments are moved to the @emph{end} of the archive;
256 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
257 specified place instead.
258
259 @item p
260 @cindex printing from archive
261 @emph{Print} the specified members of the archive, to the standard
262 output file. If the @samp{v} modifier is specified, show the member
263 name before copying its contents to standard output.
264
265 If you specify no @var{member} arguments, all the files in the archive are
266 printed.
267
268 @item q
269 @cindex quick append to archive
270 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
271 @var{archive}, without checking for replacement.
272
273 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
274 operation; new members are always placed at the end of the archive.
275
276 The modifier @samp{v} makes @code{ar} list each file as it is appended.
277
278 Since the point of this operation is speed, the archive's symbol table
279 index is not updated, even if it already existed; you can use @samp{ar s} or
280 @code{ranlib} explicitly to update the symbol table index.
281
282 However, too many different systems assume quick append rebuilds the
283 index, so GNU ar implements @code{q} as a synonym for @code{r}.
284
285 @item r
286 @cindex replacement in archive
287 Insert the files @var{member}@dots{} into @var{archive} (with
288 @emph{replacement}). This operation differs from @samp{q} in that any
289 previously existing members are deleted if their names match those being
290 added.
291
292 If one of the files named in @var{member}@dots{} does not exist, @code{ar}
293 displays an error message, and leaves undisturbed any existing members
294 of the archive matching that name.
295
296 By default, new members are added at the end of the file; but you may
297 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
298 placement relative to some existing member.
299
300 The modifier @samp{v} used with this operation elicits a line of
301 output for each file inserted, along with one of the letters @samp{a} or
302 @samp{r} to indicate whether the file was appended (no old member
303 deleted) or replaced.
304
305 @item t
306 @cindex contents of archive
307 Display a @emph{table} listing the contents of @var{archive}, or those
308 of the files listed in @var{member}@dots{} that are present in the
309 archive. Normally only the member name is shown; if you also want to
310 see the modes (permissions), timestamp, owner, group, and size, you can
311 request that by also specifying the @samp{v} modifier.
312
313 If you do not specify a @var{member}, all files in the archive
314 are listed.
315
316 @cindex repeated names in archive
317 @cindex name duplication in archive
318 If there is more than one file with the same name (say, @samp{fie}) in
319 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
320 first instance; to see them all, you must ask for a complete
321 listing---in our example, @samp{ar t b.a}.
322 @c WRS only; per Gumby, this is implementation-dependent, and in a more
323 @c recent case in fact works the other way.
324
325 @item x
326 @cindex extract from archive
327 @emph{Extract} members (named @var{member}) from the archive. You can
328 use the @samp{v} modifier with this operation, to request that
329 @code{ar} list each name as it extracts it.
330
331 If you do not specify a @var{member}, all files in the archive
332 are extracted.
333
334 @end table
335
336 A number of modifiers (@var{mod}) may immediately follow the @var{p}
337 keyletter, to specify variations on an operation's behavior:
338
339 @table @code
340 @item a
341 @cindex relative placement in archive
342 Add new files @emph{after} an existing member of the
343 archive. If you use the modifier @samp{a}, the name of an existing archive
344 member must be present as the @var{relpos} argument, before the
345 @var{archive} specification.
346
347 @item b
348 Add new files @emph{before} an existing member of the
349 archive. If you use the modifier @samp{b}, 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{i}).
352
353 @item c
354 @cindex creating archives
355 @emph{Create} the archive. The specified @var{archive} is always
356 created if it did not exist, when you request an update. But a warning is
357 issued unless you specify in advance that you expect to create it, by
358 using this modifier.
359
360 @item f
361 Truncate names in the archive. @sc{gnu} @code{ar} will normally permit file
362 names of any length. This will cause it to create archives which are
363 not compatible with the native @code{ar} program on some systems. If
364 this is a concern, the @samp{f} modifier may be used to truncate file
365 names when putting them in the archive.
366
367 @item i
368 Insert new files @emph{before} an existing member of the
369 archive. If you use the modifier @samp{i}, the name of an existing archive
370 member must be present as the @var{relpos} argument, before the
371 @var{archive} specification. (same as @samp{b}).
372
373 @item l
374 This modifier is accepted but not used.
375 @c whaffor ar l modifier??? presumably compat; with
376 @c what???---doc@@cygnus.com, 25jan91
377
378 @item o
379 @cindex dates in archive
380 Preserve the @emph{original} dates of members when extracting them. If
381 you do not specify this modifier, files extracted from the archive
382 are stamped with the time of extraction.
383
384 @item s
385 @cindex writing archive index
386 Write an object-file index into the archive, or update an existing one,
387 even if no other change is made to the archive. You may use this modifier
388 flag either with any operation, or alone. Running @samp{ar s} on an
389 archive is equivalent to running @samp{ranlib} on it.
390
391 @item S
392 @cindex not writing archive index
393 Do not generate an archive symbol table. This can speed up building a
394 large library in several steps. The resulting archive can not be used
395 with the linker. In order to build a symbol table, you must omit the
396 @samp{S} modifier on the last execution of @samp{ar}, or you must run
397 @samp{ranlib} on the archive.
398
399 @item u
400 @cindex updating an archive
401 Normally, @samp{ar r}@dots{} inserts all files
402 listed into the archive. If you would like to insert @emph{only} those
403 of the files you list that are newer than existing members of the same
404 names, use this modifier. The @samp{u} modifier is allowed only for the
405 operation @samp{r} (replace). In particular, the combination @samp{qu} is
406 not allowed, since checking the timestamps would lose any speed
407 advantage from the operation @samp{q}.
408
409 @item v
410 This modifier requests the @emph{verbose} version of an operation. Many
411 operations display additional information, such as filenames processed,
412 when the modifier @samp{v} is appended.
413
414 @item V
415 This modifier shows the version number of @code{ar}.
416 @end table
417
418 @node ar scripts
419 @section Controlling @code{ar} with a script
420
421 @smallexample
422 ar -M [ <@var{script} ]
423 @end smallexample
424
425 @cindex MRI compatibility, @code{ar}
426 @cindex scripts, @code{ar}
427 If you use the single command-line option @samp{-M} with @code{ar}, you
428 can control its operation with a rudimentary command language. This
429 form of @code{ar} operates interactively if standard input is coming
430 directly from a terminal. During interactive use, @code{ar} prompts for
431 input (the prompt is @samp{AR >}), and continues executing even after
432 errors. If you redirect standard input to a script file, no prompts are
433 issued, and @code{ar} abandons execution (with a nonzero exit code)
434 on any error.
435
436 The @code{ar} command language is @emph{not} designed to be equivalent
437 to the command-line options; in fact, it provides somewhat less control
438 over archives. The only purpose of the command language is to ease the
439 transition to @sc{gnu} @code{ar} for developers who already have scripts
440 written for the MRI ``librarian'' program.
441
442 The syntax for the @code{ar} command language is straightforward:
443 @itemize @bullet
444 @item
445 commands are recognized in upper or lower case; for example, @code{LIST}
446 is the same as @code{list}. In the following descriptions, commands are
447 shown in upper case for clarity.
448
449 @item
450 a single command may appear on each line; it is the first word on the
451 line.
452
453 @item
454 empty lines are allowed, and have no effect.
455
456 @item
457 comments are allowed; text after either of the characters @samp{*}
458 or @samp{;} is ignored.
459
460 @item
461 Whenever you use a list of names as part of the argument to an @code{ar}
462 command, you can separate the individual names with either commas or
463 blanks. Commas are shown in the explanations below, for clarity.
464
465 @item
466 @samp{+} is used as a line continuation character; if @samp{+} appears
467 at the end of a line, the text on the following line is considered part
468 of the current command.
469 @end itemize
470
471 Here are the commands you can use in @code{ar} scripts, or when using
472 @code{ar} interactively. Three of them have special significance:
473
474 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
475 a temporary file required for most of the other commands.
476
477 @code{SAVE} commits the changes so far specified by the script. Prior
478 to @code{SAVE}, commands affect only the temporary copy of the current
479 archive.
480
481 @table @code
482 @item ADDLIB @var{archive}
483 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
484 Add all the contents of @var{archive} (or, if specified, each named
485 @var{module} from @var{archive}) to the current archive.
486
487 Requires prior use of @code{OPEN} or @code{CREATE}.
488
489 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
490 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
491 @c else like "ar q..."
492 Add each named @var{member} as a module in the current archive.
493
494 Requires prior use of @code{OPEN} or @code{CREATE}.
495
496 @item CLEAR
497 Discard the contents of the current archive, cancelling the effect of
498 any operations since the last @code{SAVE}. May be executed (with no
499 effect) even if no current archive is specified.
500
501 @item CREATE @var{archive}
502 Creates an archive, and makes it the current archive (required for many
503 other commands). The new archive is created with a temporary name; it
504 is not actually saved as @var{archive} until you use @code{SAVE}.
505 You can overwrite existing archives; similarly, the contents of any
506 existing file named @var{archive} will not be destroyed until @code{SAVE}.
507
508 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
509 Delete each listed @var{module} from the current archive; equivalent to
510 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
511
512 Requires prior use of @code{OPEN} or @code{CREATE}.
513
514 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
515 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
516 List each named @var{module} present in @var{archive}. The separate
517 command @code{VERBOSE} specifies the form of the output: when verbose
518 output is off, output is like that of @samp{ar -t @var{archive}
519 @var{module}@dots{}}. When verbose output is on, the listing is like
520 @samp{ar -tv @var{archive} @var{module}@dots{}}.
521
522 Output normally goes to the standard output stream; however, if you
523 specify @var{outputfile} as a final argument, @code{ar} directs the
524 output to that file.
525
526 @item END
527 Exit from @code{ar}, with a @code{0} exit code to indicate successful
528 completion. This command does not save the output file; if you have
529 changed the current archive since the last @code{SAVE} command, those
530 changes are lost.
531
532 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
533 Extract each named @var{module} from the current archive, writing them
534 into the current directory as separate files. Equivalent to @samp{ar -x
535 @var{archive} @var{module}@dots{}}.
536
537 Requires prior use of @code{OPEN} or @code{CREATE}.
538
539 @ignore
540 @c FIXME Tokens but no commands???
541 @item FULLDIR
542
543 @item HELP
544 @end ignore
545
546 @item LIST
547 Display full contents of the current archive, in ``verbose'' style
548 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
549 tv @var{archive}}). (This single command is a @sc{gnu} @code{ld}
550 enhancement, rather than present for MRI compatibility.)
551
552 Requires prior use of @code{OPEN} or @code{CREATE}.
553
554 @item OPEN @var{archive}
555 Opens an existing archive for use as the current archive (required for
556 many other commands). Any changes as the result of subsequent commands
557 will not actually affect @var{archive} until you next use @code{SAVE}.
558
559 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
560 In the current archive, replace each existing @var{module} (named in
561 the @code{REPLACE} arguments) from files in the current working directory.
562 To execute this command without errors, both the file, and the module in
563 the current archive, must exist.
564
565 Requires prior use of @code{OPEN} or @code{CREATE}.
566
567 @item VERBOSE
568 Toggle an internal flag governing the output from @code{DIRECTORY}.
569 When the flag is on, @code{DIRECTORY} output matches output from
570 @samp{ar -tv }@dots{}.
571
572 @item SAVE
573 Commit your changes to the current archive, and actually save it as a
574 file with the name specified in the last @code{CREATE} or @code{OPEN}
575 command.
576
577 Requires prior use of @code{OPEN} or @code{CREATE}.
578
579 @end table
580
581 @iftex
582 @node ld
583 @chapter ld
584 @cindex linker
585 @kindex ld
586 The @sc{gnu} linker @code{ld} is now described in a separate manual.
587 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
588 @end iftex
589
590 @node nm
591 @chapter nm
592 @cindex symbols
593 @kindex nm
594
595 @smallexample
596 nm [ -a | --debug-syms ] [ -g | --extern-only ]
597 [ -B ] [ -C | --demangle ] [ -D | --dynamic ]
598 [ -s | --print-armap ] [ -A | -o | --print-file-name ]
599 [ -n | -v | --numeric-sort ] [ -p | --no-sort ]
600 [ -r | --reverse-sort ] [ --size-sort ] [ -u | --undefined-only ]
601 [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ]
602 [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ]
603 [ --defined-only ] [-l | --line-numbers ]
604 [ --no-demangle ] [ -V | --version ] [ --help ] [ @var{objfile}@dots{} ]
605 @end smallexample
606
607 @sc{gnu} @code{nm} lists the symbols from object files @var{objfile}@dots{}.
608 If no object files are listed as arguments, @code{nm} assumes
609 @file{a.out}.
610
611 For each symbol, @code{nm} shows:
612
613 @itemize @bullet
614 @item
615 The symbol value, in the radix selected by options (see below), or
616 hexadecimal by default.
617
618 @item
619 The symbol type. At least the following types are used; others are, as
620 well, depending on the object file format. If lowercase, the symbol is
621 local; if uppercase, the symbol is global (external).
622
623 @c Some more detail on exactly what these symbol types are used for
624 @c would be nice.
625 @table @code
626 @item A
627 The symbol's value is absolute, and will not be changed by further
628 linking.
629
630 @item B
631 The symbol is in the uninitialized data section (known as BSS).
632
633 @item C
634 The symbol is common. Common symbols are uninitialized data. When
635 linking, multiple common symbols may appear with the same name. If the
636 symbol is defined anywhere, the common symbols are treated as undefined
637 references. For more details on common symbols, see the discussion of
638 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
639
640 @item D
641 The symbol is in the initialized data section.
642
643 @item G
644 The symbol is in an initialized data section for small objects. Some
645 object file formats permit more efficient access to small data objects,
646 such as a global int variable as opposed to a large global array.
647
648 @item I
649 The symbol is an indirect reference to another symbol. This is a GNU
650 extension to the a.out object file format which is rarely used.
651
652 @item N
653 The symbol is a debugging symbol.
654
655 @item R
656 The symbol is in a read only data section.
657
658 @item S
659 The symbol is in an uninitialized data section for small objects.
660
661 @item T
662 The symbol is in the text (code) section.
663
664 @item U
665 The symbol is undefined.
666
667 @item W
668 The symbol is weak. When a weak defined symbol is linked with a normal
669 defined symbol, the normal defined symbol is used with no error. When a
670 weak undefined symbol is linked and the symbol is not defined, the value
671 of the weak symbol becomes zero with no error.
672
673 @item -
674 The symbol is a stabs symbol in an a.out object file. In this case, the
675 next values printed are the stabs other field, the stabs desc field, and
676 the stab type. Stabs symbols are used to hold debugging information;
677 for more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
678 ``stabs'' debug format}.
679
680 @item ?
681 The symbol type is unknown, or object file format specific.
682 @end table
683
684 @item
685 The symbol name.
686 @end itemize
687
688 The long and short forms of options, shown here as alternatives, are
689 equivalent.
690
691 @table @code
692 @item -A
693 @itemx -o
694 @itemx --print-file-name
695 @cindex input file name
696 @cindex file name
697 @cindex source file name
698 Precede each symbol by the name of the input file (or archive element)
699 in which it was found, rather than identifying the input file once only,
700 before all of its symbols.
701
702 @item -a
703 @itemx --debug-syms
704 @cindex debugging symbols
705 Display all symbols, even debugger-only symbols; normally these are not
706 listed.
707
708 @item -B
709 @cindex @code{nm} format
710 @cindex @code{nm} compatibility
711 The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}).
712
713 @item -C
714 @itemx --demangle
715 @cindex demangling in nm
716 Decode (@dfn{demangle}) low-level symbol names into user-level names.
717 Besides removing any initial underscore prepended by the system, this
718 makes C++ function names readable. @xref{c++filt}, for more information
719 on demangling.
720
721 @item --no-demangle
722 Do not demangle low-level symbol names. This is the default.
723
724 @item -D
725 @itemx --dynamic
726 @cindex dynamic symbols
727 Display the dynamic symbols rather than the normal symbols. This is
728 only meaningful for dynamic objects, such as certain types of shared
729 libraries.
730
731 @item -f @var{format}
732 @itemx --format=@var{format}
733 @cindex @code{nm} format
734 @cindex @code{nm} compatibility
735 Use the output format @var{format}, which can be @code{bsd},
736 @code{sysv}, or @code{posix}. The default is @code{bsd}.
737 Only the first character of @var{format} is significant; it can be
738 either upper or lower case.
739
740 @item -g
741 @itemx --extern-only
742 @cindex external symbols
743 Display only external symbols.
744
745 @item -l
746 @itemx --line-numbers
747 @cindex symbol line numbers
748 For each symbol, use debugging information to try to find a filename and
749 line number. For a defined symbol, look for the line number of the
750 address of the symbol. For an undefined symbol, look for the line
751 number of a relocation entry which refers to the symbol. If line number
752 information can be found, print it after the other symbol information.
753
754 @item -n
755 @itemx -v
756 @itemx --numeric-sort
757 Sort symbols numerically by their addresses, rather than alphabetically
758 by their names.
759
760 @item -p
761 @itemx --no-sort
762 @cindex sorting symbols
763 Do not bother to sort the symbols in any order; print them in the order
764 encountered.
765
766 @item -P
767 @itemx --portability
768 Use the POSIX.2 standard output format instead of the default format.
769 Equivalent to @samp{-f posix}.
770
771 @item -s
772 @itemx --print-armap
773 @cindex symbol index, listing
774 When listing symbols from archive members, include the index: a mapping
775 (stored in the archive by @code{ar} or @code{ranlib}) of which modules
776 contain definitions for which names.
777
778 @item -r
779 @itemx --reverse-sort
780 Reverse the order of the sort (whether numeric or alphabetic); let the
781 last come first.
782
783 @item --size-sort
784 Sort symbols by size. The size is computed as the difference between
785 the value of the symbol and the value of the symbol with the next higher
786 value. The size of the symbol is printed, rather than the value.
787
788 @item -t @var{radix}
789 @itemx --radix=@var{radix}
790 Use @var{radix} as the radix for printing the symbol values. It must be
791 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
792
793 @item --target=@var{bfdname}
794 @cindex object code format
795 Specify an object code format other than your system's default format.
796 @xref{Target Selection}, for more information.
797
798 @item -u
799 @itemx --undefined-only
800 @cindex external symbols
801 @cindex undefined symbols
802 Display only undefined symbols (those external to each object file).
803
804 @item --defined-only
805 @cindex external symbols
806 @cindex undefined symbols
807 Display only defined symbols for each object file.
808
809 @item -V
810 @itemx --version
811 Show the version number of @code{nm} and exit.
812
813 @item --help
814 Show a summary of the options to @code{nm} and exit.
815 @end table
816
817 @node objcopy
818 @chapter objcopy
819
820 @smallexample
821 objcopy [ -F @var{bfdname} | --target=@var{bfdname} ]
822 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
823 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
824 [ -S | --strip-all ] [ -g | --strip-debug ]
825 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
826 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
827 [ -L @var{symbolname} | --localize-symbol=@var{symbolname} ]
828 [ -W @var{symbolname} | --weaken-symbol=@var{symbolname} ]
829 [ -x | --discard-all ] [ -X | --discard-locals ]
830 [ -b @var{byte} | --byte=@var{byte} ]
831 [ -i @var{interleave} | --interleave=@var{interleave} ]
832 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
833 [ -p | --preserve-dates ] [ --debugging ]
834 [ --gap-fill=@var{val} ] [ --pad-to=@var{address} ]
835 [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ]
836 [ --adjust-vma=@var{incr} ]
837 [ --adjust-section-vma=@var{section}@{=,+,-@}@var{val} ]
838 [ --adjust-warnings ] [ --no-adjust-warnings ]
839 [ --set-section-flags=@var{section}=@var{flags} ]
840 [ --add-section=@var{sectionname}=@var{filename} ]
841 [ --change-leading-char ] [ --remove-leading-char ]
842 [ --weaken ]
843 [ -v | --verbose ] [ -V | --version ] [ --help ]
844 @var{infile} [@var{outfile}]
845 @end smallexample
846
847 The @sc{gnu} @code{objcopy} utility copies the contents of an object
848 file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to
849 read and write the object files. It can write the destination object
850 file in a format different from that of the source object file. The
851 exact behavior of @code{objcopy} is controlled by command-line options.
852
853 @code{objcopy} creates temporary files to do its translations and
854 deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its
855 translation work; it has access to all the formats described in @sc{bfd}
856 and thus is able to recognize most formats without being told
857 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
858
859 @code{objcopy} can be used to generate S-records by using an output
860 target of @samp{srec} (e.g., use @samp{-O srec}).
861
862 @code{objcopy} can be used to generate a raw binary file by using an
863 output target of @samp{binary} (e.g., use @samp{-O binary}). When
864 @code{objcopy} generates a raw binary file, it will essentially produce
865 a memory dump of the contents of the input object file. All symbols and
866 relocation information will be discarded. The memory dump will start at
867 the load address of the lowest section copied into the output file.
868
869 When generating an S-record or a raw binary file, it may be helpful to
870 use @samp{-S} to remove sections containing debugging information. In
871 some cases @samp{-R} will be useful to remove sections which contain
872 information which is not needed by the binary file.
873
874 @table @code
875 @item @var{infile}
876 @itemx @var{outfile}
877 The source and output files, respectively.
878 If you do not specify @var{outfile}, @code{objcopy} creates a
879 temporary file and destructively renames the result with
880 the name of @var{infile}.
881
882 @item -I @var{bfdname}
883 @itemx --input-target=@var{bfdname}
884 Consider the source file's object format to be @var{bfdname}, rather than
885 attempting to deduce it. @xref{Target Selection}, for more information.
886
887 @item -O @var{bfdname}
888 @itemx --output-target=@var{bfdname}
889 Write the output file using the object format @var{bfdname}.
890 @xref{Target Selection}, for more information.
891
892 @item -F @var{bfdname}
893 @itemx --target=@var{bfdname}
894 Use @var{bfdname} as the object format for both the input and the output
895 file; i.e., simply transfer data from source to destination with no
896 translation. @xref{Target Selection}, for more information.
897
898 @item -R @var{sectionname}
899 @itemx --remove-section=@var{sectionname}
900 Remove any section named @var{sectionname} from the output file. This
901 option may be given more than once. Note that using this option
902 inappropriately may make the output file unusable.
903
904 @item -S
905 @itemx --strip-all
906 Do not copy relocation and symbol information from the source file.
907
908 @item -g
909 @itemx --strip-debug
910 Do not copy debugging symbols from the source file.
911
912 @item --strip-unneeded
913 Strip all symbols that are not needed for relocation processing.
914
915 @item -K @var{symbolname}
916 @itemx --keep-symbol=@var{symbolname}
917 Copy only symbol @var{symbolname} from the source file. This option may
918 be given more than once.
919
920 @item -N @var{symbolname}
921 @itemx --strip-symbol=@var{symbolname}
922 Do not copy symbol @var{symbolname} from the source file. This option
923 may be given more than once.
924
925 @item -L @var{symbolname}
926 @itemx --localize-symbol=@var{symbolname}
927 Make symbol @var{symbolname} local to the file, so that it is not
928 visible externally. This option may be given more than once.
929
930 @item -W @var{symbolname}
931 @itemx --weaken-symbol=@var{symbolname}
932 Make symbol @var{symbolname} weak. This option may be given more than once.
933
934 @item -x
935 @itemx --discard-all
936 Do not copy non-global symbols from the source file.
937 @c FIXME any reason to prefer "non-global" to "local" here?
938
939 @item -X
940 @itemx --discard-locals
941 Do not copy compiler-generated local symbols.
942 (These usually start with @samp{L} or @samp{.}.)
943
944 @item -b @var{byte}
945 @itemx --byte=@var{byte}
946 Keep only every @var{byte}th byte of the input file (header data is not
947 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
948 where @var{interleave} is given by the @samp{-i} or @samp{--interleave}
949 option, or the default of 4. This option is useful for creating files
950 to program @sc{rom}. It is typically used with an @code{srec} output
951 target.
952
953 @item -i @var{interleave}
954 @itemx --interleave=@var{interleave}
955 Only copy one out of every @var{interleave} bytes. Select which byte to
956 copy with the @var{-b} or @samp{--byte} option. The default is 4.
957 @code{objcopy} ignores this option if you do not specify either @samp{-b} or
958 @samp{--byte}.
959
960 @item -p
961 @itemx --preserve-dates
962 Set the access and modification dates of the output file to be the same
963 as those of the input file.
964
965 @item --debugging
966 Convert debugging information, if possible. This is not the default
967 because only certain debugging formats are supported, and the
968 conversion process can be time consuming.
969
970 @item --gap-fill @var{val}
971 Fill gaps between sections with @var{val}. This operation applies to
972 the @emph{load address} (LMA) of the sections. It is done by increasing
973 the size of the section with the lower address, and filling in the extra
974 space created with @var{val}.
975
976 @item --pad-to @var{address}
977 Pad the output file up to the load address @var{address}. This is
978 done by increasing the size of the last section. The extra space is
979 filled in with the value specified by @samp{--gap-fill} (default zero).
980
981 @item --set-start @var{val}
982 Set the address of the new file to @var{val}. Not all object file
983 formats support setting the start address.
984
985 @item --adjust-start @var{incr}
986 Adjust the start address by adding @var{incr}. Not all object file
987 formats support setting the start address.
988
989 @item --adjust-vma @var{incr}
990 Adjust the address of all sections, as well as the start address, by
991 adding @var{incr}. Some object file formats do not permit section
992 addresses to be changed arbitrarily. Note that this does not relocate
993 the sections; if the program expects sections to be loaded at a certain
994 address, and this option is used to change the sections such that they
995 are loaded at a different address, the program may fail.
996
997 @item --adjust-section-vma @var{section}@{=,+,-@}@var{val}
998 Set or adjust the address of the named @var{section}. If @samp{=} is
999 used, the section address is set to @var{val}. Otherwise, @var{val} is
1000 added to or subtracted from the section address. See the comments under
1001 @samp{--adjust-vma}, above. If @var{section} does not exist in the
1002 input file, a warning will be issued, unless @samp{--no-adjust-warnings}
1003 is used.
1004
1005 @item --adjust-warnings
1006 If @samp{--adjust-section-vma} is used, and the named section does not
1007 exist, issue a warning. This is the default.
1008
1009 @item --no-adjust-warnings
1010 Do not issue a warning if @samp{--adjust-section-vma} is used, even if
1011 the named section does not exist.
1012
1013 @item --set-section-flags @var{section}=@var{flags}
1014 Set the flags for the named section. The @var{flags} argument is a
1015 comma separated string of flag names. The recognized names are
1016 @samp{alloc}, @samp{contents}, @samp{load}, @samp{readonly},
1017 @samp{code}, @samp{data}, and @samp{rom}. You can set the
1018 @samp{contents} flag for a section which does not have contents, but it
1019 is not meaningful to clear the @samp{contents} flag of a section which
1020 does have contents--just remove the section instead. Not all flags are
1021 meaningful for all object file formats.
1022
1023 @item --add-section @var{sectionname}=@var{filename}
1024 Add a new section named @var{sectionname} while copying the file. The
1025 contents of the new section are taken from the file @var{filename}. The
1026 size of the section will be the size of the file. This option only
1027 works on file formats which can support sections with arbitrary names.
1028
1029 @item --change-leading-char
1030 Some object file formats use special characters at the start of
1031 symbols. The most common such character is underscore, which compilers
1032 often add before every symbol. This option tells @code{objcopy} to
1033 change the leading character of every symbol when it converts between
1034 object file formats. If the object file formats use the same leading
1035 character, this option has no effect. Otherwise, it will add a
1036 character, or remove a character, or change a character, as
1037 appropriate.
1038
1039 @item --remove-leading-char
1040 If the first character of a global symbol is a special symbol leading
1041 character used by the object file format, remove the character. The
1042 most common symbol leading character is underscore. This option will
1043 remove a leading underscore from all global symbols. This can be useful
1044 if you want to link together objects of different file formats with
1045 different conventions for symbol names. This is different from
1046 @code{--change-leading-char} because it always changes the symbol name
1047 when appropriate, regardless of the object file format of the output
1048 file.
1049
1050 @item --weaken
1051 Change all global symbols in the file to be weak. This can be useful
1052 when building an object which will be linked against other objects using
1053 the @code{-R} option to the linker. This option is only effective when
1054 using an object file format which supports weak symbols.
1055
1056 @item -V
1057 @itemx --version
1058 Show the version number of @code{objcopy}.
1059
1060 @item -v
1061 @itemx --verbose
1062 Verbose output: list all object files modified. In the case of
1063 archives, @samp{objcopy -V} lists all members of the archive.
1064
1065 @item --help
1066 Show a summary of the options to @code{objcopy}.
1067 @end table
1068
1069 @node objdump
1070 @chapter objdump
1071
1072 @cindex object file information
1073 @kindex objdump
1074
1075 @smallexample
1076 objdump [ -a | --archive-headers ]
1077 [ -b @var{bfdname} | --target=@var{bfdname} ] [ --debugging ]
1078 [ -C | --demangle ] [ -d | --disassemble ]
1079 [ -D | --disassemble-all ] [ --disassemble-zeroes ]
1080 [ -EB | -EL | --endian=@{big | little @} ]
1081 [ -f | --file-headers ]
1082 [ -h | --section-headers | --headers ] [ -i | --info ]
1083 [ -j @var{section} | --section=@var{section} ]
1084 [ -l | --line-numbers ] [ -S | --source ]
1085 [ -m @var{machine} | --architecture=@var{machine} ]
1086 [ -r | --reloc ] [ -R | --dynamic-reloc ]
1087 [ -s | --full-contents ] [ --stabs ]
1088 [ -t | --syms ] [ -T | --dynamic-syms ] [ -x | --all-headers ]
1089 [ -w | --wide ] [ --start-address=@var{address} ]
1090 [ --stop-address=@var{address} ]
1091 [ --prefix-addresses] [ --[no-]show-raw-insn ]
1092 [ --adjust-vma=@var{offset} ]
1093 [ --version ] [ --help ]
1094 @var{objfile}@dots{}
1095 @end smallexample
1096
1097 @code{objdump} displays information about one or more object files.
1098 The options control what particular information to display. This
1099 information is mostly useful to programmers who are working on the
1100 compilation tools, as opposed to programmers who just want their
1101 program to compile and work.
1102
1103 @var{objfile}@dots{} are the object files to be examined. When you
1104 specify archives, @code{objdump} shows information on each of the member
1105 object files.
1106
1107 The long and short forms of options, shown here as alternatives, are
1108 equivalent. At least one option besides @samp{-l} must be given.
1109
1110 @table @code
1111 @item -a
1112 @itemx --archive-header
1113 @cindex archive headers
1114 If any of the @var{objfile} files are archives, display the archive
1115 header information (in a format similar to @samp{ls -l}). Besides the
1116 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1117 the object file format of each archive member.
1118
1119 @item --adjust-vma=@var{offset}
1120 @cindex section addresses in objdump
1121 @cindex VMA in objdump
1122 When dumping information, first add @var{offset} to all the section
1123 addresses. This is useful if the section addresses do not correspond to
1124 the symbol table, which can happen when putting sections at particular
1125 addresses when using a format which can not represent section addresses,
1126 such as a.out.
1127
1128 @item -b @var{bfdname}
1129 @itemx --target=@var{bfdname}
1130 @cindex object code format
1131 Specify that the object-code format for the object files is
1132 @var{bfdname}. This option may not be necessary; @var{objdump} can
1133 automatically recognize many formats.
1134
1135 For example,
1136 @example
1137 objdump -b oasys -m vax -h fu.o
1138 @end example
1139 @noindent
1140 displays summary information from the section headers (@samp{-h}) of
1141 @file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
1142 file in the format produced by Oasys compilers. You can list the
1143 formats available with the @samp{-i} option.
1144 @xref{Target Selection}, for more information.
1145
1146 @item -C
1147 @itemx --demangle
1148 @cindex demangling in objdump
1149 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1150 Besides removing any initial underscore prepended by the system, this
1151 makes C++ function names readable. @xref{c++filt}, for more information
1152 on demangling.
1153
1154 @item --debugging
1155 Display debugging information. This attempts to parse debugging
1156 information stored in the file and print it out using a C like syntax.
1157 Only certain types of debugging information have been implemented.
1158
1159 @item -d
1160 @itemx --disassemble
1161 @cindex disassembling object code
1162 @cindex machine instructions
1163 Display the assembler mnemonics for the machine instructions from
1164 @var{objfile}. This option only disassembles those sections which are
1165 expected to contain instructions.
1166
1167 @item -D
1168 @itemx --disassemble-all
1169 Like @samp{-d}, but disassemble the contents of all sections, not just
1170 those expected to contain instructions.
1171
1172 @item --prefix-addresses
1173 When disassembling, print the complete address on each line. This is
1174 the older disassembly format.
1175
1176 @item --disassemble-zeroes
1177 Normally the disassembly output will skip blocks of zeroes. This
1178 option directs the disassembler to disassemble those blocks, just like
1179 any other data.
1180
1181 @item -EB
1182 @itemx -EL
1183 @itemx --endian=@{big|little@}
1184 @cindex endianness
1185 @cindex disassembly endianness
1186 Specify the endianness of the object files. This only affects
1187 disassembly. This can be useful when disassembling a file format which
1188 does not describe endianness information, such as S-records.
1189
1190 @item -f
1191 @itemx --file-header
1192 @cindex object file header
1193 Display summary information from the overall header of
1194 each of the @var{objfile} files.
1195
1196 @item -h
1197 @itemx --section-header
1198 @itemx --header
1199 @cindex section headers
1200 Display summary information from the section headers of the
1201 object file.
1202
1203 File segments may be relocated to nonstandard addresses, for example by
1204 using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
1205 @code{ld}. However, some object file formats, such as a.out, do not
1206 store the starting address of the file segments. In those situations,
1207 although @code{ld} relocates the sections correctly, using @samp{objdump
1208 -h} to list the file section headers cannot show the correct addresses.
1209 Instead, it shows the usual addresses, which are implicit for the
1210 target.
1211
1212 @item --help
1213 Print a summary of the options to @code{objdump} and exit.
1214
1215 @item -i
1216 @itemx --info
1217 @cindex architectures available
1218 @cindex object formats available
1219 Display a list showing all architectures and object formats available
1220 for specification with @samp{-b} or @samp{-m}.
1221
1222 @item -j @var{name}
1223 @itemx --section=@var{name}
1224 @cindex section information
1225 Display information only for section @var{name}.
1226
1227 @item -l
1228 @itemx --line-numbers
1229 @cindex source filenames for object files
1230 Label the display (using debugging information) with the filename and
1231 source line numbers corresponding to the object code or relocs shown.
1232 Only useful with @samp{-d}, @samp{-D}, or @samp{-r}.
1233
1234 @item -m @var{machine}
1235 @itemx --architecture=@var{machine}
1236 @cindex architecture
1237 @cindex disassembly architecture
1238 Specify the architecture to use when disassembling object files. This
1239 can be useful when disasembling object files which do not describe
1240 architecture information, such as S-records. You can list the available
1241 architectures with the @samp{-i} option.
1242
1243 @item -r
1244 @itemx --reloc
1245 @cindex relocation entries, in object file
1246 Print the relocation entries of the file. If used with @samp{-d} or
1247 @samp{-D}, the relocations are printed interspersed with the
1248 disassembly.
1249
1250 @item -R
1251 @itemx --dynamic-reloc
1252 @cindex dynamic relocation entries, in object file
1253 Print the dynamic relocation entries of the file. This is only
1254 meaningful for dynamic objects, such as certain types of shared
1255 libraries.
1256
1257 @item -s
1258 @itemx --full-contents
1259 @cindex sections, full contents
1260 @cindex object file sections
1261 Display the full contents of any sections requested.
1262
1263 @item -S
1264 @itemx --source
1265 @cindex source disassembly
1266 @cindex disassembly, with source
1267 Display source code intermixed with disassembly, if possible. Implies
1268 @samp{-d}.
1269
1270 @item --show-raw-insn
1271 When disassembling instructions, print the instruction in hex as well as
1272 in symbolic form. This is the default except when
1273 @code{--prefix-addresses} is used.
1274
1275 @item --no-show-raw-insn
1276 When disassembling instructions, do not print the instruction bytes.
1277 This is the default when @code{--prefix-addresses} is used.
1278
1279 @item --stabs
1280 @cindex stab
1281 @cindex .stab
1282 @cindex debug symbols
1283 @cindex ELF object file format
1284 Display the full contents of any sections requested. Display the
1285 contents of the .stab and .stab.index and .stab.excl sections from an
1286 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1287 @code{.stab} debugging symbol-table entries are carried in an ELF
1288 section. In most other file formats, debugging symbol-table entries are
1289 interleaved with linkage symbols, and are visible in the @samp{--syms}
1290 output. For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1291 Overview,stabs.info, The ``stabs'' debug format}.
1292
1293 @item --start-address=@var{address}
1294 @cindex start-address
1295 Start displaying data at the specified address. This affects the output
1296 of the @code{-d}, @code{-r} and @code{-s} options.
1297
1298 @item --stop-address=@var{address}
1299 @cindex stop-address
1300 Stop displaying data at the specified address. This affects the output
1301 of the @code{-d}, @code{-r} and @code{-s} options.
1302
1303 @item -t
1304 @itemx --syms
1305 @cindex symbol table entries, printing
1306 Print the symbol table entries of the file.
1307 This is similar to the information provided by the @samp{nm} program.
1308
1309 @item -T
1310 @itemx --dynamic-syms
1311 @cindex dynamic symbol table entries, printing
1312 Print the dynamic symbol table entries of the file. This is only
1313 meaningful for dynamic objects, such as certain types of shared
1314 libraries. This is similar to the information provided by the @samp{nm}
1315 program when given the @samp{-D} (@samp{--dynamic}) option.
1316
1317 @item --version
1318 Print the version number of @code{objdump} and exit.
1319
1320 @item -x
1321 @itemx --all-header
1322 @cindex all header information, object file
1323 @cindex header information, all
1324 Display all available header information, including the symbol table and
1325 relocation entries. Using @samp{-x} is equivalent to specifying all of
1326 @samp{-a -f -h -r -t}.
1327
1328 @item -w
1329 @itemx --wide
1330 @cindex wide output, printing
1331 Format some lines for output devices that have more than 80 columns.
1332 @end table
1333
1334 @node ranlib
1335 @chapter ranlib
1336
1337 @kindex ranlib
1338 @cindex archive contents
1339 @cindex symbol index
1340
1341 @smallexample
1342 ranlib [-vV] @var{archive}
1343 @end smallexample
1344
1345 @code{ranlib} generates an index to the contents of an archive and
1346 stores it in the archive. The index lists each symbol defined by a
1347 member of an archive that is a relocatable object file.
1348
1349 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
1350
1351 An archive with such an index speeds up linking to the library and
1352 allows routines in the library to call each other without regard to
1353 their placement in the archive.
1354
1355 The @sc{gnu} @code{ranlib} program is another form of @sc{gnu} @code{ar}; running
1356 @code{ranlib} is completely equivalent to executing @samp{ar -s}.
1357 @xref{ar}.
1358
1359 @table @code
1360 @item -v
1361 @itemx -V
1362 Show the version number of @code{ranlib}.
1363 @end table
1364
1365 @node size
1366 @chapter size
1367
1368 @kindex size
1369 @cindex section sizes
1370
1371 @smallexample
1372 size [ -A | -B | --format=@var{compatibility} ]
1373 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
1374 [ --target=@var{bfdname} ] [ -V | --version ]
1375 [ @var{objfile}@dots{} ]
1376 @end smallexample
1377
1378 The @sc{gnu} @code{size} utility lists the section sizes---and the total
1379 size---for each of the object or archive files @var{objfile} in its
1380 argument list. By default, one line of output is generated for each
1381 object file or each module in an archive.
1382
1383 @var{objfile}@dots{} are the object files to be examined.
1384 If none are specified, the file @code{a.out} will be used.
1385
1386 The command line options have the following meanings:
1387
1388 @table @code
1389 @item -A
1390 @itemx -B
1391 @itemx --format=@var{compatibility}
1392 @cindex @code{size} display format
1393 Using one of these options, you can choose whether the output from @sc{gnu}
1394 @code{size} resembles output from System V @code{size} (using @samp{-A},
1395 or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
1396 @samp{--format=berkeley}). The default is the one-line format similar to
1397 Berkeley's.
1398 @c Bonus for doc-source readers: you can also say --format=strange (or
1399 @c anything else that starts with 's') for sysv, and --format=boring (or
1400 @c anything else that starts with 'b') for Berkeley.
1401
1402 Here is an example of the Berkeley (default) format of output from
1403 @code{size}:
1404 @smallexample
1405 size --format=Berkeley ranlib size
1406 text data bss dec hex filename
1407 294880 81920 11592 388392 5ed28 ranlib
1408 294880 81920 11888 388688 5ee50 size
1409 @end smallexample
1410
1411 @noindent
1412 This is the same data, but displayed closer to System V conventions:
1413
1414 @smallexample
1415 size --format=SysV ranlib size
1416 ranlib :
1417 section size addr
1418 .text 294880 8192
1419 .data 81920 303104
1420 .bss 11592 385024
1421 Total 388392
1422
1423
1424 size :
1425 section size addr
1426 .text 294880 8192
1427 .data 81920 303104
1428 .bss 11888 385024
1429 Total 388688
1430 @end smallexample
1431
1432 @item --help
1433 Show a summary of acceptable arguments and options.
1434
1435 @item -d
1436 @itemx -o
1437 @itemx -x
1438 @itemx --radix=@var{number}
1439 @cindex @code{size} number format
1440 @cindex radix for section sizes
1441 Using one of these options, you can control whether the size of each
1442 section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1443 (@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1444 @samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
1445 values (8, 10, 16) are supported. The total size is always given in two
1446 radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1447 octal and hexadecimal if you're using @samp{-o}.
1448
1449 @item --target=@var{bfdname}
1450 @cindex object code format
1451 Specify that the object-code format for @var{objfile} is
1452 @var{bfdname}. This option may not be necessary; @code{size} can
1453 automatically recognize many formats.
1454 @xref{Target Selection}, for more information.
1455
1456 @item -V
1457 @itemx --version
1458 Display the version number of @code{size}.
1459 @end table
1460
1461 @node strings
1462 @chapter strings
1463 @kindex strings
1464 @cindex listings strings
1465 @cindex printing strings
1466 @cindex strings, printing
1467
1468 @smallexample
1469 strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
1470 [--all] [--print-file-name] [--bytes=@var{min-len}]
1471 [--radix=@var{radix}] [--target=@var{bfdname}]
1472 [--help] [--version] @var{file}@dots{}
1473 @end smallexample
1474
1475 For each @var{file} given, @sc{gnu} @code{strings} prints the printable
1476 character sequences that are at least 4 characters long (or the number
1477 given with the options below) and are followed by an unprintable
1478 character. By default, it only prints the strings from the initialized
1479 and loaded sections of object files; for other types of files, it prints
1480 the strings from the whole file.
1481
1482 @code{strings} is mainly useful for determining the contents of non-text
1483 files.
1484
1485 @table @code
1486 @item -a
1487 @itemx --all
1488 @itemx -
1489 Do not scan only the initialized and loaded sections of object files;
1490 scan the whole files.
1491
1492 @item -f
1493 @itemx --print-file-name
1494 Print the name of the file before each string.
1495
1496 @item --help
1497 Print a summary of the program usage on the standard output and exit.
1498
1499 @item -@var{min-len}
1500 @itemx -n @var{min-len}
1501 @itemx --bytes=@var{min-len}
1502 Print sequences of characters that are at least @var{min-len} characters
1503 long, instead of the default 4.
1504
1505 @item -o
1506 Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1507 act like @samp{-t d} instead. Since we can not be compatible with both
1508 ways, we simply chose one.
1509
1510 @item -t @var{radix}
1511 @itemx --radix=@var{radix}
1512 Print the offset within the file before each string. The single
1513 character argument specifies the radix of the offset---@samp{o} for
1514 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1515
1516 @item --target=@var{bfdname}
1517 @cindex object code format
1518 Specify an object code format other than your system's default format.
1519 @xref{Target Selection}, for more information.
1520
1521 @item -v
1522 @itemx --version
1523 Print the program version number on the standard output and exit.
1524 @end table
1525
1526 @node strip
1527 @chapter strip
1528
1529 @kindex strip
1530 @cindex removing symbols
1531 @cindex discarding symbols
1532 @cindex symbols, discarding
1533
1534 @smallexample
1535 strip [ -F @var{bfdname} | --target=@var{bfdname} ]
1536 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1537 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
1538 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
1539 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
1540 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
1541 [ -x | --discard-all ] [ -X | --discard-locals ]
1542 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
1543 [ -o @var{file} ] [ -p | --preserve-dates ]
1544 [ -v | --verbose ] [ -V | --version ] [ --help ]
1545 @var{objfile}@dots{}
1546 @end smallexample
1547
1548 @sc{gnu} @code{strip} discards all symbols from object files
1549 @var{objfile}. The list of object files may include archives.
1550 At least one object file must be given.
1551
1552 @code{strip} modifies the files named in its argument,
1553 rather than writing modified copies under different names.
1554
1555 @table @code
1556 @item -F @var{bfdname}
1557 @itemx --target=@var{bfdname}
1558 Treat the original @var{objfile} as a file with the object
1559 code format @var{bfdname}, and rewrite it in the same format.
1560 @xref{Target Selection}, for more information.
1561
1562 @item --help
1563 Show a summary of the options to @code{strip} and exit.
1564
1565 @item -I @var{bfdname}
1566 @itemx --input-target=@var{bfdname}
1567 Treat the original @var{objfile} as a file with the object
1568 code format @var{bfdname}.
1569 @xref{Target Selection}, for more information.
1570
1571 @item -O @var{bfdname}
1572 @itemx --output-target=@var{bfdname}
1573 Replace @var{objfile} with a file in the output format @var{bfdname}.
1574 @xref{Target Selection}, for more information.
1575
1576 @item -R @var{sectionname}
1577 @itemx --remove-section=@var{sectionname}
1578 Remove any section named @var{sectionname} from the output file. This
1579 option may be given more than once. Note that using this option
1580 inappropriately may make the output file unusable.
1581
1582 @item -s
1583 @itemx --strip-all
1584 Remove all symbols.
1585
1586 @item -g
1587 @itemx -S
1588 @itemx --strip-debug
1589 Remove debugging symbols only.
1590
1591 @item --strip-unneeded
1592 Remove all symbols that are not needed for relocation processing.
1593
1594 @item -K @var{symbolname}
1595 @itemx --keep-symbol=@var{symbolname}
1596 Keep only symbol @var{symbolname} from the source file. This option may
1597 be given more than once.
1598
1599 @item -N @var{symbolname}
1600 @itemx --strip-symbol=@var{symbolname}
1601 Remove symbol @var{symbolname} from the source file. This option may be
1602 given more than once, and may be combined with strip options other than
1603 @code{-K}.
1604
1605 @item -o @var{file}
1606 Put the stripped output in @var{file}, rather than replacing the
1607 existing file. When this argument is used, only one @var{objfile}
1608 argument may be specified.
1609
1610 @item -p
1611 @itemx --preserve-dates
1612 Preserve the access and modification dates of the file.
1613
1614 @item -x
1615 @itemx --discard-all
1616 Remove non-global symbols.
1617
1618 @item -X
1619 @itemx --discard-locals
1620 Remove compiler-generated local symbols.
1621 (These usually start with @samp{L} or @samp{.}.)
1622
1623 @item -V
1624 @itemx --version
1625 Show the version number for @code{strip}.
1626
1627 @item -v
1628 @itemx --verbose
1629 Verbose output: list all object files modified. In the case of
1630 archives, @samp{strip -v} lists all members of the archive.
1631 @end table
1632
1633 @node c++filt
1634 @chapter c++filt
1635
1636 @kindex c++filt
1637 @cindex demangling C++ symbols
1638
1639 @smallexample
1640 c++filt [ -_ | --strip-underscores ]
1641 [ -n | --no-strip-underscores ]
1642 [ -s @var{format} | --format=@var{format} ]
1643 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
1644 @end smallexample
1645
1646 The C++ language provides function overloading, which means that you can
1647 write many functions with the same name (providing each takes parameters
1648 of different types). All C++ function names are encoded into a
1649 low-level assembly label (this process is known as
1650 @dfn{mangling}). The @code{c++filt} program does the inverse mapping: it
1651 decodes (@dfn{demangles}) low-level names into user-level names so that
1652 the linker can keep these overloaded functions from clashing.
1653
1654 Every alphanumeric word (consisting of letters, digits, underscores,
1655 dollars, or periods) seen in the input is a potential label. If the
1656 label decodes into a C++ name, the C++ name replaces the low-level
1657 name in the output.
1658
1659 You can use @code{c++filt} to decipher individual symbols:
1660
1661 @example
1662 c++filt @var{symbol}
1663 @end example
1664
1665 If no @var{symbol} arguments are given, @code{c++filt} reads symbol
1666 names from the standard input and writes the demangled names to the
1667 standard output. All results are printed on the standard output.
1668
1669 @table @code
1670 @item -_
1671 @itemx --strip-underscores
1672 On some systems, both the C and C++ compilers put an underscore in front
1673 of every name. For example, the C name @code{foo} gets the low-level
1674 name @code{_foo}. This option removes the initial underscore. Whether
1675 @code{c++filt} removes the underscore by default is target dependent.
1676
1677 @item -n
1678 @itemx --no-strip-underscores
1679 Do not remove the initial underscore.
1680
1681 @item -s @var{format}
1682 @itemx --format=@var{format}
1683 @sc{gnu} @code{nm} can decode three different methods of mangling, used by
1684 different C++ compilers. The argument to this option selects which
1685 method it uses:
1686
1687 @table @code
1688 @item gnu
1689 the one used by the @sc{gnu} compiler (the default method)
1690 @item lucid
1691 the one used by the Lucid compiler
1692 @item arm
1693 the one specified by the C++ Annotated Reference Manual
1694 @end table
1695
1696 @item --help
1697 Print a summary of the options to @code{c++filt} and exit.
1698
1699 @item --version
1700 Print the version number of @code{c++filt} and exit.
1701 @end table
1702
1703 @quotation
1704 @emph{Warning:} @code{c++filt} is a new utility, and the details of its
1705 user interface are subject to change in future releases. In particular,
1706 a command-line option may be required in the the future to decode a name
1707 passed as an argument on the command line; in other words,
1708
1709 @example
1710 c++filt @var{symbol}
1711 @end example
1712
1713 @noindent
1714 may in a future release become
1715
1716 @example
1717 c++filt @var{option} @var{symbol}
1718 @end example
1719 @end quotation
1720
1721 @node addr2line
1722 @chapter addr2line
1723
1724 @kindex addr2line
1725 @cindex address to file name and line number
1726
1727 @smallexample
1728 addr2line [ -b @var{bfdname} | --target=@var{bfdname} ]
1729 [ -C | --demangle ]
1730 [ -e @var{filename} | --exe=@var{filename} ]
1731 [ -f | --functions ] [ -s | --basename ]
1732 [ -H | --help ] [ -V | --version ]
1733 [ addr addr ... ]
1734 @end smallexample
1735
1736 @code{addr2line} translates program addresses into file names and line
1737 numbers. Given an address and an executable, it uses the debugging
1738 information in the executable to figure out which file name and line
1739 number are associated with a given address.
1740
1741 The executable to use is specified with the @code{-e} option. The
1742 default is @file{a.out}.
1743
1744 @code{addr2line} has two modes of operation.
1745
1746 In the first, hexadecimal addresses are specified on the command line,
1747 and @code{addr2line} displays the file name and line number for each
1748 address.
1749
1750 In the second, @code{addr2line} reads hexadecimal addresses from
1751 standard input, and prints the file name and line number for each
1752 address on standard output. In this mode, @code{addr2line} may be used
1753 in a pipe to convert dynamically chosen addresses.
1754
1755 The format of the output is @samp{FILENAME:LINENO}. The file name and
1756 line number for each address is printed on a separate line. If the
1757 @code{-f} option is used, then each @samp{FILENAME:LINENO} line is
1758 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
1759 containing the address.
1760
1761 If the file name or function name can not be determined,
1762 @code{addr2line} will print two question marks in their place. If the
1763 line number can not be determined, @code{addr2line} will print 0.
1764
1765 The long and short forms of options, shown here as alternatives, are
1766 equivalent.
1767
1768 @table @code
1769 @item -b @var{bfdname}
1770 @itemx --target=@var{bfdname}
1771 @cindex object code format
1772 Specify that the object-code format for the object files is
1773 @var{bfdname}.
1774
1775 @item -C
1776 @itemx --demangle
1777 @cindex demangling in objdump
1778 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1779 Besides removing any initial underscore prepended by the system, this
1780 makes C++ function names readable. @xref{c++filt}, for more information
1781 on demangling.
1782
1783 @item -e @var{filename}
1784 @itemx --exe=@var{filename}
1785 Specify the name of the executable for which addresses should be
1786 translated. The default file is @file{a.out}.
1787
1788 @item -f
1789 @itemx --functions
1790 Display function names as well as file and line number information.
1791
1792 @item -s
1793 @itemx --basenames
1794 Display only the base of each file name.
1795 @end table
1796
1797 @node nlmconv
1798 @chapter nlmconv
1799
1800 @code{nlmconv} converts a relocatable object file into a NetWare
1801 Loadable Module.
1802
1803 @ignore
1804 @code{nlmconv} currently works with @samp{i386} object
1805 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
1806 object files in @sc{elf}, or @code{a.out} format@footnote{
1807 @code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
1808 format in the Binary File Descriptor library. It has only been tested
1809 with the above formats.}.
1810 @end ignore
1811
1812 @quotation
1813 @emph{Warning:} @code{nlmconv} is not always built as part of the binary
1814 utilities, since it is only useful for NLM targets.
1815 @end quotation
1816
1817 @smallexample
1818 nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1819 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
1820 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
1821 [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
1822 [ -h | --help ] [ -V | --version ]
1823 @var{infile} @var{outfile}
1824 @end smallexample
1825
1826 @code{nlmconv} converts the relocatable @samp{i386} object file
1827 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
1828 reading @var{headerfile} for NLM header information. For instructions
1829 on writing the NLM command file language used in header files, see the
1830 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
1831 Development and Tools Overview}, which is part of the NLM Software
1832 Developer's Kit (``NLM SDK''), available from Novell, Inc.
1833 @code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
1834 @var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for
1835 more information.
1836
1837 @code{nlmconv} can perform a link step. In other words, you can list
1838 more than one object file for input if you list them in the definitions
1839 file (rather than simply specifying one input file on the command line).
1840 In this case, @code{nlmconv} calls the linker for you.
1841
1842 @table @code
1843 @item -I @var{bfdname}
1844 @itemx --input-target=@var{bfdname}
1845 Object format of the input file. @code{nlmconv} can usually determine
1846 the format of a given file (so no default is necessary).
1847 @xref{Target Selection}, for more information.
1848
1849 @item -O @var{bfdname}
1850 @itemx --output-target=@var{bfdname}
1851 Object format of the output file. @code{nlmconv} infers the output
1852 format based on the input format, e.g. for a @samp{i386} input file the
1853 output format is @samp{nlm32-i386}.
1854 @xref{Target Selection}, for more information.
1855
1856 @item -T @var{headerfile}
1857 @itemx --header-file=@var{headerfile}
1858 Reads @var{headerfile} for NLM header information. For instructions on
1859 writing the NLM command file language used in header files, see@ see the
1860 @samp{linkers} section, of the @cite{NLM Development and Tools
1861 Overview}, which is part of the NLM Software Developer's Kit, available
1862 from Novell, Inc.
1863
1864 @item -d
1865 @itemx --debug
1866 Displays (on standard error) the linker command line used by @code{nlmconv}.
1867
1868 @item -l @var{linker}
1869 @itemx --linker=@var{linker}
1870 Use @var{linker} for any linking. @var{linker} can be an abosolute or a
1871 relative pathname.
1872
1873 @item -h
1874 @itemx --help
1875 Prints a usage summary.
1876
1877 @item -V
1878 @itemx --version
1879 Prints the version number for @code{nlmconv}.
1880 @end table
1881
1882 @node windres
1883 @chapter windres
1884
1885 @code{windres} may be used to manipulate Windows resources.
1886
1887 @quotation
1888 @emph{Warning:} @code{windres} is not always built as part of the binary
1889 utilities, since it is only useful for Windows targets.
1890 @end quotation
1891
1892 @smallexample
1893 windres [options] [input-file] [output-file]
1894 @end smallexample
1895
1896 @code{windres} reads resources from an input file and copies them into
1897 an output file. Either file may be in one of three formats:
1898
1899 @table @code
1900 @item rc
1901 A text format read by the Resource Compiler.
1902
1903 @item res
1904 A binary format generated by the Resource Compiler.
1905
1906 @item coff
1907 A COFF object or executable.
1908 @end table
1909
1910 The exact description of these different formats is available in
1911 documentation from Microsoft.
1912
1913 When @code{windres} converts from the @code{rc} format to the @code{res}
1914 format, it is acting like the Windows Resource Compiler. When
1915 @code{windres} converts from the @code{res} format to the @code{coff}
1916 format, it is acting like the Windows @code{CVTRES} program.
1917
1918 When @code{windres} generates an @code{rc} file, the output is similar
1919 but not identical to the format expected for the input. When an input
1920 @code{rc} file refers to an external filename, an output @code{rc} file
1921 will instead include the file contents.
1922
1923 If the input or output format is not specified, @code{windres} will
1924 guess based on the file name, or, for the input file, the file contents.
1925 A file with an extension of @file{.rc} will be treated as an @code{rc}
1926 file, a file with an extension of @file{.res} will be treated as a
1927 @code{res} file, and a file with an extension of @file{.o} or
1928 @file{.exe} will be treated as a @code{coff} file.
1929
1930 If no output file is specified, @code{windres} will print the resources
1931 in @code{rc} format to standard output.
1932
1933 The normal use is for you to write an @code{rc} file, use @code{windres}
1934 to convert it to a COFF object file, and then link the COFF file into
1935 your application. This will make the resources described in the
1936 @code{rc} file available to Windows.
1937
1938 @table @code
1939 @item -i @var{filename}
1940 @itemx --input @var{filename}
1941 The name of the input file. If this option is not used, then
1942 @code{windres} will use the first non-option argument as the input file
1943 name. If there are no non-option arguments, then @code{windres} will
1944 read from standard input. @code{windres} can not read a COFF file from
1945 standard input.
1946
1947 @item -o @var{filename}
1948 @itemx --output @var{filename}
1949 The name of the output file. If this option is not used, then
1950 @code{windres} will use the first non-option argument, after any used
1951 for the input file name, as the output file name. If there is no
1952 non-option argument, then @code{windres} will write to standard output.
1953 @code{windres} can not write a COFF file to standard output.
1954
1955 @item -I @var{format}
1956 @itemx --input-format @var{format}
1957 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
1958 @samp{coff}. If no input format is specified, @code{windres} will
1959 guess, as described above.
1960
1961 @item -O @var{format}
1962 @itemx --output-format @var{format}
1963 The output format to generate. @var{format} may be @samp{res},
1964 @samp{rc}, or @samp{coff}. If no output format is specified,
1965 @code{windres} will guess, as described above.
1966
1967 @item -F @var{target}
1968 @itemx --target @var{target}
1969 Specify the BFD format to use for a COFF file as input or output. This
1970 is a BFD target name; you can use the @code{--help} option to see a list
1971 of supported targets. Normally @code{windres} will use the default
1972 format, which is the first one listed by the @code{--help} option.
1973 @ref{Target Selection}.
1974
1975 @item --preprocessor @var{program}
1976 When @code{windres} reads an @code{rc} file, it runs it through the C
1977 preprocessor first. This option may be used to specify the preprocessor
1978 to use, including any leading arguments. The default preprocessor
1979 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
1980
1981 @item --include-dir @var{directory}
1982 Specify an include directory to use when reading an @code{rc} file.
1983 @code{windres} will pass this to the preprocessor as an @code{-I}
1984 option. @code{windres} will also search this directory when looking for
1985 files named in the @code{rc} file.
1986
1987 @item --define @var{sym[=val]}
1988 Specify a @code{-D} option to pass to the preprocessor when reading an
1989 @code{rc} file.
1990
1991 @item --language @var{val}
1992 Specify the default language to use when reading an @code{rc} file.
1993 @var{val} should be a hexadecimal language code. The low eight bits are
1994 the language, and the high eight bits are the sublanguage.
1995
1996 @item --help
1997 Prints a usage summary.
1998
1999 @item --version
2000 Prints the version number for @code{windres}.
2001
2002 @item --yydebug
2003 If @code{windres} is compiled with @code{YYDEBUG} defined as @code{1},
2004 this will turn on parser debugging.
2005 @end table
2006
2007 @node Selecting The Target System
2008 @chapter Selecting the target system
2009
2010 You can specify three aspects of the target system to the @sc{gnu}
2011 binary file utilities, each in several ways:
2012
2013 @itemize @bullet
2014 @item
2015 the target
2016
2017 @item
2018 the architecture
2019
2020 @item
2021 the linker emulation (which applies to the linker only)
2022 @end itemize
2023
2024 In the following summaries, the lists of ways to specify values are in
2025 order of decreasing precedence. The ways listed first override those
2026 listed later.
2027
2028 The commands to list valid values only list the values for which the
2029 programs you are running were configured. If they were configured with
2030 @samp{--enable-targets=all}, the commands list most of the available
2031 values, but a few are left out; not all targets can be configured in at
2032 once because some of them can only be configured @dfn{native} (on hosts
2033 with the same type as the target system).
2034
2035 @menu
2036 * Target Selection::
2037 * Architecture Selection::
2038 * Linker Emulation Selection::
2039 @end menu
2040
2041 @node Target Selection
2042 @section Target Selection
2043
2044 A @dfn{target} is an object file format. A given target may be
2045 supported for multiple architectures (@pxref{Architecture Selection}).
2046 A target selection may also have variations for different operating
2047 systems or architectures.
2048
2049 The command to list valid target values is @samp{objdump -i}
2050 (the first column of output contains the relevant information).
2051
2052 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
2053 @samp{a.out-sunos-big}.
2054
2055 You can also specify a target using a configuration triplet. This is
2056 the same sort of name that is passed to configure to specify a target.
2057 When you use a configuration triplet as an argument, it must be fully
2058 canonicalized. You can see the canonical version of a triplet by
2059 running the shell script @file{config.sub} which is included with the
2060 sources.
2061
2062 Some sample configuration triplets are: @samp{m68k-hp-bsd},
2063 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
2064
2065 @subheading @code{objdump} Target
2066
2067 Ways to specify:
2068
2069 @enumerate
2070 @item
2071 command line option: @samp{-b} or @samp{--target}
2072
2073 @item
2074 environment variable @code{GNUTARGET}
2075
2076 @item
2077 deduced from the input file
2078 @end enumerate
2079
2080 @subheading @code{objcopy} and @code{strip} Input Target
2081
2082 Ways to specify:
2083
2084 @enumerate
2085 @item
2086 command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
2087
2088 @item
2089 environment variable @code{GNUTARGET}
2090
2091 @item
2092 deduced from the input file
2093 @end enumerate
2094
2095 @subheading @code{objcopy} and @code{strip} Output Target
2096
2097 Ways to specify:
2098
2099 @enumerate
2100 @item
2101 command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
2102
2103 @item
2104 the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
2105
2106 @item
2107 environment variable @code{GNUTARGET}
2108
2109 @item
2110 deduced from the input file
2111 @end enumerate
2112
2113 @subheading @code{nm}, @code{size}, and @code{strings} Target
2114
2115 Ways to specify:
2116
2117 @enumerate
2118 @item
2119 command line option: @samp{--target}
2120
2121 @item
2122 environment variable @code{GNUTARGET}
2123
2124 @item
2125 deduced from the input file
2126 @end enumerate
2127
2128 @subheading Linker Input Target
2129
2130 Ways to specify:
2131
2132 @enumerate
2133 @item
2134 command line option: @samp{-b} or @samp{--format}
2135 (@pxref{Options,,Options,ld.info,Using LD})
2136
2137 @item
2138 script command @code{TARGET}
2139 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2140
2141 @item
2142 environment variable @code{GNUTARGET}
2143 (@pxref{Environment,,Environment,ld.info,Using LD})
2144
2145 @item
2146 the default target of the selected linker emulation
2147 (@pxref{Linker Emulation Selection})
2148 @end enumerate
2149
2150 @subheading Linker Output Target
2151
2152 Ways to specify:
2153
2154 @enumerate
2155 @item
2156 command line option: @samp{-oformat}
2157 (@pxref{Options,,Options,ld.info,Using LD})
2158
2159 @item
2160 script command @code{OUTPUT_FORMAT}
2161 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2162
2163 @item
2164 the linker input target (see ``Linker Input Target'' above)
2165 @end enumerate
2166
2167 @node Architecture Selection
2168 @section Architecture selection
2169
2170 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
2171 to run. Its name may contain a colon, separating the name of the
2172 processor family from the name of the particular @sc{cpu}.
2173
2174 The command to list valid architecture values is @samp{objdump -i} (the
2175 second column contains the relevant information).
2176
2177 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
2178
2179 @subheading @code{objdump} Architecture
2180
2181 Ways to specify:
2182
2183 @enumerate
2184 @item
2185 command line option: @samp{-m} or @samp{--architecture}
2186
2187 @item
2188 deduced from the input file
2189 @end enumerate
2190
2191 @subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
2192
2193 Ways to specify:
2194
2195 @enumerate
2196 @item
2197 deduced from the input file
2198 @end enumerate
2199
2200 @subheading Linker Input Architecture
2201
2202 Ways to specify:
2203
2204 @enumerate
2205 @item
2206 deduced from the input file
2207 @end enumerate
2208
2209 @subheading Linker Output Architecture
2210
2211 Ways to specify:
2212
2213 @enumerate
2214 @item
2215 script command @code{OUTPUT_ARCH}
2216 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2217
2218 @item
2219 the default architecture from the linker output target
2220 (@pxref{Target Selection})
2221 @end enumerate
2222
2223 @node Linker Emulation Selection
2224 @section Linker emulation selection
2225
2226 A linker @dfn{emulation} is a ``personality'' of the linker, which gives
2227 the linker default values for the other aspects of the target system.
2228 In particular, it consists of
2229
2230 @itemize @bullet
2231 @item
2232 the linker script
2233
2234 @item
2235 the target
2236
2237 @item
2238 several ``hook'' functions that are run at certain stages of the linking
2239 process to do special things that some targets require
2240 @end itemize
2241
2242 The command to list valid linker emulation values is @samp{ld -V}.
2243
2244 Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
2245
2246 Ways to specify:
2247
2248 @enumerate
2249 @item
2250 command line option: @samp{-m}
2251 (@pxref{Options,,Options,ld.info,Using LD})
2252
2253 @item
2254 environment variable @code{LDEMULATION}
2255
2256 @item
2257 compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
2258 which comes from @code{EMUL} in @file{config/@var{target}.mt}
2259 @end enumerate
2260
2261 @node Reporting Bugs
2262 @chapter Reporting Bugs
2263 @cindex bugs
2264 @cindex reporting bugs
2265
2266 Your bug reports play an essential role in making the binary utilities
2267 reliable.
2268
2269 Reporting a bug may help you by bringing a solution to your problem, or
2270 it may not. But in any case the principal function of a bug report is
2271 to help the entire community by making the next version of the binary
2272 utilities work better. Bug reports are your contribution to their
2273 maintenance.
2274
2275 In order for a bug report to serve its purpose, you must include the
2276 information that enables us to fix the bug.
2277
2278 @menu
2279 * Bug Criteria:: Have you found a bug?
2280 * Bug Reporting:: How to report bugs
2281 @end menu
2282
2283 @node Bug Criteria
2284 @section Have you found a bug?
2285 @cindex bug criteria
2286
2287 If you are not sure whether you have found a bug, here are some guidelines:
2288
2289 @itemize @bullet
2290 @cindex fatal signal
2291 @cindex crash
2292 @item
2293 If a binary utility gets a fatal signal, for any input whatever, that is
2294 a bug. Reliable utilities never crash.
2295
2296 @cindex error on valid input
2297 @item
2298 If a binary utility produces an error message for valid input, that is a
2299 bug.
2300
2301 @item
2302 If you are an experienced user of binary utilities, your suggestions for
2303 improvement are welcome in any case.
2304 @end itemize
2305
2306 @node Bug Reporting
2307 @section How to report bugs
2308 @cindex bug reports
2309 @cindex bugs, reporting
2310
2311 A number of companies and individuals offer support for @sc{gnu}
2312 products. If you obtained the binary utilities from a support
2313 organization, we recommend you contact that organization first.
2314
2315 You can find contact information for many support companies and
2316 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
2317 distribution.
2318
2319 In any event, we also recommend that you send bug reports for the binary
2320 utilities to @samp{bug-gnu-utils@@gnu.org}.
2321
2322 The fundamental principle of reporting bugs usefully is this:
2323 @strong{report all the facts}. If you are not sure whether to state a
2324 fact or leave it out, state it!
2325
2326 Often people omit facts because they think they know what causes the
2327 problem and assume that some details do not matter. Thus, you might
2328 assume that the name of a file you use in an example does not matter.
2329 Well, probably it does not, but one cannot be sure. Perhaps the bug is
2330 a stray memory reference which happens to fetch from the location where
2331 that pathname is stored in memory; perhaps, if the pathname were
2332 different, the contents of that location would fool the utility into
2333 doing the right thing despite the bug. Play it safe and give a
2334 specific, complete example. That is the easiest thing for you to do,
2335 and the most helpful.
2336
2337 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
2338 it is new to us. Therefore, always write your bug reports on the assumption
2339 that the bug has not been reported previously.
2340
2341 Sometimes people give a few sketchy facts and ask, ``Does this ring a
2342 bell?'' Those bug reports are useless, and we urge everyone to
2343 @emph{refuse to respond to them} except to chide the sender to report
2344 bugs properly.
2345
2346 To enable us to fix the bug, you should include all these things:
2347
2348 @itemize @bullet
2349 @item
2350 The version of the utility. Each utility announces it if you start it
2351 with the @samp{--version} argument.
2352
2353 Without this, we will not know whether there is any point in looking for
2354 the bug in the current version of the binary utilities.
2355
2356 @item
2357 Any patches you may have applied to the source, including any patches
2358 made to the @code{BFD} library.
2359
2360 @item
2361 The type of machine you are using, and the operating system name and
2362 version number.
2363
2364 @item
2365 What compiler (and its version) was used to compile the utilities---e.g.
2366 ``@code{gcc-2.7}''.
2367
2368 @item
2369 The command arguments you gave the utility to observe the bug. To
2370 guarantee you will not omit something important, list them all. A copy
2371 of the Makefile (or the output from make) is sufficient.
2372
2373 If we were to try to guess the arguments, we would probably guess wrong
2374 and then we might not encounter the bug.
2375
2376 @item
2377 A complete input file, or set of input files, that will reproduce the
2378 bug. If the utility is reading an object file or files, then it is
2379 generally most helpful to send the actual object files, uuencoded if
2380 necessary to get them through the mail system. Making them available
2381 for anonymous FTP is not as good, but may be the only reasonable choice
2382 for large object files.
2383
2384 If the source files were produced exclusively using @sc{gnu} programs
2385 (e.g., @code{gcc}, @code{gas}, and/or the @sc{gnu} @code{ld}), then it
2386 may be OK to send the source files rather than the object files. In
2387 this case, be sure to say exactly what version of @code{gcc}, or
2388 whatever, was used to produce the object files. Also say how
2389 @code{gcc}, or whatever, was configured.
2390
2391 @item
2392 A description of what behavior you observe that you believe is
2393 incorrect. For example, ``It gets a fatal signal.''
2394
2395 Of course, if the bug is that the utility gets a fatal signal, then we
2396 will certainly notice it. But if the bug is incorrect output, we might
2397 not notice unless it is glaringly wrong. You might as well not give us
2398 a chance to make a mistake.
2399
2400 Even if the problem you experience is a fatal signal, you should still
2401 say so explicitly. Suppose something strange is going on, such as, your
2402 copy of the utility is out of synch, or you have encountered a bug in
2403 the C library on your system. (This has happened!) Your copy might
2404 crash and ours would not. If you told us to expect a crash, then when
2405 ours fails to crash, we would know that the bug was not happening for
2406 us. If you had not told us to expect a crash, then we would not be able
2407 to draw any conclusion from our observations.
2408
2409 @item
2410 If you wish to suggest changes to the source, send us context diffs, as
2411 generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
2412 option. Always send diffs from the old file to the new file. If you
2413 even discuss something in the @code{ld} source, refer to it by context,
2414 not by line number.
2415
2416 The line numbers in our development sources will not match those in your
2417 sources. Your line numbers would convey no useful information to us.
2418 @end itemize
2419
2420 Here are some things that are not necessary:
2421
2422 @itemize @bullet
2423 @item
2424 A description of the envelope of the bug.
2425
2426 Often people who encounter a bug spend a lot of time investigating
2427 which changes to the input file will make the bug go away and which
2428 changes will not affect it.
2429
2430 This is often time consuming and not very useful, because the way we
2431 will find the bug is by running a single example under the debugger
2432 with breakpoints, not by pure deduction from a series of examples.
2433 We recommend that you save your time for something else.
2434
2435 Of course, if you can find a simpler example to report @emph{instead}
2436 of the original one, that is a convenience for us. Errors in the
2437 output will be easier to spot, running under the debugger will take
2438 less time, and so on.
2439
2440 However, simplification is not vital; if you do not want to do this,
2441 report the bug anyway and send us the entire test case you used.
2442
2443 @item
2444 A patch for the bug.
2445
2446 A patch for the bug does help us if it is a good one. But do not omit
2447 the necessary information, such as the test case, on the assumption that
2448 a patch is all we need. We might see problems with your patch and decide
2449 to fix the problem another way, or we might not understand it at all.
2450
2451 Sometimes with programs as complicated as the binary utilities it is
2452 very hard to construct an example that will make the program follow a
2453 certain path through the code. If you do not send us the example, we
2454 will not be able to construct one, so we will not be able to verify that
2455 the bug is fixed.
2456
2457 And if we cannot understand what bug you are trying to fix, or why your
2458 patch should be an improvement, we will not install it. A test case will
2459 help us to understand.
2460
2461 @item
2462 A guess about what the bug is or what it depends on.
2463
2464 Such guesses are usually wrong. Even we cannot guess right about such
2465 things without first using the debugger to find the facts.
2466 @end itemize
2467
2468 @node Index
2469 @unnumbered Index
2470
2471 @printindex cp
2472
2473 @contents
2474 @bye
This page took 0.081172 seconds and 4 git commands to generate.